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