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)
163 /* Set the state to unregistered to avoid further unchained
164 * events to be queued, and flush any in-progress drainers
166 mutex_lock(&sas_ha->drain_mutex);
167 spin_lock_irq(&sas_ha->state_lock);
168 clear_bit(SAS_HA_REGISTERED, &sas_ha->state);
169 spin_unlock_irq(&sas_ha->state_lock);
170 __sas_drain_work(sas_ha);
171 mutex_unlock(&sas_ha->drain_mutex);
173 sas_unregister_ports(sas_ha);
175 /* flush unregistration work */
176 mutex_lock(&sas_ha->drain_mutex);
177 __sas_drain_work(sas_ha);
178 mutex_unlock(&sas_ha->drain_mutex);
180 if (sas_ha->lldd_max_execute_num > 1) {
181 sas_shutdown_queue(sas_ha);
182 sas_ha->lldd_max_execute_num = 1;
188 static int sas_get_linkerrors(struct sas_phy *phy)
190 if (scsi_is_sas_phy_local(phy)) {
191 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
192 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
193 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
194 struct sas_internal *i =
195 to_sas_internal(sas_ha->core.shost->transportt);
197 return i->dft->lldd_control_phy(asd_phy, PHY_FUNC_GET_EVENTS, NULL);
200 return sas_smp_get_phy_events(phy);
203 int sas_try_ata_reset(struct asd_sas_phy *asd_phy)
205 struct domain_device *dev = NULL;
207 /* try to route user requested link resets through libata */
209 dev = asd_phy->port->port_dev;
211 /* validate that dev has been probed */
213 dev = sas_find_dev_by_rphy(dev->rphy);
215 if (dev && dev_is_sata(dev)) {
216 sas_ata_schedule_reset(dev);
217 sas_ata_wait_eh(dev);
225 * transport_sas_phy_reset - reset a phy and permit libata to manage the link
227 * phy reset request via sysfs in host workqueue context so we know we
228 * can block on eh and safely traverse the domain_device topology
230 static int transport_sas_phy_reset(struct sas_phy *phy, int hard_reset)
232 enum phy_func reset_type;
235 reset_type = PHY_FUNC_HARD_RESET;
237 reset_type = PHY_FUNC_LINK_RESET;
239 if (scsi_is_sas_phy_local(phy)) {
240 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
241 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
242 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
243 struct sas_internal *i =
244 to_sas_internal(sas_ha->core.shost->transportt);
246 if (!hard_reset && sas_try_ata_reset(asd_phy) == 0)
248 return i->dft->lldd_control_phy(asd_phy, reset_type, NULL);
250 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
251 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
252 struct domain_device *ata_dev = sas_ex_to_ata(ddev, phy->number);
254 if (ata_dev && !hard_reset) {
255 sas_ata_schedule_reset(ata_dev);
256 sas_ata_wait_eh(ata_dev);
259 return sas_smp_phy_control(ddev, phy->number, reset_type, NULL);
263 static int sas_phy_enable(struct sas_phy *phy, int enable)
269 cmd = PHY_FUNC_LINK_RESET;
271 cmd = PHY_FUNC_DISABLE;
273 if (scsi_is_sas_phy_local(phy)) {
274 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
275 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
276 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
277 struct sas_internal *i =
278 to_sas_internal(sas_ha->core.shost->transportt);
281 ret = transport_sas_phy_reset(phy, 0);
283 ret = i->dft->lldd_control_phy(asd_phy, cmd, NULL);
285 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
286 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
289 ret = transport_sas_phy_reset(phy, 0);
291 ret = sas_smp_phy_control(ddev, phy->number, cmd, NULL);
296 int sas_phy_reset(struct sas_phy *phy, int hard_reset)
299 enum phy_func reset_type;
305 reset_type = PHY_FUNC_HARD_RESET;
307 reset_type = PHY_FUNC_LINK_RESET;
309 if (scsi_is_sas_phy_local(phy)) {
310 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
311 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
312 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
313 struct sas_internal *i =
314 to_sas_internal(sas_ha->core.shost->transportt);
316 ret = i->dft->lldd_control_phy(asd_phy, reset_type, NULL);
318 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
319 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
320 ret = sas_smp_phy_control(ddev, phy->number, reset_type, NULL);
325 int sas_set_phy_speed(struct sas_phy *phy,
326 struct sas_phy_linkrates *rates)
330 if ((rates->minimum_linkrate &&
331 rates->minimum_linkrate > phy->maximum_linkrate) ||
332 (rates->maximum_linkrate &&
333 rates->maximum_linkrate < phy->minimum_linkrate))
336 if (rates->minimum_linkrate &&
337 rates->minimum_linkrate < phy->minimum_linkrate_hw)
338 rates->minimum_linkrate = phy->minimum_linkrate_hw;
340 if (rates->maximum_linkrate &&
341 rates->maximum_linkrate > phy->maximum_linkrate_hw)
342 rates->maximum_linkrate = phy->maximum_linkrate_hw;
344 if (scsi_is_sas_phy_local(phy)) {
345 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
346 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
347 struct asd_sas_phy *asd_phy = sas_ha->sas_phy[phy->number];
348 struct sas_internal *i =
349 to_sas_internal(sas_ha->core.shost->transportt);
351 ret = i->dft->lldd_control_phy(asd_phy, PHY_FUNC_SET_LINK_RATE,
354 struct sas_rphy *rphy = dev_to_rphy(phy->dev.parent);
355 struct domain_device *ddev = sas_find_dev_by_rphy(rphy);
356 ret = sas_smp_phy_control(ddev, phy->number,
357 PHY_FUNC_LINK_RESET, rates);
364 static void sas_phy_release(struct sas_phy *phy)
366 kfree(phy->hostdata);
367 phy->hostdata = NULL;
370 static void phy_reset_work(struct work_struct *work)
372 struct sas_phy_data *d = container_of(work, typeof(*d), reset_work);
374 d->reset_result = transport_sas_phy_reset(d->phy, d->hard_reset);
377 static void phy_enable_work(struct work_struct *work)
379 struct sas_phy_data *d = container_of(work, typeof(*d), enable_work);
381 d->enable_result = sas_phy_enable(d->phy, d->enable);
384 static int sas_phy_setup(struct sas_phy *phy)
386 struct sas_phy_data *d = kzalloc(sizeof(*d), GFP_KERNEL);
391 mutex_init(&d->event_lock);
392 INIT_WORK(&d->reset_work, phy_reset_work);
393 INIT_WORK(&d->enable_work, phy_enable_work);
400 static int queue_phy_reset(struct sas_phy *phy, int hard_reset)
402 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
403 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
404 struct sas_phy_data *d = phy->hostdata;
410 /* libsas workqueue coordinates ata-eh reset with discovery */
411 mutex_lock(&d->event_lock);
413 d->hard_reset = hard_reset;
415 spin_lock_irq(&ha->state_lock);
416 sas_queue_work(ha, &d->reset_work);
417 spin_unlock_irq(&ha->state_lock);
419 rc = sas_drain_work(ha);
421 rc = d->reset_result;
422 mutex_unlock(&d->event_lock);
427 static int queue_phy_enable(struct sas_phy *phy, int enable)
429 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
430 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
431 struct sas_phy_data *d = phy->hostdata;
437 /* libsas workqueue coordinates ata-eh reset with discovery */
438 mutex_lock(&d->event_lock);
439 d->enable_result = 0;
442 spin_lock_irq(&ha->state_lock);
443 sas_queue_work(ha, &d->enable_work);
444 spin_unlock_irq(&ha->state_lock);
446 rc = sas_drain_work(ha);
448 rc = d->enable_result;
449 mutex_unlock(&d->event_lock);
454 static struct sas_function_template sft = {
455 .phy_enable = queue_phy_enable,
456 .phy_reset = queue_phy_reset,
457 .phy_setup = sas_phy_setup,
458 .phy_release = sas_phy_release,
459 .set_phy_speed = sas_set_phy_speed,
460 .get_linkerrors = sas_get_linkerrors,
461 .smp_handler = sas_smp_handler,
464 struct scsi_transport_template *
465 sas_domain_attach_transport(struct sas_domain_function_template *dft)
467 struct scsi_transport_template *stt = sas_attach_transport(&sft);
468 struct sas_internal *i;
473 i = to_sas_internal(stt);
475 stt->create_work_queue = 1;
476 stt->eh_timed_out = sas_scsi_timed_out;
477 stt->eh_strategy_handler = sas_scsi_recover_host;
481 EXPORT_SYMBOL_GPL(sas_domain_attach_transport);
484 void sas_domain_release_transport(struct scsi_transport_template *stt)
486 sas_release_transport(stt);
488 EXPORT_SYMBOL_GPL(sas_domain_release_transport);
490 /* ---------- SAS Class register/unregister ---------- */
492 static int __init sas_class_init(void)
494 sas_task_cache = KMEM_CACHE(sas_task, SLAB_HWCACHE_ALIGN);
501 static void __exit sas_class_exit(void)
503 kmem_cache_destroy(sas_task_cache);
506 MODULE_AUTHOR("Luben Tuikov <luben_tuikov@adaptec.com>");
507 MODULE_DESCRIPTION("SAS Transport Layer");
508 MODULE_LICENSE("GPL v2");
510 module_init(sas_class_init);
511 module_exit(sas_class_exit);
513 EXPORT_SYMBOL_GPL(sas_register_ha);
514 EXPORT_SYMBOL_GPL(sas_unregister_ha);