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