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

source code of linux/drivers/scsi/libsas/sas_internal.h