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_H 28 #define _SATA_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 /* 35 * Generic SATA Host Adapter Implementation 36 */ 37 38 #include <sys/types.h> 39 #include <sys/scsi/scsi.h> 40 #include <sys/scsi/impl/services.h> 41 #include <sys/sata/sata_defs.h> 42 #include <sys/sata/sata_hba.h> 43 44 /* Common flags specifying current state of a port or an attached drive. */ 45 #define SATA_STATE_PROBING 0x000001 46 #define SATA_STATE_PROBED 0x000002 47 48 /* Statistics counters */ 49 struct sata_port_stats { 50 uint64_t link_lost; /* event counter */ 51 uint64_t link_established; /* event counter */ 52 uint64_t device_attached; /* event counter */ 53 uint64_t device_detached; /* event counter */ 54 uint64_t port_reset; /* event counter */ 55 uint64_t port_pwr_changed; /* event counter */ 56 }; 57 58 typedef struct sata_port_stats sata_port_stats_t; 59 60 struct sata_drive_stats { 61 uint64_t media_error; /* available ??? */ 62 uint64_t drive_reset; /* event counter */ 63 } sata_drv_stats_t; 64 65 typedef struct sata_drive_stats sata_drive_stats_t; 66 67 struct sata_ctrl_stats { 68 uint64_t ctrl_reset; /* event counter */ 69 uint64_t ctrl_pwr_change; /* event counter */ 70 }; 71 72 typedef struct sata_ctrl_stats sata_ctrl_stats_t; 73 74 75 /* 76 * SATA HBA instance info structure 77 */ 78 struct sata_hba_inst { 79 dev_info_t *satahba_dip; /* this HBA instance devinfo */ 80 struct sata_hba_inst *satahba_next; /* ptr to next sata_hba_inst */ 81 struct sata_hba_inst *satahba_prev; /* ptr to prev sata_hba_inst */ 82 struct scsi_hba_tran *satahba_scsi_tran; /* scsi_hba_tran */ 83 struct sata_hba_tran *satahba_tran; /* sata_hba_tran */ 84 kmutex_t satahba_mutex; /* sata hba cntrl mutex */ 85 struct taskq *satahba_taskq; /* cmd completion task queue */ 86 87 /* 88 * HBA event flags: 89 * SATA_EVNT_MAIN 90 * SATA_EVNT_PWR_LEVEL_CHANGED 91 * SATA_EVNT_SKIP 92 */ 93 uint_t satahba_event_flags; 94 95 struct sata_cport_info *satahba_dev_port[SATA_MAX_CPORTS]; 96 97 /* 98 * DEVCTL open flag: 99 * SATA_DEVCTL_SOPENED 100 * SATA_DEVCTL_EXOPENED 101 */ 102 uint_t satahba_open_flag; /* shared open flag */ 103 struct sata_ctrl_stats satahba_stats; /* HBA cntrl statistics */ 104 105 uint_t satahba_attached; /* HBA attaching: */ 106 /* 0 - not completed */ 107 /* 1 - completed */ 108 }; 109 110 typedef struct sata_hba_inst sata_hba_inst_t; 111 112 /* 113 * SATA controller's device port info and state. 114 * This structure is pointed to by the sata_hba_inst.satahba_dev_port[x] 115 * where x is a device port number. 116 * cport_state holds port state flags, defined in sata_hba.h file. 117 * cport_event_flags holds SATA_EVNT_* flags defined in this file and in 118 * sata_hba.h file. 119 * cport_dev_type holds SATA_DTYPE_* types defined in sata_hba.h file. 120 */ 121 struct sata_cport_info { 122 sata_address_t cport_addr; /* this port SATA address */ 123 kmutex_t cport_mutex; /* port mutex */ 124 125 /* 126 * Port state flags 127 * SATA_STATE_UNKNOWN 128 * SATA_STATE_PROBING 129 * SATA_STATE_PROBED 130 * SATA_STATE_READY 131 * SATA_PSTATE_PWRON 132 * SATA_PSTATE_PWROFF 133 * SATA_PSTATE_SHUTDOWN 134 * SATA_PSTATE_FAILED 135 */ 136 uint32_t cport_state; 137 138 /* 139 * Port event flags: 140 * SATA_EVNT_DEVICE_ATTACHED 141 * SATA_EVNT_DEVICE_DETACHED 142 * SATA_EVNT_LINK_LOST 143 * SATA_EVNT_LINK_ESTABLISHED 144 * SATA_EVNT_PORT_FAILED 145 * SATA_EVNT_PWR_LEVEL_CHANGED 146 */ 147 uint32_t cport_event_flags; 148 149 struct sata_port_scr cport_scr; /* Port status and ctrl regs */ 150 151 /* 152 * Attached device type: 153 * SATA_DTYPE_NONE 154 * SATA_DTYPE_ATADISK 155 * SATA_DTYPE_ATAPICD 156 * SATA_DTYPE_ATAPITAPE 157 * SATA_DTYPE_ATAPIDISK 158 * SATA_DTYPE_PMULT 159 * SATA_DTYPE_UNKNOWN 160 */ 161 uint32_t cport_dev_type; 162 union { 163 struct sata_drive_info *cport_sata_drive; /* Attached drive info */ 164 struct sata_pmult_info *cport_sata_pmult; /* Attached Port Mult */ 165 } cport_devp; 166 /* lbolt value at link lost */ 167 clock_t cport_link_lost_time; 168 /* lbolt value @ dev attached */ 169 clock_t cport_dev_attach_time; 170 171 struct sata_port_stats cport_stats; /* Port statistics */ 172 173 boolean_t cport_tgtnode_clean; /* Target node usable */ 174 }; 175 176 typedef struct sata_cport_info sata_cport_info_t; 177 178 /* 179 * Attached SATA drive info and state. 180 * This structure is pointed to by sata_cport_info's cport_sata_drive field 181 * when a drive is attached directly to a controller device port. 182 */ 183 struct sata_drive_info { 184 sata_address_t satadrv_addr; /* this drive SATA address */ 185 186 /* 187 * Drive state flags 188 * SATA_STATE_UNKNOWN 189 * SATA_STATE_PROBING 190 * SATA_STATE_PROBED 191 * SATA_STATE_READY 192 * SATA_DSTATE_PWR_ACTIVE 193 * SATA_DSTATE_PWR_IDLE 194 * SATA_DSTATE_RESET 195 * SATA_DSTATE_FAILED 196 */ 197 uint32_t satadrv_state; 198 199 /* 200 * drive event flags: 201 * SATA_EVNT_DRIVE_RESET 202 */ 203 uint32_t satadrv_event_flags; 204 /* 205 * lbolt value @ start of 206 * device reset processing 207 */ 208 clock_t satadrv_reset_time; 209 /* 210 * Attached device type: 211 * SATA_DTYPE_ATADISK 212 * SATA_DTYPE_ATAPICD 213 * SATA_DTYPE_ATAPITAPE 214 * SATA_DTYPE_ATAPIDISK 215 */ 216 uint32_t satadrv_type; 217 218 uint32_t satadrv_status_reg; /* drive status reg */ 219 uint32_t satadrv_error_reg; /* drive error reg */ 220 uint16_t satadrv_features_support; /* drive features support */ 221 uint16_t satadrv_queue_depth; /* drive queue depth */ 222 uint16_t satadrv_atapi_cdb_len; /* atapi supported cdb length */ 223 uint16_t satadrv_atapi_trans_ver; /* atapi transport version */ 224 uint16_t satadrv_settings; /* drive settings flags */ 225 uint16_t satadrv_features_enabled; /* drive features enabled */ 226 uint64_t satadrv_capacity; /* drive capacity */ 227 uint64_t satadrv_max_queue_depth; /* maximum queue depth */ 228 sata_id_t satadrv_id; /* Device Identify Data */ 229 struct sata_drive_stats satadrv_stats; /* drive statistics */ 230 }; 231 232 typedef struct sata_drive_info sata_drive_info_t; 233 234 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_drive_info)) 235 236 237 /* Port Multiplier & host port info and state */ 238 struct sata_pmult_info { 239 sata_address_t pmult_addr; /* this PMult SATA Address */ 240 kmutex_t pmult_mutex; /* pmult (host port) mutex */ 241 242 /* 243 * PMult state flags 244 * SATA_STATE_UNKNOWN 245 * SATA_STATE_PROBING 246 * SATA_STATE_PROBED 247 * SATA_STATE_READY 248 * SATA_PSTATE_FAILED 249 */ 250 uint32_t pmult_state; 251 uint32_t pmult_event_flags; /* Undefined for now */ 252 struct sata_port_scr pmult_scr; /* Host port SCR block */ 253 uint32_t pmult_num_dev_ports; /* Number of data ports */ 254 struct sata_pmport_info *pmult_dev_port[SATA_MAX_PMPORTS - 1]; 255 }; 256 257 typedef struct sata_pmult_info sata_pmult_info_t; 258 259 /* Port Multiplier's device port info & state */ 260 struct sata_pmport_info { 261 sata_address_t pmport_addr; /* this SATA port address */ 262 kmutex_t pmport_mutex; /* pmult device port mutex */ 263 264 /* 265 * Port state flags 266 * SATA_STATE_UNKNOWN 267 * SATA_STATE_PROBING 268 * SATA_STATE_PROBED 269 * SATA_STATE_READY 270 * SATA_PSTATE_PWRON 271 * SATA_PSTATE_PWROFF 272 * SATA_PSTATE_SHUTDOWN 273 * SATA_PSTATE_FAILED 274 */ 275 uint32_t pmport_state; 276 277 /* 278 * Port event flags: 279 * SATA_EVNT_DEVICE_ATTACHED 280 * SATA_EVNT_DEVICE_DETACHED 281 * SATA_EVNT_LINK_LOST 282 * SATA_EVNT_LINK_ESTABLISHED 283 * SATA_EVNT_PORT_FAILED 284 * SATA_EVNT_PWR_LEVEL_CHANGED 285 */ 286 uint32_t pmport_event_flags; 287 288 struct sata_port_scr pmport_scr; /* PMult device port scr */ 289 290 /* 291 * Attached device type: 292 * SATA_DTYPE_NONE 293 * SATA_DTYPE_ATADISK 294 * SATA_DTYPE_ATAPICD 295 * SATA_DTYPE_ATAPITAPE 296 * SATA_DTYPE_ATAPIDISK 297 * SATA_DTYPE_UNKNOWN 298 */ 299 uint32_t pmport_dev_type; 300 301 struct sata_drive_info *pmport_sata_drive; /* Attached drive info */ 302 303 /* lbolt value at link lost */ 304 clock_t pmport_link_lost_time; 305 /* lbolt value @ dev attached */ 306 clock_t pmport_dev_attach_time; 307 308 struct sata_port_stats pmport_stats; /* Port statistics */ 309 310 boolean_t pmport_tgtnode_clean; /* Target node usable */ 311 }; 312 313 typedef struct sata_pmport_info sata_pmport_info_t; 314 315 /* 316 * Port SSTATUS register (sata_port_scr sport_sstatus field). 317 * Link bits are valid only in port active state. 318 */ 319 #define SATA_PORT_DEVLINK_UP 0x00000103 /* Link with dev established */ 320 #define SATA_PORT_DEVLINK_UP_MASK 0x0000010F /* Mask for link bits */ 321 322 /* 323 * Port state clear mask (cport_state and pmport_state fields). 324 * SATA_PSTATE_SHUTDOWN and power state are preserved. 325 */ 326 #define SATA_PORT_STATE_CLEAR_MASK (~(SATA_PSTATE_SHUTDOWN)) 327 328 /* 329 * Valid i.e.supported device types mask (cport_dev_type, satadrv_type, 330 * pmult_dev_type fields). 331 * ATA disks and ATAPI CD/DVD now. 332 */ 333 #define SATA_VALID_DEV_TYPE (SATA_DTYPE_ATADISK | \ 334 SATA_DTYPE_ATAPICD | \ 335 SATA_DTYPE_ATAPITAPE | \ 336 SATA_DTYPE_ATAPIDISK) 337 338 /* 339 * Device feature_support (satadrv_features_support) 340 */ 341 #define SATA_DEV_F_DMA 0x01 342 #define SATA_DEV_F_LBA28 0x02 343 #define SATA_DEV_F_LBA48 0x04 344 #define SATA_DEV_F_NCQ 0x08 345 #define SATA_DEV_F_SATA1 0x10 346 #define SATA_DEV_F_SATA2 0x20 347 #define SATA_DEV_F_TCQ 0x40 /* Non NCQ tagged queuing */ 348 349 /* 350 * Device features enabled (satadrv_features_enabled) 351 */ 352 #define SATA_DEV_F_E_TAGGED_QING 0x01 /* Tagged queuing enabled */ 353 #define SATA_DEV_F_E_UNTAGGED_QING 0x02 /* Untagged queuing enabled */ 354 355 /* 356 * Drive settings flags (satdrv_settings) 357 */ 358 #define SATA_DEV_READ_AHEAD 0x0001 /* Read Ahead enabled */ 359 #define SATA_DEV_WRITE_CACHE 0x0002 /* Write cache ON */ 360 #define SATA_DEV_DMA 0x0004 /* DMA selected */ 361 #define SATA_DEV_SERIAL_FEATURES 0x8000 /* Serial ATA feat. enabled */ 362 #define SATA_DEV_ASYNCH_NOTIFY 0x2000 /* Asynch-event enabled */ 363 #define SATA_DEV_RMSN 0x0100 /* Rem Media Stat Notfc enbl */ 364 365 /* 366 * Internal event and flags. 367 * These flags are set in the *_event_flags fields of various structures. 368 * Events and lock flags defined below are used internally by the 369 * SATA framework (they are not reported by SATA HBA drivers). 370 */ 371 #define SATA_EVNT_MAIN 0x80000000 372 #define SATA_EVNT_SKIP 0x40000000 373 #define SATA_EVNT_INPROC_DEVICE_RESET 0x08000000 374 #define SATA_EVNT_CLEAR_DEVICE_RESET 0x04000000 375 #define SATA_EVNT_TARGET_NODE_CLEANUP 0x00000100 376 #define SATA_EVNT_AUTOONLINE_DEVICE 0x00000200 377 378 /* 379 * Lock flags - used to serialize configuration operations 380 * on ports and devices. 381 * SATA_EVNT_LOCK_PORT_BUSY is set by event daemon to prevent 382 * simultaneous cfgadm operations. 383 * SATA_APCTL_LOCK_PORT_BUSY is set by cfgadm ioctls to prevent 384 * simultaneous event processing. 385 */ 386 #define SATA_EVNT_LOCK_PORT_BUSY 0x00800000 387 #define SATA_APCTL_LOCK_PORT_BUSY 0x00400000 388 389 /* Mask for port events */ 390 #define SATA_EVNT_PORT_EVENTS (SATA_EVNT_DEVICE_ATTACHED | \ 391 SATA_EVNT_DEVICE_DETACHED | \ 392 SATA_EVNT_LINK_LOST | \ 393 SATA_EVNT_LINK_ESTABLISHED | \ 394 SATA_EVNT_PORT_FAILED | \ 395 SATA_EVNT_TARGET_NODE_CLEANUP | \ 396 SATA_EVNT_AUTOONLINE_DEVICE) 397 /* Mask for drive events */ 398 #define SATA_EVNT_DRIVE_EVENTS (SATA_EVNT_DEVICE_RESET | \ 399 SATA_EVNT_INPROC_DEVICE_RESET) 400 #define SATA_EVNT_CONTROLLER_EVENTS SATA_EVNT_PWR_LEVEL_CHANGED 401 402 /* Delays and timeout duration definitions */ 403 #define SATA_EVNT_DAEMON_SLEEP_TIME 50000 /* 50 ms */ 404 #define SATA_EVNT_DAEMON_TERM_TIMEOUT 100000 /* 100 ms */ 405 #define SATA_EVNT_DAEMON_TERM_WAIT 60000000 /* 60 s */ 406 #define SATA_EVNT_LINK_LOST_TIMEOUT 1000000 /* 1 s */ 407 408 #define SATA_DEV_IDENTIFY_TIMEOUT 60000000 /* 60 s, device enumeration */ 409 #define SATA_DEV_REPROBE_TIMEOUT 30000000 /* 30 s, dev resp after rst */ 410 #define SATA_DEV_RETRY_DLY 10000 /* 10 ms */ 411 412 /* DEVICE IDENTIFY and device initialization retry delay */ 413 #define SATA_DEV_IDENTIFY_RETRY 1 414 #define SATA_DEV_IDENTIFY_NORETRY 0 415 416 /* 417 * sata_scsi's hba_open_flag: field indicating open devctl instance. 418 * 0 = closed, 1 = shared open, 2 = exclusive open. 419 */ 420 #define SATA_DEVCTL_CLOSED 0 421 #define SATA_DEVCTL_SOPENED 1 422 #define SATA_DEVCTL_EXOPENED 2 423 424 /* 425 * sata_pkt_txlate structure contains info about resources allocated 426 * for the packet 427 * Address of this structure is stored in scsi_pkt.pkt_ha_private and 428 * in sata_pkt.sata_hba_private fields, so all three strucures are 429 * cross-linked, with sata_pkt_txlate as a centerpiece. 430 */ 431 432 typedef struct sata_pkt_txlate { 433 struct sata_hba_inst *txlt_sata_hba_inst; 434 struct scsi_pkt *txlt_scsi_pkt; 435 struct sata_pkt *txlt_sata_pkt; 436 ddi_dma_handle_t txlt_buf_dma_handle; 437 uint_t txlt_flags; /* data-in / data-out */ 438 uint_t txlt_num_dma_win; /* number of DMA windows */ 439 uint_t txlt_cur_dma_win; /* current DMA window */ 440 441 /* cookies in the current DMA window */ 442 uint_t txlt_curwin_num_dma_cookies; 443 444 /* processed dma cookies in current DMA win */ 445 uint_t txlt_curwin_processed_dma_cookies; 446 size_t txlt_total_residue; 447 ddi_dma_cookie_t txlt_dma_cookie; /* default dma cookie */ 448 int txlt_dma_cookie_list_len; /* alloc list len */ 449 ddi_dma_cookie_t *txlt_dma_cookie_list; /* dma cookie list */ 450 int txlt_num_dma_cookies; /* dma cookies in list */ 451 452 /* temporary buffer access handle */ 453 ddi_acc_handle_t txlt_tmp_buf_handle; 454 caddr_t txlt_tmp_buf; /* temp buffer address */ 455 } sata_pkt_txlate_t; 456 457 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sata_pkt_txlate)) 458 _NOTE(SCHEME_PROTECTS_DATA("unshared data", scsi_pkt)) 459 460 461 /* 462 * Additional scsi sense code definitions. 463 * These definition should eventually be moved to scsi header file 464 * usr/src/uts/common/sys/scsi/generic/sense.h 465 */ 466 #define SD_SCSI_ASC_NO_ADD_SENSE 0x00 467 #define SD_SCSI_ASC_LU_NOT_READY 0x04 468 #define SD_SCSI_ASC_WRITE_ERR 0x0c 469 #define SD_SCSI_ASC_UNREC_READ_ERR 0x11 470 #define SD_SCSI_ASC_INVALID_COMMAND_CODE 0x20 471 #define SD_SCSI_ASC_LBA_OUT_OF_RANGE 0x21 472 #define SD_SCSI_ASC_INVALID_FIELD_IN_CDB 0x24 473 #define SD_SCSI_ASC_INVALID_FIELD_IN_PARAMS_LIST 0x26 474 #define SD_SCSI_ASC_RESET 0x29 475 #define SD_SCSI_ASC_SAVING_PARAMS_NOT_SUPPORTED 0x39 476 477 478 /* SCSI defs missing from scsi headers */ 479 /* Missing from sys/scsi/generic/commands.h */ 480 #define SCMD_SYNCHRONIZE_CACHE_G1 0x91 481 /* 482 * Missing from sys/scsi/impl/mode.h, although defined 483 * in sys/scsi/targets/sddefs.h as MODEPAGE_ERR_RECOV 484 */ 485 #define MODEPAGE_RW_ERRRECOV 0x01 /* read/write recovery */ 486 487 /* 488 * Macros for accessing various structure fields 489 */ 490 491 #define SATA_TRAN(sata_hba_inst) \ 492 sata_hba_inst->satahba_tran 493 494 #define SATA_DIP(sata_hba_inst) \ 495 sata_hba_inst->satahba_dip 496 497 #define SATA_NUM_CPORTS(sata_hba_inst) \ 498 sata_hba_inst->satahba_tran->sata_tran_hba_num_cports 499 500 #define SATA_QDEPTH(sata_hba_inst) \ 501 sata_hba_inst->satahba_tran->sata_tran_hba_qdepth 502 503 #define SATA_FEATURES(sata_hba_inst) \ 504 sata_hba_inst->satahba_tran->sata_tran_hba_features_support 505 506 #define SATA_DMA_ATTR(sata_hba_inst) \ 507 sata_hba_inst->satahba_tran->sata_tran_hba_dma_attr 508 509 #define SATA_START_FUNC(sata_hba_inst) \ 510 sata_hba_inst->satahba_tran->sata_tran_start 511 512 #define SATA_ABORT_FUNC(sata_hba_inst) \ 513 sata_hba_inst->satahba_tran->sata_tran_abort 514 515 #define SATA_RESET_DPORT_FUNC(sata_hba_inst) \ 516 sata_hba_inst->satahba_tran->sata_tran_reset_dport 517 518 #define SATA_PORT_DEACTIVATE_FUNC(sata_hba_inst) \ 519 (sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \ 520 NULL : \ 521 sata_hba_inst->satahba_tran->sata_tran_hotplug_ops->\ 522 sata_tran_port_deactivate) 523 524 #define SATA_PORT_ACTIVATE_FUNC(sata_hba_inst) \ 525 (sata_hba_inst->satahba_tran->sata_tran_hotplug_ops == NULL ? \ 526 NULL : \ 527 sata_hba_inst->satahba_tran->sata_tran_hotplug_ops->\ 528 sata_tran_port_activate) 529 530 #define SATA_PROBE_PORT_FUNC(sata_hba_inst) \ 531 sata_hba_inst->satahba_tran->sata_tran_probe_port 532 533 #define SATA_SELFTEST_FUNC(sata_hba_inst) \ 534 sata_hba_inst->satahba_tran->sata_tran_selftest 535 536 #define SATA_CPORT_MUTEX(sata_hba_inst, cport) \ 537 sata_hba_inst->satahba_dev_port[cport]->cport_mutex 538 539 #define SATA_CPORT_INFO(sata_hba_inst, cport) \ 540 sata_hba_inst->satahba_dev_port[cport] 541 542 #define SATA_CPORT_STATE(sata_hba_inst, cport) \ 543 sata_hba_inst->satahba_dev_port[cport]->cport_state 544 545 #define SATA_CPORT_EVENT_FLAGS(sata_hba_inst, cport) \ 546 sata_hba_inst->satahba_dev_port[cport]->cport_event_flags 547 548 #define SATA_CPORT_SCR(sata_hba_inst, cport) \ 549 sata_hba_inst->satahba_dev_port[cport]->cport_scr 550 551 #define SATA_CPORT_DEV_TYPE(sata_hba_inst, cport) \ 552 sata_hba_inst->satahba_dev_port[cport]->cport_dev_type 553 554 #define SATA_CPORT_DRV_INFO(sata_hba_inst, cport) \ 555 sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_drive 556 557 #define SATA_CPORTINFO_DRV_TYPE(cportinfo) \ 558 cportinfo->cport_dev_type 559 560 #define SATA_CPORTINFO_DRV_INFO(cportinfo) \ 561 cportinfo->cport_devp.cport_sata_drive 562 563 #define SATA_CPORTINFO_PMULT_INFO(cportinfo) \ 564 cportinfo->cport_devp.cport_sata_pmult 565 566 #define SATA_PMULT_INFO(sata_hba_inst, cport) \ 567 sata_hba_inst->satahba_dev_port[cport]->cport_devp.cport_sata_pmult 568 569 #define SATA_NUM_PMPORTS(sata_hba_inst, cport) \ 570 sata_hba_inst->satahba_dev_port[cport]->\ 571 cport_devp.cport_sata_pmult->pmult_num_dev_ports 572 573 #define SATA_PMPORT_INFO(sata_hba_inst, cport, pmport) \ 574 sata_hba_inst->satahba_dev_port[cport]->\ 575 cport_devp.cport_sata_pmult->pmult_dev_port[pmport] 576 577 #define SATA_PMPORT_DRV_INFO(sata_hba_inst, cport, pmport) \ 578 sata_hba_inst->satahba_dev_port[cport]->\ 579 cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->\ 580 pmport_sata_drive 581 582 #define SATA_PMPORT_STATE(sata_hba_inst, cport, pmport) \ 583 sata_hba_inst->satahba_dev_port[cport]->\ 584 cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_state 585 586 #define SATA_PMPORT_SCR(sata_hba_inst, cport, pmport) \ 587 sata_hba_inst->satahba_dev_port[cport]->\ 588 cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_scr 589 590 #define SATA_PMPORT_DEV_TYPE(sata_hba_inst, cport, pmport) \ 591 sata_hba_inst->satahba_dev_port[cport]->\ 592 cport_devp.cport_sata_pmult->pmult_dev_port[pmport]->pmport_dev_type 593 594 #define SATA_PMPORTINFO_DRV_TYPE(pmportinfo) \ 595 pmportinfo->pmport_dev_type 596 597 #define SATA_PMPORTINFO_DRV_INFO(pmportinfo) \ 598 pmportinfo->pmport_sata_drive 599 600 #define SATA_TXLT_HBA_INST(spx) \ 601 spx->txlt_sata_hba_inst 602 603 #define SATA_TXLT_CPORT(spx) \ 604 spx->txlt_sata_pkt->satapkt_device.satadev_addr.cport 605 606 #define SATA_TXLT_CPORT_MUTEX(spx) \ 607 spx->txlt_sata_hba_inst->\ 608 satahba_dev_port[spx->txlt_sata_pkt->\ 609 satapkt_device.satadev_addr.cport]->cport_mutex 610 611 #define SATA_TXLT_TASKQ(spx) \ 612 spx->txlt_sata_hba_inst->\ 613 satahba_taskq 614 615 /* 616 * Minor number construction for devctl and attachment point nodes. 617 * All necessary information has to be encoded in NBITSMINOR32 bits. 618 * 619 * Devctl node minor number: 620 * ((controller_instance << SATA_CNTRL_INSTANCE_SHIFT) | SATA_DEVCTL_NODE) 621 * 622 * Attachment point node minor number has to include controller 623 * instance (7 bits), controller port number (5 bits) and port multiplier 624 * device port number (4 bits) and port multiplier device port 625 * indicator (1 bit). Additionally, a single bit is used to 626 * differentiate between attachment point node and device control node. 627 * 628 * Attachment point minor number: 629 * ((controller_instance << SATA_CNTRL_INSTANCE_SHIFT) | SATA_AP_NODE | 630 * [(port_multiplier_device_port << SATA_PMULT_PORT_SHIFT) | SATA_PMULT_AP] | 631 * (controller_port)) 632 * 633 * 17 bits are used (if 64 instances of controllers are expected) 634 * bit 18 is reserved for future use. 635 * 636 * -------------------------------------------------------- 637 * |17|16|15|14|13|12|11|10 |09|08|07|06|05|04|03|02|01|00| 638 * -------------------------------------------------------- 639 * | R| c| c| c| c| c| c|a/d|pm|pp|pp|pp|pp|cp|cp|cp|cp|cp| 640 * -------------------------------------------------------- 641 * Where: 642 * cp - device port number on the HBA SATA controller 643 * pp - device port number on the port multiplier 644 * pm - 0 - target attached to controller device port 645 * 1 - target attached to port multiplier's device port 646 * a/d - 0 - devctl node 647 * 1 - attachment point node 648 * c - controller number 649 * R - reserved bit 650 */ 651 652 #define SATA_AP_NODE 0x400 /* Attachment Point node */ 653 #define SATA_DEVCTL_NODE 0x000 /* DEVCTL node */ 654 #define SATA_PMULT_AP 0x200 /* device on PMult port */ 655 #define SATA_PMULT_PORT_SHIFT 5 656 #define SATA_CNTRL_INSTANCE_SHIFT 11 657 #define SATA_CPORT_MASK 0x1f /* 32 device ports */ 658 #define SATA_PMULT_PORT_MASK 0xf /* 15 device ports */ 659 #define SATA_CNTRL_INSTANCE_MASK 0x03F /* 64 controllers */ 660 661 /* Macro for creating devctl node minor number */ 662 #define SATA_MAKE_DEVCTL_MINOR(controller_instance) \ 663 ((controller_instance << SATA_CNTRL_INSTANCE_SHIFT) | \ 664 SATA_DEVCTL_NODE) 665 666 /* Macro for creating an attachment point node minor number */ 667 #define SATA_MAKE_AP_MINOR(cntrl_instance, cport, pmport, qual) \ 668 (qual & (SATA_ADDR_PMPORT | SATA_ADDR_DPMPORT) ? \ 669 (((cntrl_instance) << SATA_CNTRL_INSTANCE_SHIFT) | \ 670 SATA_AP_NODE | SATA_PMULT_AP | \ 671 (pmport << SATA_PMULT_PORT_SHIFT) | cport) : \ 672 (((cntrl_instance) << SATA_CNTRL_INSTANCE_SHIFT) | \ 673 SATA_AP_NODE | cport)) 674 675 /* Macro retrieving controller number from a minor number */ 676 #define SATA_MINOR2INSTANCE(minor) \ 677 ((minor >> SATA_CNTRL_INSTANCE_SHIFT) & SATA_CNTRL_INSTANCE_MASK) 678 679 /* 680 * Macro for creating an attachment point number from sata address. 681 * Address qualifier has to be one of: 682 * SATA_ADDR_DCPORT, SATA_ADDR_DPMPORT, SATA_ADDR_CPORT or SATA_ADDR_PMPORT 683 */ 684 #define SATA_MAKE_AP_NUMBER(cport, pmport, qual) \ 685 ((qual & (SATA_ADDR_PMPORT | SATA_ADDR_DPMPORT)) ? \ 686 (SATA_PMULT_AP | (pmport << SATA_PMULT_PORT_SHIFT) | cport) : \ 687 (cport)) 688 689 /* 690 * SCSI target number format 691 * 692 * ------------------------------- 693 * | 9| 8| 7| 6| 5| 4| 3| 2| 1| 0| Bit number 694 * ------------------------------- 695 * |pm|pp|pp|pp|pp|cp|cp|cp|cp|cp| 696 * ------------------------------- 697 * Where: 698 * cp - device port number on the HBA SATA controller 699 * pp - device port number on the port multiplier 700 * pm - 0 - target attached to controller device port 701 * 1 - target attached to port multiplier's device port 702 */ 703 704 /* SATA ports to SCSI target number translation */ 705 706 #define SATA_TO_SCSI_TARGET(cport, pmport, qual) \ 707 (qual == SATA_ADDR_DCPORT ? cport : \ 708 (cport | (pmport << SATA_PMULT_PORT_SHIFT) | SATA_PMULT_AP)) 709 710 /* SCSI target number to SATA cntrl/pmport/cport translations */ 711 #define SCSI_TO_SATA_CPORT(scsi_target) \ 712 (scsi_target & SATA_CPORT_MASK) 713 714 #define SCSI_TO_SATA_PMPORT(scsi_target) \ 715 ((scsi_target >> SATA_PMULT_PORT_SHIFT) & SATA_PMULT_PORT_MASK) 716 717 #define SCSI_TO_SATA_ADDR_QUAL(scsi_target) \ 718 ((scsi_target & SATA_PMULT_AP) ? SATA_ADDR_DPMPORT : \ 719 SATA_ADDR_DCPORT) 720 721 722 /* Debug flags */ 723 #if DEBUG 724 725 #define SATA_DEBUG 726 #define SATA_DBG_SCSI_IF 1 727 #define SATA_DBG_HBA_IF 2 728 #define SATA_DBG_NODES 4 729 #define SATA_DBG_IOCTL_IF 8 730 #define SATA_DBG_EVENTS 0x10 731 #define SATA_DBG_EVENTS_PROC 0x20 732 #define SATA_DBG_EVENTS_PROCPST 0x40 733 #define SATA_DBG_EVENTS_CNTRL 0x80 734 #define SATA_DBG_EVENTS_DAEMON 0x100 735 #define SATA_DBG_DMA_SETUP 0x400 736 #define SATA_DBG_DEV_SETTINGS 0x800 737 #define SATA_DBG_ATAPI 0x1000 738 #define SATA_DBG_ATAPI_PACKET 0x8000 739 #define SATA_DBG_INTR_CTX 0x10000 740 741 typedef struct sata_atapi_cmd { 742 uint8_t acdb[SATA_ATAPI_MAX_CDB_LEN]; 743 uint8_t arqs[SATA_ATAPI_RQSENSE_LEN]; 744 uint_t sata_pkt_reason; 745 uint_t scsi_pkt_reason; 746 } sata_atapi_cmd_t; 747 748 /* Debug macros */ 749 #define SATADBG1(flag, sata, format, arg1) \ 750 if (sata_debug_flags & (flag)) { \ 751 sata_log(sata, CE_CONT, format, arg1); \ 752 } 753 754 #define SATADBG2(flag, sata, format, arg1, arg2) \ 755 if (sata_debug_flags & (flag)) { \ 756 sata_log(sata, CE_CONT, format, arg1, arg2); \ 757 } 758 759 #define SATADBG3(flag, sata, format, arg1, arg2, arg3) \ 760 if (sata_debug_flags & (flag)) { \ 761 sata_log(sata, CE_CONT, format, arg1, arg2, arg3); \ 762 } 763 #else 764 765 #define SATADBG1(flag, dip, frmt, arg1) 766 #define SATADBG2(flag, dip, frmt, arg1, arg2) 767 #define SATADBG3(flag, dip, frmt, arg1, arg2, arg3) 768 769 #endif 770 771 /* sata_rev_tag 1.42 */ 772 773 #ifdef __cplusplus 774 } 775 #endif 776 777 #endif /* _SATA_H */ 778