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 int sas_register_ports(struct sas_ha_struct *sas_ha);
56 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
57
58 void sas_disable_revalidation(struct sas_ha_struct *ha);
59 void sas_enable_revalidation(struct sas_ha_struct *ha);
60 void sas_queue_deferred_work(struct sas_ha_struct *ha);
61 void __sas_drain_work(struct sas_ha_struct *ha);
62
63 void sas_deform_port(struct asd_sas_phy *phy, int gone);
64
65 void sas_porte_bytes_dmaed(struct work_struct *work);
66 void sas_porte_broadcast_rcvd(struct work_struct *work);
67 void sas_porte_link_reset_err(struct work_struct *work);
68 void sas_porte_timer_event(struct work_struct *work);
69 void sas_porte_hard_reset(struct work_struct *work);
70 bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
71
72 int sas_notify_lldd_dev_found(struct domain_device *);
73 void sas_notify_lldd_dev_gone(struct domain_device *);
74
75 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
76 struct sas_rphy *rphy);
77 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
78 enum phy_func phy_func, struct sas_phy_linkrates *);
79 int sas_smp_get_phy_events(struct sas_phy *phy);
80
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_rps_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 void sas_task_internal_done(struct sas_task *task);
97 void sas_task_internal_timedout(struct timer_list *t);
98 int sas_execute_tmf(struct domain_device *device, void *parameter,
99 int para_len, int force_phy_id,
100 struct sas_tmf_task *tmf);
101
102 #ifdef CONFIG_SCSI_SAS_HOST_SMP
103 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
104 #else
sas_smp_host_handler(struct bsg_job * job,struct Scsi_Host * shost)105 static inline void sas_smp_host_handler(struct bsg_job *job,
106 struct Scsi_Host *shost)
107 {
108 shost_printk(KERN_ERR, shost,
109 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
110 bsg_job_done(job, -EINVAL, 0);
111 }
112 #endif
113
sas_fail_probe(struct domain_device * dev,const char * func,int err)114 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
115 {
116 pr_warn("%s: for %s device %016llx returned %d\n",
117 func, dev->parent ? "exp-attached" :
118 "direct-attached",
119 SAS_ADDR(dev->sas_addr), err);
120 sas_unregister_dev(dev->port, dev);
121 }
122
sas_fill_in_rphy(struct domain_device * dev,struct sas_rphy * rphy)123 static inline void sas_fill_in_rphy(struct domain_device *dev,
124 struct sas_rphy *rphy)
125 {
126 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
127 rphy->identify.initiator_port_protocols = dev->iproto;
128 rphy->identify.target_port_protocols = dev->tproto;
129 switch (dev->dev_type) {
130 case SAS_SATA_DEV:
131 /* FIXME: need sata device type */
132 case SAS_END_DEVICE:
133 case SAS_SATA_PENDING:
134 rphy->identify.device_type = SAS_END_DEVICE;
135 break;
136 case SAS_EDGE_EXPANDER_DEVICE:
137 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
138 break;
139 case SAS_FANOUT_EXPANDER_DEVICE:
140 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
141 break;
142 default:
143 rphy->identify.device_type = SAS_PHY_UNUSED;
144 break;
145 }
146 }
147
sas_phy_set_target(struct asd_sas_phy * p,struct domain_device * dev)148 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
149 {
150 struct sas_phy *phy = p->phy;
151
152 if (dev) {
153 if (dev_is_sata(dev))
154 phy->identify.device_type = SAS_END_DEVICE;
155 else
156 phy->identify.device_type = dev->dev_type;
157 phy->identify.target_port_protocols = dev->tproto;
158 } else {
159 phy->identify.device_type = SAS_PHY_UNUSED;
160 phy->identify.target_port_protocols = 0;
161 }
162 }
163
sas_add_parent_port(struct domain_device * dev,int phy_id)164 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
165 {
166 struct expander_device *ex = &dev->ex_dev;
167 struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
168
169 if (!ex->parent_port) {
170 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
171 /* FIXME: error handling */
172 BUG_ON(!ex->parent_port);
173 BUG_ON(sas_port_add(ex->parent_port));
174 sas_port_mark_backlink(ex->parent_port);
175 }
176 sas_port_add_phy(ex->parent_port, ex_phy->phy);
177 }
178
sas_alloc_device(void)179 static inline struct domain_device *sas_alloc_device(void)
180 {
181 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
182
183 if (dev) {
184 INIT_LIST_HEAD(&dev->siblings);
185 INIT_LIST_HEAD(&dev->dev_list_node);
186 INIT_LIST_HEAD(&dev->disco_list_node);
187 kref_init(&dev->kref);
188 spin_lock_init(&dev->done_lock);
189 }
190 return dev;
191 }
192
sas_put_device(struct domain_device * dev)193 static inline void sas_put_device(struct domain_device *dev)
194 {
195 kref_put(&dev->kref, sas_free_device);
196 }
197
198 #endif /* _SAS_INTERNAL_H_ */
199