66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * CDDL HEADER START
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * The contents of this file are subject to the terms of the
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Common Development and Distribution License (the "License").
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * You may not use this file except in compliance with the License.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * See the License for the specific language governing permissions
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * and limitations under the License.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * When distributing Covered Code, include this CDDL HEADER in each
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * If applicable, add the following below this CDDL HEADER, with the
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * fields enclosed by brackets "[]" replaced with your own identifying
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * information: Portions Copyright [yyyy] [name of copyright owner]
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * CDDL HEADER END
0bc523e585d34fb799f65e1c4fd7d163e401a501Alan Perry * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Use is subject to license terms.
257c04ecb24858f6d68020a41589306f554ea434Marcel Telka * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlfextern "C" {
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Generic SATA Host Adapter Implementation
4372d277de71fc7c19cb9f41df9b8757b34e2cc5pawelw/* Common flags specifying current state of a port or an attached drive. */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Statistics counters */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA HBA instance info structure
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf dev_info_t *satahba_dip; /* this HBA instance devinfo */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_hba_inst *satahba_next; /* ptr to next sata_hba_inst */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_hba_inst *satahba_prev; /* ptr to prev sata_hba_inst */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct scsi_hba_tran *satahba_scsi_tran; /* scsi_hba_tran */
7a1efdfee8cbdecea34d3d866bbfb46e39b06e0apawelw struct taskq *satahba_taskq; /* cmd completion task queue */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * HBA event flags:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_MAIN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_PWR_LEVEL_CHANGED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_SKIP
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_cport_info *satahba_dev_port[SATA_MAX_CPORTS];
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * DEVCTL open flag:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DEVCTL_SOPENED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DEVCTL_EXOPENED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_ctrl_stats satahba_stats; /* HBA cntrl statistics */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf /* 0 - not completed */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf /* 1 - completed */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA controller's device port info and state.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * This structure is pointed to by the sata_hba_inst.satahba_dev_port[x]
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * where x is a device port number.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cport_state holds port state flags, defined in sata_hba.h file.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cport_event_flags holds SATA_EVNT_* flags defined in this file and in
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cport_dev_type holds SATA_DTYPE_* types defined in sata_hba.h file.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port state flags
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_UNKNOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBING
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_READY
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_PWRON
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_PWROFF
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_SHUTDOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_FAILED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port event flags:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_DEVICE_ATTACHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_DEVICE_DETACHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_LINK_LOST
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_LINK_ESTABLISHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_PORT_FAILED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_PWR_LEVEL_CHANGED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_port_scr cport_scr; /* Port status and ctrl regs */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attached device type:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_NONE
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATADISK
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATAPICD
385470574fb49e32c324af06c01d697a16cc3c4bying tian - Beijing China * SATA_DTYPE_ATAPITAPE
f8a673ad9145b262edb65a98fb3fb92027d23a05ying tian - Beijing China * SATA_DTYPE_ATAPIDISK
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_PMULT
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_UNKNOWN
257c04ecb24858f6d68020a41589306f554ea434Marcel Telka * SATA_DTYPE_ATAPIPROC
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_drive_info *cport_sata_drive; /* Attached drive info */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_pmult_info *cport_sata_pmult; /* Attached Port Mult */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf /* lbolt value at link lost */
6ed1276fb5fe78fb1cce38682748a830ef8bd157pawelw /* lbolt value @ dev attached */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_port_stats cport_stats; /* Port statistics */
4360436b3c604bc28d37be269ad152b4c38157c3pawelw boolean_t cport_tgtnode_clean; /* Target node usable */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attached SATA drive info and state.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * This structure is pointed to by sata_cport_info's cport_sata_drive field
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * when a drive is attached directly to a controller device port.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_address_t satadrv_addr; /* this drive SATA address */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Drive state flags
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_UNKNOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBING
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_READY
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DSTATE_PWR_ACTIVE
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DSTATE_PWR_IDLE
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DSTATE_RESET
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DSTATE_FAILED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * drive event flags:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_DRIVE_RESET
4372d277de71fc7c19cb9f41df9b8757b34e2cc5pawelw * lbolt value @ start of
4372d277de71fc7c19cb9f41df9b8757b34e2cc5pawelw * device reset processing
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attached device type:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATADISK
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATAPICD
385470574fb49e32c324af06c01d697a16cc3c4bying tian - Beijing China * SATA_DTYPE_ATAPITAPE
f8a673ad9145b262edb65a98fb3fb92027d23a05ying tian - Beijing China * SATA_DTYPE_ATAPIDISK
257c04ecb24858f6d68020a41589306f554ea434Marcel Telka * SATA_DTYPE_ATAPIPROC
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf uint16_t satadrv_features_support; /* drive features support */
2038334ab26baaa43c9083f35def041511c3cc1fUnknown uint16_t satadrv_atapi_cdb_len; /* atapi supported cdb length */
2038334ab26baaa43c9083f35def041511c3cc1fUnknown uint16_t satadrv_atapi_trans_ver; /* atapi transport version */
4e54023805e14cf984b9f0041df73c16334a7a88ls uint16_t satadrv_features_enabled; /* drive features enabled */
2038334ab26baaa43c9083f35def041511c3cc1fUnknown uint64_t satadrv_max_queue_depth; /* maximum queue depth */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_drive_stats satadrv_stats; /* drive statistics */
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * saved standby timer
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * [0] - [3] = high - low
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu uint8_t satadrv_power_level; /* saved power level */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_drive_info))
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Port Multiplier & host port info and state */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_address_t pmult_addr; /* this PMult SATA Address */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * PMult state flags
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_UNKNOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBING
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_READY
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_FAILED
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang struct sata_pmult_gscr pmult_gscr; /* PMult GSCR block */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf uint32_t pmult_num_dev_ports; /* Number of data ports */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_pmport_info *pmult_dev_port[SATA_MAX_PMPORTS - 1];
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_pmult_info))
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang_NOTE(MUTEX_PROTECTS_DATA(sata_cport_info::cport_mutex, \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Port Multiplier's device port info & state */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_address_t pmport_addr; /* this SATA port address */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port state flags
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_UNKNOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBING
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_PROBED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_STATE_READY
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_PWRON
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_PWROFF
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_SHUTDOWN
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_FAILED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port event flags:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_DEVICE_ATTACHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_DEVICE_DETACHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_LINK_LOST
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_LINK_ESTABLISHED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_PORT_FAILED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_PWR_LEVEL_CHANGED
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_port_scr pmport_scr; /* PMult device port scr */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attached device type:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_NONE
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATADISK
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_ATAPICD
385470574fb49e32c324af06c01d697a16cc3c4bying tian - Beijing China * SATA_DTYPE_ATAPITAPE
f8a673ad9145b262edb65a98fb3fb92027d23a05ying tian - Beijing China * SATA_DTYPE_ATAPIDISK
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_DTYPE_UNKNOWN
257c04ecb24858f6d68020a41589306f554ea434Marcel Telka * SATA_DTYPE_ATAPIPROC
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_drive_info *pmport_sata_drive; /* Attached drive info */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf /* lbolt value at link lost */
6ed1276fb5fe78fb1cce38682748a830ef8bd157pawelw /* lbolt value @ dev attached */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf struct sata_port_stats pmport_stats; /* Port statistics */
4360436b3c604bc28d37be269ad152b4c38157c3pawelw boolean_t pmport_tgtnode_clean; /* Target node usable */
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * sata drive's power level
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * default value is active
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * pm-capable value definition according to PSARC 2009/310
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port SSTATUS register (sata_port_scr sport_sstatus field).
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Link bits are valid only in port active state.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PORT_DEVLINK_UP 0x00000103 /* Link with dev established */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PORT_DEVLINK_UP_MASK 0x0000010F /* Mask for link bits */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Port state clear mask (cport_state and pmport_state fields).
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_PSTATE_SHUTDOWN and power state are preserved.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PORT_STATE_CLEAR_MASK (~(SATA_PSTATE_SHUTDOWN))
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Valid i.e.supported device types mask (cport_dev_type, satadrv_type,
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * pmult_dev_type fields).
2038334ab26baaa43c9083f35def041511c3cc1fUnknown * ATA disks and ATAPI CD/DVD now.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Device feature_support (satadrv_features_support)
4e54023805e14cf984b9f0041df73c16334a7a88ls * Device features enabled (satadrv_features_enabled)
4e54023805e14cf984b9f0041df73c16334a7a88ls#define SATA_DEV_F_E_TAGGED_QING 0x01 /* Tagged queuing enabled */
4e54023805e14cf984b9f0041df73c16334a7a88ls#define SATA_DEV_F_E_UNTAGGED_QING 0x02 /* Untagged queuing enabled */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Drive settings flags (satdrv_settings)
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_DEV_READ_AHEAD 0x0001 /* Read Ahead enabled */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_DEV_SERIAL_FEATURES 0x8000 /* Serial ATA feat. enabled */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_DEV_ASYNCH_NOTIFY 0x2000 /* Asynch-event enabled */
2038334ab26baaa43c9083f35def041511c3cc1fUnknown#define SATA_DEV_RMSN 0x0100 /* Rem Media Stat Notfc enbl */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Internal event and flags.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * These flags are set in the *_event_flags fields of various structures.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Events and lock flags defined below are used internally by the
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA framework (they are not reported by SATA HBA drivers).
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Lock flags - used to serialize configuration operations
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * on ports and devices.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_EVNT_LOCK_PORT_BUSY is set by event daemon to prevent
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * simultaneous cfgadm operations.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SATA_APCTL_LOCK_PORT_BUSY is set by cfgadm ioctls to prevent
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * simultaneous event processing.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Mask for port events */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_EVNT_PORT_EVENTS (SATA_EVNT_DEVICE_ATTACHED | \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Mask for drive events */
4360436b3c604bc28d37be269ad152b4c38157c3pawelw#define SATA_EVNT_DRIVE_EVENTS (SATA_EVNT_DEVICE_RESET | \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_EVNT_CONTROLLER_EVENTS SATA_EVNT_PWR_LEVEL_CHANGED
c75976d12071ddd21443266260066ba036671682pawelw/* Delays and timeout duration definitions */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_EVNT_DAEMON_TERM_TIMEOUT 100000 /* 100 ms */
4372d277de71fc7c19cb9f41df9b8757b34e2cc5pawelw#define SATA_DEV_IDENTIFY_TIMEOUT 60000000 /* 60 s, device enumeration */
4372d277de71fc7c19cb9f41df9b8757b34e2cc5pawelw#define SATA_DEV_REPROBE_TIMEOUT 30000000 /* 30 s, dev resp after rst */
6ed1276fb5fe78fb1cce38682748a830ef8bd157pawelw/* DEVICE IDENTIFY and device initialization retry delay */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * sata_scsi's hba_open_flag: field indicating open devctl instance.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * 0 = closed, 1 = shared open, 2 = exclusive open.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * sata_pkt_txlate structure contains info about resources allocated
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * for the packet
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Address of this structure is stored in scsi_pkt.pkt_ha_private and
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * in sata_pkt.sata_hba_private fields, so all three strucures are
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cross-linked, with sata_pkt_txlate as a centerpiece.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf /* cookies in the current DMA window */
4360436b3c604bc28d37be269ad152b4c38157c3pawelw /* processed dma cookies in current DMA win */
4360436b3c604bc28d37be269ad152b4c38157c3pawelw ddi_dma_cookie_t txlt_dma_cookie; /* default dma cookie */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf ddi_dma_cookie_t *txlt_dma_cookie_list; /* dma cookie list */
7a70ede882eacbae00c8d5209afb443e7755684cpawelw /* temporary buffer access handle */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_pkt_txlate))
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry/* Length of largest sense buffer used by sata */
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry#define SATA_MAX_SENSE_LEN MAX(sizeof (struct scsi_arq_status), \
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry sizeof (struct scsi_arq_status) - sizeof (struct scsi_extended_sense) + \
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry sizeof (struct scsi_descr_sense_hdr) + \
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry MAX(sizeof (struct scsi_cmd_specific_sense_descr), \
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry sizeof (struct scsi_ata_status_ret_sense_descr)))
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry * Sense Data structure for ATA Pass Through
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry * This is the entire sense data block passed back up to scsi. It is
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry * effectively the scsi_arq_status structure for ATA Sense Return descriptor
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry * format sense data.
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry struct scsi_ata_status_ret_sense_descr apt_sd_sense;
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Additional scsi sense code definitions.
2038334ab26baaa43c9083f35def041511c3cc1fUnknown * These definition should eventually be moved to scsi header file
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu#define SD_SCSI_ASC_INVALID_FIELD_IN_PARAMS_LIST 0x26
63aa537723d4883425b44d96b6316b7ad14053fcAlan Perry#define SD_SCSI_ASC_SAVING_PARAMS_NOT_SUPPORTED 0x39
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* SCSI defs missing from scsi headers */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Missing from sys/scsi/generic/commands.h */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define MODEPAGE_RW_ERRRECOV 0x01 /* read/write recovery */
0bc523e585d34fb799f65e1c4fd7d163e401a501Alan Perry/* Missing from sys/scsi/impl/commands.h */
0bc523e585d34fb799f65e1c4fd7d163e401a501Alan Perry#define SCSI_READ_CAPACITY16_MAX_LBA 0xfffffffffffffffe
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu * medium access command
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu (((cmd) == SCMD_READ) || ((cmd) == SCMD_WRITE) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_READ_G1) || ((cmd) == SCMD_WRITE_G1) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_READ_G4) || ((cmd) == SCMD_WRITE_G4) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_READ_G5) || ((cmd) == SCMD_WRITE_G5) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_VERIFY) || ((cmd) == SCMD_VERIFY_G4) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_VERIFY_G5) || ((cmd) == 0x7f) /* VERIFY(32) */|| \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_SYNCHRONIZE_CACHE) || ((cmd) == SCMD_SPACE_G4) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_READ_LONG) || ((cmd) == SCMD_SVC_ACTION_IN_G4) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == SCMD_WRITE_LONG) || ((cmd) == SCMD_SVC_ACTION_OUT_G4) || \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == 0x41) || ((cmd) == 0x93) || /* WRITE SAME */ \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == 0x52) || ((cmd) == 0x50) || /* XDREAD & XDWRITE */ \
2ee4dfc799525d35706ee64a901cd970a7080bb6Jane Chu ((cmd) == 0x53) || ((cmd) == 0x51) || /* XDWRITEREAD & XPWRITE */ \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Macros for accessing various structure fields
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_hba_inst->satahba_tran->sata_tran_hba_features_support
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf (sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf (sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \
4360436b3c604bc28d37be269ad152b4c38157c3pawelw#define SATA_CPORT_EVENT_FLAGS(sata_hba_inst, cport) \
4360436b3c604bc28d37be269ad152b4c38157c3pawelw sata_hba_inst->satahba_dev_port[cport]->cport_event_flags
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_drive
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_pmult
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang#define SATA_PMPORT_MUTEX(sata_hba_inst, cport, pmport) \
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_mutex
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PMPORT_DRV_INFO(sata_hba_inst, cport, pmport) \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PMPORT_STATE(sata_hba_inst, cport, pmport) \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_state
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_scr
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_PMPORT_DEV_TYPE(sata_hba_inst, cport, pmport) \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_dev_type
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang#define SATA_PMPORT_EVENT_FLAGS(sata_hba_inst, cport, pmport) \
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->\
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang spx->txlt_sata_pkt->satapkt_device.satadev_addr.pmport
8aa6aadbbfba50077655c6a46a5e269c880e4ab4Xiao-Yu Zhang spx->txlt_sata_pkt->satapkt_device.satadev_addr.qual
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Minor number construction for devctl and attachment point nodes.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * All necessary information has to be encoded in NBITSMINOR32 bits.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Devctl node minor number:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * ((controller_instance << SATA_CNTRL_INSTANCE_SHIFT) | SATA_DEVCTL_NODE)
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attachment point node minor number has to include controller
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * instance (7 bits), controller port number (5 bits) and port multiplier
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * device port number (4 bits) and port multiplier device port
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * indicator (1 bit). Additionally, a single bit is used to
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * differentiate between attachment point node and device control node.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * Attachment point minor number:
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * ((controller_instance << SATA_CNTRL_INSTANCE_SHIFT) | SATA_AP_NODE |
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * [(port_multiplier_device_port << SATA_PMULT_PORT_SHIFT) | SATA_PMULT_AP] |
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * (controller_port))
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * 17 bits are used (if 64 instances of controllers are expected)
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * bit 18 is reserved for future use.
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * --------------------------------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * |17|16|15|14|13|12|11|10 |09|08|07|06|05|04|03|02|01|00|
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * --------------------------------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * | R| c| c| c| c| c| c|a/d|pm|pp|pp|pp|pp|cp|cp|cp|cp|cp|
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * --------------------------------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cp - device port number on the HBA SATA controller
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * pp - device port number on the port multiplier
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * pm - 0 - target attached to controller device port
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * 1 - target attached to port multiplier's device port
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * a/d - 0 - devctl node
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * 1 - attachment point node
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * c - controller number
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * R - reserved bit
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_CNTRL_INSTANCE_MASK 0x03F /* 64 controllers */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Macro for creating devctl node minor number */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Macro for creating an attachment point node minor number */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#define SATA_MAKE_AP_MINOR(cntrl_instance, cport, pmport, qual) \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Macro retrieving controller number from a minor number */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf ((minor >> SATA_CNTRL_INSTANCE_SHIFT) & SATA_CNTRL_INSTANCE_MASK)
f76ee27a7c2e4dbe22aec6ce187c04e980f90349pawelw * Macro for creating an attachment point number from sata address.
f76ee27a7c2e4dbe22aec6ce187c04e980f90349pawelw * Address qualifier has to be one of:
f76ee27a7c2e4dbe22aec6ce187c04e980f90349pawelw * SATA_ADDR_DCPORT, SATA_ADDR_DPMPORT, SATA_ADDR_CPORT or SATA_ADDR_PMPORT
f76ee27a7c2e4dbe22aec6ce187c04e980f90349pawelw (SATA_PMULT_AP | (pmport << SATA_PMULT_PORT_SHIFT) | cport) : \
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * SCSI target number format
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * -------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * | 9| 8| 7| 6| 5| 4| 3| 2| 1| 0| Bit number
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * -------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * |pm|pp|pp|pp|pp|cp|cp|cp|cp|cp|
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * -------------------------------
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * cp - device port number on the HBA SATA controller
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * pp - device port number on the port multiplier
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * pm - 0 - target attached to controller device port
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf * 1 - target attached to port multiplier's device port
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* SATA ports to SCSI target number translation */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf (cport | (pmport << SATA_PMULT_PORT_SHIFT) | SATA_PMULT_AP))
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* SCSI target number to SATA cntrl/pmport/cport translations */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf ((scsi_target >> SATA_PMULT_PORT_SHIFT) & SATA_PMULT_PORT_MASK)
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Debug flags */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf/* Debug macros */
918304a3bd962ac065ad520336a044d94b40ad16Xiao-Yu Zhang/* sata_rev_tag 1.46 */
66f9d5cb3cc0652e2d9d1366fb950efbe4ca2f24mlf#endif /* _SATA_H */