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
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 struct asd_sas_event *sas_alloc_event_gfp(struct asd_sas_phy *phy,
53 gfp_t gfp_flags);
54 void sas_free_event(struct asd_sas_event *event);
55
56 int sas_register_ports(struct sas_ha_struct *sas_ha);
57 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
58
59 void sas_disable_revalidation(struct sas_ha_struct *ha);
60 void sas_enable_revalidation(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 int 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 int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
82 int sas_notify_phy_event_gfp(struct asd_sas_phy *phy, enum phy_event event,
83 gfp_t flags);
84 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
85 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
86 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
87 int sas_ex_phy_discover(struct domain_device *dev, int single);
88 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
89 struct smp_resp *rps_resp);
90 int sas_try_ata_reset(struct asd_sas_phy *phy);
91 void sas_hae_reset(struct work_struct *work);
92
93 void sas_free_device(struct kref *kref);
94 void sas_destruct_devices(struct asd_sas_port *port);
95
96 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
97 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
98
99 #ifdef CONFIG_SCSI_SAS_HOST_SMP
100 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
101 #else
sas_smp_host_handler(struct bsg_job * job,struct Scsi_Host * shost)102 static inline void sas_smp_host_handler(struct bsg_job *job,
103 struct Scsi_Host *shost)
104 {
105 shost_printk(KERN_ERR, shost,
106 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
107 bsg_job_done(job, -EINVAL, 0);
108 }
109 #endif
110
sas_fail_probe(struct domain_device * dev,const char * func,int err)111 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
112 {
113 pr_warn("%s: for %s device %016llx returned %d\n",
114 func, dev->parent ? "exp-attached" :
115 "direct-attached",
116 SAS_ADDR(dev->sas_addr), err);
117 sas_unregister_dev(dev->port, dev);
118 }
119
sas_fill_in_rphy(struct domain_device * dev,struct sas_rphy * rphy)120 static inline void sas_fill_in_rphy(struct domain_device *dev,
121 struct sas_rphy *rphy)
122 {
123 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
124 rphy->identify.initiator_port_protocols = dev->iproto;
125 rphy->identify.target_port_protocols = dev->tproto;
126 switch (dev->dev_type) {
127 case SAS_SATA_DEV:
128 /* FIXME: need sata device type */
129 case SAS_END_DEVICE:
130 case SAS_SATA_PENDING:
131 rphy->identify.device_type = SAS_END_DEVICE;
132 break;
133 case SAS_EDGE_EXPANDER_DEVICE:
134 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
135 break;
136 case SAS_FANOUT_EXPANDER_DEVICE:
137 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
138 break;
139 default:
140 rphy->identify.device_type = SAS_PHY_UNUSED;
141 break;
142 }
143 }
144
sas_phy_set_target(struct asd_sas_phy * p,struct domain_device * dev)145 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
146 {
147 struct sas_phy *phy = p->phy;
148
149 if (dev) {
150 if (dev_is_sata(dev))
151 phy->identify.device_type = SAS_END_DEVICE;
152 else
153 phy->identify.device_type = dev->dev_type;
154 phy->identify.target_port_protocols = dev->tproto;
155 } else {
156 phy->identify.device_type = SAS_PHY_UNUSED;
157 phy->identify.target_port_protocols = 0;
158 }
159 }
160
sas_add_parent_port(struct domain_device * dev,int phy_id)161 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
162 {
163 struct expander_device *ex = &dev->ex_dev;
164 struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
165
166 if (!ex->parent_port) {
167 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
168 /* FIXME: error handling */
169 BUG_ON(!ex->parent_port);
170 BUG_ON(sas_port_add(ex->parent_port));
171 sas_port_mark_backlink(ex->parent_port);
172 }
173 sas_port_add_phy(ex->parent_port, ex_phy->phy);
174 }
175
sas_alloc_device(void)176 static inline struct domain_device *sas_alloc_device(void)
177 {
178 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
179
180 if (dev) {
181 INIT_LIST_HEAD(&dev->siblings);
182 INIT_LIST_HEAD(&dev->dev_list_node);
183 INIT_LIST_HEAD(&dev->disco_list_node);
184 kref_init(&dev->kref);
185 spin_lock_init(&dev->done_lock);
186 }
187 return dev;
188 }
189
sas_put_device(struct domain_device * dev)190 static inline void sas_put_device(struct domain_device *dev)
191 {
192 kref_put(&dev->kref, sas_free_device);
193 }
194
195 #endif /* _SAS_INTERNAL_H_ */
196