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_register_phys(struct sas_ha_struct *sas_ha); 45 46 struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags); 47 void sas_free_event(struct asd_sas_event *event); 48 49 struct sas_task *sas_alloc_task(gfp_t flags); 50 struct sas_task *sas_alloc_slow_task(gfp_t flags); 51 void sas_free_task(struct sas_task *task); 52 53 int sas_register_ports(struct sas_ha_struct *sas_ha); 54 void sas_unregister_ports(struct sas_ha_struct *sas_ha); 55 56 void sas_disable_revalidation(struct sas_ha_struct *ha); 57 void sas_enable_revalidation(struct sas_ha_struct *ha); 58 void sas_queue_deferred_work(struct sas_ha_struct *ha); 59 void __sas_drain_work(struct sas_ha_struct *ha); 60 61 void sas_deform_port(struct asd_sas_phy *phy, int gone); 62 63 void sas_porte_bytes_dmaed(struct work_struct *work); 64 void sas_porte_broadcast_rcvd(struct work_struct *work); 65 void sas_porte_link_reset_err(struct work_struct *work); 66 void sas_porte_timer_event(struct work_struct *work); 67 void sas_porte_hard_reset(struct work_struct *work); 68 bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw); 69 70 int sas_notify_lldd_dev_found(struct domain_device *); 71 void sas_notify_lldd_dev_gone(struct domain_device *); 72 73 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost, 74 struct sas_rphy *rphy); 75 int sas_smp_phy_control(struct domain_device *dev, int phy_id, 76 enum phy_func phy_func, struct sas_phy_linkrates *); 77 int sas_smp_get_phy_events(struct sas_phy *phy); 78 79 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port); 80 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy); 81 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id); 82 int sas_ex_phy_discover(struct domain_device *dev, int single); 83 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id, 84 struct smp_rps_resp *rps_resp); 85 int sas_get_phy_attached_dev(struct domain_device *dev, int phy_id, 86 u8 *sas_addr, enum sas_device_type *type); 87 int sas_try_ata_reset(struct asd_sas_phy *phy); 88 89 void sas_free_device(struct kref *kref); 90 void sas_destruct_devices(struct asd_sas_port *port); 91 92 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS]; 93 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS]; 94 95 void sas_task_internal_done(struct sas_task *task); 96 void sas_task_internal_timedout(struct timer_list *t); 97 int sas_execute_tmf(struct domain_device *device, void *parameter, 98 int para_len, int force_phy_id, 99 struct sas_tmf_task *tmf); 100 101 #ifdef CONFIG_SCSI_SAS_HOST_SMP 102 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost); 103 #else 104 static inline void sas_smp_host_handler(struct bsg_job *job, 105 struct Scsi_Host *shost) 106 { 107 shost_printk(KERN_ERR, shost, 108 "Cannot send SMP to a sas host (not enabled in CONFIG)\n"); 109 bsg_job_done(job, -EINVAL, 0); 110 } 111 #endif 112 113 static inline bool sas_phy_match_dev_addr(struct domain_device *dev, 114 struct ex_phy *phy) 115 { 116 return SAS_ADDR(dev->sas_addr) == SAS_ADDR(phy->attached_sas_addr); 117 } 118 119 static inline bool sas_phy_match_port_addr(struct asd_sas_port *port, 120 struct ex_phy *phy) 121 { 122 return SAS_ADDR(port->sas_addr) == SAS_ADDR(phy->attached_sas_addr); 123 } 124 125 static inline bool sas_phy_addr_match(struct ex_phy *p1, struct ex_phy *p2) 126 { 127 return SAS_ADDR(p1->attached_sas_addr) == SAS_ADDR(p2->attached_sas_addr); 128 } 129 130 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err) 131 { 132 pr_warn("%s: for %s device %016llx returned %d\n", 133 func, dev->parent ? "exp-attached" : 134 "direct-attached", 135 SAS_ADDR(dev->sas_addr), err); 136 sas_unregister_dev(dev->port, dev); 137 } 138 139 static inline void sas_fill_in_rphy(struct domain_device *dev, 140 struct sas_rphy *rphy) 141 { 142 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr); 143 rphy->identify.initiator_port_protocols = dev->iproto; 144 rphy->identify.target_port_protocols = dev->tproto; 145 switch (dev->dev_type) { 146 case SAS_SATA_DEV: 147 /* FIXME: need sata device type */ 148 case SAS_END_DEVICE: 149 case SAS_SATA_PENDING: 150 rphy->identify.device_type = SAS_END_DEVICE; 151 break; 152 case SAS_EDGE_EXPANDER_DEVICE: 153 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE; 154 break; 155 case SAS_FANOUT_EXPANDER_DEVICE: 156 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE; 157 break; 158 default: 159 rphy->identify.device_type = SAS_PHY_UNUSED; 160 break; 161 } 162 } 163 164 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev) 165 { 166 struct sas_phy *phy = p->phy; 167 168 if (dev) { 169 if (dev_is_sata(dev)) 170 phy->identify.device_type = SAS_END_DEVICE; 171 else 172 phy->identify.device_type = dev->dev_type; 173 phy->identify.target_port_protocols = dev->tproto; 174 } else { 175 phy->identify.device_type = SAS_PHY_UNUSED; 176 phy->identify.target_port_protocols = 0; 177 } 178 } 179 180 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id) 181 { 182 struct expander_device *ex = &dev->ex_dev; 183 struct ex_phy *ex_phy = &ex->ex_phy[phy_id]; 184 185 if (!ex->parent_port) { 186 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id); 187 /* FIXME: error handling */ 188 BUG_ON(!ex->parent_port); 189 BUG_ON(sas_port_add(ex->parent_port)); 190 sas_port_mark_backlink(ex->parent_port); 191 } 192 sas_port_add_phy(ex->parent_port, ex_phy->phy); 193 } 194 195 static inline struct domain_device *sas_alloc_device(void) 196 { 197 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL); 198 199 if (dev) { 200 INIT_LIST_HEAD(&dev->siblings); 201 INIT_LIST_HEAD(&dev->dev_list_node); 202 INIT_LIST_HEAD(&dev->disco_list_node); 203 kref_init(&dev->kref); 204 spin_lock_init(&dev->done_lock); 205 } 206 return dev; 207 } 208 209 static inline void sas_put_device(struct domain_device *dev) 210 { 211 kref_put(&dev->kref, sas_free_device); 212 } 213 214 #endif /* _SAS_INTERNAL_H_ */ 215