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