xref: /openbmc/linux/drivers/scsi/libsas/sas_port.c (revision 517e5153)
1 /*
2  * Serial Attached SCSI (SAS) Port class
3  *
4  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
5  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
6  *
7  * This file is licensed under GPLv2.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of the
12  * License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24 
25 #include "sas_internal.h"
26 
27 #include <scsi/scsi_transport.h>
28 #include <scsi/scsi_transport_sas.h>
29 #include "../scsi_sas_internal.h"
30 
31 static bool phy_is_wideport_member(struct asd_sas_port *port, struct asd_sas_phy *phy)
32 {
33 	struct sas_ha_struct *sas_ha = phy->ha;
34 
35 	if (memcmp(port->attached_sas_addr, phy->attached_sas_addr,
36 		   SAS_ADDR_SIZE) != 0 || (sas_ha->strict_wide_ports &&
37 	     memcmp(port->sas_addr, phy->sas_addr, SAS_ADDR_SIZE) != 0))
38 		return false;
39 	return true;
40 }
41 
42 static void sas_resume_port(struct asd_sas_phy *phy)
43 {
44 	struct domain_device *dev;
45 	struct asd_sas_port *port = phy->port;
46 	struct sas_ha_struct *sas_ha = phy->ha;
47 	struct sas_internal *si = to_sas_internal(sas_ha->core.shost->transportt);
48 
49 	if (si->dft->lldd_port_formed)
50 		si->dft->lldd_port_formed(phy);
51 
52 	if (port->suspended)
53 		port->suspended = 0;
54 	else {
55 		/* we only need to handle "link returned" actions once */
56 		return;
57 	}
58 
59 	/* if the port came back:
60 	 * 1/ presume every device came back
61 	 * 2/ force the next revalidation to check all expander phys
62 	 */
63 	list_for_each_entry(dev, &port->dev_list, dev_list_node) {
64 		int i, rc;
65 
66 		rc = sas_notify_lldd_dev_found(dev);
67 		if (rc) {
68 			sas_unregister_dev(port, dev);
69 			continue;
70 		}
71 
72 		if (dev->dev_type == SAS_EDGE_EXPANDER_DEVICE || dev->dev_type == SAS_FANOUT_EXPANDER_DEVICE) {
73 			dev->ex_dev.ex_change_count = -1;
74 			for (i = 0; i < dev->ex_dev.num_phys; i++) {
75 				struct ex_phy *phy = &dev->ex_dev.ex_phy[i];
76 
77 				phy->phy_change_count = -1;
78 			}
79 		}
80 	}
81 
82 	sas_discover_event(port, DISCE_RESUME);
83 }
84 
85 /**
86  * sas_form_port -- add this phy to a port
87  * @phy: the phy of interest
88  *
89  * This function adds this phy to an existing port, thus creating a wide
90  * port, or it creates a port and adds the phy to the port.
91  */
92 static void sas_form_port(struct asd_sas_phy *phy)
93 {
94 	int i;
95 	struct sas_ha_struct *sas_ha = phy->ha;
96 	struct asd_sas_port *port = phy->port;
97 	struct sas_internal *si =
98 		to_sas_internal(sas_ha->core.shost->transportt);
99 	unsigned long flags;
100 
101 	if (port) {
102 		if (!phy_is_wideport_member(port, phy))
103 			sas_deform_port(phy, 0);
104 		else if (phy->suspended) {
105 			phy->suspended = 0;
106 			sas_resume_port(phy);
107 
108 			/* phy came back, try to cancel the timeout */
109 			wake_up(&sas_ha->eh_wait_q);
110 			return;
111 		} else {
112 			SAS_DPRINTK("%s: phy%d belongs to port%d already(%d)!\n",
113 				    __func__, phy->id, phy->port->id,
114 				    phy->port->num_phys);
115 			return;
116 		}
117 	}
118 
119 	/* see if the phy should be part of a wide port */
120 	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
121 	for (i = 0; i < sas_ha->num_phys; i++) {
122 		port = sas_ha->sas_port[i];
123 		spin_lock(&port->phy_list_lock);
124 		if (*(u64 *) port->sas_addr &&
125 		    phy_is_wideport_member(port, phy) && port->num_phys > 0) {
126 			/* wide port */
127 			SAS_DPRINTK("phy%d matched wide port%d\n", phy->id,
128 				    port->id);
129 			break;
130 		}
131 		spin_unlock(&port->phy_list_lock);
132 	}
133 	/* The phy does not match any existing port, create a new one */
134 	if (i == sas_ha->num_phys) {
135 		for (i = 0; i < sas_ha->num_phys; i++) {
136 			port = sas_ha->sas_port[i];
137 			spin_lock(&port->phy_list_lock);
138 			if (*(u64 *)port->sas_addr == 0
139 				&& port->num_phys == 0) {
140 				memcpy(port->sas_addr, phy->sas_addr,
141 					SAS_ADDR_SIZE);
142 				break;
143 			}
144 			spin_unlock(&port->phy_list_lock);
145 		}
146 	}
147 
148 	if (i >= sas_ha->num_phys) {
149 		printk(KERN_NOTICE "%s: couldn't find a free port, bug?\n",
150 		       __func__);
151 		spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
152 		return;
153 	}
154 
155 	/* add the phy to the port */
156 	list_add_tail(&phy->port_phy_el, &port->phy_list);
157 	sas_phy_set_target(phy, port->port_dev);
158 	phy->port = port;
159 	port->num_phys++;
160 	port->phy_mask |= (1U << phy->id);
161 
162 	if (*(u64 *)port->attached_sas_addr == 0) {
163 		port->class = phy->class;
164 		memcpy(port->attached_sas_addr, phy->attached_sas_addr,
165 		       SAS_ADDR_SIZE);
166 		port->iproto = phy->iproto;
167 		port->tproto = phy->tproto;
168 		port->oob_mode = phy->oob_mode;
169 		port->linkrate = phy->linkrate;
170 	} else
171 		port->linkrate = max(port->linkrate, phy->linkrate);
172 	spin_unlock(&port->phy_list_lock);
173 	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
174 
175 	if (!port->port) {
176 		port->port = sas_port_alloc(phy->phy->dev.parent, port->id);
177 		BUG_ON(!port->port);
178 		sas_port_add(port->port);
179 	}
180 	sas_port_add_phy(port->port, phy->phy);
181 
182 	SAS_DPRINTK("%s added to %s, phy_mask:0x%x (%16llx)\n",
183 		    dev_name(&phy->phy->dev), dev_name(&port->port->dev),
184 		    port->phy_mask,
185 		    SAS_ADDR(port->attached_sas_addr));
186 
187 	if (port->port_dev)
188 		port->port_dev->pathways = port->num_phys;
189 
190 	/* Tell the LLDD about this port formation. */
191 	if (si->dft->lldd_port_formed)
192 		si->dft->lldd_port_formed(phy);
193 
194 	sas_discover_event(phy->port, DISCE_DISCOVER_DOMAIN);
195 	flush_workqueue(sas_ha->disco_q);
196 }
197 
198 /**
199  * sas_deform_port -- remove this phy from the port it belongs to
200  * @phy: the phy of interest
201  *
202  * This is called when the physical link to the other phy has been
203  * lost (on this phy), in Event thread context. We cannot delay here.
204  */
205 void sas_deform_port(struct asd_sas_phy *phy, int gone)
206 {
207 	struct sas_ha_struct *sas_ha = phy->ha;
208 	struct asd_sas_port *port = phy->port;
209 	struct sas_internal *si =
210 		to_sas_internal(sas_ha->core.shost->transportt);
211 	struct domain_device *dev;
212 	unsigned long flags;
213 
214 	if (!port)
215 		return;		  /* done by a phy event */
216 
217 	dev = port->port_dev;
218 	if (dev)
219 		dev->pathways--;
220 
221 	if (port->num_phys == 1) {
222 		sas_unregister_domain_devices(port, gone);
223 		sas_port_delete(port->port);
224 		port->port = NULL;
225 	} else {
226 		sas_port_delete_phy(port->port, phy->phy);
227 		sas_device_set_phy(dev, port->port);
228 	}
229 
230 	if (si->dft->lldd_port_deformed)
231 		si->dft->lldd_port_deformed(phy);
232 
233 	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
234 	spin_lock(&port->phy_list_lock);
235 
236 	list_del_init(&phy->port_phy_el);
237 	sas_phy_set_target(phy, NULL);
238 	phy->port = NULL;
239 	port->num_phys--;
240 	port->phy_mask &= ~(1U << phy->id);
241 
242 	if (port->num_phys == 0) {
243 		INIT_LIST_HEAD(&port->phy_list);
244 		memset(port->sas_addr, 0, SAS_ADDR_SIZE);
245 		memset(port->attached_sas_addr, 0, SAS_ADDR_SIZE);
246 		port->class = 0;
247 		port->iproto = 0;
248 		port->tproto = 0;
249 		port->oob_mode = 0;
250 		port->phy_mask = 0;
251 	}
252 	spin_unlock(&port->phy_list_lock);
253 	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
254 
255 	return;
256 }
257 
258 /* ---------- SAS port events ---------- */
259 
260 void sas_porte_bytes_dmaed(struct work_struct *work)
261 {
262 	struct asd_sas_event *ev = to_asd_sas_event(work);
263 	struct asd_sas_phy *phy = ev->phy;
264 
265 	sas_form_port(phy);
266 }
267 
268 void sas_porte_broadcast_rcvd(struct work_struct *work)
269 {
270 	struct asd_sas_event *ev = to_asd_sas_event(work);
271 	struct asd_sas_phy *phy = ev->phy;
272 	unsigned long flags;
273 	u32 prim;
274 
275 	spin_lock_irqsave(&phy->sas_prim_lock, flags);
276 	prim = phy->sas_prim;
277 	spin_unlock_irqrestore(&phy->sas_prim_lock, flags);
278 
279 	SAS_DPRINTK("broadcast received: %d\n", prim);
280 	sas_discover_event(phy->port, DISCE_REVALIDATE_DOMAIN);
281 
282 	if (phy->port)
283 		flush_workqueue(phy->port->ha->disco_q);
284 }
285 
286 void sas_porte_link_reset_err(struct work_struct *work)
287 {
288 	struct asd_sas_event *ev = to_asd_sas_event(work);
289 	struct asd_sas_phy *phy = ev->phy;
290 
291 	sas_deform_port(phy, 1);
292 }
293 
294 void sas_porte_timer_event(struct work_struct *work)
295 {
296 	struct asd_sas_event *ev = to_asd_sas_event(work);
297 	struct asd_sas_phy *phy = ev->phy;
298 
299 	sas_deform_port(phy, 1);
300 }
301 
302 void sas_porte_hard_reset(struct work_struct *work)
303 {
304 	struct asd_sas_event *ev = to_asd_sas_event(work);
305 	struct asd_sas_phy *phy = ev->phy;
306 
307 	sas_deform_port(phy, 1);
308 }
309 
310 /* ---------- SAS port registration ---------- */
311 
312 static void sas_init_port(struct asd_sas_port *port,
313 			  struct sas_ha_struct *sas_ha, int i)
314 {
315 	memset(port, 0, sizeof(*port));
316 	port->id = i;
317 	INIT_LIST_HEAD(&port->dev_list);
318 	INIT_LIST_HEAD(&port->disco_list);
319 	INIT_LIST_HEAD(&port->destroy_list);
320 	spin_lock_init(&port->phy_list_lock);
321 	INIT_LIST_HEAD(&port->phy_list);
322 	port->ha = sas_ha;
323 
324 	spin_lock_init(&port->dev_list_lock);
325 }
326 
327 int sas_register_ports(struct sas_ha_struct *sas_ha)
328 {
329 	int i;
330 
331 	/* initialize the ports and discovery */
332 	for (i = 0; i < sas_ha->num_phys; i++) {
333 		struct asd_sas_port *port = sas_ha->sas_port[i];
334 
335 		sas_init_port(port, sas_ha, i);
336 		sas_init_disc(&port->disc, port);
337 	}
338 	return 0;
339 }
340 
341 void sas_unregister_ports(struct sas_ha_struct *sas_ha)
342 {
343 	int i;
344 
345 	for (i = 0; i < sas_ha->num_phys; i++)
346 		if (sas_ha->sas_phy[i]->port)
347 			sas_deform_port(sas_ha->sas_phy[i], 0);
348 
349 }
350 
351 const work_func_t sas_port_event_fns[PORT_NUM_EVENTS] = {
352 	[PORTE_BYTES_DMAED] = sas_porte_bytes_dmaed,
353 	[PORTE_BROADCAST_RCVD] = sas_porte_broadcast_rcvd,
354 	[PORTE_LINK_RESET_ERR] = sas_porte_link_reset_err,
355 	[PORTE_TIMER_EVENT] = sas_porte_timer_event,
356 	[PORTE_HARD_RESET] = sas_porte_hard_reset,
357 };
358