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