1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 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 18 #ifdef pr_fmt 19 #undef pr_fmt 20 #endif 21 22 #define SAS_FMT "sas: " 23 24 #define pr_fmt(fmt) SAS_FMT fmt 25 26 #define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble) 27 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0) 28 29 struct sas_phy_data { 30 /* let reset be performed in sas_queue_work() context */ 31 struct sas_phy *phy; 32 struct mutex event_lock; 33 int hard_reset; 34 int reset_result; 35 struct sas_work reset_work; 36 int enable; 37 int enable_result; 38 struct sas_work enable_work; 39 }; 40 41 void sas_scsi_recover_host(struct Scsi_Host *shost); 42 43 int sas_show_class(enum sas_class class, char *buf); 44 int sas_show_proto(enum sas_protocol proto, char *buf); 45 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf); 46 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf); 47 48 int sas_register_phys(struct sas_ha_struct *sas_ha); 49 void sas_unregister_phys(struct sas_ha_struct *sas_ha); 50 51 struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy); 52 void sas_free_event(struct asd_sas_event *event); 53 54 int sas_register_ports(struct sas_ha_struct *sas_ha); 55 void sas_unregister_ports(struct sas_ha_struct *sas_ha); 56 57 int sas_init_events(struct sas_ha_struct *sas_ha); 58 void sas_disable_revalidation(struct sas_ha_struct *ha); 59 void sas_enable_revalidation(struct sas_ha_struct *ha); 60 void __sas_drain_work(struct sas_ha_struct *ha); 61 62 void sas_deform_port(struct asd_sas_phy *phy, int gone); 63 64 void sas_porte_bytes_dmaed(struct work_struct *work); 65 void sas_porte_broadcast_rcvd(struct work_struct *work); 66 void sas_porte_link_reset_err(struct work_struct *work); 67 void sas_porte_timer_event(struct work_struct *work); 68 void sas_porte_hard_reset(struct work_struct *work); 69 int sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw); 70 71 int sas_notify_lldd_dev_found(struct domain_device *); 72 void sas_notify_lldd_dev_gone(struct domain_device *); 73 74 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost, 75 struct sas_rphy *rphy); 76 int sas_smp_phy_control(struct domain_device *dev, int phy_id, 77 enum phy_func phy_func, struct sas_phy_linkrates *); 78 int sas_smp_get_phy_events(struct sas_phy *phy); 79 80 int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event); 81 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port); 82 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy); 83 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id); 84 int sas_ex_phy_discover(struct domain_device *dev, int single); 85 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id, 86 struct smp_resp *rps_resp); 87 int sas_try_ata_reset(struct asd_sas_phy *phy); 88 void sas_hae_reset(struct work_struct *work); 89 90 void sas_free_device(struct kref *kref); 91 void sas_destruct_devices(struct asd_sas_port *port); 92 93 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS]; 94 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS]; 95 96 #ifdef CONFIG_SCSI_SAS_HOST_SMP 97 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost); 98 #else 99 static inline void sas_smp_host_handler(struct bsg_job *job, 100 struct Scsi_Host *shost) 101 { 102 shost_printk(KERN_ERR, shost, 103 "Cannot send SMP to a sas host (not enabled in CONFIG)\n"); 104 bsg_job_done(job, -EINVAL, 0); 105 } 106 #endif 107 108 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err) 109 { 110 pr_warn("%s: for %s device %16llx returned %d\n", 111 func, dev->parent ? "exp-attached" : 112 "direct-attached", 113 SAS_ADDR(dev->sas_addr), err); 114 sas_unregister_dev(dev->port, dev); 115 } 116 117 static inline void sas_fill_in_rphy(struct domain_device *dev, 118 struct sas_rphy *rphy) 119 { 120 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr); 121 rphy->identify.initiator_port_protocols = dev->iproto; 122 rphy->identify.target_port_protocols = dev->tproto; 123 switch (dev->dev_type) { 124 case SAS_SATA_DEV: 125 /* FIXME: need sata device type */ 126 case SAS_END_DEVICE: 127 case SAS_SATA_PENDING: 128 rphy->identify.device_type = SAS_END_DEVICE; 129 break; 130 case SAS_EDGE_EXPANDER_DEVICE: 131 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE; 132 break; 133 case SAS_FANOUT_EXPANDER_DEVICE: 134 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE; 135 break; 136 default: 137 rphy->identify.device_type = SAS_PHY_UNUSED; 138 break; 139 } 140 } 141 142 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev) 143 { 144 struct sas_phy *phy = p->phy; 145 146 if (dev) { 147 if (dev_is_sata(dev)) 148 phy->identify.device_type = SAS_END_DEVICE; 149 else 150 phy->identify.device_type = dev->dev_type; 151 phy->identify.target_port_protocols = dev->tproto; 152 } else { 153 phy->identify.device_type = SAS_PHY_UNUSED; 154 phy->identify.target_port_protocols = 0; 155 } 156 } 157 158 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id) 159 { 160 struct expander_device *ex = &dev->ex_dev; 161 struct ex_phy *ex_phy = &ex->ex_phy[phy_id]; 162 163 if (!ex->parent_port) { 164 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id); 165 /* FIXME: error handling */ 166 BUG_ON(!ex->parent_port); 167 BUG_ON(sas_port_add(ex->parent_port)); 168 sas_port_mark_backlink(ex->parent_port); 169 } 170 sas_port_add_phy(ex->parent_port, ex_phy->phy); 171 } 172 173 static inline struct domain_device *sas_alloc_device(void) 174 { 175 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL); 176 177 if (dev) { 178 INIT_LIST_HEAD(&dev->siblings); 179 INIT_LIST_HEAD(&dev->dev_list_node); 180 INIT_LIST_HEAD(&dev->disco_list_node); 181 kref_init(&dev->kref); 182 spin_lock_init(&dev->done_lock); 183 } 184 return dev; 185 } 186 187 static inline void sas_put_device(struct domain_device *dev) 188 { 189 kref_put(&dev->kref, sas_free_device); 190 } 191 192 #endif /* _SAS_INTERNAL_H_ */ 193