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_hash_addr(u8 *hashed, const u8 *sas_addr);
43
44 int sas_discover_root_expander(struct domain_device *dev);
45
46 int sas_ex_revalidate_domain(struct domain_device *dev);
47 void sas_unregister_domain_devices(struct asd_sas_port *port, bool gone);
48 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port);
49 void sas_discover_event(struct asd_sas_port *port, enum discover_event ev);
50
51 void sas_init_dev(struct domain_device *dev);
52 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev);
53
54 void sas_scsi_recover_host(struct Scsi_Host *shost);
55
56 int sas_register_phys(struct sas_ha_struct *sas_ha);
57 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
58
59 struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags);
60 void sas_free_event(struct asd_sas_event *event);
61
62 struct sas_task *sas_alloc_task(gfp_t flags);
63 struct sas_task *sas_alloc_slow_task(gfp_t flags);
64 void sas_free_task(struct sas_task *task);
65
66 int sas_register_ports(struct sas_ha_struct *sas_ha);
67 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
68
69 void sas_disable_revalidation(struct sas_ha_struct *ha);
70 void sas_enable_revalidation(struct sas_ha_struct *ha);
71 void sas_queue_deferred_work(struct sas_ha_struct *ha);
72 void __sas_drain_work(struct sas_ha_struct *ha);
73
74 void sas_deform_port(struct asd_sas_phy *phy, bool gone);
75
76 void sas_porte_bytes_dmaed(struct work_struct *work);
77 void sas_porte_broadcast_rcvd(struct work_struct *work);
78 void sas_porte_link_reset_err(struct work_struct *work);
79 void sas_porte_timer_event(struct work_struct *work);
80 void sas_porte_hard_reset(struct work_struct *work);
81 bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
82
83 int sas_notify_lldd_dev_found(struct domain_device *);
84 void sas_notify_lldd_dev_gone(struct domain_device *);
85
86 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
87 struct sas_rphy *rphy);
88 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
89 enum phy_func phy_func, struct sas_phy_linkrates *);
90 int sas_smp_get_phy_events(struct sas_phy *phy);
91
92 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
93 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
94 struct domain_device *sas_ex_phy_to_dev(struct domain_device *ex_dev, int phy_id);
95 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
96 int sas_ex_phy_discover(struct domain_device *dev, int single);
97 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
98 struct smp_rps_resp *rps_resp);
99 int sas_get_phy_attached_dev(struct domain_device *dev, int phy_id,
100 u8 *sas_addr, enum sas_device_type *type);
101 int sas_try_ata_reset(struct asd_sas_phy *phy);
102
103 void sas_free_device(struct kref *kref);
104 void sas_destruct_devices(struct asd_sas_port *port);
105
106 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
107 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
108
109 void sas_task_internal_done(struct sas_task *task);
110 void sas_task_internal_timedout(struct timer_list *t);
111 int sas_execute_tmf(struct domain_device *device, void *parameter,
112 int para_len, int force_phy_id,
113 struct sas_tmf_task *tmf);
114
115 #ifdef CONFIG_SCSI_SAS_HOST_SMP
116 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
117 #else
sas_smp_host_handler(struct bsg_job * job,struct Scsi_Host * shost)118 static inline void sas_smp_host_handler(struct bsg_job *job,
119 struct Scsi_Host *shost)
120 {
121 shost_printk(KERN_ERR, shost,
122 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
123 bsg_job_done(job, -EINVAL, 0);
124 }
125 #endif
126
sas_phy_match_dev_addr(struct domain_device * dev,struct ex_phy * phy)127 static inline bool sas_phy_match_dev_addr(struct domain_device *dev,
128 struct ex_phy *phy)
129 {
130 return SAS_ADDR(dev->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
131 }
132
sas_phy_match_port_addr(struct asd_sas_port * port,struct ex_phy * phy)133 static inline bool sas_phy_match_port_addr(struct asd_sas_port *port,
134 struct ex_phy *phy)
135 {
136 return SAS_ADDR(port->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
137 }
138
sas_phy_addr_match(struct ex_phy * p1,struct ex_phy * p2)139 static inline bool sas_phy_addr_match(struct ex_phy *p1, struct ex_phy *p2)
140 {
141 return SAS_ADDR(p1->attached_sas_addr) == SAS_ADDR(p2->attached_sas_addr);
142 }
143
sas_fail_probe(struct domain_device * dev,const char * func,int err)144 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
145 {
146 pr_warn("%s: for %s device %016llx returned %d\n",
147 func, dev->parent ? "exp-attached" :
148 "direct-attached",
149 SAS_ADDR(dev->sas_addr), err);
150 sas_unregister_dev(dev->port, dev);
151 }
152
sas_fill_in_rphy(struct domain_device * dev,struct sas_rphy * rphy)153 static inline void sas_fill_in_rphy(struct domain_device *dev,
154 struct sas_rphy *rphy)
155 {
156 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
157 rphy->identify.initiator_port_protocols = dev->iproto;
158 rphy->identify.target_port_protocols = dev->tproto;
159 switch (dev->dev_type) {
160 case SAS_SATA_DEV:
161 /* FIXME: need sata device type */
162 case SAS_END_DEVICE:
163 case SAS_SATA_PENDING:
164 rphy->identify.device_type = SAS_END_DEVICE;
165 break;
166 case SAS_EDGE_EXPANDER_DEVICE:
167 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
168 break;
169 case SAS_FANOUT_EXPANDER_DEVICE:
170 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
171 break;
172 default:
173 rphy->identify.device_type = SAS_PHY_UNUSED;
174 break;
175 }
176 }
177
sas_phy_set_target(struct asd_sas_phy * p,struct domain_device * dev)178 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
179 {
180 struct sas_phy *phy = p->phy;
181
182 if (dev) {
183 if (dev_is_sata(dev))
184 phy->identify.device_type = SAS_END_DEVICE;
185 else
186 phy->identify.device_type = dev->dev_type;
187 phy->identify.target_port_protocols = dev->tproto;
188 } else {
189 phy->identify.device_type = SAS_PHY_UNUSED;
190 phy->identify.target_port_protocols = 0;
191 }
192 }
193
sas_alloc_device(void)194 static inline struct domain_device *sas_alloc_device(void)
195 {
196 struct domain_device *dev = kzalloc_obj(*dev);
197
198 if (dev) {
199 INIT_LIST_HEAD(&dev->siblings);
200 INIT_LIST_HEAD(&dev->dev_list_node);
201 INIT_LIST_HEAD(&dev->disco_list_node);
202 kref_init(&dev->kref);
203 spin_lock_init(&dev->done_lock);
204 }
205 return dev;
206 }
207
sas_put_device(struct domain_device * dev)208 static inline void sas_put_device(struct domain_device *dev)
209 {
210 kref_put(&dev->kref, sas_free_device);
211 }
212
213 #ifdef CONFIG_SCSI_SAS_ATA
214
215 int sas_ata_init(struct domain_device *dev);
216 void sas_ata_task_abort(struct sas_task *task);
217 int sas_discover_sata(struct domain_device *dev);
218 int sas_ata_add_dev(struct domain_device *parent, struct ex_phy *phy,
219 struct domain_device *child, int phy_id);
220 void sas_ata_strategy_handler(struct Scsi_Host *shost);
221 void sas_ata_eh(struct Scsi_Host *shost, struct list_head *work_q);
222 void sas_ata_end_eh(struct ata_port *ap);
223 void sas_ata_wait_eh(struct domain_device *dev);
224 void sas_probe_sata(struct asd_sas_port *port);
225 void sas_suspend_sata(struct asd_sas_port *port);
226 void sas_resume_sata(struct asd_sas_port *port);
227
228 #else
229
sas_ata_init(struct domain_device * dev)230 static inline int sas_ata_init(struct domain_device *dev)
231 {
232 return 0;
233 }
234
sas_ata_task_abort(struct sas_task * task)235 static inline void sas_ata_task_abort(struct sas_task *task)
236 {
237 }
238
sas_ata_strategy_handler(struct Scsi_Host * shost)239 static inline void sas_ata_strategy_handler(struct Scsi_Host *shost)
240 {
241 }
242
sas_ata_eh(struct Scsi_Host * shost,struct list_head * work_q)243 static inline void sas_ata_eh(struct Scsi_Host *shost, struct list_head *work_q)
244 {
245 }
246
sas_ata_end_eh(struct ata_port * ap)247 static inline void sas_ata_end_eh(struct ata_port *ap)
248 {
249 }
250
sas_ata_wait_eh(struct domain_device * dev)251 static inline void sas_ata_wait_eh(struct domain_device *dev)
252 {
253 }
254
sas_probe_sata(struct asd_sas_port * port)255 static inline void sas_probe_sata(struct asd_sas_port *port)
256 {
257 }
258
sas_suspend_sata(struct asd_sas_port * port)259 static inline void sas_suspend_sata(struct asd_sas_port *port)
260 {
261 }
262
sas_resume_sata(struct asd_sas_port * port)263 static inline void sas_resume_sata(struct asd_sas_port *port)
264 {
265 }
266
sas_ata_disabled_notice(void)267 static inline void sas_ata_disabled_notice(void)
268 {
269 pr_notice_once("ATA device seen but CONFIG_SCSI_SAS_ATA=N\n");
270 }
271
sas_discover_sata(struct domain_device * dev)272 static inline int sas_discover_sata(struct domain_device *dev)
273 {
274 sas_ata_disabled_notice();
275 return -ENXIO;
276 }
277
sas_ata_add_dev(struct domain_device * parent,struct ex_phy * phy,struct domain_device * child,int phy_id)278 static inline int sas_ata_add_dev(struct domain_device *parent, struct ex_phy *phy,
279 struct domain_device *child, int phy_id)
280 {
281 sas_ata_disabled_notice();
282 return -ENODEV;
283 }
284
285 #endif
286
287 #endif /* _SAS_INTERNAL_H_ */
288