12908d778SJames Bottomley /* 22908d778SJames Bottomley * SAS host prototypes and structures header file 32908d778SJames Bottomley * 42908d778SJames Bottomley * Copyright (C) 2005 Adaptec, Inc. All rights reserved. 52908d778SJames Bottomley * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com> 62908d778SJames Bottomley * 72908d778SJames Bottomley * This file is licensed under GPLv2. 82908d778SJames Bottomley * 92908d778SJames Bottomley * This program is free software; you can redistribute it and/or 102908d778SJames Bottomley * modify it under the terms of the GNU General Public License as 112908d778SJames Bottomley * published by the Free Software Foundation; either version 2 of the 122908d778SJames Bottomley * License, or (at your option) any later version. 132908d778SJames Bottomley * 142908d778SJames Bottomley * This program is distributed in the hope that it will be useful, but 152908d778SJames Bottomley * WITHOUT ANY WARRANTY; without even the implied warranty of 162908d778SJames Bottomley * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 172908d778SJames Bottomley * General Public License for more details. 182908d778SJames Bottomley * 192908d778SJames Bottomley * You should have received a copy of the GNU General Public License 202908d778SJames Bottomley * along with this program; if not, write to the Free Software 212908d778SJames Bottomley * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 222908d778SJames Bottomley * USA 232908d778SJames Bottomley * 242908d778SJames Bottomley */ 252908d778SJames Bottomley 262908d778SJames Bottomley #ifndef _LIBSAS_H_ 272908d778SJames Bottomley #define _LIBSAS_H_ 282908d778SJames Bottomley 292908d778SJames Bottomley 302908d778SJames Bottomley #include <linux/timer.h> 312908d778SJames Bottomley #include <linux/pci.h> 322908d778SJames Bottomley #include <scsi/sas.h> 33fa1c1e8fSDarrick J. Wong #include <linux/libata.h> 342908d778SJames Bottomley #include <linux/list.h> 352908d778SJames Bottomley #include <asm/semaphore.h> 362908d778SJames Bottomley #include <scsi/scsi_device.h> 372908d778SJames Bottomley #include <scsi/scsi_cmnd.h> 382908d778SJames Bottomley #include <scsi/scsi_transport_sas.h> 3987ae9afdSAdrian Bunk #include <linux/scatterlist.h> 402908d778SJames Bottomley 412908d778SJames Bottomley struct block_device; 422908d778SJames Bottomley 432908d778SJames Bottomley enum sas_class { 442908d778SJames Bottomley SAS, 452908d778SJames Bottomley EXPANDER 462908d778SJames Bottomley }; 472908d778SJames Bottomley 482908d778SJames Bottomley enum sas_phy_role { 492908d778SJames Bottomley PHY_ROLE_NONE = 0, 502908d778SJames Bottomley PHY_ROLE_TARGET = 0x40, 512908d778SJames Bottomley PHY_ROLE_INITIATOR = 0x80, 522908d778SJames Bottomley }; 532908d778SJames Bottomley 542908d778SJames Bottomley enum sas_phy_type { 552908d778SJames Bottomley PHY_TYPE_PHYSICAL, 562908d778SJames Bottomley PHY_TYPE_VIRTUAL 572908d778SJames Bottomley }; 582908d778SJames Bottomley 592908d778SJames Bottomley /* The events are mnemonically described in sas_dump.c 602908d778SJames Bottomley * so when updating/adding events here, please also 612908d778SJames Bottomley * update the other file too. 622908d778SJames Bottomley */ 632908d778SJames Bottomley enum ha_event { 642908d778SJames Bottomley HAE_RESET = 0U, 652908d778SJames Bottomley HA_NUM_EVENTS = 1, 662908d778SJames Bottomley }; 672908d778SJames Bottomley 682908d778SJames Bottomley enum port_event { 692908d778SJames Bottomley PORTE_BYTES_DMAED = 0U, 702908d778SJames Bottomley PORTE_BROADCAST_RCVD = 1, 712908d778SJames Bottomley PORTE_LINK_RESET_ERR = 2, 722908d778SJames Bottomley PORTE_TIMER_EVENT = 3, 732908d778SJames Bottomley PORTE_HARD_RESET = 4, 742908d778SJames Bottomley PORT_NUM_EVENTS = 5, 752908d778SJames Bottomley }; 762908d778SJames Bottomley 772908d778SJames Bottomley enum phy_event { 782908d778SJames Bottomley PHYE_LOSS_OF_SIGNAL = 0U, 792908d778SJames Bottomley PHYE_OOB_DONE = 1, 802908d778SJames Bottomley PHYE_OOB_ERROR = 2, 812908d778SJames Bottomley PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */ 822908d778SJames Bottomley PHY_NUM_EVENTS = 4, 832908d778SJames Bottomley }; 842908d778SJames Bottomley 852908d778SJames Bottomley enum discover_event { 862908d778SJames Bottomley DISCE_DISCOVER_DOMAIN = 0U, 872908d778SJames Bottomley DISCE_REVALIDATE_DOMAIN = 1, 882908d778SJames Bottomley DISCE_PORT_GONE = 2, 892908d778SJames Bottomley DISC_NUM_EVENTS = 3, 902908d778SJames Bottomley }; 912908d778SJames Bottomley 922908d778SJames Bottomley /* ---------- Expander Devices ---------- */ 932908d778SJames Bottomley 942908d778SJames Bottomley #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj) 952908d778SJames Bottomley #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\ 962908d778SJames Bottomley attr) 972908d778SJames Bottomley 982908d778SJames Bottomley enum routing_attribute { 992908d778SJames Bottomley DIRECT_ROUTING, 1002908d778SJames Bottomley SUBTRACTIVE_ROUTING, 1012908d778SJames Bottomley TABLE_ROUTING, 1022908d778SJames Bottomley }; 1032908d778SJames Bottomley 1042908d778SJames Bottomley enum ex_phy_state { 1052908d778SJames Bottomley PHY_EMPTY, 1062908d778SJames Bottomley PHY_VACANT, 1072908d778SJames Bottomley PHY_NOT_PRESENT, 1082908d778SJames Bottomley PHY_DEVICE_DISCOVERED 1092908d778SJames Bottomley }; 1102908d778SJames Bottomley 1112908d778SJames Bottomley struct ex_phy { 1122908d778SJames Bottomley int phy_id; 1132908d778SJames Bottomley 1142908d778SJames Bottomley enum ex_phy_state phy_state; 1152908d778SJames Bottomley 1162908d778SJames Bottomley enum sas_dev_type attached_dev_type; 11788edf746SJames Bottomley enum sas_linkrate linkrate; 1182908d778SJames Bottomley 1192908d778SJames Bottomley u8 attached_sata_host:1; 1202908d778SJames Bottomley u8 attached_sata_dev:1; 1212908d778SJames Bottomley u8 attached_sata_ps:1; 1222908d778SJames Bottomley 1235929faf3SDarrick J. Wong enum sas_protocol attached_tproto; 1245929faf3SDarrick J. Wong enum sas_protocol attached_iproto; 1252908d778SJames Bottomley 1262908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; 1272908d778SJames Bottomley u8 attached_phy_id; 1282908d778SJames Bottomley 1292908d778SJames Bottomley u8 phy_change_count; 1302908d778SJames Bottomley enum routing_attribute routing_attr; 1312908d778SJames Bottomley u8 virtual:1; 1322908d778SJames Bottomley 1332908d778SJames Bottomley int last_da_index; 1342908d778SJames Bottomley 1352908d778SJames Bottomley struct sas_phy *phy; 1362908d778SJames Bottomley struct sas_port *port; 1372908d778SJames Bottomley }; 1382908d778SJames Bottomley 1392908d778SJames Bottomley struct expander_device { 1402908d778SJames Bottomley struct list_head children; 1412908d778SJames Bottomley 1422908d778SJames Bottomley u16 ex_change_count; 1432908d778SJames Bottomley u16 max_route_indexes; 1442908d778SJames Bottomley u8 num_phys; 1452908d778SJames Bottomley u8 configuring:1; 1462908d778SJames Bottomley u8 conf_route_table:1; 1472908d778SJames Bottomley u8 enclosure_logical_id[8]; 1482908d778SJames Bottomley 1492908d778SJames Bottomley struct ex_phy *ex_phy; 1502908d778SJames Bottomley struct sas_port *parent_port; 1512908d778SJames Bottomley }; 1522908d778SJames Bottomley 1532908d778SJames Bottomley /* ---------- SATA device ---------- */ 1542908d778SJames Bottomley enum ata_command_set { 1552908d778SJames Bottomley ATA_COMMAND_SET = 0, 1562908d778SJames Bottomley ATAPI_COMMAND_SET = 1, 1572908d778SJames Bottomley }; 1582908d778SJames Bottomley 1592908d778SJames Bottomley struct sata_device { 1602908d778SJames Bottomley enum ata_command_set command_set; 1612908d778SJames Bottomley struct smp_resp rps_resp; /* report_phy_sata_resp */ 1622908d778SJames Bottomley __le16 *identify_device; 1632908d778SJames Bottomley __le16 *identify_packet_device; 1642908d778SJames Bottomley 1652908d778SJames Bottomley u8 port_no; /* port number, if this is a PM (Port) */ 1662908d778SJames Bottomley struct list_head children; /* PM Ports if this is a PM */ 167fa1c1e8fSDarrick J. Wong 168fa1c1e8fSDarrick J. Wong struct ata_port *ap; 169fa1c1e8fSDarrick J. Wong struct ata_host ata_host; 170fa1c1e8fSDarrick J. Wong struct ata_taskfile tf; 171fa1c1e8fSDarrick J. Wong u32 sstatus; 172fa1c1e8fSDarrick J. Wong u32 serror; 173fa1c1e8fSDarrick J. Wong u32 scontrol; 1742908d778SJames Bottomley }; 1752908d778SJames Bottomley 1762908d778SJames Bottomley /* ---------- Domain device ---------- */ 1772908d778SJames Bottomley struct domain_device { 1782908d778SJames Bottomley enum sas_dev_type dev_type; 1792908d778SJames Bottomley 18088edf746SJames Bottomley enum sas_linkrate linkrate; 18188edf746SJames Bottomley enum sas_linkrate min_linkrate; 18288edf746SJames Bottomley enum sas_linkrate max_linkrate; 1832908d778SJames Bottomley 1842908d778SJames Bottomley int pathways; 1852908d778SJames Bottomley 1862908d778SJames Bottomley struct domain_device *parent; 1872908d778SJames Bottomley struct list_head siblings; /* devices on the same level */ 1882908d778SJames Bottomley struct asd_sas_port *port; /* shortcut to root of the tree */ 1892908d778SJames Bottomley 1902908d778SJames Bottomley struct list_head dev_list_node; 1912908d778SJames Bottomley 1925929faf3SDarrick J. Wong enum sas_protocol iproto; 1935929faf3SDarrick J. Wong enum sas_protocol tproto; 1942908d778SJames Bottomley 1952908d778SJames Bottomley struct sas_rphy *rphy; 1962908d778SJames Bottomley 1972908d778SJames Bottomley u8 sas_addr[SAS_ADDR_SIZE]; 1982908d778SJames Bottomley u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 1992908d778SJames Bottomley 2002908d778SJames Bottomley u8 frame_rcvd[32]; 2012908d778SJames Bottomley 2022908d778SJames Bottomley union { 2032908d778SJames Bottomley struct expander_device ex_dev; 2042908d778SJames Bottomley struct sata_device sata_dev; /* STP & directly attached */ 2052908d778SJames Bottomley }; 2062908d778SJames Bottomley 2072908d778SJames Bottomley void *lldd_dev; 2082908d778SJames Bottomley }; 2092908d778SJames Bottomley 210c4028958SDavid Howells struct sas_discovery_event { 211c4028958SDavid Howells struct work_struct work; 212c4028958SDavid Howells struct asd_sas_port *port; 213c4028958SDavid Howells }; 214c4028958SDavid Howells 2152908d778SJames Bottomley struct sas_discovery { 2162908d778SJames Bottomley spinlock_t disc_event_lock; 217c4028958SDavid Howells struct sas_discovery_event disc_work[DISC_NUM_EVENTS]; 2182908d778SJames Bottomley unsigned long pending; 2192908d778SJames Bottomley u8 fanout_sas_addr[8]; 2202908d778SJames Bottomley u8 eeds_a[8]; 2212908d778SJames Bottomley u8 eeds_b[8]; 2222908d778SJames Bottomley int max_level; 2232908d778SJames Bottomley }; 2242908d778SJames Bottomley 2252908d778SJames Bottomley 2262908d778SJames Bottomley /* The port struct is Class:RW, driver:RO */ 2272908d778SJames Bottomley struct asd_sas_port { 2282908d778SJames Bottomley /* private: */ 2292908d778SJames Bottomley struct completion port_gone_completion; 2302908d778SJames Bottomley 2312908d778SJames Bottomley struct sas_discovery disc; 2322908d778SJames Bottomley struct domain_device *port_dev; 2332908d778SJames Bottomley spinlock_t dev_list_lock; 2342908d778SJames Bottomley struct list_head dev_list; 23588edf746SJames Bottomley enum sas_linkrate linkrate; 2362908d778SJames Bottomley 2372908d778SJames Bottomley struct sas_phy *phy; 2382908d778SJames Bottomley struct work_struct work; 2392908d778SJames Bottomley 2402908d778SJames Bottomley /* public: */ 2412908d778SJames Bottomley int id; 2422908d778SJames Bottomley 2432908d778SJames Bottomley enum sas_class class; 2442908d778SJames Bottomley u8 sas_addr[SAS_ADDR_SIZE]; 2452908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; 2465929faf3SDarrick J. Wong enum sas_protocol iproto; 2475929faf3SDarrick J. Wong enum sas_protocol tproto; 2482908d778SJames Bottomley 2492908d778SJames Bottomley enum sas_oob_mode oob_mode; 2502908d778SJames Bottomley 2512908d778SJames Bottomley spinlock_t phy_list_lock; 2522908d778SJames Bottomley struct list_head phy_list; 2532908d778SJames Bottomley int num_phys; 2542908d778SJames Bottomley u32 phy_mask; 2552908d778SJames Bottomley 2562908d778SJames Bottomley struct sas_ha_struct *ha; 2572908d778SJames Bottomley 2582908d778SJames Bottomley struct sas_port *port; 2592908d778SJames Bottomley 2602908d778SJames Bottomley void *lldd_port; /* not touched by the sas class code */ 2612908d778SJames Bottomley }; 2622908d778SJames Bottomley 263c4028958SDavid Howells struct asd_sas_event { 264c4028958SDavid Howells struct work_struct work; 265c4028958SDavid Howells struct asd_sas_phy *phy; 266c4028958SDavid Howells }; 267c4028958SDavid Howells 2682908d778SJames Bottomley /* The phy pretty much is controlled by the LLDD. 2692908d778SJames Bottomley * The class only reads those fields. 2702908d778SJames Bottomley */ 2712908d778SJames Bottomley struct asd_sas_phy { 2722908d778SJames Bottomley /* private: */ 2732908d778SJames Bottomley /* protected by ha->event_lock */ 274c4028958SDavid Howells struct asd_sas_event port_events[PORT_NUM_EVENTS]; 275c4028958SDavid Howells struct asd_sas_event phy_events[PHY_NUM_EVENTS]; 2762908d778SJames Bottomley 2772908d778SJames Bottomley unsigned long port_events_pending; 2782908d778SJames Bottomley unsigned long phy_events_pending; 2792908d778SJames Bottomley 2802908d778SJames Bottomley int error; 2812908d778SJames Bottomley 2822908d778SJames Bottomley struct sas_phy *phy; 2832908d778SJames Bottomley 2842908d778SJames Bottomley /* public: */ 2852908d778SJames Bottomley /* The following are class:RO, driver:R/W */ 2862908d778SJames Bottomley int enabled; /* must be set */ 2872908d778SJames Bottomley 2882908d778SJames Bottomley int id; /* must be set */ 2892908d778SJames Bottomley enum sas_class class; 2905929faf3SDarrick J. Wong enum sas_protocol iproto; 2915929faf3SDarrick J. Wong enum sas_protocol tproto; 2922908d778SJames Bottomley 2932908d778SJames Bottomley enum sas_phy_type type; 2942908d778SJames Bottomley enum sas_phy_role role; 2952908d778SJames Bottomley enum sas_oob_mode oob_mode; 29688edf746SJames Bottomley enum sas_linkrate linkrate; 2972908d778SJames Bottomley 2982908d778SJames Bottomley u8 *sas_addr; /* must be set */ 2992908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */ 3002908d778SJames Bottomley 3012908d778SJames Bottomley spinlock_t frame_rcvd_lock; 3022908d778SJames Bottomley u8 *frame_rcvd; /* must be set */ 3032908d778SJames Bottomley int frame_rcvd_size; 3042908d778SJames Bottomley 3052908d778SJames Bottomley spinlock_t sas_prim_lock; 3062908d778SJames Bottomley u32 sas_prim; 3072908d778SJames Bottomley 3082908d778SJames Bottomley struct list_head port_phy_el; /* driver:RO */ 3092908d778SJames Bottomley struct asd_sas_port *port; /* Class:RW, driver: RO */ 3102908d778SJames Bottomley 3112908d778SJames Bottomley struct sas_ha_struct *ha; /* may be set; the class sets it anyway */ 3122908d778SJames Bottomley 3132908d778SJames Bottomley void *lldd_phy; /* not touched by the sas_class_code */ 3142908d778SJames Bottomley }; 3152908d778SJames Bottomley 3162908d778SJames Bottomley struct scsi_core { 3172908d778SJames Bottomley struct Scsi_Host *shost; 3182908d778SJames Bottomley 3192908d778SJames Bottomley spinlock_t task_queue_lock; 3202908d778SJames Bottomley struct list_head task_queue; 3212908d778SJames Bottomley int task_queue_size; 3222908d778SJames Bottomley 323d7a54e30SChristoph Hellwig struct task_struct *queue_thread; 3242908d778SJames Bottomley }; 3252908d778SJames Bottomley 326c4028958SDavid Howells struct sas_ha_event { 327c4028958SDavid Howells struct work_struct work; 328c4028958SDavid Howells struct sas_ha_struct *ha; 329c4028958SDavid Howells }; 330c4028958SDavid Howells 3316b0efb85SDarrick J. Wong enum sas_ha_state { 3326b0efb85SDarrick J. Wong SAS_HA_REGISTERED, 3336b0efb85SDarrick J. Wong SAS_HA_UNREGISTERED 3346b0efb85SDarrick J. Wong }; 3356b0efb85SDarrick J. Wong 3362908d778SJames Bottomley struct sas_ha_struct { 3372908d778SJames Bottomley /* private: */ 3382908d778SJames Bottomley spinlock_t event_lock; 339c4028958SDavid Howells struct sas_ha_event ha_events[HA_NUM_EVENTS]; 3402908d778SJames Bottomley unsigned long pending; 3412908d778SJames Bottomley 3426b0efb85SDarrick J. Wong enum sas_ha_state state; 3436b0efb85SDarrick J. Wong spinlock_t state_lock; 3446b0efb85SDarrick J. Wong 3452908d778SJames Bottomley struct scsi_core core; 3462908d778SJames Bottomley 3472908d778SJames Bottomley /* public: */ 3482908d778SJames Bottomley char *sas_ha_name; 3491d1bbee6SJeff Garzik struct device *dev; /* should be set */ 3502908d778SJames Bottomley struct module *lldd_module; /* should be set */ 3512908d778SJames Bottomley 3522908d778SJames Bottomley u8 *sas_addr; /* must be set */ 3532908d778SJames Bottomley u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 3542908d778SJames Bottomley 3552908d778SJames Bottomley spinlock_t phy_port_lock; 3562908d778SJames Bottomley struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */ 3572908d778SJames Bottomley struct asd_sas_port **sas_port; /* array of valid pointers, must be set */ 3582908d778SJames Bottomley int num_phys; /* must be set, gt 0, static */ 3592908d778SJames Bottomley 3602908d778SJames Bottomley /* The class calls this to send a task for execution. */ 3612908d778SJames Bottomley int lldd_max_execute_num; 3622908d778SJames Bottomley int lldd_queue_size; 3632908d778SJames Bottomley 3642908d778SJames Bottomley /* LLDD calls these to notify the class of an event. */ 3652908d778SJames Bottomley void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event); 3662908d778SJames Bottomley void (*notify_port_event)(struct asd_sas_phy *, enum port_event); 3672908d778SJames Bottomley void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event); 3682908d778SJames Bottomley 3692908d778SJames Bottomley void *lldd_ha; /* not touched by sas class code */ 370f456393eSDarrick J. Wong 371f456393eSDarrick J. Wong struct list_head eh_done_q; 3722908d778SJames Bottomley }; 3732908d778SJames Bottomley 3742908d778SJames Bottomley #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata) 3752908d778SJames Bottomley 3762908d778SJames Bottomley static inline struct domain_device * 3772908d778SJames Bottomley starget_to_domain_dev(struct scsi_target *starget) { 3782908d778SJames Bottomley return starget->hostdata; 3792908d778SJames Bottomley } 3802908d778SJames Bottomley 3812908d778SJames Bottomley static inline struct domain_device * 3822908d778SJames Bottomley sdev_to_domain_dev(struct scsi_device *sdev) { 3832908d778SJames Bottomley return starget_to_domain_dev(sdev->sdev_target); 3842908d778SJames Bottomley } 3852908d778SJames Bottomley 3862908d778SJames Bottomley static inline struct domain_device * 3872908d778SJames Bottomley cmd_to_domain_dev(struct scsi_cmnd *cmd) 3882908d778SJames Bottomley { 3892908d778SJames Bottomley return sdev_to_domain_dev(cmd->device); 3902908d778SJames Bottomley } 3912908d778SJames Bottomley 3922908d778SJames Bottomley void sas_hash_addr(u8 *hashed, const u8 *sas_addr); 3932908d778SJames Bottomley 3942908d778SJames Bottomley /* Before calling a notify event, LLDD should use this function 3952908d778SJames Bottomley * when the link is severed (possibly from its tasklet). 3962908d778SJames Bottomley * The idea is that the Class only reads those, while the LLDD, 3972908d778SJames Bottomley * can R/W these (thus avoiding a race). 3982908d778SJames Bottomley */ 3992908d778SJames Bottomley static inline void sas_phy_disconnected(struct asd_sas_phy *phy) 4002908d778SJames Bottomley { 4012908d778SJames Bottomley phy->oob_mode = OOB_NOT_CONNECTED; 40288edf746SJames Bottomley phy->linkrate = SAS_LINK_RATE_UNKNOWN; 4032908d778SJames Bottomley } 4042908d778SJames Bottomley 4052908d778SJames Bottomley /* ---------- Tasks ---------- */ 4062908d778SJames Bottomley /* 4072908d778SJames Bottomley service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED | 4082908d778SJames Bottomley exec_status | | | 4092908d778SJames Bottomley ---------------------+---------------------+-----------------------+ 4102908d778SJames Bottomley SAM_... | X | | 4112908d778SJames Bottomley DEV_NO_RESPONSE | X | X | 4122908d778SJames Bottomley INTERRUPTED | X | | 4132908d778SJames Bottomley QUEUE_FULL | | X | 4142908d778SJames Bottomley DEVICE_UNKNOWN | | X | 4152908d778SJames Bottomley SG_ERR | | X | 4162908d778SJames Bottomley ---------------------+---------------------+-----------------------+ 4172908d778SJames Bottomley */ 4182908d778SJames Bottomley 4192908d778SJames Bottomley enum service_response { 4202908d778SJames Bottomley SAS_TASK_COMPLETE, 4212908d778SJames Bottomley SAS_TASK_UNDELIVERED = -1, 4222908d778SJames Bottomley }; 4232908d778SJames Bottomley 4242908d778SJames Bottomley enum exec_status { 4252908d778SJames Bottomley SAM_GOOD = 0, 4262908d778SJames Bottomley SAM_CHECK_COND = 2, 4272908d778SJames Bottomley SAM_COND_MET = 4, 4282908d778SJames Bottomley SAM_BUSY = 8, 4292908d778SJames Bottomley SAM_INTERMEDIATE = 0x10, 4302908d778SJames Bottomley SAM_IM_COND_MET = 0x12, 4312908d778SJames Bottomley SAM_RESV_CONFLICT= 0x14, 4322908d778SJames Bottomley SAM_TASK_SET_FULL= 0x28, 4332908d778SJames Bottomley SAM_ACA_ACTIVE = 0x30, 4342908d778SJames Bottomley SAM_TASK_ABORTED = 0x40, 4352908d778SJames Bottomley 4362908d778SJames Bottomley SAS_DEV_NO_RESPONSE = 0x80, 4372908d778SJames Bottomley SAS_DATA_UNDERRUN, 4382908d778SJames Bottomley SAS_DATA_OVERRUN, 4392908d778SJames Bottomley SAS_INTERRUPTED, 4402908d778SJames Bottomley SAS_QUEUE_FULL, 4412908d778SJames Bottomley SAS_DEVICE_UNKNOWN, 4422908d778SJames Bottomley SAS_SG_ERR, 4432908d778SJames Bottomley SAS_OPEN_REJECT, 4442908d778SJames Bottomley SAS_OPEN_TO, 4452908d778SJames Bottomley SAS_PROTO_RESPONSE, 4462908d778SJames Bottomley SAS_PHY_DOWN, 4472908d778SJames Bottomley SAS_NAK_R_ERR, 4482908d778SJames Bottomley SAS_PENDING, 4492908d778SJames Bottomley SAS_ABORTED_TASK, 4502908d778SJames Bottomley }; 4512908d778SJames Bottomley 4522908d778SJames Bottomley /* When a task finishes with a response, the LLDD examines the 4532908d778SJames Bottomley * response: 4542908d778SJames Bottomley * - For an ATA task task_status_struct::stat is set to 4552908d778SJames Bottomley * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the 4562908d778SJames Bottomley * contents of struct ata_task_resp. 4572908d778SJames Bottomley * - For SSP tasks, if no data is present or status/TMF response 4582908d778SJames Bottomley * is valid, task_status_struct::stat is set. If data is present 4592908d778SJames Bottomley * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets 4602908d778SJames Bottomley * task_status_struct::buf_valid_size, and task_status_struct::stat is 4612908d778SJames Bottomley * set to SAM_CHECK_COND. 4622908d778SJames Bottomley * 4632908d778SJames Bottomley * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp 4642908d778SJames Bottomley * for ATA task. 4652908d778SJames Bottomley * 4662908d778SJames Bottomley * "frame_len" is the total frame length, which could be more or less 4672908d778SJames Bottomley * than actually copied. 4682908d778SJames Bottomley * 4692908d778SJames Bottomley * Tasks ending with response, always set the residual field. 4702908d778SJames Bottomley */ 4712908d778SJames Bottomley struct ata_task_resp { 4722908d778SJames Bottomley u16 frame_len; 4732908d778SJames Bottomley u8 ending_fis[24]; /* dev to host or data-in */ 4742908d778SJames Bottomley u32 sstatus; 4752908d778SJames Bottomley u32 serror; 4762908d778SJames Bottomley u32 scontrol; 4772908d778SJames Bottomley u32 sactive; 4782908d778SJames Bottomley }; 4792908d778SJames Bottomley 4802908d778SJames Bottomley #define SAS_STATUS_BUF_SIZE 96 4812908d778SJames Bottomley 4822908d778SJames Bottomley struct task_status_struct { 4832908d778SJames Bottomley enum service_response resp; 4842908d778SJames Bottomley enum exec_status stat; 4852908d778SJames Bottomley int buf_valid_size; 4862908d778SJames Bottomley 4872908d778SJames Bottomley u8 buf[SAS_STATUS_BUF_SIZE]; 4882908d778SJames Bottomley 4892908d778SJames Bottomley u32 residual; 4902908d778SJames Bottomley enum sas_open_rej_reason open_rej_reason; 4912908d778SJames Bottomley }; 4922908d778SJames Bottomley 4932908d778SJames Bottomley /* ATA and ATAPI task queuable to a SAS LLDD. 4942908d778SJames Bottomley */ 4952908d778SJames Bottomley struct sas_ata_task { 4962908d778SJames Bottomley struct host_to_dev_fis fis; 4972908d778SJames Bottomley u8 atapi_packet[16]; /* 0 if not ATAPI task */ 4982908d778SJames Bottomley 4992908d778SJames Bottomley u8 retry_count; /* hardware retry, should be > 0 */ 5002908d778SJames Bottomley 5012908d778SJames Bottomley u8 dma_xfer:1; /* PIO:0 or DMA:1 */ 5022908d778SJames Bottomley u8 use_ncq:1; 5032908d778SJames Bottomley u8 set_affil_pol:1; 5042908d778SJames Bottomley u8 stp_affil_pol:1; 5052908d778SJames Bottomley 5062908d778SJames Bottomley u8 device_control_reg_update:1; 5072908d778SJames Bottomley }; 5082908d778SJames Bottomley 5092908d778SJames Bottomley struct sas_smp_task { 5102908d778SJames Bottomley struct scatterlist smp_req; 5112908d778SJames Bottomley struct scatterlist smp_resp; 5122908d778SJames Bottomley }; 5132908d778SJames Bottomley 5142908d778SJames Bottomley enum task_attribute { 5152908d778SJames Bottomley TASK_ATTR_SIMPLE = 0, 5162908d778SJames Bottomley TASK_ATTR_HOQ = 1, 5172908d778SJames Bottomley TASK_ATTR_ORDERED= 2, 5182908d778SJames Bottomley TASK_ATTR_ACA = 4, 5192908d778SJames Bottomley }; 5202908d778SJames Bottomley 5212908d778SJames Bottomley struct sas_ssp_task { 5222908d778SJames Bottomley u8 retry_count; /* hardware retry, should be > 0 */ 5232908d778SJames Bottomley 5242908d778SJames Bottomley u8 LUN[8]; 5252908d778SJames Bottomley u8 enable_first_burst:1; 5262908d778SJames Bottomley enum task_attribute task_attr; 5272908d778SJames Bottomley u8 task_prio; 5282908d778SJames Bottomley u8 cdb[16]; 5292908d778SJames Bottomley }; 5302908d778SJames Bottomley 5312908d778SJames Bottomley struct sas_task { 5322908d778SJames Bottomley struct domain_device *dev; 5332908d778SJames Bottomley struct list_head list; 5342908d778SJames Bottomley 5352908d778SJames Bottomley spinlock_t task_state_lock; 5362908d778SJames Bottomley unsigned task_state_flags; 5372908d778SJames Bottomley 5385929faf3SDarrick J. Wong enum sas_protocol task_proto; 5392908d778SJames Bottomley 5402908d778SJames Bottomley /* Used by the discovery code. */ 5412908d778SJames Bottomley struct timer_list timer; 5422908d778SJames Bottomley struct completion completion; 5432908d778SJames Bottomley 5442908d778SJames Bottomley union { 5452908d778SJames Bottomley struct sas_ata_task ata_task; 5462908d778SJames Bottomley struct sas_smp_task smp_task; 5472908d778SJames Bottomley struct sas_ssp_task ssp_task; 5482908d778SJames Bottomley }; 5492908d778SJames Bottomley 5502908d778SJames Bottomley struct scatterlist *scatter; 5512908d778SJames Bottomley int num_scatter; 5522908d778SJames Bottomley u32 total_xfer_len; 5532908d778SJames Bottomley u8 data_dir:2; /* Use PCI_DMA_... */ 5542908d778SJames Bottomley 5552908d778SJames Bottomley struct task_status_struct task_status; 5562908d778SJames Bottomley void (*task_done)(struct sas_task *); 5572908d778SJames Bottomley 5582908d778SJames Bottomley void *lldd_task; /* for use by LLDDs */ 5592908d778SJames Bottomley void *uldd_task; 56079a5eb60SDarrick J. Wong 56179a5eb60SDarrick J. Wong struct work_struct abort_work; 5622908d778SJames Bottomley }; 5632908d778SJames Bottomley 5648ee24023SDarrick J. Wong extern struct kmem_cache *sas_task_cache; 5652908d778SJames Bottomley 5662908d778SJames Bottomley #define SAS_TASK_STATE_PENDING 1 5672908d778SJames Bottomley #define SAS_TASK_STATE_DONE 2 5682908d778SJames Bottomley #define SAS_TASK_STATE_ABORTED 4 5693ebf6922SDarrick J. Wong #define SAS_TASK_NEED_DEV_RESET 8 570b218a0d8SDarrick J. Wong #define SAS_TASK_AT_INITIATOR 16 5712908d778SJames Bottomley 5723cc27547SAl Viro static inline struct sas_task *sas_alloc_task(gfp_t flags) 5732908d778SJames Bottomley { 574c3762229SRobert P. J. Day struct sas_task *task = kmem_cache_zalloc(sas_task_cache, flags); 5752908d778SJames Bottomley 5762908d778SJames Bottomley if (task) { 5772908d778SJames Bottomley INIT_LIST_HEAD(&task->list); 5782908d778SJames Bottomley spin_lock_init(&task->task_state_lock); 5792908d778SJames Bottomley task->task_state_flags = SAS_TASK_STATE_PENDING; 5802908d778SJames Bottomley init_timer(&task->timer); 5812908d778SJames Bottomley init_completion(&task->completion); 5822908d778SJames Bottomley } 5832908d778SJames Bottomley 5842908d778SJames Bottomley return task; 5852908d778SJames Bottomley } 5862908d778SJames Bottomley 5872908d778SJames Bottomley static inline void sas_free_task(struct sas_task *task) 5882908d778SJames Bottomley { 5892908d778SJames Bottomley if (task) { 5902908d778SJames Bottomley BUG_ON(!list_empty(&task->list)); 5912908d778SJames Bottomley kmem_cache_free(sas_task_cache, task); 5922908d778SJames Bottomley } 5932908d778SJames Bottomley } 5942908d778SJames Bottomley 5952908d778SJames Bottomley struct sas_domain_function_template { 5962908d778SJames Bottomley /* The class calls these to notify the LLDD of an event. */ 5972908d778SJames Bottomley void (*lldd_port_formed)(struct asd_sas_phy *); 5982908d778SJames Bottomley void (*lldd_port_deformed)(struct asd_sas_phy *); 5992908d778SJames Bottomley 6002908d778SJames Bottomley /* The class calls these when a device is found or gone. */ 6012908d778SJames Bottomley int (*lldd_dev_found)(struct domain_device *); 6022908d778SJames Bottomley void (*lldd_dev_gone)(struct domain_device *); 6032908d778SJames Bottomley 6042908d778SJames Bottomley int (*lldd_execute_task)(struct sas_task *, int num, 6053cc27547SAl Viro gfp_t gfp_flags); 6062908d778SJames Bottomley 6072908d778SJames Bottomley /* Task Management Functions. Must be called from process context. */ 6082908d778SJames Bottomley int (*lldd_abort_task)(struct sas_task *); 6092908d778SJames Bottomley int (*lldd_abort_task_set)(struct domain_device *, u8 *lun); 6102908d778SJames Bottomley int (*lldd_clear_aca)(struct domain_device *, u8 *lun); 6112908d778SJames Bottomley int (*lldd_clear_task_set)(struct domain_device *, u8 *lun); 6122908d778SJames Bottomley int (*lldd_I_T_nexus_reset)(struct domain_device *); 6132908d778SJames Bottomley int (*lldd_lu_reset)(struct domain_device *, u8 *lun); 6142908d778SJames Bottomley int (*lldd_query_task)(struct sas_task *); 6152908d778SJames Bottomley 6162908d778SJames Bottomley /* Port and Adapter management */ 6172908d778SJames Bottomley int (*lldd_clear_nexus_port)(struct asd_sas_port *); 6182908d778SJames Bottomley int (*lldd_clear_nexus_ha)(struct sas_ha_struct *); 6192908d778SJames Bottomley 6202908d778SJames Bottomley /* Phy management */ 621a01e70e5SJames Bottomley int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *); 6222908d778SJames Bottomley }; 6232908d778SJames Bottomley 6242908d778SJames Bottomley extern int sas_register_ha(struct sas_ha_struct *); 6252908d778SJames Bottomley extern int sas_unregister_ha(struct sas_ha_struct *); 6262908d778SJames Bottomley 627acbf167dSDarrick J. Wong int sas_set_phy_speed(struct sas_phy *phy, 628acbf167dSDarrick J. Wong struct sas_phy_linkrates *rates); 629acbf167dSDarrick J. Wong int sas_phy_enable(struct sas_phy *phy, int enabled); 630dea22214SDarrick J. Wong int sas_phy_reset(struct sas_phy *phy, int hard_reset); 631338ec570SDarrick J. Wong int sas_queue_up(struct sas_task *task); 6322908d778SJames Bottomley extern int sas_queuecommand(struct scsi_cmnd *, 6332908d778SJames Bottomley void (*scsi_done)(struct scsi_cmnd *)); 6342908d778SJames Bottomley extern int sas_target_alloc(struct scsi_target *); 6352908d778SJames Bottomley extern int sas_slave_alloc(struct scsi_device *); 6362908d778SJames Bottomley extern int sas_slave_configure(struct scsi_device *); 6372908d778SJames Bottomley extern void sas_slave_destroy(struct scsi_device *); 6382908d778SJames Bottomley extern int sas_change_queue_depth(struct scsi_device *, int new_depth); 6392908d778SJames Bottomley extern int sas_change_queue_type(struct scsi_device *, int qt); 6402908d778SJames Bottomley extern int sas_bios_param(struct scsi_device *, 6412908d778SJames Bottomley struct block_device *, 6422908d778SJames Bottomley sector_t capacity, int *hsc); 6432908d778SJames Bottomley extern struct scsi_transport_template * 6442908d778SJames Bottomley sas_domain_attach_transport(struct sas_domain_function_template *); 6452908d778SJames Bottomley extern void sas_domain_release_transport(struct scsi_transport_template *); 6462908d778SJames Bottomley 6472908d778SJames Bottomley int sas_discover_root_expander(struct domain_device *); 6482908d778SJames Bottomley 6492908d778SJames Bottomley void sas_init_ex_attr(void); 6502908d778SJames Bottomley 6512908d778SJames Bottomley int sas_ex_revalidate_domain(struct domain_device *); 6522908d778SJames Bottomley 6532908d778SJames Bottomley void sas_unregister_domain_devices(struct asd_sas_port *port); 6542908d778SJames Bottomley void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *); 6552908d778SJames Bottomley int sas_discover_event(struct asd_sas_port *, enum discover_event ev); 6562908d778SJames Bottomley 6572908d778SJames Bottomley int sas_discover_sata(struct domain_device *); 6582908d778SJames Bottomley int sas_discover_end_dev(struct domain_device *); 6592908d778SJames Bottomley 6602908d778SJames Bottomley void sas_unregister_dev(struct domain_device *); 6612908d778SJames Bottomley 6622908d778SJames Bottomley void sas_init_dev(struct domain_device *); 6632908d778SJames Bottomley 664396819fbSDarrick J. Wong void sas_task_abort(struct sas_task *); 665396819fbSDarrick J. Wong int __sas_task_abort(struct sas_task *); 666ad689233SDarrick J. Wong int sas_eh_device_reset_handler(struct scsi_cmnd *cmd); 667a9344e68SDarrick J. Wong int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd); 66879a5eb60SDarrick J. Wong 669fa1c1e8fSDarrick J. Wong extern void sas_target_destroy(struct scsi_target *); 670fa1c1e8fSDarrick J. Wong extern int sas_slave_alloc(struct scsi_device *); 671fa1c1e8fSDarrick J. Wong extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg); 672fa1c1e8fSDarrick J. Wong 673ba1fc175SFUJITA Tomonori extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy, 674ba1fc175SFUJITA Tomonori struct request *req); 675366ca51fSJames Bottomley 676366ca51fSJames Bottomley extern void sas_ssp_task_response(struct device *dev, struct sas_task *task, 677366ca51fSJames Bottomley struct ssp_response_iu *iu); 6785319578cSJames Bottomley struct sas_phy *sas_find_local_phy(struct domain_device *dev); 679366ca51fSJames Bottomley 68045e6cdf4SDarrick J. Wong int sas_request_addr(struct Scsi_Host *shost, u8 *addr); 68145e6cdf4SDarrick J. Wong 6822908d778SJames Bottomley #endif /* _SASLIB_H_ */ 683