1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Serial Attached SCSI (SAS) class internal header file 4 * 5 * Copyright (C) 2005 Adaptec, Inc. All rights reserved. 6 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com> 7 */ 8 9 #ifndef _SAS_INTERNAL_H_ 10 #define _SAS_INTERNAL_H_ 11 12 #include <scsi/scsi.h> 13 #include <scsi/scsi_host.h> 14 #include <scsi/scsi_transport_sas.h> 15 #include <scsi/libsas.h> 16 #include <scsi/sas_ata.h> 17 #include <linux/pm_runtime.h> 18 19 #ifdef pr_fmt 20 #undef pr_fmt 21 #endif 22 23 #define SAS_FMT "sas: " 24 25 #define pr_fmt(fmt) SAS_FMT fmt 26 27 #define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble) 28 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0) 29 30 struct sas_phy_data { 31 /* let reset be performed in sas_queue_work() context */ 32 struct sas_phy *phy; 33 struct mutex event_lock; 34 int hard_reset; 35 int reset_result; 36 struct sas_work reset_work; 37 int enable; 38 int enable_result; 39 struct sas_work enable_work; 40 }; 41 42 void sas_scsi_recover_host(struct Scsi_Host *shost); 43 44 int sas_show_class(enum sas_class class, char *buf); 45 int sas_show_proto(enum sas_protocol proto, char *buf); 46 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf); 47 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf); 48 49 int sas_register_phys(struct sas_ha_struct *sas_ha); 50 void sas_unregister_phys(struct sas_ha_struct *sas_ha); 51 52 struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags); 53 void sas_free_event(struct asd_sas_event *event); 54 55 struct sas_task *sas_alloc_task(gfp_t flags); 56 struct sas_task *sas_alloc_slow_task(gfp_t flags); 57 void sas_free_task(struct sas_task *task); 58 59 int sas_register_ports(struct sas_ha_struct *sas_ha); 60 void sas_unregister_ports(struct sas_ha_struct *sas_ha); 61 62 void sas_disable_revalidation(struct sas_ha_struct *ha); 63 void sas_enable_revalidation(struct sas_ha_struct *ha); 64 void sas_queue_deferred_work(struct sas_ha_struct *ha); 65 void __sas_drain_work(struct sas_ha_struct *ha); 66 67 void sas_deform_port(struct asd_sas_phy *phy, int gone); 68 69 void sas_porte_bytes_dmaed(struct work_struct *work); 70 void sas_porte_broadcast_rcvd(struct work_struct *work); 71 void sas_porte_link_reset_err(struct work_struct *work); 72 void sas_porte_timer_event(struct work_struct *work); 73 void sas_porte_hard_reset(struct work_struct *work); 74 bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw); 75 76 int sas_notify_lldd_dev_found(struct domain_device *); 77 void sas_notify_lldd_dev_gone(struct domain_device *); 78 79 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost, 80 struct sas_rphy *rphy); 81 int sas_smp_phy_control(struct domain_device *dev, int phy_id, 82 enum phy_func phy_func, struct sas_phy_linkrates *); 83 int sas_smp_get_phy_events(struct sas_phy *phy); 84 85 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port); 86 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy); 87 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id); 88 int sas_ex_phy_discover(struct domain_device *dev, int single); 89 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id, 90 struct smp_rps_resp *rps_resp); 91 int sas_get_phy_attached_dev(struct domain_device *dev, int phy_id, 92 u8 *sas_addr, enum sas_device_type *type); 93 int sas_try_ata_reset(struct asd_sas_phy *phy); 94 void sas_hae_reset(struct work_struct *work); 95 96 void sas_free_device(struct kref *kref); 97 void sas_destruct_devices(struct asd_sas_port *port); 98 99 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS]; 100 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS]; 101 102 void sas_task_internal_done(struct sas_task *task); 103 void sas_task_internal_timedout(struct timer_list *t); 104 int sas_execute_tmf(struct domain_device *device, void *parameter, 105 int para_len, int force_phy_id, 106 struct sas_tmf_task *tmf); 107 108 #ifdef CONFIG_SCSI_SAS_HOST_SMP 109 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost); 110 #else 111 static inline void sas_smp_host_handler(struct bsg_job *job, 112 struct Scsi_Host *shost) 113 { 114 shost_printk(KERN_ERR, shost, 115 "Cannot send SMP to a sas host (not enabled in CONFIG)\n"); 116 bsg_job_done(job, -EINVAL, 0); 117 } 118 #endif 119 120 static inline bool sas_phy_match_dev_addr(struct domain_device *dev, 121 struct ex_phy *phy) 122 { 123 return SAS_ADDR(dev->sas_addr) == SAS_ADDR(phy->attached_sas_addr); 124 } 125 126 static inline bool sas_phy_match_port_addr(struct asd_sas_port *port, 127 struct ex_phy *phy) 128 { 129 return SAS_ADDR(port->sas_addr) == SAS_ADDR(phy->attached_sas_addr); 130 } 131 132 static inline bool sas_phy_addr_match(struct ex_phy *p1, struct ex_phy *p2) 133 { 134 return SAS_ADDR(p1->attached_sas_addr) == SAS_ADDR(p2->attached_sas_addr); 135 } 136 137 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err) 138 { 139 pr_warn("%s: for %s device %016llx returned %d\n", 140 func, dev->parent ? "exp-attached" : 141 "direct-attached", 142 SAS_ADDR(dev->sas_addr), err); 143 sas_unregister_dev(dev->port, dev); 144 } 145 146 static inline void sas_fill_in_rphy(struct domain_device *dev, 147 struct sas_rphy *rphy) 148 { 149 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr); 150 rphy->identify.initiator_port_protocols = dev->iproto; 151 rphy->identify.target_port_protocols = dev->tproto; 152 switch (dev->dev_type) { 153 case SAS_SATA_DEV: 154 /* FIXME: need sata device type */ 155 case SAS_END_DEVICE: 156 case SAS_SATA_PENDING: 157 rphy->identify.device_type = SAS_END_DEVICE; 158 break; 159 case SAS_EDGE_EXPANDER_DEVICE: 160 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE; 161 break; 162 case SAS_FANOUT_EXPANDER_DEVICE: 163 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE; 164 break; 165 default: 166 rphy->identify.device_type = SAS_PHY_UNUSED; 167 break; 168 } 169 } 170 171 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev) 172 { 173 struct sas_phy *phy = p->phy; 174 175 if (dev) { 176 if (dev_is_sata(dev)) 177 phy->identify.device_type = SAS_END_DEVICE; 178 else 179 phy->identify.device_type = dev->dev_type; 180 phy->identify.target_port_protocols = dev->tproto; 181 } else { 182 phy->identify.device_type = SAS_PHY_UNUSED; 183 phy->identify.target_port_protocols = 0; 184 } 185 } 186 187 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id) 188 { 189 struct expander_device *ex = &dev->ex_dev; 190 struct ex_phy *ex_phy = &ex->ex_phy[phy_id]; 191 192 if (!ex->parent_port) { 193 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id); 194 /* FIXME: error handling */ 195 BUG_ON(!ex->parent_port); 196 BUG_ON(sas_port_add(ex->parent_port)); 197 sas_port_mark_backlink(ex->parent_port); 198 } 199 sas_port_add_phy(ex->parent_port, ex_phy->phy); 200 } 201 202 static inline struct domain_device *sas_alloc_device(void) 203 { 204 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL); 205 206 if (dev) { 207 INIT_LIST_HEAD(&dev->siblings); 208 INIT_LIST_HEAD(&dev->dev_list_node); 209 INIT_LIST_HEAD(&dev->disco_list_node); 210 kref_init(&dev->kref); 211 spin_lock_init(&dev->done_lock); 212 } 213 return dev; 214 } 215 216 static inline void sas_put_device(struct domain_device *dev) 217 { 218 kref_put(&dev->kref, sas_free_device); 219 } 220 221 #endif /* _SAS_INTERNAL_H_ */ 222