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/pci.h>
26 #include <linux/scatterlist.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_internal.h"
35 /* ---------- Basic task processing for discovery purposes ---------- */
37 void sas_init_dev(struct domain_device *dev)
39 INIT_LIST_HEAD(&dev->siblings);
40 INIT_LIST_HEAD(&dev->dev_list_node);
41 switch (dev->dev_type) {
46 INIT_LIST_HEAD(&dev->ex_dev.children);
51 INIT_LIST_HEAD(&dev->sata_dev.children);
58 static void sas_task_timedout(unsigned long _task)
60 struct sas_task *task = (void *) _task;
63 spin_lock_irqsave(&task->task_state_lock, flags);
64 if (!(task->task_state_flags & SAS_TASK_STATE_DONE))
65 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
66 spin_unlock_irqrestore(&task->task_state_lock, flags);
68 complete(&task->completion);
71 static void sas_disc_task_done(struct sas_task *task)
73 if (!del_timer(&task->timer))
75 complete(&task->completion);
78 #define SAS_DEV_TIMEOUT 10
81 * sas_execute_task -- Basic task processing for discovery
82 * @task: the task to be executed
83 * @buffer: pointer to buffer to do I/O
84 * @size: size of @buffer
85 * @pci_dma_dir: PCI_DMA_...
87 static int sas_execute_task(struct sas_task *task, void *buffer, int size,
91 struct scatterlist *scatter = NULL;
92 struct task_status_struct *ts = &task->task_status;
95 struct sas_internal *i =
96 to_sas_internal(task->dev->port->ha->core.shost->transportt);
98 if (pci_dma_dir != PCI_DMA_NONE) {
99 scatter = kzalloc(sizeof(*scatter), GFP_KERNEL);
103 sg_init_one(scatter, buffer, size);
107 task->task_proto = task->dev->tproto;
108 task->scatter = scatter;
109 task->num_scatter = num_scatter;
110 task->total_xfer_len = size;
111 task->data_dir = pci_dma_dir;
112 task->task_done = sas_disc_task_done;
114 for (retries = 0; retries < 5; retries++) {
115 task->task_state_flags = SAS_TASK_STATE_PENDING;
116 init_completion(&task->completion);
118 task->timer.data = (unsigned long) task;
119 task->timer.function = sas_task_timedout;
120 task->timer.expires = jiffies + SAS_DEV_TIMEOUT*HZ;
121 add_timer(&task->timer);
123 res = i->dft->lldd_execute_task(task, 1, GFP_KERNEL);
125 del_timer(&task->timer);
126 SAS_DPRINTK("executing SAS discovery task failed:%d\n",
130 wait_for_completion(&task->completion);
132 if (task->task_state_flags & SAS_TASK_STATE_ABORTED) {
134 SAS_DPRINTK("task aborted, flags:0x%x\n",
135 task->task_state_flags);
136 res2 = i->dft->lldd_abort_task(task);
137 SAS_DPRINTK("came back from abort task\n");
138 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
139 if (res2 == TMF_RESP_FUNC_COMPLETE)
140 continue; /* Retry the task */
145 if (task->task_status.stat == SAM_BUSY ||
146 task->task_status.stat == SAM_TASK_SET_FULL ||
147 task->task_status.stat == SAS_QUEUE_FULL) {
148 SAS_DPRINTK("task: q busy, sleeping...\n");
149 schedule_timeout_interruptible(HZ);
150 } else if (task->task_status.stat == SAM_CHECK_COND) {
151 struct scsi_sense_hdr shdr;
153 if (!scsi_normalize_sense(ts->buf, ts->buf_valid_size,
155 SAS_DPRINTK("couldn't normalize sense\n");
158 if ((shdr.sense_key == 6 && shdr.asc == 0x29) ||
159 (shdr.sense_key == 2 && shdr.asc == 4 &&
161 SAS_DPRINTK("device %016llx LUN: %016llx "
162 "powering up or not ready yet, "
164 SAS_ADDR(task->dev->sas_addr),
165 SAS_ADDR(task->ssp_task.LUN));
167 schedule_timeout_interruptible(5*HZ);
168 } else if (shdr.sense_key == 1) {
171 } else if (shdr.sense_key == 5) {
174 SAS_DPRINTK("dev %016llx LUN: %016llx "
175 "sense key:0x%x ASC:0x%x ASCQ:0x%x"
177 SAS_ADDR(task->dev->sas_addr),
178 SAS_ADDR(task->ssp_task.LUN),
180 shdr.asc, shdr.ascq);
182 } else if (task->task_status.resp != SAS_TASK_COMPLETE ||
183 task->task_status.stat != SAM_GOOD) {
184 SAS_DPRINTK("task finished with resp:0x%x, "
186 task->task_status.resp,
187 task->task_status.stat);
195 if (pci_dma_dir != PCI_DMA_NONE)
201 /* ---------- Domain device discovery ---------- */
204 * sas_get_port_device -- Discover devices which caused port creation
205 * @port: pointer to struct sas_port of interest
207 * Devices directly attached to a HA port, have no parent. This is
208 * how we know they are (domain) "root" devices. All other devices
209 * do, and should have their "parent" pointer set appropriately as
210 * soon as a child device is discovered.
212 static int sas_get_port_device(struct asd_sas_port *port)
215 struct asd_sas_phy *phy;
216 struct sas_rphy *rphy;
217 struct domain_device *dev;
219 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
223 spin_lock_irqsave(&port->phy_list_lock, flags);
224 if (list_empty(&port->phy_list)) {
225 spin_unlock_irqrestore(&port->phy_list_lock, flags);
229 phy = container_of(port->phy_list.next, struct asd_sas_phy, port_phy_el);
230 spin_lock(&phy->frame_rcvd_lock);
231 memcpy(dev->frame_rcvd, phy->frame_rcvd, min(sizeof(dev->frame_rcvd),
232 (size_t)phy->frame_rcvd_size));
233 spin_unlock(&phy->frame_rcvd_lock);
234 spin_unlock_irqrestore(&port->phy_list_lock, flags);
236 if (dev->frame_rcvd[0] == 0x34 && port->oob_mode == SATA_OOB_MODE) {
237 struct dev_to_host_fis *fis =
238 (struct dev_to_host_fis *) dev->frame_rcvd;
239 if (fis->interrupt_reason == 1 && fis->lbal == 1 &&
240 fis->byte_count_low==0x69 && fis->byte_count_high == 0x96
241 && (fis->device & ~0x10) == 0)
242 dev->dev_type = SATA_PM;
244 dev->dev_type = SATA_DEV;
245 dev->tproto = SATA_PROTO;
247 struct sas_identify_frame *id =
248 (struct sas_identify_frame *) dev->frame_rcvd;
249 dev->dev_type = id->dev_type;
250 dev->iproto = id->initiator_bits;
251 dev->tproto = id->target_bits;
256 switch (dev->dev_type) {
258 rphy = sas_end_device_alloc(port->port);
261 rphy = sas_expander_alloc(port->port,
262 SAS_EDGE_EXPANDER_DEVICE);
265 rphy = sas_expander_alloc(port->port,
266 SAS_FANOUT_EXPANDER_DEVICE);
270 printk("ERROR: Unidentified device type %d\n", dev->dev_type);
279 rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
280 memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
281 sas_fill_in_rphy(dev, rphy);
282 sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
283 port->port_dev = dev;
285 dev->linkrate = port->linkrate;
286 dev->min_linkrate = port->linkrate;
287 dev->max_linkrate = port->linkrate;
288 dev->pathways = port->num_phys;
289 memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
290 memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
291 memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
292 port->disc.max_level = 0;
295 spin_lock(&port->dev_list_lock);
296 list_add_tail(&dev->dev_list_node, &port->dev_list);
297 spin_unlock(&port->dev_list_lock);
302 /* ---------- Discover and Revalidate ---------- */
304 /* ---------- SATA ---------- */
306 static void sas_get_ata_command_set(struct domain_device *dev)
308 struct dev_to_host_fis *fis =
309 (struct dev_to_host_fis *) dev->frame_rcvd;
311 if ((fis->sector_count == 1 && /* ATA */
317 (fis->sector_count == 0 && /* CE-ATA (mATA) */
321 (fis->device & ~0x10) == 0))
323 dev->sata_dev.command_set = ATA_COMMAND_SET;
325 else if ((fis->interrupt_reason == 1 && /* ATAPI */
327 fis->byte_count_low == 0x14 &&
328 fis->byte_count_high == 0xEB &&
329 (fis->device & ~0x10) == 0))
331 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
333 else if ((fis->sector_count == 1 && /* SEMB */
339 (fis->interrupt_reason == 1 && /* SATA PM */
341 fis->byte_count_low == 0x69 &&
342 fis->byte_count_high == 0x96 &&
343 (fis->device & ~0x10) == 0))
345 /* Treat it as a superset? */
346 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
350 * sas_issue_ata_cmd -- Basic SATA command processing for discovery
351 * @dev: the device to send the command to
352 * @command: the command register
353 * @features: the features register
354 * @buffer: pointer to buffer to do I/O
355 * @size: size of @buffer
356 * @pci_dma_dir: PCI_DMA_...
358 static int sas_issue_ata_cmd(struct domain_device *dev, u8 command,
359 u8 features, void *buffer, int size,
363 struct sas_task *task;
364 struct dev_to_host_fis *d2h_fis = (struct dev_to_host_fis *)
368 task = sas_alloc_task(GFP_KERNEL);
374 task->ata_task.fis.command = command;
375 task->ata_task.fis.features = features;
376 task->ata_task.fis.device = d2h_fis->device;
377 task->ata_task.retry_count = 1;
379 res = sas_execute_task(task, buffer, size, pci_dma_dir);
386 static void sas_sata_propagate_sas_addr(struct domain_device *dev)
389 struct asd_sas_port *port = dev->port;
390 struct asd_sas_phy *phy;
394 memcpy(port->attached_sas_addr, dev->sas_addr, SAS_ADDR_SIZE);
395 spin_lock_irqsave(&port->phy_list_lock, flags);
396 list_for_each_entry(phy, &port->phy_list, port_phy_el)
397 memcpy(phy->attached_sas_addr, dev->sas_addr, SAS_ADDR_SIZE);
398 spin_unlock_irqrestore(&port->phy_list_lock, flags);
401 #define ATA_IDENTIFY_DEV 0xEC
402 #define ATA_IDENTIFY_PACKET_DEV 0xA1
403 #define ATA_SET_FEATURES 0xEF
404 #define ATA_FEATURE_PUP_STBY_SPIN_UP 0x07
407 * sas_discover_sata_dev -- discover a STP/SATA device (SATA_DEV)
408 * @dev: STP/SATA device of interest (ATA/ATAPI)
410 * The LLDD has already been notified of this device, so that we can
411 * send FISes to it. Here we try to get IDENTIFY DEVICE or IDENTIFY
412 * PACKET DEVICE, if ATAPI device, so that the LLDD can fine-tune its
413 * performance for this device.
415 static int sas_discover_sata_dev(struct domain_device *dev)
421 identify_x = kzalloc(512, GFP_KERNEL);
425 if (dev->sata_dev.command_set == ATA_COMMAND_SET) {
426 dev->sata_dev.identify_device = identify_x;
427 command = ATA_IDENTIFY_DEV;
429 dev->sata_dev.identify_packet_device = identify_x;
430 command = ATA_IDENTIFY_PACKET_DEV;
433 res = sas_issue_ata_cmd(dev, command, 0, identify_x, 512,
438 /* lives on the media? */
439 if (le16_to_cpu(identify_x[0]) & 4) {
440 /* incomplete response */
441 SAS_DPRINTK("sending SET FEATURE/PUP_STBY_SPIN_UP to "
442 "dev %llx\n", SAS_ADDR(dev->sas_addr));
443 if (!le16_to_cpu(identify_x[83] & (1<<6)))
445 res = sas_issue_ata_cmd(dev, ATA_SET_FEATURES,
446 ATA_FEATURE_PUP_STBY_SPIN_UP,
447 NULL, 0, PCI_DMA_NONE);
451 schedule_timeout_interruptible(5*HZ); /* More time? */
452 res = sas_issue_ata_cmd(dev, command, 0, identify_x, 512,
459 if (dev->port->oob_mode != SATA_OOB_MODE) {
460 memcpy(dev->sas_addr, dev->sata_dev.rps_resp.rps.stp_sas_addr,
462 } else if (dev->sata_dev.command_set == ATA_COMMAND_SET &&
463 (le16_to_cpu(dev->sata_dev.identify_device[108]) & 0xF000)
467 for (i = 0; i < 4; i++) {
469 (le16_to_cpu(dev->sata_dev.identify_device[108+i]) & 0xFF00) >> 8;
470 dev->sas_addr[2*i+1] =
471 le16_to_cpu(dev->sata_dev.identify_device[108+i]) & 0x00FF;
474 sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
476 sas_sata_propagate_sas_addr(dev);
478 /* XXX Hint: register this SATA device with SATL.
479 When this returns, dev->sata_dev->lu is alive and
481 sas_satl_register_dev(dev);
485 dev->sata_dev.identify_packet_device = NULL;
486 dev->sata_dev.identify_device = NULL;
491 static int sas_discover_sata_pm(struct domain_device *dev)
496 int sas_notify_lldd_dev_found(struct domain_device *dev)
499 struct sas_ha_struct *sas_ha = dev->port->ha;
500 struct Scsi_Host *shost = sas_ha->core.shost;
501 struct sas_internal *i = to_sas_internal(shost->transportt);
503 if (i->dft->lldd_dev_found) {
504 res = i->dft->lldd_dev_found(dev);
506 printk("sas: driver on pcidev %s cannot handle "
507 "device %llx, error:%d\n",
508 pci_name(sas_ha->pcidev),
509 SAS_ADDR(dev->sas_addr), res);
516 void sas_notify_lldd_dev_gone(struct domain_device *dev)
518 struct sas_ha_struct *sas_ha = dev->port->ha;
519 struct Scsi_Host *shost = sas_ha->core.shost;
520 struct sas_internal *i = to_sas_internal(shost->transportt);
522 if (i->dft->lldd_dev_gone)
523 i->dft->lldd_dev_gone(dev);
526 /* ---------- Common/dispatchers ---------- */
529 * sas_discover_sata -- discover an STP/SATA domain device
530 * @dev: pointer to struct domain_device of interest
532 * First we notify the LLDD of this device, so we can send frames to
533 * it. Then depending on the type of device we call the appropriate
534 * discover functions. Once device discover is done, we notify the
535 * LLDD so that it can fine-tune its parameters for the device, by
536 * removing it and then adding it. That is, the second time around,
537 * the driver would have certain fields, that it is looking at, set.
538 * Finally we initialize the kobj so that the device can be added to
539 * the system at registration time. Devices directly attached to a HA
540 * port, have no parents. All other devices do, and should have their
541 * "parent" pointer set appropriately before calling this function.
543 int sas_discover_sata(struct domain_device *dev)
547 sas_get_ata_command_set(dev);
549 res = sas_notify_lldd_dev_found(dev);
553 switch (dev->dev_type) {
555 res = sas_discover_sata_dev(dev);
558 res = sas_discover_sata_pm(dev);
564 sas_notify_lldd_dev_gone(dev);
566 sas_notify_lldd_dev_found(dev);
572 * sas_discover_end_dev -- discover an end device (SSP, etc)
573 * @end: pointer to domain device of interest
575 * See comment in sas_discover_sata().
577 int sas_discover_end_dev(struct domain_device *dev)
581 res = sas_notify_lldd_dev_found(dev);
585 res = sas_rphy_add(dev->rphy);
589 /* do this to get the end device port attributes which will have
590 * been scanned in sas_rphy_add */
591 sas_notify_lldd_dev_gone(dev);
592 sas_notify_lldd_dev_found(dev);
597 sas_notify_lldd_dev_gone(dev);
601 /* ---------- Device registration and unregistration ---------- */
603 static inline void sas_unregister_common_dev(struct domain_device *dev)
605 sas_notify_lldd_dev_gone(dev);
607 dev->port->port_dev = NULL;
609 list_del_init(&dev->siblings);
610 list_del_init(&dev->dev_list_node);
613 void sas_unregister_dev(struct domain_device *dev)
616 sas_remove_children(&dev->rphy->dev);
617 sas_rphy_delete(dev->rphy);
620 if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV) {
621 /* remove the phys and ports, everything else should be gone */
622 kfree(dev->ex_dev.ex_phy);
623 dev->ex_dev.ex_phy = NULL;
625 sas_unregister_common_dev(dev);
628 void sas_unregister_domain_devices(struct asd_sas_port *port)
630 struct domain_device *dev, *n;
632 list_for_each_entry_safe_reverse(dev,n,&port->dev_list,dev_list_node)
633 sas_unregister_dev(dev);
635 port->port->rphy = NULL;
639 /* ---------- Discovery and Revalidation ---------- */
642 * sas_discover_domain -- discover the domain
643 * @port: port to the domain of interest
645 * NOTE: this process _must_ quit (return) as soon as any connection
646 * errors are encountered. Connection recovery is done elsewhere.
647 * Discover process only interrogates devices in order to discover the
650 static void sas_discover_domain(struct work_struct *work)
653 struct sas_discovery_event *ev =
654 container_of(work, struct sas_discovery_event, work);
655 struct asd_sas_port *port = ev->port;
657 sas_begin_event(DISCE_DISCOVER_DOMAIN, &port->disc.disc_event_lock,
658 &port->disc.pending);
663 error = sas_get_port_device(port);
668 SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
671 switch (port->port_dev->dev_type) {
673 error = sas_discover_end_dev(port->port_dev);
677 error = sas_discover_root_expander(port->port_dev);
681 error = sas_discover_sata(port->port_dev);
684 SAS_DPRINTK("unhandled device %d\n", port->port_dev->dev_type);
689 kfree(port->port_dev); /* not kobject_register-ed yet */
690 port->port_dev = NULL;
693 SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
694 current->pid, error);
697 static void sas_revalidate_domain(struct work_struct *work)
700 struct sas_discovery_event *ev =
701 container_of(work, struct sas_discovery_event, work);
702 struct asd_sas_port *port = ev->port;
704 sas_begin_event(DISCE_REVALIDATE_DOMAIN, &port->disc.disc_event_lock,
705 &port->disc.pending);
707 SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
710 res = sas_ex_revalidate_domain(port->port_dev);
712 SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
713 port->id, current->pid, res);
716 /* ---------- Events ---------- */
718 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
720 struct sas_discovery *disc;
726 BUG_ON(ev >= DISC_NUM_EVENTS);
728 sas_queue_event(ev, &disc->disc_event_lock, &disc->pending,
729 &disc->disc_work[ev].work, port->ha->core.shost);
735 * sas_init_disc -- initialize the discovery struct in the port
736 * @port: pointer to struct port
738 * Called when the ports are being initialized.
740 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
744 static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
745 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
746 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
749 spin_lock_init(&disc->disc_event_lock);
751 for (i = 0; i < DISC_NUM_EVENTS; i++) {
752 INIT_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
753 disc->disc_work[i].port = port;