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 <scsi/scsi_device.h> 362908d778SJames Bottomley #include <scsi/scsi_cmnd.h> 372908d778SJames Bottomley #include <scsi/scsi_transport_sas.h> 3887ae9afdSAdrian Bunk #include <linux/scatterlist.h> 395a0e3ad6STejun Heo #include <linux/slab.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, 8987c8331fSDan Williams DISCE_PROBE = 3, 9087c8331fSDan Williams DISCE_DESTRUCT = 4, 9187c8331fSDan Williams DISC_NUM_EVENTS = 5, 922908d778SJames Bottomley }; 932908d778SJames Bottomley 942908d778SJames Bottomley /* ---------- Expander Devices ---------- */ 952908d778SJames Bottomley 962908d778SJames Bottomley #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj) 972908d778SJames Bottomley #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\ 982908d778SJames Bottomley attr) 992908d778SJames Bottomley 1002908d778SJames Bottomley enum routing_attribute { 1012908d778SJames Bottomley DIRECT_ROUTING, 1022908d778SJames Bottomley SUBTRACTIVE_ROUTING, 1032908d778SJames Bottomley TABLE_ROUTING, 1042908d778SJames Bottomley }; 1052908d778SJames Bottomley 1062908d778SJames Bottomley enum ex_phy_state { 1072908d778SJames Bottomley PHY_EMPTY, 1082908d778SJames Bottomley PHY_VACANT, 1092908d778SJames Bottomley PHY_NOT_PRESENT, 1102908d778SJames Bottomley PHY_DEVICE_DISCOVERED 1112908d778SJames Bottomley }; 1122908d778SJames Bottomley 1132908d778SJames Bottomley struct ex_phy { 1142908d778SJames Bottomley int phy_id; 1152908d778SJames Bottomley 1162908d778SJames Bottomley enum ex_phy_state phy_state; 1172908d778SJames Bottomley 1182908d778SJames Bottomley enum sas_dev_type attached_dev_type; 11988edf746SJames Bottomley enum sas_linkrate linkrate; 1202908d778SJames Bottomley 1212908d778SJames Bottomley u8 attached_sata_host:1; 1222908d778SJames Bottomley u8 attached_sata_dev:1; 1232908d778SJames Bottomley u8 attached_sata_ps:1; 1242908d778SJames Bottomley 1255929faf3SDarrick J. Wong enum sas_protocol attached_tproto; 1265929faf3SDarrick J. Wong enum sas_protocol attached_iproto; 1272908d778SJames Bottomley 1282908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; 1292908d778SJames Bottomley u8 attached_phy_id; 1302908d778SJames Bottomley 1312908d778SJames Bottomley u8 phy_change_count; 1322908d778SJames Bottomley enum routing_attribute routing_attr; 1332908d778SJames Bottomley u8 virtual:1; 1342908d778SJames Bottomley 1352908d778SJames Bottomley int last_da_index; 1362908d778SJames Bottomley 1372908d778SJames Bottomley struct sas_phy *phy; 1382908d778SJames Bottomley struct sas_port *port; 1392908d778SJames Bottomley }; 1402908d778SJames Bottomley 1412908d778SJames Bottomley struct expander_device { 1422908d778SJames Bottomley struct list_head children; 1432908d778SJames Bottomley 1442908d778SJames Bottomley u16 ex_change_count; 1452908d778SJames Bottomley u16 max_route_indexes; 1462908d778SJames Bottomley u8 num_phys; 147ffaac8f4SLuben Tuikov 148ffaac8f4SLuben Tuikov u8 t2t_supp:1; 1492908d778SJames Bottomley u8 configuring:1; 1502908d778SJames Bottomley u8 conf_route_table:1; 151ffaac8f4SLuben Tuikov 1522908d778SJames Bottomley u8 enclosure_logical_id[8]; 1532908d778SJames Bottomley 1542908d778SJames Bottomley struct ex_phy *ex_phy; 1552908d778SJames Bottomley struct sas_port *parent_port; 15689d3cf6aSJeff Skirvin 15789d3cf6aSJeff Skirvin struct mutex cmd_mutex; 1582908d778SJames Bottomley }; 1592908d778SJames Bottomley 1602908d778SJames Bottomley /* ---------- SATA device ---------- */ 1612908d778SJames Bottomley enum ata_command_set { 1622908d778SJames Bottomley ATA_COMMAND_SET = 0, 1632908d778SJames Bottomley ATAPI_COMMAND_SET = 1, 1642908d778SJames Bottomley }; 1652908d778SJames Bottomley 1662908d778SJames Bottomley struct sata_device { 1672908d778SJames Bottomley enum ata_command_set command_set; 1682908d778SJames Bottomley struct smp_resp rps_resp; /* report_phy_sata_resp */ 1692908d778SJames Bottomley u8 port_no; /* port number, if this is a PM (Port) */ 1702908d778SJames Bottomley struct list_head children; /* PM Ports if this is a PM */ 171fa1c1e8fSDarrick J. Wong 172fa1c1e8fSDarrick J. Wong struct ata_port *ap; 173fa1c1e8fSDarrick J. Wong struct ata_host ata_host; 174fa1c1e8fSDarrick J. Wong struct ata_taskfile tf; 1752908d778SJames Bottomley }; 1762908d778SJames Bottomley 177e139942dSDan Williams enum { 178e139942dSDan Williams SAS_DEV_GONE, 17987c8331fSDan Williams SAS_DEV_DESTROY, 180e139942dSDan Williams }; 181e139942dSDan Williams 1822908d778SJames Bottomley struct domain_device { 1839095a64aSDan Williams spinlock_t done_lock; 1842908d778SJames Bottomley enum sas_dev_type dev_type; 1852908d778SJames Bottomley 18688edf746SJames Bottomley enum sas_linkrate linkrate; 18788edf746SJames Bottomley enum sas_linkrate min_linkrate; 18888edf746SJames Bottomley enum sas_linkrate max_linkrate; 1892908d778SJames Bottomley 1902908d778SJames Bottomley int pathways; 1912908d778SJames Bottomley 1922908d778SJames Bottomley struct domain_device *parent; 1932908d778SJames Bottomley struct list_head siblings; /* devices on the same level */ 1942908d778SJames Bottomley struct asd_sas_port *port; /* shortcut to root of the tree */ 195f41a0c44SDan Williams struct sas_phy *phy; 1962908d778SJames Bottomley 1972908d778SJames Bottomley struct list_head dev_list_node; 19887c8331fSDan Williams struct list_head disco_list_node; /* awaiting probe or destruct */ 1992908d778SJames Bottomley 2005929faf3SDarrick J. Wong enum sas_protocol iproto; 2015929faf3SDarrick J. Wong enum sas_protocol tproto; 2022908d778SJames Bottomley 2032908d778SJames Bottomley struct sas_rphy *rphy; 2042908d778SJames Bottomley 2052908d778SJames Bottomley u8 sas_addr[SAS_ADDR_SIZE]; 2062908d778SJames Bottomley u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 2072908d778SJames Bottomley 2082908d778SJames Bottomley u8 frame_rcvd[32]; 2092908d778SJames Bottomley 2102908d778SJames Bottomley union { 2112908d778SJames Bottomley struct expander_device ex_dev; 2122908d778SJames Bottomley struct sata_device sata_dev; /* STP & directly attached */ 2132908d778SJames Bottomley }; 2142908d778SJames Bottomley 2152908d778SJames Bottomley void *lldd_dev; 216e139942dSDan Williams unsigned long state; 217735f7d2fSDan Williams struct kref kref; 2182908d778SJames Bottomley }; 2192908d778SJames Bottomley 220c4028958SDavid Howells struct sas_discovery_event { 221c4028958SDavid Howells struct work_struct work; 222c4028958SDavid Howells struct asd_sas_port *port; 223c4028958SDavid Howells }; 224c4028958SDavid Howells 2252908d778SJames Bottomley struct sas_discovery { 226c4028958SDavid Howells struct sas_discovery_event disc_work[DISC_NUM_EVENTS]; 2272908d778SJames Bottomley unsigned long pending; 2282908d778SJames Bottomley u8 fanout_sas_addr[8]; 2292908d778SJames Bottomley u8 eeds_a[8]; 2302908d778SJames Bottomley u8 eeds_b[8]; 2312908d778SJames Bottomley int max_level; 2322908d778SJames Bottomley }; 2332908d778SJames Bottomley 2342908d778SJames Bottomley /* The port struct is Class:RW, driver:RO */ 2352908d778SJames Bottomley struct asd_sas_port { 2362908d778SJames Bottomley /* private: */ 2372908d778SJames Bottomley struct completion port_gone_completion; 2382908d778SJames Bottomley 2392908d778SJames Bottomley struct sas_discovery disc; 2402908d778SJames Bottomley struct domain_device *port_dev; 2412908d778SJames Bottomley spinlock_t dev_list_lock; 2422908d778SJames Bottomley struct list_head dev_list; 24387c8331fSDan Williams struct list_head disco_list; 24487c8331fSDan Williams struct list_head destroy_list; 24588edf746SJames Bottomley enum sas_linkrate linkrate; 2462908d778SJames Bottomley 2472908d778SJames Bottomley struct work_struct work; 2482908d778SJames Bottomley 2492908d778SJames Bottomley /* public: */ 2502908d778SJames Bottomley int id; 2512908d778SJames Bottomley 2522908d778SJames Bottomley enum sas_class class; 2532908d778SJames Bottomley u8 sas_addr[SAS_ADDR_SIZE]; 2542908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; 2555929faf3SDarrick J. Wong enum sas_protocol iproto; 2565929faf3SDarrick J. Wong enum sas_protocol tproto; 2572908d778SJames Bottomley 2582908d778SJames Bottomley enum sas_oob_mode oob_mode; 2592908d778SJames Bottomley 2602908d778SJames Bottomley spinlock_t phy_list_lock; 2612908d778SJames Bottomley struct list_head phy_list; 2622908d778SJames Bottomley int num_phys; 2632908d778SJames Bottomley u32 phy_mask; 2642908d778SJames Bottomley 2652908d778SJames Bottomley struct sas_ha_struct *ha; 2662908d778SJames Bottomley 2672908d778SJames Bottomley struct sas_port *port; 2682908d778SJames Bottomley 2692908d778SJames Bottomley void *lldd_port; /* not touched by the sas class code */ 2702908d778SJames Bottomley }; 2712908d778SJames Bottomley 272c4028958SDavid Howells struct asd_sas_event { 273c4028958SDavid Howells struct work_struct work; 274c4028958SDavid Howells struct asd_sas_phy *phy; 275c4028958SDavid Howells }; 276c4028958SDavid Howells 2772908d778SJames Bottomley /* The phy pretty much is controlled by the LLDD. 2782908d778SJames Bottomley * The class only reads those fields. 2792908d778SJames Bottomley */ 2802908d778SJames Bottomley struct asd_sas_phy { 2812908d778SJames Bottomley /* private: */ 282c4028958SDavid Howells struct asd_sas_event port_events[PORT_NUM_EVENTS]; 283c4028958SDavid Howells struct asd_sas_event phy_events[PHY_NUM_EVENTS]; 2842908d778SJames Bottomley 2852908d778SJames Bottomley unsigned long port_events_pending; 2862908d778SJames Bottomley unsigned long phy_events_pending; 2872908d778SJames Bottomley 2882908d778SJames Bottomley int error; 2892908d778SJames Bottomley 2902908d778SJames Bottomley struct sas_phy *phy; 2912908d778SJames Bottomley 2922908d778SJames Bottomley /* public: */ 2932908d778SJames Bottomley /* The following are class:RO, driver:R/W */ 2942908d778SJames Bottomley int enabled; /* must be set */ 2952908d778SJames Bottomley 2962908d778SJames Bottomley int id; /* must be set */ 2972908d778SJames Bottomley enum sas_class class; 2985929faf3SDarrick J. Wong enum sas_protocol iproto; 2995929faf3SDarrick J. Wong enum sas_protocol tproto; 3002908d778SJames Bottomley 3012908d778SJames Bottomley enum sas_phy_type type; 3022908d778SJames Bottomley enum sas_phy_role role; 3032908d778SJames Bottomley enum sas_oob_mode oob_mode; 30488edf746SJames Bottomley enum sas_linkrate linkrate; 3052908d778SJames Bottomley 3062908d778SJames Bottomley u8 *sas_addr; /* must be set */ 3072908d778SJames Bottomley u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */ 3082908d778SJames Bottomley 3092908d778SJames Bottomley spinlock_t frame_rcvd_lock; 3102908d778SJames Bottomley u8 *frame_rcvd; /* must be set */ 3112908d778SJames Bottomley int frame_rcvd_size; 3122908d778SJames Bottomley 3132908d778SJames Bottomley spinlock_t sas_prim_lock; 3142908d778SJames Bottomley u32 sas_prim; 3152908d778SJames Bottomley 3162908d778SJames Bottomley struct list_head port_phy_el; /* driver:RO */ 3172908d778SJames Bottomley struct asd_sas_port *port; /* Class:RW, driver: RO */ 3182908d778SJames Bottomley 3192908d778SJames Bottomley struct sas_ha_struct *ha; /* may be set; the class sets it anyway */ 3202908d778SJames Bottomley 3212908d778SJames Bottomley void *lldd_phy; /* not touched by the sas_class_code */ 3222908d778SJames Bottomley }; 3232908d778SJames Bottomley 3242908d778SJames Bottomley struct scsi_core { 3252908d778SJames Bottomley struct Scsi_Host *shost; 3262908d778SJames Bottomley 3279095a64aSDan Williams struct mutex task_queue_flush; 3282908d778SJames Bottomley spinlock_t task_queue_lock; 3292908d778SJames Bottomley struct list_head task_queue; 3302908d778SJames Bottomley int task_queue_size; 3312908d778SJames Bottomley 332d7a54e30SChristoph Hellwig struct task_struct *queue_thread; 3332908d778SJames Bottomley }; 3342908d778SJames Bottomley 335c4028958SDavid Howells struct sas_ha_event { 336c4028958SDavid Howells struct work_struct work; 337c4028958SDavid Howells struct sas_ha_struct *ha; 338c4028958SDavid Howells }; 339c4028958SDavid Howells 3406b0efb85SDarrick J. Wong enum sas_ha_state { 3416b0efb85SDarrick J. Wong SAS_HA_REGISTERED, 342b1124cd3SDan Williams SAS_HA_DRAINING, 34387c8331fSDan Williams SAS_HA_ATA_EH_ACTIVE, 3449095a64aSDan Williams SAS_HA_FROZEN, 3456b0efb85SDarrick J. Wong }; 3466b0efb85SDarrick J. Wong 3472908d778SJames Bottomley struct sas_ha_struct { 3482908d778SJames Bottomley /* private: */ 349c4028958SDavid Howells struct sas_ha_event ha_events[HA_NUM_EVENTS]; 3502908d778SJames Bottomley unsigned long pending; 3512908d778SJames Bottomley 352b1124cd3SDan Williams struct list_head defer_q; /* work queued while draining */ 353b1124cd3SDan Williams struct mutex drain_mutex; 354f8daa6e6SDan Williams unsigned long state; 3556b0efb85SDarrick J. Wong spinlock_t state_lock; 3566b0efb85SDarrick J. Wong 35787c8331fSDan Williams struct mutex disco_mutex; 35887c8331fSDan Williams 3592908d778SJames Bottomley struct scsi_core core; 3602908d778SJames Bottomley 3612908d778SJames Bottomley /* public: */ 3622908d778SJames Bottomley char *sas_ha_name; 3631d1bbee6SJeff Garzik struct device *dev; /* should be set */ 3642908d778SJames Bottomley struct module *lldd_module; /* should be set */ 3652908d778SJames Bottomley 3662908d778SJames Bottomley u8 *sas_addr; /* must be set */ 3672908d778SJames Bottomley u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE]; 3682908d778SJames Bottomley 3692908d778SJames Bottomley spinlock_t phy_port_lock; 3702908d778SJames Bottomley struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */ 3712908d778SJames Bottomley struct asd_sas_port **sas_port; /* array of valid pointers, must be set */ 3722908d778SJames Bottomley int num_phys; /* must be set, gt 0, static */ 3732908d778SJames Bottomley 3742908d778SJames Bottomley /* The class calls this to send a task for execution. */ 3752908d778SJames Bottomley int lldd_max_execute_num; 3762908d778SJames Bottomley int lldd_queue_size; 37700f0254eSDan Williams int strict_wide_ports; /* both sas_addr and attached_sas_addr must match 37800f0254eSDan Williams * their siblings when forming wide ports */ 3792908d778SJames Bottomley 3802908d778SJames Bottomley /* LLDD calls these to notify the class of an event. */ 3812908d778SJames Bottomley void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event); 3822908d778SJames Bottomley void (*notify_port_event)(struct asd_sas_phy *, enum port_event); 3832908d778SJames Bottomley void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event); 3842908d778SJames Bottomley 3852908d778SJames Bottomley void *lldd_ha; /* not touched by sas class code */ 386f456393eSDarrick J. Wong 3873944f509SDan Williams struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */ 3883944f509SDan Williams struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */ 3892908d778SJames Bottomley }; 3902908d778SJames Bottomley 3912908d778SJames Bottomley #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata) 3922908d778SJames Bottomley 3932908d778SJames Bottomley static inline struct domain_device * 3942908d778SJames Bottomley starget_to_domain_dev(struct scsi_target *starget) { 3952908d778SJames Bottomley return starget->hostdata; 3962908d778SJames Bottomley } 3972908d778SJames Bottomley 3982908d778SJames Bottomley static inline struct domain_device * 3992908d778SJames Bottomley sdev_to_domain_dev(struct scsi_device *sdev) { 4002908d778SJames Bottomley return starget_to_domain_dev(sdev->sdev_target); 4012908d778SJames Bottomley } 4022908d778SJames Bottomley 403b50102d3SDan Williams static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev) 404b50102d3SDan Williams { 405b50102d3SDan Williams return &dev->sata_dev.ap->link.device[0]; 406b50102d3SDan Williams } 407b50102d3SDan Williams 4082908d778SJames Bottomley static inline struct domain_device * 4092908d778SJames Bottomley cmd_to_domain_dev(struct scsi_cmnd *cmd) 4102908d778SJames Bottomley { 4112908d778SJames Bottomley return sdev_to_domain_dev(cmd->device); 4122908d778SJames Bottomley } 4132908d778SJames Bottomley 4142908d778SJames Bottomley void sas_hash_addr(u8 *hashed, const u8 *sas_addr); 4152908d778SJames Bottomley 4162908d778SJames Bottomley /* Before calling a notify event, LLDD should use this function 4172908d778SJames Bottomley * when the link is severed (possibly from its tasklet). 4182908d778SJames Bottomley * The idea is that the Class only reads those, while the LLDD, 4192908d778SJames Bottomley * can R/W these (thus avoiding a race). 4202908d778SJames Bottomley */ 4212908d778SJames Bottomley static inline void sas_phy_disconnected(struct asd_sas_phy *phy) 4222908d778SJames Bottomley { 4232908d778SJames Bottomley phy->oob_mode = OOB_NOT_CONNECTED; 42488edf746SJames Bottomley phy->linkrate = SAS_LINK_RATE_UNKNOWN; 4252908d778SJames Bottomley } 4262908d778SJames Bottomley 4278ec6552fSDan Williams static inline unsigned int to_sas_gpio_od(int device, int bit) 4288ec6552fSDan Williams { 4298ec6552fSDan Williams return 3 * device + bit; 4308ec6552fSDan Williams } 4318ec6552fSDan Williams 432f41a0c44SDan Williams static inline void sas_put_local_phy(struct sas_phy *phy) 433f41a0c44SDan Williams { 434f41a0c44SDan Williams put_device(&phy->dev); 435f41a0c44SDan Williams } 436f41a0c44SDan Williams 437d962480eSDan Williams #ifdef CONFIG_SCSI_SAS_HOST_SMP 4388ec6552fSDan Williams int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count); 439d962480eSDan Williams #else 440d962480eSDan Williams static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count) 441d962480eSDan Williams { 442d962480eSDan Williams return -1; 443d962480eSDan Williams } 444d962480eSDan Williams #endif 4458ec6552fSDan Williams 4462908d778SJames Bottomley /* ---------- Tasks ---------- */ 4472908d778SJames Bottomley /* 4482908d778SJames Bottomley service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED | 4492908d778SJames Bottomley exec_status | | | 4502908d778SJames Bottomley ---------------------+---------------------+-----------------------+ 4512908d778SJames Bottomley SAM_... | X | | 4522908d778SJames Bottomley DEV_NO_RESPONSE | X | X | 4532908d778SJames Bottomley INTERRUPTED | X | | 4542908d778SJames Bottomley QUEUE_FULL | | X | 4552908d778SJames Bottomley DEVICE_UNKNOWN | | X | 4562908d778SJames Bottomley SG_ERR | | X | 4572908d778SJames Bottomley ---------------------+---------------------+-----------------------+ 4582908d778SJames Bottomley */ 4592908d778SJames Bottomley 4602908d778SJames Bottomley enum service_response { 4612908d778SJames Bottomley SAS_TASK_COMPLETE, 4622908d778SJames Bottomley SAS_TASK_UNDELIVERED = -1, 4632908d778SJames Bottomley }; 4642908d778SJames Bottomley 4652908d778SJames Bottomley enum exec_status { 466a3a14252SDan Williams /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of 467a3a14252SDan Williams * them here to silence 'case value not in enumerated type' warnings 468a3a14252SDan Williams */ 469a3a14252SDan Williams __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION, 4702908d778SJames Bottomley 4712908d778SJames Bottomley SAS_DEV_NO_RESPONSE = 0x80, 4722908d778SJames Bottomley SAS_DATA_UNDERRUN, 4732908d778SJames Bottomley SAS_DATA_OVERRUN, 4742908d778SJames Bottomley SAS_INTERRUPTED, 4752908d778SJames Bottomley SAS_QUEUE_FULL, 4762908d778SJames Bottomley SAS_DEVICE_UNKNOWN, 4772908d778SJames Bottomley SAS_SG_ERR, 4782908d778SJames Bottomley SAS_OPEN_REJECT, 4792908d778SJames Bottomley SAS_OPEN_TO, 4802908d778SJames Bottomley SAS_PROTO_RESPONSE, 4812908d778SJames Bottomley SAS_PHY_DOWN, 4822908d778SJames Bottomley SAS_NAK_R_ERR, 4832908d778SJames Bottomley SAS_PENDING, 4842908d778SJames Bottomley SAS_ABORTED_TASK, 4852908d778SJames Bottomley }; 4862908d778SJames Bottomley 4872908d778SJames Bottomley /* When a task finishes with a response, the LLDD examines the 4882908d778SJames Bottomley * response: 4892908d778SJames Bottomley * - For an ATA task task_status_struct::stat is set to 4902908d778SJames Bottomley * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the 4912908d778SJames Bottomley * contents of struct ata_task_resp. 4922908d778SJames Bottomley * - For SSP tasks, if no data is present or status/TMF response 4932908d778SJames Bottomley * is valid, task_status_struct::stat is set. If data is present 4942908d778SJames Bottomley * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets 4952908d778SJames Bottomley * task_status_struct::buf_valid_size, and task_status_struct::stat is 4962908d778SJames Bottomley * set to SAM_CHECK_COND. 4972908d778SJames Bottomley * 4982908d778SJames Bottomley * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp 4992908d778SJames Bottomley * for ATA task. 5002908d778SJames Bottomley * 5012908d778SJames Bottomley * "frame_len" is the total frame length, which could be more or less 5022908d778SJames Bottomley * than actually copied. 5032908d778SJames Bottomley * 5042908d778SJames Bottomley * Tasks ending with response, always set the residual field. 5052908d778SJames Bottomley */ 5062908d778SJames Bottomley struct ata_task_resp { 5072908d778SJames Bottomley u16 frame_len; 5082908d778SJames Bottomley u8 ending_fis[24]; /* dev to host or data-in */ 5092908d778SJames Bottomley }; 5102908d778SJames Bottomley 5112908d778SJames Bottomley #define SAS_STATUS_BUF_SIZE 96 5122908d778SJames Bottomley 5132908d778SJames Bottomley struct task_status_struct { 5142908d778SJames Bottomley enum service_response resp; 5152908d778SJames Bottomley enum exec_status stat; 5162908d778SJames Bottomley int buf_valid_size; 5172908d778SJames Bottomley 5182908d778SJames Bottomley u8 buf[SAS_STATUS_BUF_SIZE]; 5192908d778SJames Bottomley 5202908d778SJames Bottomley u32 residual; 5212908d778SJames Bottomley enum sas_open_rej_reason open_rej_reason; 5222908d778SJames Bottomley }; 5232908d778SJames Bottomley 5242908d778SJames Bottomley /* ATA and ATAPI task queuable to a SAS LLDD. 5252908d778SJames Bottomley */ 5262908d778SJames Bottomley struct sas_ata_task { 5272908d778SJames Bottomley struct host_to_dev_fis fis; 5282908d778SJames Bottomley u8 atapi_packet[16]; /* 0 if not ATAPI task */ 5292908d778SJames Bottomley 5302908d778SJames Bottomley u8 retry_count; /* hardware retry, should be > 0 */ 5312908d778SJames Bottomley 5322908d778SJames Bottomley u8 dma_xfer:1; /* PIO:0 or DMA:1 */ 5332908d778SJames Bottomley u8 use_ncq:1; 5342908d778SJames Bottomley u8 set_affil_pol:1; 5352908d778SJames Bottomley u8 stp_affil_pol:1; 5362908d778SJames Bottomley 5372908d778SJames Bottomley u8 device_control_reg_update:1; 5382908d778SJames Bottomley }; 5392908d778SJames Bottomley 5402908d778SJames Bottomley struct sas_smp_task { 5412908d778SJames Bottomley struct scatterlist smp_req; 5422908d778SJames Bottomley struct scatterlist smp_resp; 5432908d778SJames Bottomley }; 5442908d778SJames Bottomley 5452908d778SJames Bottomley enum task_attribute { 5462908d778SJames Bottomley TASK_ATTR_SIMPLE = 0, 5472908d778SJames Bottomley TASK_ATTR_HOQ = 1, 5482908d778SJames Bottomley TASK_ATTR_ORDERED= 2, 5492908d778SJames Bottomley TASK_ATTR_ACA = 4, 5502908d778SJames Bottomley }; 5512908d778SJames Bottomley 5522908d778SJames Bottomley struct sas_ssp_task { 5532908d778SJames Bottomley u8 retry_count; /* hardware retry, should be > 0 */ 5542908d778SJames Bottomley 5552908d778SJames Bottomley u8 LUN[8]; 5562908d778SJames Bottomley u8 enable_first_burst:1; 5572908d778SJames Bottomley enum task_attribute task_attr; 5582908d778SJames Bottomley u8 task_prio; 5592908d778SJames Bottomley u8 cdb[16]; 5602908d778SJames Bottomley }; 5612908d778SJames Bottomley 5622908d778SJames Bottomley struct sas_task { 5632908d778SJames Bottomley struct domain_device *dev; 5642908d778SJames Bottomley struct list_head list; 5652908d778SJames Bottomley 5662908d778SJames Bottomley spinlock_t task_state_lock; 5672908d778SJames Bottomley unsigned task_state_flags; 5682908d778SJames Bottomley 5695929faf3SDarrick J. Wong enum sas_protocol task_proto; 5702908d778SJames Bottomley 5712908d778SJames Bottomley /* Used by the discovery code. */ 5722908d778SJames Bottomley struct timer_list timer; 5732908d778SJames Bottomley struct completion completion; 5742908d778SJames Bottomley 5752908d778SJames Bottomley union { 5762908d778SJames Bottomley struct sas_ata_task ata_task; 5772908d778SJames Bottomley struct sas_smp_task smp_task; 5782908d778SJames Bottomley struct sas_ssp_task ssp_task; 5792908d778SJames Bottomley }; 5802908d778SJames Bottomley 5812908d778SJames Bottomley struct scatterlist *scatter; 5822908d778SJames Bottomley int num_scatter; 5832908d778SJames Bottomley u32 total_xfer_len; 5842908d778SJames Bottomley u8 data_dir:2; /* Use PCI_DMA_... */ 5852908d778SJames Bottomley 5862908d778SJames Bottomley struct task_status_struct task_status; 5872908d778SJames Bottomley void (*task_done)(struct sas_task *); 5882908d778SJames Bottomley 5892908d778SJames Bottomley void *lldd_task; /* for use by LLDDs */ 5902908d778SJames Bottomley void *uldd_task; 59179a5eb60SDarrick J. Wong 59279a5eb60SDarrick J. Wong struct work_struct abort_work; 5932908d778SJames Bottomley }; 5942908d778SJames Bottomley 5952908d778SJames Bottomley #define SAS_TASK_STATE_PENDING 1 5962908d778SJames Bottomley #define SAS_TASK_STATE_DONE 2 5972908d778SJames Bottomley #define SAS_TASK_STATE_ABORTED 4 5983ebf6922SDarrick J. Wong #define SAS_TASK_NEED_DEV_RESET 8 599b218a0d8SDarrick J. Wong #define SAS_TASK_AT_INITIATOR 16 6002908d778SJames Bottomley 6014fcf812cSDan Williams extern struct sas_task *sas_alloc_task(gfp_t flags); 6024fcf812cSDan Williams extern void sas_free_task(struct sas_task *task); 6032908d778SJames Bottomley 6042908d778SJames Bottomley struct sas_domain_function_template { 6052908d778SJames Bottomley /* The class calls these to notify the LLDD of an event. */ 6062908d778SJames Bottomley void (*lldd_port_formed)(struct asd_sas_phy *); 6072908d778SJames Bottomley void (*lldd_port_deformed)(struct asd_sas_phy *); 6082908d778SJames Bottomley 6092908d778SJames Bottomley /* The class calls these when a device is found or gone. */ 6102908d778SJames Bottomley int (*lldd_dev_found)(struct domain_device *); 6112908d778SJames Bottomley void (*lldd_dev_gone)(struct domain_device *); 6122908d778SJames Bottomley 6132908d778SJames Bottomley int (*lldd_execute_task)(struct sas_task *, int num, 6143cc27547SAl Viro gfp_t gfp_flags); 6152908d778SJames Bottomley 6162908d778SJames Bottomley /* Task Management Functions. Must be called from process context. */ 6172908d778SJames Bottomley int (*lldd_abort_task)(struct sas_task *); 6182908d778SJames Bottomley int (*lldd_abort_task_set)(struct domain_device *, u8 *lun); 6192908d778SJames Bottomley int (*lldd_clear_aca)(struct domain_device *, u8 *lun); 6202908d778SJames Bottomley int (*lldd_clear_task_set)(struct domain_device *, u8 *lun); 6212908d778SJames Bottomley int (*lldd_I_T_nexus_reset)(struct domain_device *); 6221ca1e43eSDave Jiang int (*lldd_ata_soft_reset)(struct domain_device *); 62336a39947SDan Williams int (*lldd_ata_check_ready)(struct domain_device *); 624b91bb296SDan Williams void (*lldd_ata_set_dmamode)(struct domain_device *); 6252908d778SJames Bottomley int (*lldd_lu_reset)(struct domain_device *, u8 *lun); 6262908d778SJames Bottomley int (*lldd_query_task)(struct sas_task *); 6272908d778SJames Bottomley 6282908d778SJames Bottomley /* Port and Adapter management */ 6292908d778SJames Bottomley int (*lldd_clear_nexus_port)(struct asd_sas_port *); 6302908d778SJames Bottomley int (*lldd_clear_nexus_ha)(struct sas_ha_struct *); 6312908d778SJames Bottomley 6322908d778SJames Bottomley /* Phy management */ 633a01e70e5SJames Bottomley int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *); 6348ec6552fSDan Williams 6358ec6552fSDan Williams /* GPIO support */ 6368ec6552fSDan Williams int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type, 6378ec6552fSDan Williams u8 reg_index, u8 reg_count, u8 *write_data); 6382908d778SJames Bottomley }; 6392908d778SJames Bottomley 6402908d778SJames Bottomley extern int sas_register_ha(struct sas_ha_struct *); 6412908d778SJames Bottomley extern int sas_unregister_ha(struct sas_ha_struct *); 6422908d778SJames Bottomley 643acbf167dSDarrick J. Wong int sas_set_phy_speed(struct sas_phy *phy, 644acbf167dSDarrick J. Wong struct sas_phy_linkrates *rates); 645dea22214SDarrick J. Wong int sas_phy_reset(struct sas_phy *phy, int hard_reset); 646338ec570SDarrick J. Wong int sas_queue_up(struct sas_task *task); 647f281233dSJeff Garzik extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *); 6482908d778SJames Bottomley extern int sas_target_alloc(struct scsi_target *); 6492908d778SJames Bottomley extern int sas_slave_alloc(struct scsi_device *); 6502908d778SJames Bottomley extern int sas_slave_configure(struct scsi_device *); 651e881a172SMike Christie extern int sas_change_queue_depth(struct scsi_device *, int new_depth, 652e881a172SMike Christie int reason); 6532908d778SJames Bottomley extern int sas_change_queue_type(struct scsi_device *, int qt); 6542908d778SJames Bottomley extern int sas_bios_param(struct scsi_device *, 6552908d778SJames Bottomley struct block_device *, 6562908d778SJames Bottomley sector_t capacity, int *hsc); 6572908d778SJames Bottomley extern struct scsi_transport_template * 6582908d778SJames Bottomley sas_domain_attach_transport(struct sas_domain_function_template *); 6592908d778SJames Bottomley extern void sas_domain_release_transport(struct scsi_transport_template *); 6602908d778SJames Bottomley 6612908d778SJames Bottomley int sas_discover_root_expander(struct domain_device *); 6622908d778SJames Bottomley 6632908d778SJames Bottomley void sas_init_ex_attr(void); 6642908d778SJames Bottomley 6652908d778SJames Bottomley int sas_ex_revalidate_domain(struct domain_device *); 6662908d778SJames Bottomley 6677d05919aSDan Williams void sas_unregister_domain_devices(struct asd_sas_port *port, int gone); 6682908d778SJames Bottomley void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *); 6692908d778SJames Bottomley int sas_discover_event(struct asd_sas_port *, enum discover_event ev); 6702908d778SJames Bottomley 6712908d778SJames Bottomley int sas_discover_sata(struct domain_device *); 6722908d778SJames Bottomley int sas_discover_end_dev(struct domain_device *); 6732908d778SJames Bottomley 6741a34c064SDan Williams void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *); 6752908d778SJames Bottomley 6762908d778SJames Bottomley void sas_init_dev(struct domain_device *); 6772908d778SJames Bottomley 678396819fbSDarrick J. Wong void sas_task_abort(struct sas_task *); 679ad689233SDarrick J. Wong int sas_eh_device_reset_handler(struct scsi_cmnd *cmd); 680a9344e68SDarrick J. Wong int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd); 68179a5eb60SDarrick J. Wong 682fa1c1e8fSDarrick J. Wong extern void sas_target_destroy(struct scsi_target *); 683fa1c1e8fSDarrick J. Wong extern int sas_slave_alloc(struct scsi_device *); 684fa1c1e8fSDarrick J. Wong extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg); 685b1124cd3SDan Williams extern int sas_drain_work(struct sas_ha_struct *ha); 686fa1c1e8fSDarrick J. Wong 687ba1fc175SFUJITA Tomonori extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy, 688ba1fc175SFUJITA Tomonori struct request *req); 689366ca51fSJames Bottomley 690366ca51fSJames Bottomley extern void sas_ssp_task_response(struct device *dev, struct sas_task *task, 691366ca51fSJames Bottomley struct ssp_response_iu *iu); 692f41a0c44SDan Williams struct sas_phy *sas_get_local_phy(struct domain_device *dev); 693366ca51fSJames Bottomley 69445e6cdf4SDarrick J. Wong int sas_request_addr(struct Scsi_Host *shost, u8 *addr); 69545e6cdf4SDarrick J. Wong 6962908d778SJames Bottomley #endif /* _SASLIB_H_ */ 697