[SCSI] libsas: add mutex for SMP task execution
[linux-2.6.git] / drivers / scsi / libsas / sas_discover.c
1 /*
2  * Serial Attached SCSI (SAS) Discover process
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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24
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"
30
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"
35
36 /* ---------- Basic task processing for discovery purposes ---------- */
37
38 void sas_init_dev(struct domain_device *dev)
39 {
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                 INIT_LIST_HEAD(&dev->sata_dev.children);
52                 break;
53         default:
54                 break;
55         }
56 }
57
58 /* ---------- Domain device discovery ---------- */
59
60 /**
61  * sas_get_port_device -- Discover devices which caused port creation
62  * @port: pointer to struct sas_port of interest
63  *
64  * Devices directly attached to a HA port, have no parent.  This is
65  * how we know they are (domain) "root" devices.  All other devices
66  * do, and should have their "parent" pointer set appropriately as
67  * soon as a child device is discovered.
68  */
69 static int sas_get_port_device(struct asd_sas_port *port)
70 {
71         unsigned long flags;
72         struct asd_sas_phy *phy;
73         struct sas_rphy *rphy;
74         struct domain_device *dev;
75
76         dev = sas_alloc_device();
77         if (!dev)
78                 return -ENOMEM;
79
80         spin_lock_irqsave(&port->phy_list_lock, flags);
81         if (list_empty(&port->phy_list)) {
82                 spin_unlock_irqrestore(&port->phy_list_lock, flags);
83                 sas_put_device(dev);
84                 return -ENODEV;
85         }
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_irqrestore(&port->phy_list_lock, flags);
92
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;
109         }
110
111         sas_init_dev(dev);
112
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;
130         }
131
132         if (!rphy) {
133                 sas_put_device(dev);
134                 return -ENODEV;
135         }
136         rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
137         memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
138         sas_fill_in_rphy(dev, rphy);
139         sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
140         port->port_dev = dev;
141         dev->port = port;
142         dev->linkrate = port->linkrate;
143         dev->min_linkrate = port->linkrate;
144         dev->max_linkrate = port->linkrate;
145         dev->pathways = port->num_phys;
146         memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
147         memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
148         memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
149         port->disc.max_level = 0;
150
151         dev->rphy = rphy;
152
153         if (dev_is_sata(dev))
154                 list_add_tail(&dev->disco_list_node, &port->disco_list);
155         else {
156                 spin_lock_irq(&port->dev_list_lock);
157                 list_add_tail(&dev->dev_list_node, &port->dev_list);
158                 spin_unlock_irq(&port->dev_list_lock);
159         }
160
161         return 0;
162 }
163
164 /* ---------- Discover and Revalidate ---------- */
165
166 int sas_notify_lldd_dev_found(struct domain_device *dev)
167 {
168         int res = 0;
169         struct sas_ha_struct *sas_ha = dev->port->ha;
170         struct Scsi_Host *shost = sas_ha->core.shost;
171         struct sas_internal *i = to_sas_internal(shost->transportt);
172
173         if (i->dft->lldd_dev_found) {
174                 res = i->dft->lldd_dev_found(dev);
175                 if (res) {
176                         printk("sas: driver on pcidev %s cannot handle "
177                                "device %llx, error:%d\n",
178                                dev_name(sas_ha->dev),
179                                SAS_ADDR(dev->sas_addr), res);
180                 }
181                 kref_get(&dev->kref);
182         }
183         return res;
184 }
185
186
187 void sas_notify_lldd_dev_gone(struct domain_device *dev)
188 {
189         struct sas_ha_struct *sas_ha = dev->port->ha;
190         struct Scsi_Host *shost = sas_ha->core.shost;
191         struct sas_internal *i = to_sas_internal(shost->transportt);
192
193         if (i->dft->lldd_dev_gone) {
194                 i->dft->lldd_dev_gone(dev);
195                 sas_put_device(dev);
196         }
197 }
198
199 /* ---------- Common/dispatchers ---------- */
200
201
202 /**
203  * sas_discover_end_dev -- discover an end device (SSP, etc)
204  * @end: pointer to domain device of interest
205  *
206  * See comment in sas_discover_sata().
207  */
208 int sas_discover_end_dev(struct domain_device *dev)
209 {
210         int res;
211
212         res = sas_notify_lldd_dev_found(dev);
213         if (res)
214                 goto out_err2;
215
216         res = sas_rphy_add(dev->rphy);
217         if (res)
218                 goto out_err;
219
220         return 0;
221
222 out_err:
223         sas_notify_lldd_dev_gone(dev);
224 out_err2:
225         return res;
226 }
227
228 /* ---------- Device registration and unregistration ---------- */
229
230 void sas_free_device(struct kref *kref)
231 {
232         struct domain_device *dev = container_of(kref, typeof(*dev), kref);
233
234         if (dev->parent)
235                 sas_put_device(dev->parent);
236
237         /* remove the phys and ports, everything else should be gone */
238         if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
239                 kfree(dev->ex_dev.ex_phy);
240
241         kfree(dev);
242 }
243
244 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
245 {
246         sas_notify_lldd_dev_gone(dev);
247         if (!dev->parent)
248                 dev->port->port_dev = NULL;
249         else
250                 list_del_init(&dev->siblings);
251
252         spin_lock_irq(&port->dev_list_lock);
253         list_del_init(&dev->dev_list_node);
254         spin_unlock_irq(&port->dev_list_lock);
255
256         sas_put_device(dev);
257 }
258
259 static void sas_destruct_devices(struct work_struct *work)
260 {
261         struct domain_device *dev, *n;
262         struct sas_discovery_event *ev =
263                 container_of(work, struct sas_discovery_event, work);
264         struct asd_sas_port *port = ev->port;
265
266         clear_bit(DISCE_DESTRUCT, &port->disc.pending);
267
268         list_for_each_entry_safe(dev, n, &port->destroy_list, disco_list_node) {
269                 list_del_init(&dev->disco_list_node);
270
271                 sas_remove_children(&dev->rphy->dev);
272                 sas_rphy_delete(dev->rphy);
273                 dev->rphy = NULL;
274                 sas_unregister_common_dev(port, dev);
275
276                 sas_put_device(dev);
277         }
278 }
279
280 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
281 {
282         if (!test_bit(SAS_DEV_DESTROY, &dev->state) &&
283             !list_empty(&dev->disco_list_node)) {
284                 /* this rphy never saw sas_rphy_add */
285                 list_del_init(&dev->disco_list_node);
286                 sas_rphy_free(dev->rphy);
287                 dev->rphy = NULL;
288                 sas_unregister_common_dev(port, dev);
289         }
290
291         if (dev->rphy && !test_and_set_bit(SAS_DEV_DESTROY, &dev->state)) {
292                 sas_rphy_unlink(dev->rphy);
293                 list_move_tail(&dev->disco_list_node, &port->destroy_list);
294                 sas_discover_event(dev->port, DISCE_DESTRUCT);
295         }
296 }
297
298 void sas_unregister_domain_devices(struct asd_sas_port *port)
299 {
300         struct domain_device *dev, *n;
301
302         list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node)
303                 sas_unregister_dev(port, dev);
304         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node)
305                 sas_unregister_dev(port, dev);
306
307         port->port->rphy = NULL;
308
309 }
310
311 /* ---------- Discovery and Revalidation ---------- */
312
313 /**
314  * sas_discover_domain -- discover the domain
315  * @port: port to the domain of interest
316  *
317  * NOTE: this process _must_ quit (return) as soon as any connection
318  * errors are encountered.  Connection recovery is done elsewhere.
319  * Discover process only interrogates devices in order to discover the
320  * domain.
321  */
322 static void sas_discover_domain(struct work_struct *work)
323 {
324         struct domain_device *dev;
325         int error = 0;
326         struct sas_discovery_event *ev =
327                 container_of(work, struct sas_discovery_event, work);
328         struct asd_sas_port *port = ev->port;
329
330         clear_bit(DISCE_DISCOVER_DOMAIN, &port->disc.pending);
331
332         if (port->port_dev)
333                 return;
334
335         error = sas_get_port_device(port);
336         if (error)
337                 return;
338         dev = port->port_dev;
339
340         SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
341                     task_pid_nr(current));
342
343         switch (dev->dev_type) {
344         case SAS_END_DEV:
345                 error = sas_discover_end_dev(dev);
346                 break;
347         case EDGE_DEV:
348         case FANOUT_DEV:
349                 error = sas_discover_root_expander(dev);
350                 break;
351         case SATA_DEV:
352         case SATA_PM:
353 #ifdef CONFIG_SCSI_SAS_ATA
354                 error = sas_discover_sata(dev);
355                 break;
356 #else
357                 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
358                 /* Fall through */
359 #endif
360         default:
361                 error = -ENXIO;
362                 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
363                 break;
364         }
365
366         if (error) {
367                 sas_rphy_free(dev->rphy);
368                 dev->rphy = NULL;
369
370                 list_del_init(&dev->disco_list_node);
371                 spin_lock_irq(&port->dev_list_lock);
372                 list_del_init(&dev->dev_list_node);
373                 spin_unlock_irq(&port->dev_list_lock);
374
375                 sas_put_device(dev);
376                 port->port_dev = NULL;
377         }
378
379         SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
380                     task_pid_nr(current), error);
381 }
382
383 static void sas_revalidate_domain(struct work_struct *work)
384 {
385         int res = 0;
386         struct sas_discovery_event *ev =
387                 container_of(work, struct sas_discovery_event, work);
388         struct asd_sas_port *port = ev->port;
389         struct sas_ha_struct *ha = port->ha;
390
391         /* prevent revalidation from finding sata links in recovery */
392         mutex_lock(&ha->disco_mutex);
393         if (test_bit(SAS_HA_ATA_EH_ACTIVE, &ha->state)) {
394                 SAS_DPRINTK("REVALIDATION DEFERRED on port %d, pid:%d\n",
395                             port->id, task_pid_nr(current));
396                 goto out;
397         }
398
399         clear_bit(DISCE_REVALIDATE_DOMAIN, &port->disc.pending);
400
401         SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
402                     task_pid_nr(current));
403
404         if (port->port_dev)
405                 res = sas_ex_revalidate_domain(port->port_dev);
406
407         SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
408                     port->id, task_pid_nr(current), res);
409  out:
410         mutex_unlock(&ha->disco_mutex);
411 }
412
413 /* ---------- Events ---------- */
414
415 static void sas_chain_work(struct sas_ha_struct *ha, struct work_struct *work)
416 {
417         /* chained work is not subject to SA_HA_DRAINING or SAS_HA_REGISTERED */
418         scsi_queue_work(ha->core.shost, work);
419 }
420
421 static void sas_chain_event(int event, unsigned long *pending,
422                             struct work_struct *work,
423                             struct sas_ha_struct *ha)
424 {
425         if (!test_and_set_bit(event, pending)) {
426                 unsigned long flags;
427
428                 spin_lock_irqsave(&ha->state_lock, flags);
429                 sas_chain_work(ha, work);
430                 spin_unlock_irqrestore(&ha->state_lock, flags);
431         }
432 }
433
434 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
435 {
436         struct sas_discovery *disc;
437
438         if (!port)
439                 return 0;
440         disc = &port->disc;
441
442         BUG_ON(ev >= DISC_NUM_EVENTS);
443
444         sas_chain_event(ev, &disc->pending, &disc->disc_work[ev].work, port->ha);
445
446         return 0;
447 }
448
449 /**
450  * sas_init_disc -- initialize the discovery struct in the port
451  * @port: pointer to struct port
452  *
453  * Called when the ports are being initialized.
454  */
455 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
456 {
457         int i;
458
459         static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
460                 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
461                 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
462                 [DISCE_PROBE] = sas_probe_sata,
463                 [DISCE_DESTRUCT] = sas_destruct_devices,
464         };
465
466         disc->pending = 0;
467         for (i = 0; i < DISC_NUM_EVENTS; i++) {
468                 INIT_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
469                 disc->disc_work[i].port = port;
470         }
471 }