2 * Serial Attached SCSI (SAS) Transport Layer initialization
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 * This file is licensed under GPLv2.
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.
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.
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
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/sas_ata.h>
32 #include <scsi/scsi_host.h>
33 #include <scsi/scsi_device.h>
34 #include <scsi/scsi_transport.h>
35 #include <scsi/scsi_transport_sas.h>
37 #include "sas_internal.h"
39 #include "../scsi_sas_internal.h"
41 static struct kmem_cache *sas_task_cache;
43 struct sas_task *sas_alloc_task(gfp_t flags)
45 struct sas_task *task = kmem_cache_zalloc(sas_task_cache, flags);
48 INIT_LIST_HEAD(&task->list);
49 spin_lock_init(&task->task_state_lock);
50 task->task_state_flags = SAS_TASK_STATE_PENDING;
51 init_timer(&task->timer);
52 init_completion(&task->completion);
57 EXPORT_SYMBOL_GPL(sas_alloc_task);
59 void sas_free_task(struct sas_task *task)
62 BUG_ON(!list_empty(&task->list));
63 kmem_cache_free(sas_task_cache, task);
66 EXPORT_SYMBOL_GPL(sas_free_task);
68 /*------------ SAS addr hash -----------*/
69 void sas_hash_addr(u8 *hashed, const u8 *sas_addr)
71 const u32 poly = 0x00DB2777;
75 for (i = 0; i < 8; i++) {
77 for (b = 7; b >= 0; b--) {
79 if ((1 << b) & sas_addr[i]) {
80 if (!(r & 0x01000000))
82 } else if (r & 0x01000000)
87 hashed[0] = (r >> 16) & 0xFF;
88 hashed[1] = (r >> 8) & 0xFF ;
93 /* ---------- HA events ---------- */
95 void sas_hae_reset(struct work_struct *work)
97 struct sas_ha_event *ev =
98 container_of(work, struct sas_ha_event, work);
99 struct sas_ha_struct *ha = ev->ha;
101 clear_bit(HAE_RESET, &ha->pending);
104 int sas_register_ha(struct sas_ha_struct *sas_ha)
108 mutex_init(&sas_ha->disco_mutex);
109 spin_lock_init(&sas_ha->phy_port_lock);
110 sas_hash_addr(sas_ha->hashed_sas_addr, sas_ha->sas_addr);
112 if (sas_ha->lldd_queue_size == 0)
113 sas_ha->lldd_queue_size = 1;
114 else if (sas_ha->lldd_queue_size == -1)
115 sas_ha->lldd_queue_size = 128; /* Sanity */
117 set_bit(SAS_HA_REGISTERED, &sas_ha->state);
118 spin_lock_init(&sas_ha->state_lock);
119 mutex_init(&sas_ha->drain_mutex);
120 INIT_LIST_HEAD(&sas_ha->defer_q);
122 error = sas_register_phys(sas_ha);
124 printk(KERN_NOTICE "couldn't register sas phys:%d\n", error);
128 error = sas_register_ports(sas_ha);
130 printk(KERN_NOTICE "couldn't register sas ports:%d\n", error);
134 error = sas_init_events(sas_ha);
136 printk(KERN_NOTICE "couldn't start event thread:%d\n", error);
140 if (sas_ha->lldd_max_execute_num > 1) {
141 error = sas_init_queue(sas_ha);
143 printk(KERN_NOTICE "couldn't start queue thread:%d, "
144 "running in direct mode\n", error);
145 sas_ha->lldd_max_execute_num = 1;
149 INIT_LIST_HEAD(&sas_ha->eh_done_q);
150 INIT_LIST_HEAD(&sas_ha->eh_ata_q);
155 sas_unregister_ports(sas_ha);
161 int sas_unregister_ha(struct sas_ha_struct *sas_ha)
165 /* Set the state to unregistered to avoid further unchained
166 * events to be queued
168 spin_lock_irqsave(&sas_ha->state_lock, flags);
169 clear_bit(SAS_HA_REGISTERED, &sas_ha->state);
170 spin_unlock_irqrestore(&sas_ha->state_lock, flags);
171 sas_drain_work(sas_ha);
173 sas_unregister_ports(sas_ha);
174 sas_drain_work(sas_ha);
176 if (sas_ha->lldd_max_execute_num > 1) {
177 sas_shutdown_queue(sas_ha);
178 sas_ha->lldd_max_execute_num = 1;
184 static int sas_get_linkerrors(struct sas_phy *phy)
186 if (scsi_is_sas_phy_local(phy)) {
187 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
188 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
189 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
190 struct sas_internal *i =
191 to_sas_internal(sas_ha->core.shost->transportt);
193 return i->dft->lldd_control_phy(asd_phy, PHY_FUNC_GET_EVENTS, NULL);
196 return sas_smp_get_phy_events(phy);
200 * transport_sas_phy_reset - reset a phy and permit libata to manage the link
202 * phy reset request via sysfs in host workqueue context so we know we
203 * can block on eh and safely traverse the domain_device topology
205 static int transport_sas_phy_reset(struct sas_phy *phy, int hard_reset)
208 enum phy_func reset_type;
211 reset_type = PHY_FUNC_HARD_RESET;
213 reset_type = PHY_FUNC_LINK_RESET;
215 if (scsi_is_sas_phy_local(phy)) {
216 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
217 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
218 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
219 struct sas_internal *i =
220 to_sas_internal(sas_ha->core.shost->transportt);
221 struct domain_device *dev = NULL;
224 dev = asd_phy->port->port_dev;
226 /* validate that dev has been probed */
228 dev = sas_find_dev_by_rphy(dev->rphy);
230 if (dev && dev_is_sata(dev) && !hard_reset) {
231 sas_ata_schedule_reset(dev);
232 sas_ata_wait_eh(dev);
235 ret = i->dft->lldd_control_phy(asd_phy, reset_type, NULL);
237 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
238 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
239 struct domain_device *ata_dev = sas_ex_to_ata(ddev, phy->number);
241 if (ata_dev && !hard_reset) {
242 sas_ata_schedule_reset(ata_dev);
243 sas_ata_wait_eh(ata_dev);
246 ret = sas_smp_phy_control(ddev, phy->number, reset_type, NULL);
252 static int sas_phy_enable(struct sas_phy *phy, int enable)
258 cmd = PHY_FUNC_LINK_RESET;
260 cmd = PHY_FUNC_DISABLE;
262 if (scsi_is_sas_phy_local(phy)) {
263 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
264 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
265 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
266 struct sas_internal *i =
267 to_sas_internal(sas_ha->core.shost->transportt);
270 ret = transport_sas_phy_reset(phy, 0);
272 ret = i->dft->lldd_control_phy(asd_phy, cmd, NULL);
274 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
275 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
278 ret = transport_sas_phy_reset(phy, 0);
280 ret = sas_smp_phy_control(ddev, phy->number, cmd, NULL);
285 int sas_phy_reset(struct sas_phy *phy, int hard_reset)
288 enum phy_func reset_type;
291 reset_type = PHY_FUNC_HARD_RESET;
293 reset_type = PHY_FUNC_LINK_RESET;
295 if (scsi_is_sas_phy_local(phy)) {
296 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
297 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
298 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
299 struct sas_internal *i =
300 to_sas_internal(sas_ha->core.shost->transportt);
302 ret = i->dft->lldd_control_phy(asd_phy, reset_type, NULL);
304 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
305 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
306 ret = sas_smp_phy_control(ddev, phy->number, reset_type, NULL);
311 int sas_set_phy_speed(struct sas_phy *phy,
312 struct sas_phy_linkrates *rates)
316 if ((rates->minimum_linkrate &&
317 rates->minimum_linkrate > phy->maximum_linkrate) ||
318 (rates->maximum_linkrate &&
319 rates->maximum_linkrate < phy->minimum_linkrate))
322 if (rates->minimum_linkrate &&
323 rates->minimum_linkrate < phy->minimum_linkrate_hw)
324 rates->minimum_linkrate = phy->minimum_linkrate_hw;
326 if (rates->maximum_linkrate &&
327 rates->maximum_linkrate > phy->maximum_linkrate_hw)
328 rates->maximum_linkrate = phy->maximum_linkrate_hw;
330 if (scsi_is_sas_phy_local(phy)) {
331 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
332 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
333 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
334 struct sas_internal *i =
335 to_sas_internal(sas_ha->core.shost->transportt);
337 ret = i->dft->lldd_control_phy(asd_phy, PHY_FUNC_SET_LINK_RATE,
340 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
341 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
342 ret = sas_smp_phy_control(ddev, phy->number,
343 PHY_FUNC_LINK_RESET, rates);
350 static void sas_phy_release(struct sas_phy *phy)
352 kfree(phy->hostdata);
353 phy->hostdata = NULL;
356 static void phy_reset_work(struct work_struct *work)
358 struct sas_phy_data *d = container_of(work, typeof(*d), reset_work);
360 d->reset_result = transport_sas_phy_reset(d->phy, d->hard_reset);
363 static void phy_enable_work(struct work_struct *work)
365 struct sas_phy_data *d = container_of(work, typeof(*d), enable_work);
367 d->enable_result = sas_phy_enable(d->phy, d->enable);
370 static int sas_phy_setup(struct sas_phy *phy)
372 struct sas_phy_data *d = kzalloc(sizeof(*d), GFP_KERNEL);
377 mutex_init(&d->event_lock);
378 INIT_WORK(&d->reset_work, phy_reset_work);
379 INIT_WORK(&d->enable_work, phy_enable_work);
386 static int queue_phy_reset(struct sas_phy *phy, int hard_reset)
388 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
389 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
390 struct sas_phy_data *d = phy->hostdata;
396 /* libsas workqueue coordinates ata-eh reset with discovery */
397 mutex_lock(&d->event_lock);
399 d->hard_reset = hard_reset;
401 spin_lock_irq(&ha->state_lock);
402 sas_queue_work(ha, &d->reset_work);
403 spin_unlock_irq(&ha->state_lock);
405 rc = sas_drain_work(ha);
407 rc = d->reset_result;
408 mutex_unlock(&d->event_lock);
413 static int queue_phy_enable(struct sas_phy *phy, int enable)
415 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
416 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
417 struct sas_phy_data *d = phy->hostdata;
423 /* libsas workqueue coordinates ata-eh reset with discovery */
424 mutex_lock(&d->event_lock);
425 d->enable_result = 0;
428 spin_lock_irq(&ha->state_lock);
429 sas_queue_work(ha, &d->enable_work);
430 spin_unlock_irq(&ha->state_lock);
432 rc = sas_drain_work(ha);
434 rc = d->enable_result;
435 mutex_unlock(&d->event_lock);
440 static struct sas_function_template sft = {
441 .phy_enable = queue_phy_enable,
442 .phy_reset = queue_phy_reset,
443 .phy_setup = sas_phy_setup,
444 .phy_release = sas_phy_release,
445 .set_phy_speed = sas_set_phy_speed,
446 .get_linkerrors = sas_get_linkerrors,
447 .smp_handler = sas_smp_handler,
450 struct scsi_transport_template *
451 sas_domain_attach_transport(struct sas_domain_function_template *dft)
453 struct scsi_transport_template *stt = sas_attach_transport(&sft);
454 struct sas_internal *i;
459 i = to_sas_internal(stt);
461 stt->create_work_queue = 1;
462 stt->eh_timed_out = sas_scsi_timed_out;
463 stt->eh_strategy_handler = sas_scsi_recover_host;
467 EXPORT_SYMBOL_GPL(sas_domain_attach_transport);
470 void sas_domain_release_transport(struct scsi_transport_template *stt)
472 sas_release_transport(stt);
474 EXPORT_SYMBOL_GPL(sas_domain_release_transport);
476 /* ---------- SAS Class register/unregister ---------- */
478 static int __init sas_class_init(void)
480 sas_task_cache = KMEM_CACHE(sas_task, SLAB_HWCACHE_ALIGN);
487 static void __exit sas_class_exit(void)
489 kmem_cache_destroy(sas_task_cache);
492 MODULE_AUTHOR("Luben Tuikov <luben_tuikov@adaptec.com>");
493 MODULE_DESCRIPTION("SAS Transport Layer");
494 MODULE_LICENSE("GPL v2");
496 module_init(sas_class_init);
497 module_exit(sas_class_exit);
499 EXPORT_SYMBOL_GPL(sas_register_ha);
500 EXPORT_SYMBOL_GPL(sas_unregister_ha);