1 /* 2 * SAS host prototypes and structures header file 3 * 4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved. 5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com> 6 * 7 * This file is licensed under GPLv2. 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License as 11 * published by the Free Software Foundation; either version 2 of the 12 * License, or (at your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License 20 * along with this program; if not, write to the Free Software 21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 22 * USA 23 * 24 */ 25 26 #ifndef _LIBSAS_H_ 27 #define _LIBSAS_H_ 28 29 30 #include <linux/timer.h> 31 #include <linux/pci.h> 32 #include <scsi/sas.h> 33 #include <linux/list.h> 34 #include <asm/semaphore.h> 35 #include <scsi/scsi_device.h> 36 #include <scsi/scsi_cmnd.h> 37 #include <scsi/scsi_transport_sas.h> 38 #include <asm/scatterlist.h> 39 40 struct block_device; 41 42 enum sas_class { 43 SAS, 44 EXPANDER 45 }; 46 47 enum sas_phy_role { 48 PHY_ROLE_NONE = 0, 49 PHY_ROLE_TARGET = 0x40, 50 PHY_ROLE_INITIATOR = 0x80, 51 }; 52 53 enum sas_phy_type { 54 PHY_TYPE_PHYSICAL, 55 PHY_TYPE_VIRTUAL 56 }; 57 58 /* The events are mnemonically described in sas_dump.c 59 * so when updating/adding events here, please also 60 * update the other file too. 61 */ 62 enum ha_event { 63 HAE_RESET = 0U, 64 HA_NUM_EVENTS = 1, 65 }; 66 67 enum port_event { 68 PORTE_BYTES_DMAED = 0U, 69 PORTE_BROADCAST_RCVD = 1, 70 PORTE_LINK_RESET_ERR = 2, 71 PORTE_TIMER_EVENT = 3, 72 PORTE_HARD_RESET = 4, 73 PORT_NUM_EVENTS = 5, 74 }; 75 76 enum phy_event { 77 PHYE_LOSS_OF_SIGNAL = 0U, 78 PHYE_OOB_DONE = 1, 79 PHYE_OOB_ERROR = 2, 80 PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */ 81 PHY_NUM_EVENTS = 4, 82 }; 83 84 enum discover_event { 85 DISCE_DISCOVER_DOMAIN = 0U, 86 DISCE_REVALIDATE_DOMAIN = 1, 87 DISCE_PORT_GONE = 2, 88 DISC_NUM_EVENTS = 3, 89 }; 90 91 /* ---------- Expander Devices ---------- */ 92 93 #define ETASK 0xFA 94 95 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj) 96 #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\ 97 attr) 98 99 enum routing_attribute { 100 DIRECT_ROUTING, 101 SUBTRACTIVE_ROUTING, 102 TABLE_ROUTING, 103 }; 104 105 enum ex_phy_state { 106 PHY_EMPTY, 107 PHY_VACANT, 108 PHY_NOT_PRESENT, 109 PHY_DEVICE_DISCOVERED 110 }; 111 112 struct ex_phy { 113 int phy_id; 114 115 enum ex_phy_state phy_state; 116 117 enum sas_dev_type attached_dev_type; 118 enum sas_linkrate linkrate; 119 120 u8 attached_sata_host:1; 121 u8 attached_sata_dev:1; 122 u8 attached_sata_ps:1; 123 124 enum sas_proto attached_tproto; 125 enum sas_proto attached_iproto; 126 127 u8 attached_sas_addr[SAS_ADDR_SIZE]; 128 u8 attached_phy_id; 129 130 u8 phy_change_count; 131 enum routing_attribute routing_attr; 132 u8 virtual:1; 133 134 int last_da_index; 135 136 struct sas_phy *phy; 137 struct sas_port *port; 138 }; 139 140 struct expander_device { 141 struct list_head children; 142 143 u16 ex_change_count; 144 u16 max_route_indexes; 145 u8 num_phys; 146 u8 configuring:1; 147 u8 conf_route_table:1; 148 u8 enclosure_logical_id[8]; 149 150 struct ex_phy *ex_phy; 151 struct sas_port *parent_port; 152 }; 153 154 /* ---------- SATA device ---------- */ 155 enum ata_command_set { 156 ATA_COMMAND_SET = 0, 157 ATAPI_COMMAND_SET = 1, 158 }; 159 160 struct sata_device { 161 enum ata_command_set command_set; 162 struct smp_resp rps_resp; /* report_phy_sata_resp */ 163 __le16 *identify_device; 164 __le16 *identify_packet_device; 165 166 u8 port_no; /* port number, if this is a PM (Port) */ 167 struct list_head children; /* PM Ports if this is a PM */ 168 }; 169 170 /* ---------- Domain device ---------- */ 171 struct domain_device { 172 enum sas_dev_type dev_type; 173 174 enum sas_linkrate linkrate; 175 enum sas_linkrate min_linkrate; 176 enum sas_linkrate max_linkrate; 177 178 int pathways; 179 180 struct domain_device *parent; 181 struct list_head siblings; /* devices on the same level */ 182 struct asd_sas_port *port; /* shortcut to root of the tree */ 183 184 struct list_head dev_list_node; 185 186 enum sas_proto iproto; 187 enum sas_proto tproto; 188 189 struct sas_rphy *rphy; 190 191 u8 sas_addr[SAS_ADDR_SIZE]; 192 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 193 194 u8 frame_rcvd[32]; 195 196 union { 197 struct expander_device ex_dev; 198 struct sata_device sata_dev; /* STP & directly attached */ 199 }; 200 201 void *lldd_dev; 202 }; 203 204 struct sas_discovery_event { 205 struct work_struct work; 206 struct asd_sas_port *port; 207 }; 208 209 struct sas_discovery { 210 spinlock_t disc_event_lock; 211 struct sas_discovery_event disc_work[DISC_NUM_EVENTS]; 212 unsigned long pending; 213 u8 fanout_sas_addr[8]; 214 u8 eeds_a[8]; 215 u8 eeds_b[8]; 216 int max_level; 217 }; 218 219 220 /* The port struct is Class:RW, driver:RO */ 221 struct asd_sas_port { 222 /* private: */ 223 struct completion port_gone_completion; 224 225 struct sas_discovery disc; 226 struct domain_device *port_dev; 227 spinlock_t dev_list_lock; 228 struct list_head dev_list; 229 enum sas_linkrate linkrate; 230 231 struct sas_phy *phy; 232 struct work_struct work; 233 234 /* public: */ 235 int id; 236 237 enum sas_class class; 238 u8 sas_addr[SAS_ADDR_SIZE]; 239 u8 attached_sas_addr[SAS_ADDR_SIZE]; 240 enum sas_proto iproto; 241 enum sas_proto tproto; 242 243 enum sas_oob_mode oob_mode; 244 245 spinlock_t phy_list_lock; 246 struct list_head phy_list; 247 int num_phys; 248 u32 phy_mask; 249 250 struct sas_ha_struct *ha; 251 252 struct sas_port *port; 253 254 void *lldd_port; /* not touched by the sas class code */ 255 }; 256 257 struct asd_sas_event { 258 struct work_struct work; 259 struct asd_sas_phy *phy; 260 }; 261 262 /* The phy pretty much is controlled by the LLDD. 263 * The class only reads those fields. 264 */ 265 struct asd_sas_phy { 266 /* private: */ 267 /* protected by ha->event_lock */ 268 struct asd_sas_event port_events[PORT_NUM_EVENTS]; 269 struct asd_sas_event phy_events[PHY_NUM_EVENTS]; 270 271 unsigned long port_events_pending; 272 unsigned long phy_events_pending; 273 274 int error; 275 276 struct sas_phy *phy; 277 278 /* public: */ 279 /* The following are class:RO, driver:R/W */ 280 int enabled; /* must be set */ 281 282 int id; /* must be set */ 283 enum sas_class class; 284 enum sas_proto iproto; 285 enum sas_proto tproto; 286 287 enum sas_phy_type type; 288 enum sas_phy_role role; 289 enum sas_oob_mode oob_mode; 290 enum sas_linkrate linkrate; 291 292 u8 *sas_addr; /* must be set */ 293 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */ 294 295 spinlock_t frame_rcvd_lock; 296 u8 *frame_rcvd; /* must be set */ 297 int frame_rcvd_size; 298 299 spinlock_t sas_prim_lock; 300 u32 sas_prim; 301 302 struct list_head port_phy_el; /* driver:RO */ 303 struct asd_sas_port *port; /* Class:RW, driver: RO */ 304 305 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */ 306 307 void *lldd_phy; /* not touched by the sas_class_code */ 308 }; 309 310 struct scsi_core { 311 struct Scsi_Host *shost; 312 313 spinlock_t task_queue_lock; 314 struct list_head task_queue; 315 int task_queue_size; 316 317 struct semaphore queue_thread_sema; 318 int queue_thread_kill; 319 }; 320 321 struct sas_ha_event { 322 struct work_struct work; 323 struct sas_ha_struct *ha; 324 }; 325 326 struct sas_ha_struct { 327 /* private: */ 328 spinlock_t event_lock; 329 struct sas_ha_event ha_events[HA_NUM_EVENTS]; 330 unsigned long pending; 331 332 struct scsi_core core; 333 334 /* public: */ 335 char *sas_ha_name; 336 struct pci_dev *pcidev; /* should be set */ 337 struct module *lldd_module; /* should be set */ 338 339 u8 *sas_addr; /* must be set */ 340 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 341 342 spinlock_t phy_port_lock; 343 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */ 344 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */ 345 int num_phys; /* must be set, gt 0, static */ 346 347 /* The class calls this to send a task for execution. */ 348 int lldd_max_execute_num; 349 int lldd_queue_size; 350 351 /* LLDD calls these to notify the class of an event. */ 352 void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event); 353 void (*notify_port_event)(struct asd_sas_phy *, enum port_event); 354 void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event); 355 356 void *lldd_ha; /* not touched by sas class code */ 357 358 struct list_head eh_done_q; 359 }; 360 361 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata) 362 363 static inline struct domain_device * 364 starget_to_domain_dev(struct scsi_target *starget) { 365 return starget->hostdata; 366 } 367 368 static inline struct domain_device * 369 sdev_to_domain_dev(struct scsi_device *sdev) { 370 return starget_to_domain_dev(sdev->sdev_target); 371 } 372 373 static inline struct domain_device * 374 cmd_to_domain_dev(struct scsi_cmnd *cmd) 375 { 376 return sdev_to_domain_dev(cmd->device); 377 } 378 379 void sas_hash_addr(u8 *hashed, const u8 *sas_addr); 380 381 /* Before calling a notify event, LLDD should use this function 382 * when the link is severed (possibly from its tasklet). 383 * The idea is that the Class only reads those, while the LLDD, 384 * can R/W these (thus avoiding a race). 385 */ 386 static inline void sas_phy_disconnected(struct asd_sas_phy *phy) 387 { 388 phy->oob_mode = OOB_NOT_CONNECTED; 389 phy->linkrate = SAS_LINK_RATE_UNKNOWN; 390 } 391 392 /* ---------- Tasks ---------- */ 393 /* 394 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED | 395 exec_status | | | 396 ---------------------+---------------------+-----------------------+ 397 SAM_... | X | | 398 DEV_NO_RESPONSE | X | X | 399 INTERRUPTED | X | | 400 QUEUE_FULL | | X | 401 DEVICE_UNKNOWN | | X | 402 SG_ERR | | X | 403 ---------------------+---------------------+-----------------------+ 404 */ 405 406 enum service_response { 407 SAS_TASK_COMPLETE, 408 SAS_TASK_UNDELIVERED = -1, 409 }; 410 411 enum exec_status { 412 SAM_GOOD = 0, 413 SAM_CHECK_COND = 2, 414 SAM_COND_MET = 4, 415 SAM_BUSY = 8, 416 SAM_INTERMEDIATE = 0x10, 417 SAM_IM_COND_MET = 0x12, 418 SAM_RESV_CONFLICT= 0x14, 419 SAM_TASK_SET_FULL= 0x28, 420 SAM_ACA_ACTIVE = 0x30, 421 SAM_TASK_ABORTED = 0x40, 422 423 SAS_DEV_NO_RESPONSE = 0x80, 424 SAS_DATA_UNDERRUN, 425 SAS_DATA_OVERRUN, 426 SAS_INTERRUPTED, 427 SAS_QUEUE_FULL, 428 SAS_DEVICE_UNKNOWN, 429 SAS_SG_ERR, 430 SAS_OPEN_REJECT, 431 SAS_OPEN_TO, 432 SAS_PROTO_RESPONSE, 433 SAS_PHY_DOWN, 434 SAS_NAK_R_ERR, 435 SAS_PENDING, 436 SAS_ABORTED_TASK, 437 }; 438 439 /* When a task finishes with a response, the LLDD examines the 440 * response: 441 * - For an ATA task task_status_struct::stat is set to 442 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the 443 * contents of struct ata_task_resp. 444 * - For SSP tasks, if no data is present or status/TMF response 445 * is valid, task_status_struct::stat is set. If data is present 446 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets 447 * task_status_struct::buf_valid_size, and task_status_struct::stat is 448 * set to SAM_CHECK_COND. 449 * 450 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp 451 * for ATA task. 452 * 453 * "frame_len" is the total frame length, which could be more or less 454 * than actually copied. 455 * 456 * Tasks ending with response, always set the residual field. 457 */ 458 struct ata_task_resp { 459 u16 frame_len; 460 u8 ending_fis[24]; /* dev to host or data-in */ 461 u32 sstatus; 462 u32 serror; 463 u32 scontrol; 464 u32 sactive; 465 }; 466 467 #define SAS_STATUS_BUF_SIZE 96 468 469 struct task_status_struct { 470 enum service_response resp; 471 enum exec_status stat; 472 int buf_valid_size; 473 474 u8 buf[SAS_STATUS_BUF_SIZE]; 475 476 u32 residual; 477 enum sas_open_rej_reason open_rej_reason; 478 }; 479 480 /* ATA and ATAPI task queuable to a SAS LLDD. 481 */ 482 struct sas_ata_task { 483 struct host_to_dev_fis fis; 484 u8 atapi_packet[16]; /* 0 if not ATAPI task */ 485 486 u8 retry_count; /* hardware retry, should be > 0 */ 487 488 u8 dma_xfer:1; /* PIO:0 or DMA:1 */ 489 u8 use_ncq:1; 490 u8 set_affil_pol:1; 491 u8 stp_affil_pol:1; 492 493 u8 device_control_reg_update:1; 494 }; 495 496 struct sas_smp_task { 497 struct scatterlist smp_req; 498 struct scatterlist smp_resp; 499 }; 500 501 enum task_attribute { 502 TASK_ATTR_SIMPLE = 0, 503 TASK_ATTR_HOQ = 1, 504 TASK_ATTR_ORDERED= 2, 505 TASK_ATTR_ACA = 4, 506 }; 507 508 struct sas_ssp_task { 509 u8 retry_count; /* hardware retry, should be > 0 */ 510 511 u8 LUN[8]; 512 u8 enable_first_burst:1; 513 enum task_attribute task_attr; 514 u8 task_prio; 515 u8 cdb[16]; 516 }; 517 518 struct sas_task { 519 struct domain_device *dev; 520 struct list_head list; 521 522 spinlock_t task_state_lock; 523 unsigned task_state_flags; 524 525 enum sas_proto task_proto; 526 527 /* Used by the discovery code. */ 528 struct timer_list timer; 529 struct completion completion; 530 531 union { 532 struct sas_ata_task ata_task; 533 struct sas_smp_task smp_task; 534 struct sas_ssp_task ssp_task; 535 }; 536 537 struct scatterlist *scatter; 538 int num_scatter; 539 u32 total_xfer_len; 540 u8 data_dir:2; /* Use PCI_DMA_... */ 541 542 struct task_status_struct task_status; 543 void (*task_done)(struct sas_task *); 544 545 void *lldd_task; /* for use by LLDDs */ 546 void *uldd_task; 547 548 struct work_struct abort_work; 549 }; 550 551 552 553 #define SAS_TASK_STATE_PENDING 1 554 #define SAS_TASK_STATE_DONE 2 555 #define SAS_TASK_STATE_ABORTED 4 556 #define SAS_TASK_INITIATOR_ABORTED 8 557 558 static inline struct sas_task *sas_alloc_task(gfp_t flags) 559 { 560 extern struct kmem_cache *sas_task_cache; 561 struct sas_task *task = kmem_cache_alloc(sas_task_cache, flags); 562 563 if (task) { 564 memset(task, 0, sizeof(*task)); 565 INIT_LIST_HEAD(&task->list); 566 spin_lock_init(&task->task_state_lock); 567 task->task_state_flags = SAS_TASK_STATE_PENDING; 568 init_timer(&task->timer); 569 init_completion(&task->completion); 570 } 571 572 return task; 573 } 574 575 static inline void sas_free_task(struct sas_task *task) 576 { 577 if (task) { 578 extern struct kmem_cache *sas_task_cache; 579 BUG_ON(!list_empty(&task->list)); 580 kmem_cache_free(sas_task_cache, task); 581 } 582 } 583 584 struct sas_domain_function_template { 585 /* The class calls these to notify the LLDD of an event. */ 586 void (*lldd_port_formed)(struct asd_sas_phy *); 587 void (*lldd_port_deformed)(struct asd_sas_phy *); 588 589 /* The class calls these when a device is found or gone. */ 590 int (*lldd_dev_found)(struct domain_device *); 591 void (*lldd_dev_gone)(struct domain_device *); 592 593 int (*lldd_execute_task)(struct sas_task *, int num, 594 gfp_t gfp_flags); 595 596 /* Task Management Functions. Must be called from process context. */ 597 int (*lldd_abort_task)(struct sas_task *); 598 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun); 599 int (*lldd_clear_aca)(struct domain_device *, u8 *lun); 600 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun); 601 int (*lldd_I_T_nexus_reset)(struct domain_device *); 602 int (*lldd_lu_reset)(struct domain_device *, u8 *lun); 603 int (*lldd_query_task)(struct sas_task *); 604 605 /* Port and Adapter management */ 606 int (*lldd_clear_nexus_port)(struct asd_sas_port *); 607 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *); 608 609 /* Phy management */ 610 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *); 611 }; 612 613 extern int sas_register_ha(struct sas_ha_struct *); 614 extern int sas_unregister_ha(struct sas_ha_struct *); 615 616 int sas_phy_reset(struct sas_phy *phy, int hard_reset); 617 extern int sas_queuecommand(struct scsi_cmnd *, 618 void (*scsi_done)(struct scsi_cmnd *)); 619 extern int sas_target_alloc(struct scsi_target *); 620 extern int sas_slave_alloc(struct scsi_device *); 621 extern int sas_slave_configure(struct scsi_device *); 622 extern void sas_slave_destroy(struct scsi_device *); 623 extern int sas_change_queue_depth(struct scsi_device *, int new_depth); 624 extern int sas_change_queue_type(struct scsi_device *, int qt); 625 extern int sas_bios_param(struct scsi_device *, 626 struct block_device *, 627 sector_t capacity, int *hsc); 628 extern struct scsi_transport_template * 629 sas_domain_attach_transport(struct sas_domain_function_template *); 630 extern void sas_domain_release_transport(struct scsi_transport_template *); 631 632 int sas_discover_root_expander(struct domain_device *); 633 634 void sas_init_ex_attr(void); 635 636 int sas_ex_revalidate_domain(struct domain_device *); 637 638 void sas_unregister_domain_devices(struct asd_sas_port *port); 639 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *); 640 int sas_discover_event(struct asd_sas_port *, enum discover_event ev); 641 642 int sas_discover_sata(struct domain_device *); 643 int sas_discover_end_dev(struct domain_device *); 644 645 void sas_unregister_dev(struct domain_device *); 646 647 void sas_init_dev(struct domain_device *); 648 649 void sas_task_abort(struct work_struct *); 650 651 #endif /* _SASLIB_H_ */ 652