xref: /openbmc/linux/drivers/scsi/libsas/sas_init.c (revision 93dc544c)
1 /*
2  * Serial Attached SCSI (SAS) Transport Layer initialization
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22  * USA
23  *
24  */
25 
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/device.h>
29 #include <linux/spinlock.h>
30 #include <scsi/scsi_host.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_transport.h>
33 #include <scsi/scsi_transport_sas.h>
34 
35 #include "sas_internal.h"
36 
37 #include "../scsi_sas_internal.h"
38 
39 struct kmem_cache *sas_task_cache;
40 
41 /*------------ SAS addr hash -----------*/
42 void sas_hash_addr(u8 *hashed, const u8 *sas_addr)
43 {
44         const u32 poly = 0x00DB2777;
45         u32     r = 0;
46         int     i;
47 
48         for (i = 0; i < 8; i++) {
49                 int b;
50                 for (b = 7; b >= 0; b--) {
51                         r <<= 1;
52                         if ((1 << b) & sas_addr[i]) {
53                                 if (!(r & 0x01000000))
54                                         r ^= poly;
55                         } else if (r & 0x01000000)
56                                 r ^= poly;
57                 }
58         }
59 
60         hashed[0] = (r >> 16) & 0xFF;
61         hashed[1] = (r >> 8) & 0xFF ;
62         hashed[2] = r & 0xFF;
63 }
64 
65 
66 /* ---------- HA events ---------- */
67 
68 void sas_hae_reset(struct work_struct *work)
69 {
70 	struct sas_ha_event *ev =
71 		container_of(work, struct sas_ha_event, work);
72 	struct sas_ha_struct *ha = ev->ha;
73 
74 	sas_begin_event(HAE_RESET, &ha->event_lock,
75 			&ha->pending);
76 }
77 
78 int sas_register_ha(struct sas_ha_struct *sas_ha)
79 {
80 	int error = 0;
81 
82 	spin_lock_init(&sas_ha->phy_port_lock);
83 	sas_hash_addr(sas_ha->hashed_sas_addr, sas_ha->sas_addr);
84 
85 	if (sas_ha->lldd_queue_size == 0)
86 		sas_ha->lldd_queue_size = 1;
87 	else if (sas_ha->lldd_queue_size == -1)
88 		sas_ha->lldd_queue_size = 128; /* Sanity */
89 
90 	sas_ha->state = SAS_HA_REGISTERED;
91 	spin_lock_init(&sas_ha->state_lock);
92 
93 	error = sas_register_phys(sas_ha);
94 	if (error) {
95 		printk(KERN_NOTICE "couldn't register sas phys:%d\n", error);
96 		return error;
97 	}
98 
99 	error = sas_register_ports(sas_ha);
100 	if (error) {
101 		printk(KERN_NOTICE "couldn't register sas ports:%d\n", error);
102 		goto Undo_phys;
103 	}
104 
105 	error = sas_init_events(sas_ha);
106 	if (error) {
107 		printk(KERN_NOTICE "couldn't start event thread:%d\n", error);
108 		goto Undo_ports;
109 	}
110 
111 	if (sas_ha->lldd_max_execute_num > 1) {
112 		error = sas_init_queue(sas_ha);
113 		if (error) {
114 			printk(KERN_NOTICE "couldn't start queue thread:%d, "
115 			       "running in direct mode\n", error);
116 			sas_ha->lldd_max_execute_num = 1;
117 		}
118 	}
119 
120 	INIT_LIST_HEAD(&sas_ha->eh_done_q);
121 
122 	return 0;
123 
124 Undo_ports:
125 	sas_unregister_ports(sas_ha);
126 Undo_phys:
127 
128 	return error;
129 }
130 
131 int sas_unregister_ha(struct sas_ha_struct *sas_ha)
132 {
133 	unsigned long flags;
134 
135 	/* Set the state to unregistered to avoid further
136 	 * events to be queued */
137 	spin_lock_irqsave(&sas_ha->state_lock, flags);
138 	sas_ha->state = SAS_HA_UNREGISTERED;
139 	spin_unlock_irqrestore(&sas_ha->state_lock, flags);
140 	scsi_flush_work(sas_ha->core.shost);
141 
142 	sas_unregister_ports(sas_ha);
143 
144 	if (sas_ha->lldd_max_execute_num > 1) {
145 		sas_shutdown_queue(sas_ha);
146 		sas_ha->lldd_max_execute_num = 1;
147 	}
148 
149 	return 0;
150 }
151 
152 static int sas_get_linkerrors(struct sas_phy *phy)
153 {
154 	if (scsi_is_sas_phy_local(phy))
155 		/* FIXME: we have no local phy stats
156 		 * gathering at this time */
157 		return -EINVAL;
158 
159 	return sas_smp_get_phy_events(phy);
160 }
161 
162 int sas_phy_enable(struct sas_phy *phy, int enable)
163 {
164 	int ret;
165 	enum phy_func command;
166 
167 	if (enable)
168 		command = PHY_FUNC_LINK_RESET;
169 	else
170 		command = PHY_FUNC_DISABLE;
171 
172 	if (scsi_is_sas_phy_local(phy)) {
173 		struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
174 		struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
175 		struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
176 		struct sas_internal *i =
177 			to_sas_internal(sas_ha->core.shost->transportt);
178 
179 		if (!enable) {
180 			sas_phy_disconnected(asd_phy);
181 			sas_ha->notify_phy_event(asd_phy, PHYE_LOSS_OF_SIGNAL);
182 		}
183 		ret = i->dft->lldd_control_phy(asd_phy, command, NULL);
184 	} else {
185 		struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
186 		struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
187 		ret = sas_smp_phy_control(ddev, phy->number, command, NULL);
188 	}
189 	return ret;
190 }
191 
192 int sas_phy_reset(struct sas_phy *phy, int hard_reset)
193 {
194 	int ret;
195 	enum phy_func reset_type;
196 
197 	if (hard_reset)
198 		reset_type = PHY_FUNC_HARD_RESET;
199 	else
200 		reset_type = PHY_FUNC_LINK_RESET;
201 
202 	if (scsi_is_sas_phy_local(phy)) {
203 		struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
204 		struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
205 		struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
206 		struct sas_internal *i =
207 			to_sas_internal(sas_ha->core.shost->transportt);
208 
209 		ret = i->dft->lldd_control_phy(asd_phy, reset_type, NULL);
210 	} else {
211 		struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
212 		struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
213 		ret = sas_smp_phy_control(ddev, phy->number, reset_type, NULL);
214 	}
215 	return ret;
216 }
217 
218 int sas_set_phy_speed(struct sas_phy *phy,
219 		      struct sas_phy_linkrates *rates)
220 {
221 	int ret;
222 
223 	if ((rates->minimum_linkrate &&
224 	     rates->minimum_linkrate > phy->maximum_linkrate) ||
225 	    (rates->maximum_linkrate &&
226 	     rates->maximum_linkrate < phy->minimum_linkrate))
227 		return -EINVAL;
228 
229 	if (rates->minimum_linkrate &&
230 	    rates->minimum_linkrate < phy->minimum_linkrate_hw)
231 		rates->minimum_linkrate = phy->minimum_linkrate_hw;
232 
233 	if (rates->maximum_linkrate &&
234 	    rates->maximum_linkrate > phy->maximum_linkrate_hw)
235 		rates->maximum_linkrate = phy->maximum_linkrate_hw;
236 
237 	if (scsi_is_sas_phy_local(phy)) {
238 		struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
239 		struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
240 		struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
241 		struct sas_internal *i =
242 			to_sas_internal(sas_ha->core.shost->transportt);
243 
244 		ret = i->dft->lldd_control_phy(asd_phy, PHY_FUNC_SET_LINK_RATE,
245 					       rates);
246 	} else {
247 		struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
248 		struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
249 		ret = sas_smp_phy_control(ddev, phy->number,
250 					  PHY_FUNC_LINK_RESET, rates);
251 
252 	}
253 
254 	return ret;
255 }
256 
257 static struct sas_function_template sft = {
258 	.phy_enable = sas_phy_enable,
259 	.phy_reset = sas_phy_reset,
260 	.set_phy_speed = sas_set_phy_speed,
261 	.get_linkerrors = sas_get_linkerrors,
262 	.smp_handler = sas_smp_handler,
263 };
264 
265 struct scsi_transport_template *
266 sas_domain_attach_transport(struct sas_domain_function_template *dft)
267 {
268 	struct scsi_transport_template *stt = sas_attach_transport(&sft);
269 	struct sas_internal *i;
270 
271 	if (!stt)
272 		return stt;
273 
274 	i = to_sas_internal(stt);
275 	i->dft = dft;
276 	stt->create_work_queue = 1;
277 	stt->eh_timed_out = sas_scsi_timed_out;
278 	stt->eh_strategy_handler = sas_scsi_recover_host;
279 
280 	return stt;
281 }
282 EXPORT_SYMBOL_GPL(sas_domain_attach_transport);
283 
284 
285 void sas_domain_release_transport(struct scsi_transport_template *stt)
286 {
287 	sas_release_transport(stt);
288 }
289 EXPORT_SYMBOL_GPL(sas_domain_release_transport);
290 
291 /* ---------- SAS Class register/unregister ---------- */
292 
293 static int __init sas_class_init(void)
294 {
295 	sas_task_cache = kmem_cache_create("sas_task", sizeof(struct sas_task),
296 					   0, SLAB_HWCACHE_ALIGN, NULL);
297 	if (!sas_task_cache)
298 		return -ENOMEM;
299 
300 	return 0;
301 }
302 
303 static void __exit sas_class_exit(void)
304 {
305 	kmem_cache_destroy(sas_task_cache);
306 }
307 
308 MODULE_AUTHOR("Luben Tuikov <luben_tuikov@adaptec.com>");
309 MODULE_DESCRIPTION("SAS Transport Layer");
310 MODULE_LICENSE("GPL v2");
311 
312 module_init(sas_class_init);
313 module_exit(sas_class_exit);
314 
315 EXPORT_SYMBOL_GPL(sas_register_ha);
316 EXPORT_SYMBOL_GPL(sas_unregister_ha);
317