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
) {
45 INIT_LIST_HEAD(&dev
->ex_dev
.children
);
50 INIT_LIST_HEAD(&dev
->sata_dev
.children
);
57 /* ---------- Domain device discovery ---------- */
60 * sas_get_port_device -- Discover devices which caused port creation
61 * @port: pointer to struct sas_port of interest
63 * Devices directly attached to a HA port, have no parent. This is
64 * how we know they are (domain) "root" devices. All other devices
65 * do, and should have their "parent" pointer set appropriately as
66 * soon as a child device is discovered.
68 static int sas_get_port_device(struct asd_sas_port
*port
)
71 struct asd_sas_phy
*phy
;
72 struct sas_rphy
*rphy
;
73 struct domain_device
*dev
;
75 dev
= sas_alloc_device();
79 spin_lock_irqsave(&port
->phy_list_lock
, flags
);
80 if (list_empty(&port
->phy_list
)) {
81 spin_unlock_irqrestore(&port
->phy_list_lock
, flags
);
85 phy
= container_of(port
->phy_list
.next
, struct asd_sas_phy
, port_phy_el
);
86 spin_lock(&phy
->frame_rcvd_lock
);
87 memcpy(dev
->frame_rcvd
, phy
->frame_rcvd
, min(sizeof(dev
->frame_rcvd
),
88 (size_t)phy
->frame_rcvd_size
));
89 spin_unlock(&phy
->frame_rcvd_lock
);
90 spin_unlock_irqrestore(&port
->phy_list_lock
, flags
);
92 if (dev
->frame_rcvd
[0] == 0x34 && port
->oob_mode
== SATA_OOB_MODE
) {
93 struct dev_to_host_fis
*fis
=
94 (struct dev_to_host_fis
*) dev
->frame_rcvd
;
95 if (fis
->interrupt_reason
== 1 && fis
->lbal
== 1 &&
96 fis
->byte_count_low
==0x69 && fis
->byte_count_high
== 0x96
97 && (fis
->device
& ~0x10) == 0)
98 dev
->dev_type
= SATA_PM
;
100 dev
->dev_type
= SATA_DEV
;
101 dev
->tproto
= SAS_PROTOCOL_SATA
;
103 struct sas_identify_frame
*id
=
104 (struct sas_identify_frame
*) dev
->frame_rcvd
;
105 dev
->dev_type
= id
->dev_type
;
106 dev
->iproto
= id
->initiator_bits
;
107 dev
->tproto
= id
->target_bits
;
112 switch (dev
->dev_type
) {
115 rphy
= sas_end_device_alloc(port
->port
);
118 rphy
= sas_expander_alloc(port
->port
,
119 SAS_EDGE_EXPANDER_DEVICE
);
122 rphy
= sas_expander_alloc(port
->port
,
123 SAS_FANOUT_EXPANDER_DEVICE
);
126 printk("ERROR: Unidentified device type %d\n", dev
->dev_type
);
135 rphy
->identify
.phy_identifier
= phy
->phy
->identify
.phy_identifier
;
136 memcpy(dev
->sas_addr
, port
->attached_sas_addr
, SAS_ADDR_SIZE
);
137 sas_fill_in_rphy(dev
, rphy
);
138 sas_hash_addr(dev
->hashed_sas_addr
, dev
->sas_addr
);
139 port
->port_dev
= dev
;
141 dev
->linkrate
= port
->linkrate
;
142 dev
->min_linkrate
= port
->linkrate
;
143 dev
->max_linkrate
= port
->linkrate
;
144 dev
->pathways
= port
->num_phys
;
145 memset(port
->disc
.fanout_sas_addr
, 0, SAS_ADDR_SIZE
);
146 memset(port
->disc
.eeds_a
, 0, SAS_ADDR_SIZE
);
147 memset(port
->disc
.eeds_b
, 0, SAS_ADDR_SIZE
);
148 port
->disc
.max_level
= 0;
152 if (dev_is_sata(dev
))
153 list_add_tail(&dev
->disco_list_node
, &port
->disco_list
);
155 spin_lock_irq(&port
->dev_list_lock
);
156 list_add_tail(&dev
->dev_list_node
, &port
->dev_list
);
157 spin_unlock_irq(&port
->dev_list_lock
);
163 /* ---------- Discover and Revalidate ---------- */
165 int sas_notify_lldd_dev_found(struct domain_device
*dev
)
168 struct sas_ha_struct
*sas_ha
= dev
->port
->ha
;
169 struct Scsi_Host
*shost
= sas_ha
->core
.shost
;
170 struct sas_internal
*i
= to_sas_internal(shost
->transportt
);
172 if (i
->dft
->lldd_dev_found
) {
173 res
= i
->dft
->lldd_dev_found(dev
);
175 printk("sas: driver on pcidev %s cannot handle "
176 "device %llx, error:%d\n",
177 dev_name(sas_ha
->dev
),
178 SAS_ADDR(dev
->sas_addr
), res
);
180 kref_get(&dev
->kref
);
186 void sas_notify_lldd_dev_gone(struct domain_device
*dev
)
188 struct sas_ha_struct
*sas_ha
= dev
->port
->ha
;
189 struct Scsi_Host
*shost
= sas_ha
->core
.shost
;
190 struct sas_internal
*i
= to_sas_internal(shost
->transportt
);
192 if (i
->dft
->lldd_dev_gone
) {
193 i
->dft
->lldd_dev_gone(dev
);
198 /* ---------- Common/dispatchers ---------- */
202 * sas_discover_end_dev -- discover an end device (SSP, etc)
203 * @end: pointer to domain device of interest
205 * See comment in sas_discover_sata().
207 int sas_discover_end_dev(struct domain_device
*dev
)
211 res
= sas_notify_lldd_dev_found(dev
);
215 res
= sas_rphy_add(dev
->rphy
);
222 sas_notify_lldd_dev_gone(dev
);
227 /* ---------- Device registration and unregistration ---------- */
229 void sas_free_device(struct kref
*kref
)
231 struct domain_device
*dev
= container_of(kref
, typeof(*dev
), kref
);
234 sas_put_device(dev
->parent
);
236 /* remove the phys and ports, everything else should be gone */
237 if (dev
->dev_type
== EDGE_DEV
|| dev
->dev_type
== FANOUT_DEV
)
238 kfree(dev
->ex_dev
.ex_phy
);
240 if (dev_is_sata(dev
)) {
241 kfree(dev
->sata_dev
.identify_device
);
242 kfree(dev
->sata_dev
.identify_packet_device
);
248 static void sas_unregister_common_dev(struct asd_sas_port
*port
, struct domain_device
*dev
)
250 sas_notify_lldd_dev_gone(dev
);
252 dev
->port
->port_dev
= NULL
;
254 list_del_init(&dev
->siblings
);
256 spin_lock_irq(&port
->dev_list_lock
);
257 list_del_init(&dev
->dev_list_node
);
258 spin_unlock_irq(&port
->dev_list_lock
);
263 static void sas_destruct_devices(struct work_struct
*work
)
265 struct domain_device
*dev
, *n
;
266 struct sas_discovery_event
*ev
=
267 container_of(work
, struct sas_discovery_event
, work
);
268 struct asd_sas_port
*port
= ev
->port
;
270 clear_bit(DISCE_DESTRUCT
, &port
->disc
.pending
);
272 list_for_each_entry_safe(dev
, n
, &port
->destroy_list
, disco_list_node
) {
273 list_del_init(&dev
->disco_list_node
);
275 sas_remove_children(&dev
->rphy
->dev
);
276 sas_rphy_delete(dev
->rphy
);
278 sas_unregister_common_dev(port
, dev
);
284 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*dev
)
286 if (!test_bit(SAS_DEV_DESTROY
, &dev
->state
) &&
287 !list_empty(&dev
->disco_list_node
)) {
288 /* this rphy never saw sas_rphy_add */
289 list_del_init(&dev
->disco_list_node
);
290 sas_rphy_free(dev
->rphy
);
292 sas_unregister_common_dev(port
, dev
);
295 if (dev
->rphy
&& !test_and_set_bit(SAS_DEV_DESTROY
, &dev
->state
)) {
296 sas_rphy_unlink(dev
->rphy
);
297 list_move_tail(&dev
->disco_list_node
, &port
->destroy_list
);
298 sas_discover_event(dev
->port
, DISCE_DESTRUCT
);
302 void sas_unregister_domain_devices(struct asd_sas_port
*port
)
304 struct domain_device
*dev
, *n
;
306 list_for_each_entry_safe_reverse(dev
, n
, &port
->dev_list
, dev_list_node
)
307 sas_unregister_dev(port
, dev
);
308 list_for_each_entry_safe(dev
, n
, &port
->disco_list
, disco_list_node
)
309 sas_unregister_dev(port
, dev
);
311 port
->port
->rphy
= NULL
;
315 /* ---------- Discovery and Revalidation ---------- */
318 * sas_discover_domain -- discover the domain
319 * @port: port to the domain of interest
321 * NOTE: this process _must_ quit (return) as soon as any connection
322 * errors are encountered. Connection recovery is done elsewhere.
323 * Discover process only interrogates devices in order to discover the
326 static void sas_discover_domain(struct work_struct
*work
)
328 struct domain_device
*dev
;
330 struct sas_discovery_event
*ev
=
331 container_of(work
, struct sas_discovery_event
, work
);
332 struct asd_sas_port
*port
= ev
->port
;
334 clear_bit(DISCE_DISCOVER_DOMAIN
, &port
->disc
.pending
);
339 error
= sas_get_port_device(port
);
342 dev
= port
->port_dev
;
344 SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port
->id
,
345 task_pid_nr(current
));
347 switch (dev
->dev_type
) {
349 error
= sas_discover_end_dev(dev
);
353 error
= sas_discover_root_expander(dev
);
357 #ifdef CONFIG_SCSI_SAS_ATA
358 error
= sas_discover_sata(dev
);
361 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
366 SAS_DPRINTK("unhandled device %d\n", dev
->dev_type
);
371 sas_rphy_free(dev
->rphy
);
374 list_del_init(&dev
->disco_list_node
);
375 spin_lock_irq(&port
->dev_list_lock
);
376 list_del_init(&dev
->dev_list_node
);
377 spin_unlock_irq(&port
->dev_list_lock
);
380 port
->port_dev
= NULL
;
383 SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port
->id
,
384 task_pid_nr(current
), error
);
387 static void sas_revalidate_domain(struct work_struct
*work
)
390 struct sas_discovery_event
*ev
=
391 container_of(work
, struct sas_discovery_event
, work
);
392 struct asd_sas_port
*port
= ev
->port
;
393 struct sas_ha_struct
*ha
= port
->ha
;
395 /* prevent revalidation from finding sata links in recovery */
396 mutex_lock(&ha
->disco_mutex
);
397 if (test_bit(SAS_HA_ATA_EH_ACTIVE
, &ha
->state
)) {
398 SAS_DPRINTK("REVALIDATION DEFERRED on port %d, pid:%d\n",
399 port
->id
, task_pid_nr(current
));
403 clear_bit(DISCE_REVALIDATE_DOMAIN
, &port
->disc
.pending
);
405 SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port
->id
,
406 task_pid_nr(current
));
409 res
= sas_ex_revalidate_domain(port
->port_dev
);
411 SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
412 port
->id
, task_pid_nr(current
), res
);
414 mutex_unlock(&ha
->disco_mutex
);
417 /* ---------- Events ---------- */
419 static void sas_chain_work(struct sas_ha_struct
*ha
, struct work_struct
*work
)
421 /* chained work is not subject to SA_HA_DRAINING or SAS_HA_REGISTERED */
422 scsi_queue_work(ha
->core
.shost
, work
);
425 static void sas_chain_event(int event
, unsigned long *pending
,
426 struct work_struct
*work
,
427 struct sas_ha_struct
*ha
)
429 if (!test_and_set_bit(event
, pending
)) {
432 spin_lock_irqsave(&ha
->state_lock
, flags
);
433 sas_chain_work(ha
, work
);
434 spin_unlock_irqrestore(&ha
->state_lock
, flags
);
438 int sas_discover_event(struct asd_sas_port
*port
, enum discover_event ev
)
440 struct sas_discovery
*disc
;
446 BUG_ON(ev
>= DISC_NUM_EVENTS
);
448 sas_chain_event(ev
, &disc
->pending
, &disc
->disc_work
[ev
].work
, port
->ha
);
454 * sas_init_disc -- initialize the discovery struct in the port
455 * @port: pointer to struct port
457 * Called when the ports are being initialized.
459 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*port
)
463 static const work_func_t sas_event_fns
[DISC_NUM_EVENTS
] = {
464 [DISCE_DISCOVER_DOMAIN
] = sas_discover_domain
,
465 [DISCE_REVALIDATE_DOMAIN
] = sas_revalidate_domain
,
466 [DISCE_PROBE
] = sas_probe_sata
,
467 [DISCE_DESTRUCT
] = sas_destruct_devices
,
471 for (i
= 0; i
< DISC_NUM_EVENTS
; i
++) {
472 INIT_WORK(&disc
->disc_work
[i
].work
, sas_event_fns
[i
]);
473 disc
->disc_work
[i
].port
= port
;