[SCSI] libsas: unify domain_device sas_rphy lifetimes
[linux-2.6.git] / drivers / scsi / libsas / sas_discover.c
blob13b5891f996172d9a8b782c356090d3679d3aedb
1 /*
2 * Serial Attached SCSI (SAS) Discover process
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <linux/scatterlist.h>
26 #include <linux/slab.h>
27 #include <scsi/scsi_host.h>
28 #include <scsi/scsi_eh.h>
29 #include "sas_internal.h"
31 #include <scsi/scsi_transport.h>
32 #include <scsi/scsi_transport_sas.h>
33 #include <scsi/sas_ata.h>
34 #include "../scsi_sas_internal.h"
36 /* ---------- Basic task processing for discovery purposes ---------- */
38 void sas_init_dev(struct domain_device *dev)
40 switch (dev->dev_type) {
41 case SAS_END_DEV:
42 break;
43 case EDGE_DEV:
44 case FANOUT_DEV:
45 INIT_LIST_HEAD(&dev->ex_dev.children);
46 mutex_init(&dev->ex_dev.cmd_mutex);
47 break;
48 case SATA_DEV:
49 case SATA_PM:
50 case SATA_PM_PORT:
51 case SATA_PENDING:
52 INIT_LIST_HEAD(&dev->sata_dev.children);
53 break;
54 default:
55 break;
59 /* ---------- Domain device discovery ---------- */
61 /**
62 * sas_get_port_device -- Discover devices which caused port creation
63 * @port: pointer to struct sas_port of interest
65 * Devices directly attached to a HA port, have no parent. This is
66 * how we know they are (domain) "root" devices. All other devices
67 * do, and should have their "parent" pointer set appropriately as
68 * soon as a child device is discovered.
70 static int sas_get_port_device(struct asd_sas_port *port)
72 struct asd_sas_phy *phy;
73 struct sas_rphy *rphy;
74 struct domain_device *dev;
76 dev = sas_alloc_device();
77 if (!dev)
78 return -ENOMEM;
80 spin_lock_irq(&port->phy_list_lock);
81 if (list_empty(&port->phy_list)) {
82 spin_unlock_irq(&port->phy_list_lock);
83 sas_put_device(dev);
84 return -ENODEV;
86 phy = container_of(port->phy_list.next, struct asd_sas_phy, port_phy_el);
87 spin_lock(&phy->frame_rcvd_lock);
88 memcpy(dev->frame_rcvd, phy->frame_rcvd, min(sizeof(dev->frame_rcvd),
89 (size_t)phy->frame_rcvd_size));
90 spin_unlock(&phy->frame_rcvd_lock);
91 spin_unlock_irq(&port->phy_list_lock);
93 if (dev->frame_rcvd[0] == 0x34 && port->oob_mode == SATA_OOB_MODE) {
94 struct dev_to_host_fis *fis =
95 (struct dev_to_host_fis *) dev->frame_rcvd;
96 if (fis->interrupt_reason == 1 && fis->lbal == 1 &&
97 fis->byte_count_low==0x69 && fis->byte_count_high == 0x96
98 && (fis->device & ~0x10) == 0)
99 dev->dev_type = SATA_PM;
100 else
101 dev->dev_type = SATA_DEV;
102 dev->tproto = SAS_PROTOCOL_SATA;
103 } else {
104 struct sas_identify_frame *id =
105 (struct sas_identify_frame *) dev->frame_rcvd;
106 dev->dev_type = id->dev_type;
107 dev->iproto = id->initiator_bits;
108 dev->tproto = id->target_bits;
111 sas_init_dev(dev);
113 switch (dev->dev_type) {
114 case SAS_END_DEV:
115 case SATA_DEV:
116 rphy = sas_end_device_alloc(port->port);
117 break;
118 case EDGE_DEV:
119 rphy = sas_expander_alloc(port->port,
120 SAS_EDGE_EXPANDER_DEVICE);
121 break;
122 case FANOUT_DEV:
123 rphy = sas_expander_alloc(port->port,
124 SAS_FANOUT_EXPANDER_DEVICE);
125 break;
126 default:
127 printk("ERROR: Unidentified device type %d\n", dev->dev_type);
128 rphy = NULL;
129 break;
132 if (!rphy) {
133 sas_put_device(dev);
134 return -ENODEV;
137 rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
138 memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
139 sas_fill_in_rphy(dev, rphy);
140 sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
141 port->port_dev = dev;
142 dev->port = port;
143 dev->linkrate = port->linkrate;
144 dev->min_linkrate = port->linkrate;
145 dev->max_linkrate = port->linkrate;
146 dev->pathways = port->num_phys;
147 memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
148 memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
149 memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
150 port->disc.max_level = 0;
151 sas_device_set_phy(dev, port->port);
153 dev->rphy = rphy;
154 get_device(&dev->rphy->dev);
156 if (dev_is_sata(dev) || dev->dev_type == SAS_END_DEV)
157 list_add_tail(&dev->disco_list_node, &port->disco_list);
158 else {
159 spin_lock_irq(&port->dev_list_lock);
160 list_add_tail(&dev->dev_list_node, &port->dev_list);
161 spin_unlock_irq(&port->dev_list_lock);
164 spin_lock_irq(&port->phy_list_lock);
165 list_for_each_entry(phy, &port->phy_list, port_phy_el)
166 sas_phy_set_target(phy, dev);
167 spin_unlock_irq(&port->phy_list_lock);
169 return 0;
172 /* ---------- Discover and Revalidate ---------- */
174 int sas_notify_lldd_dev_found(struct domain_device *dev)
176 int res = 0;
177 struct sas_ha_struct *sas_ha = dev->port->ha;
178 struct Scsi_Host *shost = sas_ha->core.shost;
179 struct sas_internal *i = to_sas_internal(shost->transportt);
181 if (i->dft->lldd_dev_found) {
182 res = i->dft->lldd_dev_found(dev);
183 if (res) {
184 printk("sas: driver on pcidev %s cannot handle "
185 "device %llx, error:%d\n",
186 dev_name(sas_ha->dev),
187 SAS_ADDR(dev->sas_addr), res);
189 kref_get(&dev->kref);
191 return res;
195 void sas_notify_lldd_dev_gone(struct domain_device *dev)
197 struct sas_ha_struct *sas_ha = dev->port->ha;
198 struct Scsi_Host *shost = sas_ha->core.shost;
199 struct sas_internal *i = to_sas_internal(shost->transportt);
201 if (i->dft->lldd_dev_gone) {
202 i->dft->lldd_dev_gone(dev);
203 sas_put_device(dev);
207 static void sas_probe_devices(struct work_struct *work)
209 struct domain_device *dev, *n;
210 struct sas_discovery_event *ev = to_sas_discovery_event(work);
211 struct asd_sas_port *port = ev->port;
213 clear_bit(DISCE_PROBE, &port->disc.pending);
215 /* devices must be domain members before link recovery and probe */
216 list_for_each_entry(dev, &port->disco_list, disco_list_node) {
217 spin_lock_irq(&port->dev_list_lock);
218 list_add_tail(&dev->dev_list_node, &port->dev_list);
219 spin_unlock_irq(&port->dev_list_lock);
222 sas_probe_sata(port);
224 list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node) {
225 int err;
227 err = sas_rphy_add(dev->rphy);
228 if (err)
229 sas_fail_probe(dev, __func__, err);
230 else
231 list_del_init(&dev->disco_list_node);
236 * sas_discover_end_dev -- discover an end device (SSP, etc)
237 * @end: pointer to domain device of interest
239 * See comment in sas_discover_sata().
241 int sas_discover_end_dev(struct domain_device *dev)
243 int res;
245 res = sas_notify_lldd_dev_found(dev);
246 if (res)
247 return res;
248 sas_discover_event(dev->port, DISCE_PROBE);
250 return 0;
253 /* ---------- Device registration and unregistration ---------- */
255 void sas_free_device(struct kref *kref)
257 struct domain_device *dev = container_of(kref, typeof(*dev), kref);
259 put_device(&dev->rphy->dev);
260 dev->rphy = NULL;
262 if (dev->parent)
263 sas_put_device(dev->parent);
265 sas_port_put_phy(dev->phy);
266 dev->phy = NULL;
268 /* remove the phys and ports, everything else should be gone */
269 if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
270 kfree(dev->ex_dev.ex_phy);
272 if (dev_is_sata(dev) && dev->sata_dev.ap) {
273 ata_sas_port_destroy(dev->sata_dev.ap);
274 dev->sata_dev.ap = NULL;
277 kfree(dev);
280 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
282 sas_notify_lldd_dev_gone(dev);
283 if (!dev->parent)
284 dev->port->port_dev = NULL;
285 else
286 list_del_init(&dev->siblings);
288 spin_lock_irq(&port->dev_list_lock);
289 list_del_init(&dev->dev_list_node);
290 spin_unlock_irq(&port->dev_list_lock);
292 sas_put_device(dev);
295 static void sas_destruct_devices(struct work_struct *work)
297 struct domain_device *dev, *n;
298 struct sas_discovery_event *ev = to_sas_discovery_event(work);
299 struct asd_sas_port *port = ev->port;
301 clear_bit(DISCE_DESTRUCT, &port->disc.pending);
303 list_for_each_entry_safe(dev, n, &port->destroy_list, disco_list_node) {
304 list_del_init(&dev->disco_list_node);
306 sas_remove_children(&dev->rphy->dev);
307 sas_rphy_delete(dev->rphy);
308 sas_unregister_common_dev(port, dev);
312 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
314 if (!test_bit(SAS_DEV_DESTROY, &dev->state) &&
315 !list_empty(&dev->disco_list_node)) {
316 /* this rphy never saw sas_rphy_add */
317 list_del_init(&dev->disco_list_node);
318 sas_rphy_free(dev->rphy);
319 sas_unregister_common_dev(port, dev);
320 return;
323 if (!test_and_set_bit(SAS_DEV_DESTROY, &dev->state)) {
324 sas_rphy_unlink(dev->rphy);
325 list_move_tail(&dev->disco_list_node, &port->destroy_list);
326 sas_discover_event(dev->port, DISCE_DESTRUCT);
330 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone)
332 struct domain_device *dev, *n;
334 list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node) {
335 if (gone)
336 set_bit(SAS_DEV_GONE, &dev->state);
337 sas_unregister_dev(port, dev);
340 list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node)
341 sas_unregister_dev(port, dev);
343 port->port->rphy = NULL;
347 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port)
349 struct sas_ha_struct *ha;
350 struct sas_phy *new_phy;
352 if (!dev)
353 return;
355 ha = dev->port->ha;
356 new_phy = sas_port_get_phy(port);
358 /* pin and record last seen phy */
359 spin_lock_irq(&ha->phy_port_lock);
360 if (new_phy) {
361 sas_port_put_phy(dev->phy);
362 dev->phy = new_phy;
364 spin_unlock_irq(&ha->phy_port_lock);
367 /* ---------- Discovery and Revalidation ---------- */
370 * sas_discover_domain -- discover the domain
371 * @port: port to the domain of interest
373 * NOTE: this process _must_ quit (return) as soon as any connection
374 * errors are encountered. Connection recovery is done elsewhere.
375 * Discover process only interrogates devices in order to discover the
376 * domain.
378 static void sas_discover_domain(struct work_struct *work)
380 struct domain_device *dev;
381 int error = 0;
382 struct sas_discovery_event *ev = to_sas_discovery_event(work);
383 struct asd_sas_port *port = ev->port;
385 clear_bit(DISCE_DISCOVER_DOMAIN, &port->disc.pending);
387 if (port->port_dev)
388 return;
390 error = sas_get_port_device(port);
391 if (error)
392 return;
393 dev = port->port_dev;
395 SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
396 task_pid_nr(current));
398 switch (dev->dev_type) {
399 case SAS_END_DEV:
400 error = sas_discover_end_dev(dev);
401 break;
402 case EDGE_DEV:
403 case FANOUT_DEV:
404 error = sas_discover_root_expander(dev);
405 break;
406 case SATA_DEV:
407 case SATA_PM:
408 #ifdef CONFIG_SCSI_SAS_ATA
409 error = sas_discover_sata(dev);
410 break;
411 #else
412 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
413 /* Fall through */
414 #endif
415 default:
416 error = -ENXIO;
417 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
418 break;
421 if (error) {
422 sas_rphy_free(dev->rphy);
423 list_del_init(&dev->disco_list_node);
424 spin_lock_irq(&port->dev_list_lock);
425 list_del_init(&dev->dev_list_node);
426 spin_unlock_irq(&port->dev_list_lock);
428 sas_put_device(dev);
429 port->port_dev = NULL;
432 SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
433 task_pid_nr(current), error);
436 static void sas_revalidate_domain(struct work_struct *work)
438 int res = 0;
439 struct sas_discovery_event *ev = to_sas_discovery_event(work);
440 struct asd_sas_port *port = ev->port;
441 struct sas_ha_struct *ha = port->ha;
443 /* prevent revalidation from finding sata links in recovery */
444 mutex_lock(&ha->disco_mutex);
445 if (test_bit(SAS_HA_ATA_EH_ACTIVE, &ha->state)) {
446 SAS_DPRINTK("REVALIDATION DEFERRED on port %d, pid:%d\n",
447 port->id, task_pid_nr(current));
448 goto out;
451 clear_bit(DISCE_REVALIDATE_DOMAIN, &port->disc.pending);
453 SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
454 task_pid_nr(current));
456 if (port->port_dev)
457 res = sas_ex_revalidate_domain(port->port_dev);
459 SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
460 port->id, task_pid_nr(current), res);
461 out:
462 mutex_unlock(&ha->disco_mutex);
465 /* ---------- Events ---------- */
467 static void sas_chain_work(struct sas_ha_struct *ha, struct sas_work *sw)
469 /* chained work is not subject to SA_HA_DRAINING or
470 * SAS_HA_REGISTERED, because it is either submitted in the
471 * workqueue, or known to be submitted from a context that is
472 * not racing against draining
474 scsi_queue_work(ha->core.shost, &sw->work);
477 static void sas_chain_event(int event, unsigned long *pending,
478 struct sas_work *sw,
479 struct sas_ha_struct *ha)
481 if (!test_and_set_bit(event, pending)) {
482 unsigned long flags;
484 spin_lock_irqsave(&ha->state_lock, flags);
485 sas_chain_work(ha, sw);
486 spin_unlock_irqrestore(&ha->state_lock, flags);
490 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
492 struct sas_discovery *disc;
494 if (!port)
495 return 0;
496 disc = &port->disc;
498 BUG_ON(ev >= DISC_NUM_EVENTS);
500 sas_chain_event(ev, &disc->pending, &disc->disc_work[ev].work, port->ha);
502 return 0;
506 * sas_init_disc -- initialize the discovery struct in the port
507 * @port: pointer to struct port
509 * Called when the ports are being initialized.
511 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
513 int i;
515 static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
516 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
517 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
518 [DISCE_PROBE] = sas_probe_devices,
519 [DISCE_DESTRUCT] = sas_destruct_devices,
522 disc->pending = 0;
523 for (i = 0; i < DISC_NUM_EVENTS; i++) {
524 INIT_SAS_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
525 disc->disc_work[i].port = port;