sata_hba.h revision 8010:95c42a8a213e
1/* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22/* 23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27#ifndef _SATA_HBA_H 28#define _SATA_HBA_H 29 30#ifdef __cplusplus 31extern "C" { 32#endif 33 34#include <sys/sata/sata_defs.h> 35 36/* 37 * SATA Host Bus Adapter (HBA) driver transport definitions 38 */ 39 40#include <sys/types.h> 41 42#ifndef TRUE 43#define TRUE 1 44#define FALSE 0 45#endif 46 47#define SATA_SUCCESS 0 48#define SATA_RETRY 1 49#define SATA_FAILURE -1 50 51 52/* SATA Framework definitions */ 53 54#define SATA_MAX_CPORTS 32 /* Max number of controller ports */ 55 56 /* Multiplier (PMult) */ 57#define SATA_MAX_PMPORTS 16 /* Maximum number of ports on PMult */ 58#define SATA_PMULT_HOSTPORT 0xf /* Port Multiplier host port number */ 59 60 61/* 62 * SATA device address 63 * Address qualifier flags are used to specify what is addressed (device 64 * or port) and where (controller or port multiplier data port). 65 */ 66struct sata_address { 67 uint8_t cport; /* Controller's SATA port number */ 68 uint8_t pmport; /* Port Multiplier SATA port number */ 69 uint8_t qual; /* Address Qualifier flags */ 70 uint8_t pad; /* Reserved */ 71}; 72 73typedef struct sata_address sata_address_t; 74 75/* 76 * SATA address Qualifier flags (in qual field of sata_address struct). 77 * They are mutually exclusive. 78 */ 79 80#define SATA_ADDR_NULL 0x00 /* No address */ 81#define SATA_ADDR_DCPORT 0x01 /* Device attched to controller port */ 82#define SATA_ADDR_DPMPORT 0x02 /* Device attched to PM device port */ 83#define SATA_ADDR_CPORT 0x04 /* Controller's device port */ 84#define SATA_ADDR_PMPORT 0x08 /* Port Multiplier's device port */ 85#define SATA_ADDR_CNTRL 0x10 /* Controller */ 86#define SATA_ADDR_PMULT 0x20 /* Port Multiplier */ 87 88/* 89 * SATA port status and control register block. 90 * The sstatus, serror, scontrol, sactive and snotific 91 * are the copies of the SATA port status and control registers. 92 * (Port SStatus, SError, SControl, SActive and SNotification are 93 * defined by Serial ATA r1.0a sepc and Serial ATA II spec. 94 */ 95 96struct sata_port_scr 97{ 98 uint32_t sstatus; /* Port SStatus register */ 99 uint32_t serror; /* Port SError register */ 100 uint32_t scontrol; /* Port SControl register */ 101 uint32_t sactive; /* Port SActive register */ 102 uint32_t snotific; /* Port SNotification register */ 103}; 104 105typedef struct sata_port_scr sata_port_scr_t; 106 107/* 108 * SATA Device Structure (rev 1) 109 * Used to request/return state of the controller, port, port multiplier 110 * or an attached drive: 111 * The satadev_addr.cport, satadev_addr.pmport and satadev_addr.qual 112 * fields are used to specify SATA address (see sata_address structure 113 * description). 114 * The satadev_scr structure is used to pass the content of a port 115 * status and control registers. 116 * The satadev_add_info field is used by SATA HBA driver to return an 117 * additional information, which type depends on the function using 118 * sata_device as argument. For example: 119 * - in case of sata_tran_probe_port() this field should contain 120 * a number of available Port Multiplier device ports; 121 * - in case of sata_hba_event_notify() this field may contain 122 * a value specific for a reported event. 123 */ 124#define SATA_DEVICE_REV_1 1 125#define SATA_DEVICE_REV SATA_DEVICE_REV_1 126 127struct sata_device 128{ 129 int satadev_rev; /* structure version */ 130 struct sata_address satadev_addr; /* sata port/device address */ 131 uint32_t satadev_state; /* Port or device state */ 132 uint32_t satadev_type; /* Attached device type */ 133 struct sata_port_scr satadev_scr; /* Port status and ctrl regs */ 134 uint32_t satadev_add_info; /* additional information, */ 135 /* function specific */ 136}; 137 138typedef struct sata_device sata_device_t; 139 140_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_device)) 141 142 143/* 144 * satadev_state field of sata_device structure. 145 * Common flags specifying current state of a port or an attached drive. 146 * These states are mutually exclusive, obviously 147 */ 148#define SATA_STATE_UNKNOWN 0x000000 149#define SATA_STATE_READY 0x000010 150 151/* 152 * Attached drive specific states (satadev_state field of the sata_device 153 * structure). 154 * SATA_DSTATE_PWR_ACTIVE, SATA_DSTATE_PWR_IDLE and SATA_DSTATE_PWR_STANDBY 155 * are mutually exclusive. All other states may be combined with each other 156 * and with one of the power states. 157 * These flags may be used only if the address qualifier (satadev_addr.qual) is 158 * set to SATA_ADDR_DCPORT or SATA_ADDR_DPMPORT value. 159 */ 160 161#define SATA_DSTATE_PWR_ACTIVE 0x000100 162#define SATA_DSTATE_PWR_IDLE 0x000200 163#define SATA_DSTATE_PWR_STANDBY 0x000400 164#define SATA_DSTATE_RESET 0x001000 165#define SATA_DSTATE_FAILED 0x008000 166 167/* Mask for drive power states */ 168#define SATA_DSTATE_PWR (SATA_DSTATE_PWR_ACTIVE | \ 169 SATA_DSTATE_PWR_IDLE | \ 170 SATA_DSTATE_PWR_STANDBY) 171/* 172 * SATA Port specific states (satadev_state field of sata_device structure). 173 * SATA_PSTATE_PWRON and SATA_PSTATE_PWROFF are mutually exclusive. 174 * All other states may be combined with each other and with one of the power 175 * level state. 176 * These flags may be used only if the address qualifier (satadev_addr.qual) is 177 * set to SATA_ADDR_CPORT or SATA_ADDR_PMPORT value. 178 */ 179 180#define SATA_PSTATE_PWRON 0x010000 181#define SATA_PSTATE_PWROFF 0X020000 182#define SATA_PSTATE_SHUTDOWN 0x040000 183#define SATA_PSTATE_FAILED 0x080000 184 185/* Mask for the valid port-specific state flags */ 186#define SATA_PSTATE_VALID (SATA_PSTATE_PWRON | \ 187 SATA_PSTATE_PWROFF | \ 188 SATA_PSTATE_SHUTDOWN | \ 189 SATA_PSTATE_FAILED) 190 191/* Mask for a port power states */ 192#define SATA_PSTATE_PWR (SATA_PSTATE_PWRON | \ 193 SATA_PSTATE_PWROFF) 194/* 195 * Device type (in satadev_type field of sata_device structure). 196 * More device types may be added in the future. 197 */ 198 199#define SATA_DTYPE_NONE 0x00 /* No device attached */ 200#define SATA_DTYPE_ATADISK 0x01 /* ATA disk */ 201#define SATA_DTYPE_ATAPI 0x40 /* ATAPI device */ 202#define SATA_DTYPE_ATAPICD \ 203 (SATA_DTYPE_ATAPI|0x02) /* ATAPI CD/DVD device */ 204#define SATA_DTYPE_ATAPITAPE \ 205 (SATA_DTYPE_ATAPI|0x04) /* ATAPI tape */ 206#define SATA_DTYPE_ATAPIDISK \ 207 (SATA_DTYPE_ATAPI|0x08) /* ATAPI disk */ 208#define SATA_DTYPE_PMULT 0x10 /* Port Multiplier */ 209#define SATA_DTYPE_UNKNOWN 0x20 /* Device attached, unkown */ 210 211 212/* 213 * SATA cmd structure (rev 1) 214 * 215 * SATA HBA framework always sets all fields except status_reg and error_reg. 216 * SATA HBA driver action depends on the addressing type specified by 217 * addr_type field: 218 * If LBA48 addressing is indicated, SATA HBA driver has to load values from 219 * satacmd_sec_count_msb_reg, satacmd_lba_low_msb_reg, 220 * satacmd_lba_mid_msb_reg and satacmd_lba_hi_msb_reg 221 * to appropriate registers prior to loading other registers. 222 * For other addressing modes, SATA HBA driver should skip loading values 223 * from satacmd_sec_count_msb_reg, satacmd_lba_low_msb_reg, 224 * satacmd_lba_mid_msb_reg and satacmd_lba_hi_msb_reg 225 * fields and load only remaining field values to corresponding registers. 226 * 227 * satacmd_sec_count_msb and satamcd_sec_count_lsb values are loaded into 228 * sec_count register, satacmd_sec_count_msb loaded first (if LBA48 229 * addressing is used). 230 * satacmd_lba_low_msb and satacmd_lba_low_lsb values are loaded into the 231 * lba_low register, satacmd_lba_low_msb loaded first (if LBA48 addressing 232 * is used). The lba_low register is the newer name for the old 233 * sector_number register. 234 * satacmd_lba_mid_msb and satacmd_lba_mid_lsb values are loaded into lba_mid 235 * register, satacmd_lba_mid_msb loaded first (if LBA48 addressing is used). 236 * The lba_mid register is the newer name for the old cylinder_low register. 237 * satacmd_lba_high_msb and satacmd_lba_high_lsb values are loaded into 238 * the lba_high regster, satacmd_lba_high_msb loaded first (if LBA48 239 * addressing is used). The lba_high register is a newer name for the old 240 * cylinder_high register. 241 * 242 * No addressing mode is selected when an ata command does not involve actual 243 * reading/writing data from/to the media (for example IDENTIFY DEVICE or 244 * SET FEATURE command), or the ATAPI PACKET command is sent. 245 * If ATAPI PACKET command is sent and tagged commands are used, 246 * SATA HBA driver has to provide and manage a tag value and 247 * set it into the sector_count register. 248 * 249 * Device Control register is not specified in sata_cmd structure - SATA HBA 250 * driver shall set it accordingly to current mode of operation (interrupt 251 * enable/disable). 252 * 253 * Buffer structure's b_flags should be used to determine the 254 * address type of b_un.b_addr. However, there is no need to allocate DMA 255 * resources for the buffer in SATA HBA driver. 256 * DMA resources for a buffer structure are allocated by the SATA HBA 257 * framework. Scatter/gather list is to be used only for DMA transfers 258 * and it should be based on the DMA cookies list. 259 * 260 * Upon completion of a command, SATA HBA driver has to update 261 * satacmd_status_reg and satacmd_error_reg to reflect the contents of 262 * the corresponding device status and error registers. 263 * If the command completed successfully, satacmd_flags.sata_copy_xxx flags 264 * specify what register fields should be updated in sata_cmd structure. 265 * If the command completed with error, SATA HBA driver has to update 266 * satacmd_sec_count_msb, satacmd_sec_count_lsb, satacmd_lba_low_msb, 267 * satacmd_lba_low_lsb, satacmd_lba_mid_msb, satacmd_lba_mid_lsb, 268 * satacmd_lba_high_msb and satacmd_lba_high_lsb to values read from the 269 * corresponding device registers. 270 * If an operation could not complete because of the port error, the 271 * sata_pkt.satapkt_device.satadev_scr structure has to be updated. 272 * 273 * If ATAPI PACKET command was sent and command completed with error, 274 * rqsense structure has to be filed by SATA HBA driver. The satacmd_arq_cdb 275 * points to pre-set request sense cdb that may be used for issuing request 276 * sense data from the device. 277 * 278 * The sata_max_queue_depth field specifies the maximum allowable queue depth 279 * minus one, i.e. for maximum queue depth of 32, sata_max_queue_depth would 280 * be set to value 0x1f. 281 * If FPDMA-type command was sent and command completed with error, the HBA 282 * driver may use pre-set command READ LOG EXTENDED command pointed to 283 * by satacmd_rle_sata_cmd field to retrieve error data from a device. 284 * Only ATA register fields of the sata_cmd are set-up for that purpose. 285 * 286 * If the READ MULTIPLIER command was specified in cmd_reg (command directed 287 * to a port multiplier host port rather then to an attached device), 288 * upon the command completion SATA HBA driver has to update_sector count 289 * and lba fields of the sata_cmd structure to values returned via 290 * command block registers (task file registers). 291 */ 292#define SATA_CMD_REV_1 1 293#define SATA_CMD_REV_2 2 294#define SATA_CMD_REV_3 3 295#define SATA_CMD_REV SATA_CMD_REV_3 296 297#define SATA_ATAPI_MAX_CDB_LEN 16 /* Covers both 12 and 16 byte cdbs */ 298#define SATA_ATAPI_RQSENSE_LEN 24 /* Allocated Request Sense data */ 299#define SATA_ATAPI_MIN_RQSENSE_LEN 18 /* Min Fixed size Request Sense data */ 300#define SATA_ATAPI_RQSENSE_CDB_LEN 6 /* Request Sense CDB length */ 301 302#define SATA_MAX_QUEUE_DEPTH 32 /* Default max queue depth */ 303 304struct sata_cmd { 305 int satacmd_rev; /* version */ 306 struct buf *satacmd_bp; /* ptr to buffer structure */ 307 struct sata_cmd_flags { 308 uint32_t sata_data_direction : 3; /* 0-2 */ 309 uint32_t : 1; /* reserved */ /* 3 */ 310 uint32_t sata_queue_stag : 1; /* 4 */ 311 uint32_t sata_queue_otag : 1; /* 5 */ 312 uint32_t : 2; /* reserved */ /* 6-7 */ 313 uint32_t sata_queued : 1; /* 8 */ 314 uint32_t : 3; /* reserved */ /* 9-11 */ 315 uint32_t sata_ignore_dev_reset : 1; /* 12 */ 316 uint32_t sata_clear_dev_reset : 1; /* 13 */ 317 uint32_t : 2; /* reserved */ /* 14-15 */ 318 uint32_t sata_special_regs : 1; /* 16 */ 319 uint32_t sata_copy_out_sec_count_msb : 1; /* 17 */ 320 uint32_t sata_copy_out_lba_low_msb : 1; /* 18 */ 321 uint32_t sata_copy_out_lba_mid_msb : 1; /* 19 */ 322 uint32_t sata_copy_out_lba_high_msb : 1; /* 20 */ 323 uint32_t sata_copy_out_sec_count_lsb : 1; /* 21 */ 324 uint32_t sata_copy_out_lba_low_lsb : 1; /* 22 */ 325 uint32_t sata_copy_out_lba_mid_lsb : 1; /* 23 */ 326 uint32_t sata_copy_out_lba_high_lsb : 1; /* 24 */ 327 uint32_t sata_copy_out_device_reg : 1; /* 25 */ 328 uint32_t sata_copy_out_error_reg : 1; /* 26 */ 329 uint32_t sata_max_queue_depth: 5; /* 27-31 */ 330 } satacmd_flags; 331 uint8_t satacmd_addr_type; /* addr type: LBA28, LBA48 */ 332 uint8_t satacmd_features_reg_ext; /* features reg extended */ 333 uint8_t satacmd_sec_count_msb; /* sector count MSB (LBA48) */ 334 uint8_t satacmd_lba_low_msb; /* LBA Low MSB (LBA48) */ 335 uint8_t satacmd_lba_mid_msb; /* LBA Mid MSB (LBA48) */ 336 uint8_t satacmd_lba_high_msb; /* LBA High MSB (LBA48) */ 337 uint8_t satacmd_sec_count_lsb; /* sector count LSB */ 338 uint8_t satacmd_lba_low_lsb; /* LBA Low LSB */ 339 uint8_t satacmd_lba_mid_lsb; /* LBA Mid LSB */ 340 uint8_t satacmd_lba_high_lsb; /* LBA High LSB */ 341 uint8_t satacmd_device_reg; /* ATA dev reg & LBA28 MSB */ 342 uint8_t satacmd_cmd_reg; /* ata command code */ 343 uint8_t satacmd_features_reg; /* ATA features register */ 344 uint8_t satacmd_status_reg; /* ATA status register */ 345 uint8_t satacmd_error_reg; /* ATA error register */ 346 uint8_t satacmd_acdb_len; /* ATAPI cdb length */ 347 uint8_t satacmd_acdb[SATA_ATAPI_MAX_CDB_LEN]; /* ATAPI cdb */ 348 349 /* kept for binary compat. */ 350 uint8_t *pad1; /* unused */ 351 352 uint8_t satacmd_rqsense[SATA_ATAPI_RQSENSE_LEN]; 353 /* 354 * Error retrieval buffer 355 * dma handle pointer 356 * (for buffer DMA syncing) 357 * Valid only in error 358 * retrieval packet! 359 */ 360 ddi_dma_handle_t *satacmd_err_ret_buf_handle; 361 362 int satacmd_num_dma_cookies; /* number of dma cookies */ 363 /* ptr to dma cookie list */ 364 ddi_dma_cookie_t *satacmd_dma_cookie_list; 365}; 366 367typedef struct sata_cmd sata_cmd_t; 368 369_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_cmd)) 370 371 372/* ATA address type (in satacmd_addr_type field */ 373#define ATA_ADDR_LBA 0x1 374#define ATA_ADDR_LBA28 0x2 375#define ATA_ADDR_LBA48 0x4 376 377/* 378 * satacmd_flags : contain data transfer direction flags, 379 * tagged queuing type flags, queued command flag, and reset state handling 380 * flag. 381 */ 382 383/* 384 * Data transfer direction flags (satacmd_flags.sata_data_direction) 385 * Direction flags are mutually exclusive. 386 */ 387#define SATA_DIR_NODATA_XFER 0x0001 /* No data transfer */ 388#define SATA_DIR_READ 0x0002 /* Reading data from a device */ 389#define SATA_DIR_WRITE 0x0004 /* Writing data to a device */ 390 391/* 392 * Tagged Queuing type flags 393 * satacmd_flags.sata_queue_stag 394 * satacmd_flags.sata_queue_otag 395 * 396 * These flags indicate how the SATA command should be queued. 397 * 398 * sata_queue_stag 399 * Simple-queue-tagged command. It may be executed out-of-order in respect 400 * to other queued commands. 401 * sata_queue_otag 402 * Ordered-queue-tagged command. It cannot be executed out-of-order in 403 * respect to other commands, i.e. it should be executed in the order of 404 * being transported to the HBA. 405 * 406 * Translated head-of-queue-tagged scsi commands and commands that are 407 * to be put at the head of the queue are treated as sata_queue_otag 408 * tagged commands. 409 */ 410 411 412/* 413 * Queuing command set-up flag (satacmd_flags.sata_queued). 414 * This flag indicates that sata_cmd was set-up for DMA Queued command 415 * (either READ_DMA_QUEUED, READ_DMA_QUEUED_EXT, WRITE_DMA_QUEUED or 416 * WRITE_DMA_QUEUED_EXT command) or one of the Native Command Queuing commands 417 * (either READ_FPDMA_QUEUED or WRITE_FPDMA_QUEUED). 418 * This flag will be used only if sata_tran_hba_flags indicates controller 419 * support for queuing and the device for which sata_cmd is prepared supports 420 * either legacy queuing (indicated by Device Identify data word 83 bit 2) 421 * or NCQ (indicated by word 76 of Device Identify data). 422 */ 423 424/* 425 * Reset state handling 426 * satacmd_flags.sata_ignore_dev_reset 427 * satacmd_flags.sata_clear_dev_reset 428 * 429 * SATA HBA device enters reset state if the device was subjected to 430 * the Device Reset (may also enter this state if the device was reset 431 * as a side effect of port reset). SATA HBA driver sets this state. 432 * Device stays in this condition until explicit request from SATA HBA 433 * framework to clear the state. 434 */ 435 436/* 437 * SATA Packet structure (rev 1) 438 * hba_driver_private is for a private use of the SATA HBA driver; 439 * satapkt_framework_private is used only by SATA HBA framework; 440 * satapkt_comp is a callback function to be called when packet 441 * execution is completed (for any reason) if mode of operation is not 442 * synchronous (SATA_OPMODE_SYNCH); 443 * satapkt_reason specifies why the packet operation was completed 444 * 445 * NOTE: after the packet completion callback SATA HBA driver should not 446 * attempt to access any sata_pkt fields because sata_pkt is not valid anymore 447 * (it could have been destroyed). 448 * Since satapkt_hba_driver_private field cannot be retrieved, any hba private 449 * data respources allocated per packet and accessed via this pointer should 450 * either be freed before the completion callback is done, or the pointer has 451 * to be saved by the HBA driver before the completion callback. 452 */ 453#define SATA_PKT_REV_1 1 454#define SATA_PKT_REV SATA_PKT_REV_1 455 456struct sata_pkt { 457 int satapkt_rev; /* version */ 458 struct sata_device satapkt_device; /* Device address/type */ 459 460 /* HBA driver private data */ 461 void *satapkt_hba_driver_private; 462 463 /* SATA framework priv data */ 464 void *satapkt_framework_private; 465 466 /* Rqsted mode of operation */ 467 uint32_t satapkt_op_mode; 468 469 struct sata_cmd satapkt_cmd; /* composite sata command */ 470 int satapkt_time; /* time allotted to command */ 471 void (*satapkt_comp)(struct sata_pkt *); /* callback */ 472 int satapkt_reason; /* completion reason */ 473}; 474 475typedef struct sata_pkt sata_pkt_t; 476 477_NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_pkt)) 478 479 480/* 481 * Operation mode flags (in satapkt_op_mode field of sata_pkt structure). 482 * Use to specify what should be a mode of operation for specified command. 483 * Default (000b) means use Interrupt and Asynchronous mode to 484 * perform an operation. 485 * Synchronous operation menas that the packet operation has to be completed 486 * before the function called to initiate the operation returns. 487 */ 488#define SATA_OPMODE_INTERRUPTS 0 /* Use interrupts (hint) */ 489#define SATA_OPMODE_POLLING 1 /* Use polling instead of interrupts */ 490#define SATA_OPMODE_ASYNCH 0 /* Return immediately after accepting pkt */ 491#define SATA_OPMODE_SYNCH 4 /* Perform synchronous operation */ 492 493/* 494 * satapkt_reason values: 495 * 496 * SATA_PKT_QUEUE_FULL - cmd not sent because of queue full (detected 497 * by the controller). If a device reject command for this reason, it 498 * should be reported as SATA_PKT_DEV_ERROR 499 * 500 * SATA_PKT_CMD_NOT_SUPPORTED - command not supported by a controller 501 * Controller is unable to send such command to a device. 502 * If device rejects a command, it should be reported as 503 * SATA_PKT_DEV_ERROR. 504 * 505 * SATA_PKT_DEV_ERROR - cmd failed because of device reported an error. 506 * The content of status_reg (ERROR bit has to be set) and error_reg 507 * fields of the sata_cmd structure have to be set and will be used 508 * by SATA HBA Framework to determine the error cause. 509 * 510 * SATA_PKT_PORT_ERROR - cmd failed because of a link or a port error. 511 * Link failed / no communication with a device / communication error 512 * or other port related error was detected by a controller. 513 * sata_pkt.satapkt_device.satadev_scr.sXXXXXXX words have to be set. 514 * 515 * SATA_PKT_ABORTED - cmd execution was aborted by the request from the 516 * framework. Abort mechanism is HBA driver specific. 517 * 518 * SATA_PKT_TIMEOUT - cmd execution has timed-out. Timeout specified by 519 * pkt_time was exceeded. The command was terminated by the SATA HBA 520 * driver. 521 * 522 * SATA_PKT_COMPLETED - this is a value returned when an operation 523 * completes without errors. 524 * 525 * SATA_PKT_BUSY - packet was not accepted for execution because the 526 * driver was busy performing some other operation(s). 527 * 528 * SATA_PKT_RESET - packet execution was aborted because of device 529 * reset originated by either the HBA driver or the SATA framework. 530 * 531 */ 532 533#define SATA_PKT_BUSY -1 /* Not completed, busy */ 534#define SATA_PKT_COMPLETED 0 /* No error */ 535#define SATA_PKT_DEV_ERROR 1 /* Device reported error */ 536#define SATA_PKT_QUEUE_FULL 2 /* Not accepted, queue full */ 537#define SATA_PKT_PORT_ERROR 3 /* Not completed, port error */ 538#define SATA_PKT_CMD_UNSUPPORTED 4 /* Cmd unsupported */ 539#define SATA_PKT_ABORTED 5 /* Aborted by request */ 540#define SATA_PKT_TIMEOUT 6 /* Operation timeut */ 541#define SATA_PKT_RESET 7 /* Aborted by reset request */ 542 543/* 544 * Error retrieval sata packet types 545 */ 546#define SATA_ERR_RETR_PKT_TYPE_NCQ 1 547#define SATA_ERR_RETR_PKT_TYPE_ATAPI 2 548 549/* 550 * Hoplug functions vector structure (rev 1) 551 */ 552#define SATA_TRAN_HOTPLUG_OPS_REV_1 1 553 554struct sata_tran_hotplug_ops { 555 int sata_tran_hotplug_ops_rev; /* version */ 556 int (*sata_tran_port_activate)(dev_info_t *, sata_device_t *); 557 int (*sata_tran_port_deactivate)(dev_info_t *, sata_device_t *); 558}; 559 560typedef struct sata_tran_hotplug_ops sata_tran_hotplug_ops_t; 561 562 563/* 564 * Power management functions vector structure (rev 1) 565 * The embedded function returns information about the controller's 566 * power level. 567 * Additional functions may be added in the future without changes to 568 * sata_tran structure. 569 */ 570#define SATA_TRAN_PWRMGT_OPS_REV_1 1 571 572struct sata_tran_pwrmgt_ops { 573 int sata_tran_pwrmgt_ops_rev; /* version */ 574 int (*sata_tran_get_pwr_level)(dev_info_t *, sata_device_t *); 575}; 576 577typedef struct sata_tran_pwrmgt_ops sata_tran_pwrmgt_ops_t; 578 579 580/* 581 * SATA port PHY Power Level 582 * These states correspond to the interface power management state as defined 583 * in Serial ATA spec. 584 */ 585#define SATA_TRAN_PORTPWR_LEVEL1 1 /* Interface in active PM state */ 586#define SATA_TRAN_PORTPWR_LEVEL2 2 /* Interface in PARTIAL PM state */ 587#define SATA_TRAN_PORTPWR_LEVEL3 3 /* Interface in SLUMBER PM state */ 588 589/* 590 * SATA HBA Tran structure (rev 1) 591 * Registered with SATA Framework 592 * 593 * dma_attr is a pointer to data (buffer) dma attibutes of the controller 594 * DMA engine. 595 * 596 * The qdepth field specifies number of commands that may be accepted by 597 * the controller. Value range 1-32. A value greater than 1 indicates that 598 * the controller supports queuing. Support for Native Command Queuing 599 * indicated by SATA_CTLF_NCQ flag also requires qdepth set to a value 600 * greater then 1. 601 * 602 */ 603#define SATA_TRAN_HBA_REV_1 1 604#define SATA_TRAN_HBA_REV_2 2 605#define SATA_TRAN_HBA_REV SATA_TRAN_HBA_REV_2 606 607struct sata_hba_tran { 608 int sata_tran_hba_rev; /* version */ 609 dev_info_t *sata_tran_hba_dip; /* Controler dev info */ 610 ddi_dma_attr_t *sata_tran_hba_dma_attr; /* DMA attributes */ 611 int sata_tran_hba_num_cports; /* Num of HBA device ports */ 612 uint16_t sata_tran_hba_features_support; /* HBA features */ 613 uint16_t sata_tran_hba_qdepth; /* HBA-supported queue depth */ 614 615 int (*sata_tran_probe_port)(dev_info_t *, sata_device_t *); 616 int (*sata_tran_start)(dev_info_t *, sata_pkt_t *); 617 int (*sata_tran_abort)(dev_info_t *, sata_pkt_t *, int); 618 int (*sata_tran_reset_dport)(dev_info_t *, 619 sata_device_t *); 620 int (*sata_tran_selftest)(dev_info_t *, sata_device_t *); 621 622 /* Hotplug vector */ 623 struct sata_tran_hotplug_ops *sata_tran_hotplug_ops; 624 625 /* Power mgt vector */ 626 struct sata_tran_pwrmgt_ops *sata_tran_pwrmgt_ops; 627 628 int (*sata_tran_ioctl)(dev_info_t *, int, intptr_t); 629}; 630 631typedef struct sata_hba_tran sata_hba_tran_t; 632 633 634/* 635 * Controller's features support flags (sata_tran_hba_features_support). 636 * Note: SATA_CTLF_NCQ indicates that SATA controller supports NCQ in addition 637 * to legacy queuing commands, indicated by SATA_CTLF_QCMD flag. 638 */ 639 640#define SATA_CTLF_ATAPI 0x001 /* ATAPI support */ 641#define SATA_CTLF_PORT_MULTIPLIER 0x010 /* Port Multiplier suport */ 642#define SATA_CTLF_HOTPLUG 0x020 /* Hotplug support */ 643#define SATA_CTLF_ASN 0x040 /* Asynchronous Event Support */ 644#define SATA_CTLF_QCMD 0x080 /* Queued commands support */ 645#define SATA_CTLF_NCQ 0x100 /* NCQ support */ 646 647/* 648 * sata_tran_start() return values. 649 * When pkt is not accepted, the satapkt_reason has to be updated 650 * before function returns - it should reflect the same reason for not being 651 * executed as the return status of above functions. 652 * If pkt was accepted and executed synchronously, 653 * satapk_reason should indicate a completion status. 654 */ 655#define SATA_TRAN_ACCEPTED 0 /* accepted */ 656#define SATA_TRAN_QUEUE_FULL 1 /* not accepted, queue full */ 657#define SATA_TRAN_PORT_ERROR 2 /* not accepted, port error */ 658#define SATA_TRAN_CMD_UNSUPPORTED 3 /* not accepted, cmd not supported */ 659#define SATA_TRAN_BUSY 4 /* not accepted, busy */ 660 661 662/* 663 * sata_tran_abort() abort type flag 664 */ 665#define SATA_ABORT_PACKET 0 666#define SATA_ABORT_ALL_PACKETS 1 667 668 669/* 670 * Events handled by SATA HBA Framework 671 * More then one event may be reported at the same time 672 * 673 * SATA_EVNT__DEVICE_ATTACHED 674 * HBA detected the presence of a device ( electrical connection with 675 * a device was detected ). 676 * 677 * SATA_EVNT_DEVICE_DETACHED 678 * HBA detected the detachment of a device (electrical connection with 679 * a device was broken) 680 * 681 * SATA_EVNT_LINK_LOST 682 * HBA lost link with an attached device 683 * 684 * SATA_EVNT_LINK_ESTABLISHED 685 * HBA established a link with an attached device 686 * 687 * SATA_EVNT_PORT_FAILED 688 * HBA has determined that the port failed and is unuseable 689 * 690 * SATA_EVENT_DEVICE_RESET 691 * SATA device was reset, causing loss of the device setting 692 * 693 * SATA_EVNT_PWR_LEVEL_CHANGED 694 * A port or entire SATA controller power level has changed 695 * 696 */ 697#define SATA_EVNT_DEVICE_ATTACHED 0x01 698#define SATA_EVNT_DEVICE_DETACHED 0x02 699#define SATA_EVNT_LINK_LOST 0x04 700#define SATA_EVNT_LINK_ESTABLISHED 0x08 701#define SATA_EVNT_PORT_FAILED 0x10 702#define SATA_EVNT_DEVICE_RESET 0x20 703#define SATA_EVNT_PWR_LEVEL_CHANGED 0x40 704 705/* 706 * SATA Framework interface entry points 707 */ 708int sata_hba_init(struct modlinkage *); 709int sata_hba_attach(dev_info_t *, sata_hba_tran_t *, ddi_attach_cmd_t); 710int sata_hba_detach(dev_info_t *, ddi_detach_cmd_t); 711void sata_hba_fini(struct modlinkage *); 712void sata_hba_event_notify(dev_info_t *, sata_device_t *, int); 713sata_pkt_t *sata_get_error_retrieval_pkt(dev_info_t *, sata_device_t *, int); 714void sata_free_error_retrieval_pkt(sata_pkt_t *); 715void sata_free_dma_resources(sata_pkt_t *); 716 717 718#ifdef __cplusplus 719} 720#endif 721 722#endif /* _SATA_HBA_H */ 723