2 * sbp2.c - SBP-2 protocol driver for IEEE-1394
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5 * jamesg@filanet.com (JSG)
7 * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU 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 Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 * This driver implements the Serial Bus Protocol 2 (SBP-2) over IEEE-1394
28 * under Linux. The SBP-2 driver is implemented as an IEEE-1394 high-level
29 * driver. It also registers as a SCSI lower-level driver in order to accept
30 * SCSI commands for transport using SBP-2.
32 * You may access any attached SBP-2 storage devices as if they were SCSI
33 * devices (e.g. mount /dev/sda1, fdisk, mkfs, etc.).
37 * - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38 * but the code needs additional debugging.
41 #include <linux/blkdev.h>
42 #include <linux/compiler.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/gfp.h>
47 #include <linux/init.h>
48 #include <linux/kernel.h>
49 #include <linux/list.h>
50 #include <linux/module.h>
51 #include <linux/moduleparam.h>
52 #include <linux/pci.h>
53 #include <linux/slab.h>
54 #include <linux/spinlock.h>
55 #include <linux/stat.h>
56 #include <linux/string.h>
57 #include <linux/stringify.h>
58 #include <linux/types.h>
59 #include <linux/wait.h>
61 #include <asm/byteorder.h>
62 #include <asm/errno.h>
63 #include <asm/param.h>
64 #include <asm/scatterlist.h>
65 #include <asm/system.h>
66 #include <asm/types.h>
68 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
69 #include <asm/io.h> /* for bus_to_virt */
72 #include <scsi/scsi.h>
73 #include <scsi/scsi_cmnd.h>
74 #include <scsi/scsi_dbg.h>
75 #include <scsi/scsi_device.h>
76 #include <scsi/scsi_host.h>
79 #include "highlevel.h"
82 #include "ieee1394_core.h"
83 #include "ieee1394_hotplug.h"
84 #include "ieee1394_transactions.h"
85 #include "ieee1394_types.h"
90 * Module load parameter definitions
94 * Change max_speed on module load if you have a bad IEEE-1394
95 * controller that has trouble running 2KB packets at 400mb.
97 * NOTE: On certain OHCI parts I have seen short packets on async transmit
98 * (probably due to PCI latency/throughput issues with the part). You can
99 * bump down the speed if you are running into problems.
101 static int max_speed = IEEE1394_SPEED_MAX;
102 module_param(max_speed, int, 0644);
103 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
106 * Set serialize_io to 1 if you'd like only one scsi command sent
107 * down to us at a time (debugging). This might be necessary for very
108 * badly behaved sbp2 devices.
110 * TODO: Make this configurable per device.
112 static int serialize_io = 1;
113 module_param(serialize_io, int, 0444);
114 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
117 * Bump up max_sectors if you'd like to support very large sized
118 * transfers. Please note that some older sbp2 bridge chips are broken for
119 * transfers greater or equal to 128KB. Default is a value of 255
120 * sectors, or just under 128KB (at 512 byte sector size). I can note that
121 * the Oxsemi sbp2 chipsets have no problems supporting very large
124 static int max_sectors = SBP2_MAX_SECTORS;
125 module_param(max_sectors, int, 0444);
126 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
127 __stringify(SBP2_MAX_SECTORS) ")");
130 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
131 * do an exclusive login, as it's generally unsafe to have two hosts
132 * talking to a single sbp2 device at the same time (filesystem coherency,
133 * etc.). If you're running an sbp2 device that supports multiple logins,
134 * and you're either running read-only filesystems or some sort of special
135 * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
136 * File System, or Lustre, then set exclusive_login to zero.
138 * So far only bridges from Oxford Semiconductor are known to support
139 * concurrent logins. Depending on firmware, four or two concurrent logins
140 * are possible on OXFW911 and newer Oxsemi bridges.
142 static int exclusive_login = 1;
143 module_param(exclusive_login, int, 0644);
144 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
147 * If any of the following workarounds is required for your device to work,
148 * please submit the kernel messages logged by sbp2 to the linux1394-devel
151 * - 128kB max transfer
152 * Limit transfer size. Necessary for some old bridges.
155 * When scsi_mod probes the device, let the inquiry command look like that
159 * Suppress sending of mode_sense for mode page 8 if the device pretends to
160 * support the SCSI Primary Block commands instead of Reduced Block Commands.
163 * Tell sd_mod to correct the last sector number reported by read_capacity.
164 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
165 * Don't use this with devices which don't have this bug.
167 * - override internal blacklist
168 * Instead of adding to the built-in blacklist, use only the workarounds
169 * specified in the module load parameter.
170 * Useful if a blacklist entry interfered with a non-broken device.
172 static int sbp2_default_workarounds;
173 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
174 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
175 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
176 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
177 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
178 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
179 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
180 ", or a combination)");
183 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
184 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
189 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *, u32);
190 static void sbp2scsi_complete_command(struct scsi_id_instance_data *, u32,
192 void (*)(struct scsi_cmnd *));
193 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *);
194 static int sbp2_start_device(struct scsi_id_instance_data *);
195 static void sbp2_remove_device(struct scsi_id_instance_data *);
196 static int sbp2_login_device(struct scsi_id_instance_data *);
197 static int sbp2_reconnect_device(struct scsi_id_instance_data *);
198 static int sbp2_logout_device(struct scsi_id_instance_data *);
199 static void sbp2_host_reset(struct hpsb_host *);
200 static int sbp2_handle_status_write(struct hpsb_host *, int, int, quadlet_t *,
202 static int sbp2_agent_reset(struct scsi_id_instance_data *, int);
203 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *,
204 struct unit_directory *);
205 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *);
206 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *);
209 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
211 static struct hpsb_highlevel sbp2_highlevel = {
212 .name = SBP2_DEVICE_NAME,
213 .host_reset = sbp2_host_reset,
216 static struct hpsb_address_ops sbp2_ops = {
217 .write = sbp2_handle_status_write
220 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
221 static int sbp2_handle_physdma_write(struct hpsb_host *, int, int, quadlet_t *,
223 static int sbp2_handle_physdma_read(struct hpsb_host *, int, quadlet_t *, u64,
226 static struct hpsb_address_ops sbp2_physdma_ops = {
227 .read = sbp2_handle_physdma_read,
228 .write = sbp2_handle_physdma_write,
234 * Interface to driver core and IEEE 1394 core
236 static struct ieee1394_device_id sbp2_id_table[] = {
238 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
239 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
240 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
243 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
245 static int sbp2_probe(struct device *);
246 static int sbp2_remove(struct device *);
247 static int sbp2_update(struct unit_directory *);
249 static struct hpsb_protocol_driver sbp2_driver = {
250 .name = "SBP2 Driver",
251 .id_table = sbp2_id_table,
252 .update = sbp2_update,
254 .name = SBP2_DEVICE_NAME,
255 .bus = &ieee1394_bus_type,
257 .remove = sbp2_remove,
263 * Interface to SCSI core
265 static int sbp2scsi_queuecommand(struct scsi_cmnd *,
266 void (*)(struct scsi_cmnd *));
267 static int sbp2scsi_abort(struct scsi_cmnd *);
268 static int sbp2scsi_reset(struct scsi_cmnd *);
269 static int sbp2scsi_slave_alloc(struct scsi_device *);
270 static int sbp2scsi_slave_configure(struct scsi_device *);
271 static void sbp2scsi_slave_destroy(struct scsi_device *);
272 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *,
273 struct device_attribute *, char *);
275 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
277 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
278 &dev_attr_ieee1394_id,
282 static struct scsi_host_template scsi_driver_template = {
283 .module = THIS_MODULE,
284 .name = "SBP-2 IEEE-1394",
285 .proc_name = SBP2_DEVICE_NAME,
286 .queuecommand = sbp2scsi_queuecommand,
287 .eh_abort_handler = sbp2scsi_abort,
288 .eh_device_reset_handler = sbp2scsi_reset,
289 .slave_alloc = sbp2scsi_slave_alloc,
290 .slave_configure = sbp2scsi_slave_configure,
291 .slave_destroy = sbp2scsi_slave_destroy,
293 .sg_tablesize = SG_ALL,
294 .use_clustering = ENABLE_CLUSTERING,
295 .cmd_per_lun = SBP2_MAX_CMDS,
296 .can_queue = SBP2_MAX_CMDS,
298 .sdev_attrs = sbp2_sysfs_sdev_attrs,
303 * List of devices with known bugs.
305 * The firmware_revision field, masked with 0xffff00, is the best indicator
306 * for the type of bridge chip of a device. It yields a few false positives
307 * but this did not break correctly behaving devices so far.
309 static const struct {
310 u32 firmware_revision;
312 unsigned workarounds;
313 } sbp2_workarounds_table[] = {
314 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
315 .firmware_revision = 0x002800,
316 .model_id = 0x001010,
317 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
318 SBP2_WORKAROUND_MODE_SENSE_8,
320 /* Initio bridges, actually only needed for some older ones */ {
321 .firmware_revision = 0x000200,
322 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
324 /* Symbios bridge */ {
325 .firmware_revision = 0xa0b800,
326 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
329 * Note about the following Apple iPod blacklist entries:
331 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
332 * matching logic treats 0 as a wildcard, we cannot match this ID
333 * without rewriting the matching routine. Fortunately these iPods
334 * do not feature the read_capacity bug according to one report.
335 * Read_capacity behaviour as well as model_id could change due to
336 * Apple-supplied firmware updates though.
338 /* iPod 4th generation */ {
339 .firmware_revision = 0x0a2700,
340 .model_id = 0x000021,
341 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
344 .firmware_revision = 0x0a2700,
345 .model_id = 0x000023,
346 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
349 .firmware_revision = 0x0a2700,
350 .model_id = 0x00007e,
351 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
355 /**************************************
356 * General utility functions
357 **************************************/
361 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
363 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
367 for (length = (length >> 2); length--; )
368 temp[length] = be32_to_cpu(temp[length]);
374 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
376 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
380 for (length = (length >> 2); length--; )
381 temp[length] = cpu_to_be32(temp[length]);
385 #else /* BIG_ENDIAN */
386 /* Why waste the cpu cycles? */
387 #define sbp2util_be32_to_cpu_buffer(x,y) do {} while (0)
388 #define sbp2util_cpu_to_be32_buffer(x,y) do {} while (0)
391 static DECLARE_WAIT_QUEUE_HEAD(access_wq);
394 * Waits for completion of an SBP-2 access request.
395 * Returns nonzero if timed out or prematurely interrupted.
397 static int sbp2util_access_timeout(struct scsi_id_instance_data *scsi_id,
400 long leftover = wait_event_interruptible_timeout(
401 access_wq, scsi_id->access_complete, timeout);
403 scsi_id->access_complete = 0;
404 return leftover <= 0;
407 /* Frees an allocated packet */
408 static void sbp2_free_packet(struct hpsb_packet *packet)
410 hpsb_free_tlabel(packet);
411 hpsb_free_packet(packet);
414 /* This is much like hpsb_node_write(), except it ignores the response
415 * subaction and returns immediately. Can be used from interrupts.
417 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
418 quadlet_t *buffer, size_t length)
420 struct hpsb_packet *packet;
422 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
423 addr, buffer, length);
427 hpsb_set_packet_complete_task(packet,
428 (void (*)(void *))sbp2_free_packet,
431 hpsb_node_fill_packet(ne, packet);
433 if (hpsb_send_packet(packet) < 0) {
434 sbp2_free_packet(packet);
441 static void sbp2util_notify_fetch_agent(struct scsi_id_instance_data *scsi_id,
442 u64 offset, quadlet_t *data, size_t len)
445 * There is a small window after a bus reset within which the node
446 * entry's generation is current but the reconnect wasn't completed.
448 if (unlikely(atomic_read(&scsi_id->state) == SBP2LU_STATE_IN_RESET))
451 if (hpsb_node_write(scsi_id->ne,
452 scsi_id->sbp2_command_block_agent_addr + offset,
454 SBP2_ERR("sbp2util_notify_fetch_agent failed.");
456 * Now accept new SCSI commands, unless a bus reset happended during
459 if (likely(atomic_read(&scsi_id->state) != SBP2LU_STATE_IN_RESET))
460 scsi_unblock_requests(scsi_id->scsi_host);
463 static void sbp2util_write_orb_pointer(struct work_struct *work)
465 struct scsi_id_instance_data *scsi_id =
466 container_of(work, struct scsi_id_instance_data,
470 data[0] = ORB_SET_NODE_ID(scsi_id->hi->host->node_id);
471 data[1] = scsi_id->last_orb_dma;
472 sbp2util_cpu_to_be32_buffer(data, 8);
473 sbp2util_notify_fetch_agent(scsi_id, SBP2_ORB_POINTER_OFFSET, data, 8);
476 static void sbp2util_write_doorbell(struct work_struct *work)
478 struct scsi_id_instance_data *scsi_id =
479 container_of(work, struct scsi_id_instance_data,
481 sbp2util_notify_fetch_agent(scsi_id, SBP2_DOORBELL_OFFSET, NULL, 4);
485 * This function is called to create a pool of command orbs used for
486 * command processing. It is called when a new sbp2 device is detected.
488 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
490 struct sbp2scsi_host_info *hi = scsi_id->hi;
492 unsigned long flags, orbs;
493 struct sbp2_command_info *command;
495 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
497 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
498 for (i = 0; i < orbs; i++) {
499 command = kzalloc(sizeof(*command), GFP_ATOMIC);
501 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
505 command->command_orb_dma =
506 pci_map_single(hi->host->pdev, &command->command_orb,
507 sizeof(struct sbp2_command_orb),
510 pci_map_single(hi->host->pdev,
511 &command->scatter_gather_element,
512 sizeof(command->scatter_gather_element),
513 PCI_DMA_BIDIRECTIONAL);
514 INIT_LIST_HEAD(&command->list);
515 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
517 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
522 * This function is called to delete a pool of command orbs.
524 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
526 struct hpsb_host *host = scsi_id->hi->host;
527 struct list_head *lh, *next;
528 struct sbp2_command_info *command;
531 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
532 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
533 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
534 command = list_entry(lh, struct sbp2_command_info, list);
536 /* Release our generic DMA's */
537 pci_unmap_single(host->pdev, command->command_orb_dma,
538 sizeof(struct sbp2_command_orb),
540 pci_unmap_single(host->pdev, command->sge_dma,
541 sizeof(command->scatter_gather_element),
542 PCI_DMA_BIDIRECTIONAL);
546 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
551 * This function finds the sbp2_command for a given outstanding command
552 * orb.Only looks at the inuse list.
554 static struct sbp2_command_info *sbp2util_find_command_for_orb(
555 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
557 struct sbp2_command_info *command;
560 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
561 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
562 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
563 if (command->command_orb_dma == orb) {
564 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
569 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
574 * This function finds the sbp2_command for a given outstanding SCpnt.
575 * Only looks at the inuse list.
576 * Must be called with scsi_id->sbp2_command_orb_lock held.
578 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
579 struct scsi_id_instance_data *scsi_id, void *SCpnt)
581 struct sbp2_command_info *command;
583 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
584 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
585 if (command->Current_SCpnt == SCpnt)
591 * This function allocates a command orb used to send a scsi command.
593 static struct sbp2_command_info *sbp2util_allocate_command_orb(
594 struct scsi_id_instance_data *scsi_id,
595 struct scsi_cmnd *Current_SCpnt,
596 void (*Current_done)(struct scsi_cmnd *))
598 struct list_head *lh;
599 struct sbp2_command_info *command = NULL;
602 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
603 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
604 lh = scsi_id->sbp2_command_orb_completed.next;
606 command = list_entry(lh, struct sbp2_command_info, list);
607 command->Current_done = Current_done;
608 command->Current_SCpnt = Current_SCpnt;
609 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
611 SBP2_ERR("%s: no orbs available", __FUNCTION__);
613 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
618 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
620 struct scsi_id_instance_data *scsi_id =
621 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
622 struct hpsb_host *host;
625 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
629 host = scsi_id->ud->ne->host;
631 if (command->cmd_dma) {
632 if (command->dma_type == CMD_DMA_SINGLE)
633 pci_unmap_single(host->pdev, command->cmd_dma,
634 command->dma_size, command->dma_dir);
635 else if (command->dma_type == CMD_DMA_PAGE)
636 pci_unmap_page(host->pdev, command->cmd_dma,
637 command->dma_size, command->dma_dir);
638 /* XXX: Check for CMD_DMA_NONE bug */
639 command->dma_type = CMD_DMA_NONE;
640 command->cmd_dma = 0;
643 if (command->sge_buffer) {
644 pci_unmap_sg(host->pdev, command->sge_buffer,
645 command->dma_size, command->dma_dir);
646 command->sge_buffer = NULL;
651 * This function moves a command to the completed orb list.
652 * Must be called with scsi_id->sbp2_command_orb_lock held.
654 static void sbp2util_mark_command_completed(
655 struct scsi_id_instance_data *scsi_id,
656 struct sbp2_command_info *command)
658 list_del(&command->list);
659 sbp2util_free_command_dma(command);
660 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
664 * Is scsi_id valid? Is the 1394 node still present?
666 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
668 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
671 /*********************************************
672 * IEEE-1394 core driver stack related section
673 *********************************************/
675 static int sbp2_probe(struct device *dev)
677 struct unit_directory *ud;
678 struct scsi_id_instance_data *scsi_id;
680 ud = container_of(dev, struct unit_directory, device);
682 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
684 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
687 scsi_id = sbp2_alloc_device(ud);
692 sbp2_parse_unit_directory(scsi_id, ud);
694 return sbp2_start_device(scsi_id);
697 static int sbp2_remove(struct device *dev)
699 struct unit_directory *ud;
700 struct scsi_id_instance_data *scsi_id;
701 struct scsi_device *sdev;
703 ud = container_of(dev, struct unit_directory, device);
704 scsi_id = ud->device.driver_data;
708 if (scsi_id->scsi_host) {
709 /* Get rid of enqueued commands if there is no chance to
711 if (!sbp2util_node_is_available(scsi_id))
712 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
713 /* scsi_remove_device() will trigger shutdown functions of SCSI
714 * highlevel drivers which would deadlock if blocked. */
715 atomic_set(&scsi_id->state, SBP2LU_STATE_IN_SHUTDOWN);
716 scsi_unblock_requests(scsi_id->scsi_host);
718 sdev = scsi_id->sdev;
720 scsi_id->sdev = NULL;
721 scsi_remove_device(sdev);
724 sbp2_logout_device(scsi_id);
725 sbp2_remove_device(scsi_id);
730 static int sbp2_update(struct unit_directory *ud)
732 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
734 if (sbp2_reconnect_device(scsi_id)) {
737 * Ok, reconnect has failed. Perhaps we didn't
738 * reconnect fast enough. Try doing a regular login, but
739 * first do a logout just in case of any weirdness.
741 sbp2_logout_device(scsi_id);
743 if (sbp2_login_device(scsi_id)) {
744 /* Login failed too, just fail, and the backend
745 * will call our sbp2_remove for us */
746 SBP2_ERR("Failed to reconnect to sbp2 device!");
751 /* Set max retries to something large on the device. */
752 sbp2_set_busy_timeout(scsi_id);
754 /* Do a SBP-2 fetch agent reset. */
755 sbp2_agent_reset(scsi_id, 1);
757 /* Get the max speed and packet size that we can use. */
758 sbp2_max_speed_and_size(scsi_id);
760 /* Complete any pending commands with busy (so they get
761 * retried) and remove them from our queue
763 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
765 /* Accept new commands unless there was another bus reset in the
767 if (hpsb_node_entry_valid(scsi_id->ne)) {
768 atomic_set(&scsi_id->state, SBP2LU_STATE_RUNNING);
769 scsi_unblock_requests(scsi_id->scsi_host);
774 /* This functions is called by the sbp2_probe, for each new device. We now
775 * allocate one scsi host for each scsi_id (unit directory). */
776 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
778 struct sbp2scsi_host_info *hi;
779 struct Scsi_Host *scsi_host = NULL;
780 struct scsi_id_instance_data *scsi_id = NULL;
782 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
784 SBP2_ERR("failed to create scsi_id");
788 scsi_id->ne = ud->ne;
790 scsi_id->speed_code = IEEE1394_SPEED_100;
791 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
792 scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
793 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
794 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
795 INIT_LIST_HEAD(&scsi_id->scsi_list);
796 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
797 atomic_set(&scsi_id->state, SBP2LU_STATE_RUNNING);
798 INIT_DELAYED_WORK(&scsi_id->protocol_work, NULL);
800 ud->device.driver_data = scsi_id;
802 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
804 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
806 SBP2_ERR("failed to allocate hostinfo");
809 hi->host = ud->ne->host;
810 INIT_LIST_HEAD(&hi->scsi_ids);
812 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
813 /* Handle data movement if physical dma is not
814 * enabled or not supported on host controller */
815 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
817 0x0ULL, 0xfffffffcULL)) {
818 SBP2_ERR("failed to register lower 4GB address range");
824 /* Prevent unloading of the 1394 host */
825 if (!try_module_get(hi->host->driver->owner)) {
826 SBP2_ERR("failed to get a reference on 1394 host driver");
832 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
834 /* Register the status FIFO address range. We could use the same FIFO
835 * for targets at different nodes. However we need different FIFOs per
836 * target in order to support multi-unit devices.
837 * The FIFO is located out of the local host controller's physical range
838 * but, if possible, within the posted write area. Status writes will
839 * then be performed as unified transactions. This slightly reduces
840 * bandwidth usage, and some Prolific based devices seem to require it.
842 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
843 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
844 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
845 ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
846 if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
847 SBP2_ERR("failed to allocate status FIFO address range");
851 /* Register our host with the SCSI stack. */
852 scsi_host = scsi_host_alloc(&scsi_driver_template,
853 sizeof(unsigned long));
855 SBP2_ERR("failed to register scsi host");
859 scsi_host->hostdata[0] = (unsigned long)scsi_id;
861 if (!scsi_add_host(scsi_host, &ud->device)) {
862 scsi_id->scsi_host = scsi_host;
866 SBP2_ERR("failed to add scsi host");
867 scsi_host_put(scsi_host);
870 sbp2_remove_device(scsi_id);
874 static void sbp2_host_reset(struct hpsb_host *host)
876 struct sbp2scsi_host_info *hi;
877 struct scsi_id_instance_data *scsi_id;
879 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
882 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
883 if (likely(atomic_read(&scsi_id->state) !=
884 SBP2LU_STATE_IN_SHUTDOWN)) {
885 atomic_set(&scsi_id->state, SBP2LU_STATE_IN_RESET);
886 scsi_block_requests(scsi_id->scsi_host);
891 * This function is where we first pull the node unique ids, and then
892 * allocate memory and register a SBP-2 device.
894 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
896 struct sbp2scsi_host_info *hi = scsi_id->hi;
900 scsi_id->login_response =
901 pci_alloc_consistent(hi->host->pdev,
902 sizeof(struct sbp2_login_response),
903 &scsi_id->login_response_dma);
904 if (!scsi_id->login_response)
907 /* Query logins ORB DMA */
908 scsi_id->query_logins_orb =
909 pci_alloc_consistent(hi->host->pdev,
910 sizeof(struct sbp2_query_logins_orb),
911 &scsi_id->query_logins_orb_dma);
912 if (!scsi_id->query_logins_orb)
915 /* Query logins response DMA */
916 scsi_id->query_logins_response =
917 pci_alloc_consistent(hi->host->pdev,
918 sizeof(struct sbp2_query_logins_response),
919 &scsi_id->query_logins_response_dma);
920 if (!scsi_id->query_logins_response)
923 /* Reconnect ORB DMA */
924 scsi_id->reconnect_orb =
925 pci_alloc_consistent(hi->host->pdev,
926 sizeof(struct sbp2_reconnect_orb),
927 &scsi_id->reconnect_orb_dma);
928 if (!scsi_id->reconnect_orb)
932 scsi_id->logout_orb =
933 pci_alloc_consistent(hi->host->pdev,
934 sizeof(struct sbp2_logout_orb),
935 &scsi_id->logout_orb_dma);
936 if (!scsi_id->logout_orb)
941 pci_alloc_consistent(hi->host->pdev,
942 sizeof(struct sbp2_login_orb),
943 &scsi_id->login_orb_dma);
944 if (!scsi_id->login_orb)
948 * Create our command orb pool
950 if (sbp2util_create_command_orb_pool(scsi_id)) {
951 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
952 sbp2_remove_device(scsi_id);
956 /* Schedule a timeout here. The reason is that we may be so close
957 * to a bus reset, that the device is not available for logins.
958 * This can happen when the bus reset is caused by the host
959 * connected to the sbp2 device being removed. That host would
960 * have a certain amount of time to relogin before the sbp2 device
961 * allows someone else to login instead. One second makes sense. */
962 if (msleep_interruptible(1000)) {
963 sbp2_remove_device(scsi_id);
968 * Login to the sbp-2 device
970 if (sbp2_login_device(scsi_id)) {
971 /* Login failed, just remove the device. */
972 sbp2_remove_device(scsi_id);
977 * Set max retries to something large on the device
979 sbp2_set_busy_timeout(scsi_id);
982 * Do a SBP-2 fetch agent reset
984 sbp2_agent_reset(scsi_id, 1);
987 * Get the max speed and packet size that we can use
989 sbp2_max_speed_and_size(scsi_id);
991 /* Add this device to the scsi layer now */
992 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
994 SBP2_ERR("scsi_add_device failed");
995 sbp2_logout_device(scsi_id);
996 sbp2_remove_device(scsi_id);
1003 SBP2_ERR("Could not allocate memory for scsi_id");
1004 sbp2_remove_device(scsi_id);
1009 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1011 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1013 struct sbp2scsi_host_info *hi;
1020 /* This will remove our scsi device aswell */
1021 if (scsi_id->scsi_host) {
1022 scsi_remove_host(scsi_id->scsi_host);
1023 scsi_host_put(scsi_id->scsi_host);
1025 flush_scheduled_work();
1026 sbp2util_remove_command_orb_pool(scsi_id);
1028 list_del(&scsi_id->scsi_list);
1030 if (scsi_id->login_response)
1031 pci_free_consistent(hi->host->pdev,
1032 sizeof(struct sbp2_login_response),
1033 scsi_id->login_response,
1034 scsi_id->login_response_dma);
1035 if (scsi_id->login_orb)
1036 pci_free_consistent(hi->host->pdev,
1037 sizeof(struct sbp2_login_orb),
1039 scsi_id->login_orb_dma);
1040 if (scsi_id->reconnect_orb)
1041 pci_free_consistent(hi->host->pdev,
1042 sizeof(struct sbp2_reconnect_orb),
1043 scsi_id->reconnect_orb,
1044 scsi_id->reconnect_orb_dma);
1045 if (scsi_id->logout_orb)
1046 pci_free_consistent(hi->host->pdev,
1047 sizeof(struct sbp2_logout_orb),
1048 scsi_id->logout_orb,
1049 scsi_id->logout_orb_dma);
1050 if (scsi_id->query_logins_orb)
1051 pci_free_consistent(hi->host->pdev,
1052 sizeof(struct sbp2_query_logins_orb),
1053 scsi_id->query_logins_orb,
1054 scsi_id->query_logins_orb_dma);
1055 if (scsi_id->query_logins_response)
1056 pci_free_consistent(hi->host->pdev,
1057 sizeof(struct sbp2_query_logins_response),
1058 scsi_id->query_logins_response,
1059 scsi_id->query_logins_response_dma);
1061 if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
1062 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1063 scsi_id->status_fifo_addr);
1065 scsi_id->ud->device.driver_data = NULL;
1068 module_put(hi->host->driver->owner);
1073 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1075 * This function deals with physical dma write requests (for adapters that do not support
1076 * physical dma in hardware). Mostly just here for debugging...
1078 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1079 int destid, quadlet_t *data, u64 addr,
1080 size_t length, u16 flags)
1084 * Manually put the data in the right place.
1086 memcpy(bus_to_virt((u32) addr), data, length);
1087 return RCODE_COMPLETE;
1091 * This function deals with physical dma read requests (for adapters that do not support
1092 * physical dma in hardware). Mostly just here for debugging...
1094 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1095 quadlet_t *data, u64 addr, size_t length,
1100 * Grab data from memory and send a read response.
1102 memcpy(data, bus_to_virt((u32) addr), length);
1103 return RCODE_COMPLETE;
1107 /**************************************
1108 * SBP-2 protocol related section
1109 **************************************/
1112 * This function queries the device for the maximum concurrent logins it
1115 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1117 struct sbp2scsi_host_info *hi = scsi_id->hi;
1122 scsi_id->query_logins_orb->reserved1 = 0x0;
1123 scsi_id->query_logins_orb->reserved2 = 0x0;
1125 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1126 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1128 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1129 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1130 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1132 scsi_id->query_logins_orb->reserved_resp_length =
1133 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1135 scsi_id->query_logins_orb->status_fifo_hi =
1136 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1137 scsi_id->query_logins_orb->status_fifo_lo =
1138 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1140 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1142 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1144 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1145 data[1] = scsi_id->query_logins_orb_dma;
1146 sbp2util_cpu_to_be32_buffer(data, 8);
1148 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1150 if (sbp2util_access_timeout(scsi_id, 2*HZ)) {
1151 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1155 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1156 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1160 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1161 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1165 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1167 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1168 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1170 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1171 SBP2_INFO("Number of active logins: %d", active_logins);
1173 if (active_logins >= max_logins) {
1181 * This function is called in order to login to a particular SBP-2 device,
1182 * after a bus reset.
1184 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1186 struct sbp2scsi_host_info *hi = scsi_id->hi;
1189 if (!scsi_id->login_orb)
1192 if (!exclusive_login) {
1193 if (sbp2_query_logins(scsi_id)) {
1194 SBP2_INFO("Device does not support any more concurrent logins");
1199 /* Set-up login ORB, assume no password */
1200 scsi_id->login_orb->password_hi = 0;
1201 scsi_id->login_orb->password_lo = 0;
1203 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1204 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1206 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1207 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1208 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1209 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1210 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1212 scsi_id->login_orb->passwd_resp_lengths =
1213 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1215 scsi_id->login_orb->status_fifo_hi =
1216 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1217 scsi_id->login_orb->status_fifo_lo =
1218 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1220 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1222 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1224 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1225 data[1] = scsi_id->login_orb_dma;
1226 sbp2util_cpu_to_be32_buffer(data, 8);
1228 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1231 * Wait for login status (up to 20 seconds)...
1233 if (sbp2util_access_timeout(scsi_id, 20*HZ)) {
1234 SBP2_ERR("Error logging into SBP-2 device - timed out");
1239 * Sanity. Make sure status returned matches login orb.
1241 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1242 SBP2_ERR("Error logging into SBP-2 device - timed out");
1246 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1247 SBP2_ERR("Error logging into SBP-2 device - failed");
1252 * Byte swap the login response, for use when reconnecting or
1255 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1258 * Grab our command block agent address from the login response.
1260 scsi_id->sbp2_command_block_agent_addr =
1261 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1262 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1263 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1265 SBP2_INFO("Logged into SBP-2 device");
1270 * This function is called in order to logout from a particular SBP-2
1271 * device, usually called during driver unload.
1273 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1275 struct sbp2scsi_host_info *hi = scsi_id->hi;
1282 scsi_id->logout_orb->reserved1 = 0x0;
1283 scsi_id->logout_orb->reserved2 = 0x0;
1284 scsi_id->logout_orb->reserved3 = 0x0;
1285 scsi_id->logout_orb->reserved4 = 0x0;
1287 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1288 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1290 /* Notify us when complete */
1291 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1293 scsi_id->logout_orb->reserved5 = 0x0;
1294 scsi_id->logout_orb->status_fifo_hi =
1295 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1296 scsi_id->logout_orb->status_fifo_lo =
1297 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1300 * Byte swap ORB if necessary
1302 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1305 * Ok, let's write to the target's management agent register
1307 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1308 data[1] = scsi_id->logout_orb_dma;
1309 sbp2util_cpu_to_be32_buffer(data, 8);
1311 error = hpsb_node_write(scsi_id->ne,
1312 scsi_id->sbp2_management_agent_addr, data, 8);
1316 /* Wait for device to logout...1 second. */
1317 if (sbp2util_access_timeout(scsi_id, HZ))
1320 SBP2_INFO("Logged out of SBP-2 device");
1325 * This function is called in order to reconnect to a particular SBP-2
1326 * device, after a bus reset.
1328 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1330 struct sbp2scsi_host_info *hi = scsi_id->hi;
1335 * Set-up reconnect ORB
1337 scsi_id->reconnect_orb->reserved1 = 0x0;
1338 scsi_id->reconnect_orb->reserved2 = 0x0;
1339 scsi_id->reconnect_orb->reserved3 = 0x0;
1340 scsi_id->reconnect_orb->reserved4 = 0x0;
1342 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1343 scsi_id->reconnect_orb->login_ID_misc |=
1344 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1346 /* Notify us when complete */
1347 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1349 scsi_id->reconnect_orb->reserved5 = 0x0;
1350 scsi_id->reconnect_orb->status_fifo_hi =
1351 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1352 scsi_id->reconnect_orb->status_fifo_lo =
1353 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1356 * Byte swap ORB if necessary
1358 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1360 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1361 data[1] = scsi_id->reconnect_orb_dma;
1362 sbp2util_cpu_to_be32_buffer(data, 8);
1364 error = hpsb_node_write(scsi_id->ne,
1365 scsi_id->sbp2_management_agent_addr, data, 8);
1370 * Wait for reconnect status (up to 1 second)...
1372 if (sbp2util_access_timeout(scsi_id, HZ)) {
1373 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1378 * Sanity. Make sure status returned matches reconnect orb.
1380 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1381 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1385 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1386 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1390 SBP2_INFO("Reconnected to SBP-2 device");
1395 * This function is called in order to set the busy timeout (number of
1396 * retries to attempt) on the sbp2 device.
1398 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1402 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1403 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1404 SBP2_ERR("%s error", __FUNCTION__);
1409 * This function is called to parse sbp2 device's config rom unit
1410 * directory. Used to determine things like sbp2 management agent offset,
1411 * and command set used (SCSI or RBC).
1413 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1414 struct unit_directory *ud)
1416 struct csr1212_keyval *kv;
1417 struct csr1212_dentry *dentry;
1418 u64 management_agent_addr;
1419 u32 command_set_spec_id, command_set, unit_characteristics,
1421 unsigned workarounds;
1424 management_agent_addr = 0x0;
1425 command_set_spec_id = 0x0;
1427 unit_characteristics = 0x0;
1428 firmware_revision = 0x0;
1430 /* Handle different fields in the unit directory, based on keys */
1431 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1432 switch (kv->key.id) {
1433 case CSR1212_KV_ID_DEPENDENT_INFO:
1434 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET)
1435 /* Save off the management agent address */
1436 management_agent_addr =
1437 CSR1212_REGISTER_SPACE_BASE +
1438 (kv->value.csr_offset << 2);
1440 else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE)
1442 ORB_SET_LUN(kv->value.immediate);
1445 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1446 /* Command spec organization */
1447 command_set_spec_id = kv->value.immediate;
1450 case SBP2_COMMAND_SET_KEY:
1451 /* Command set used by sbp2 device */
1452 command_set = kv->value.immediate;
1455 case SBP2_UNIT_CHARACTERISTICS_KEY:
1457 * Unit characterisitcs (orb related stuff
1458 * that I'm not yet paying attention to)
1460 unit_characteristics = kv->value.immediate;
1463 case SBP2_FIRMWARE_REVISION_KEY:
1464 /* Firmware revision */
1465 firmware_revision = kv->value.immediate;
1473 workarounds = sbp2_default_workarounds;
1475 if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1476 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1477 if (sbp2_workarounds_table[i].firmware_revision &&
1478 sbp2_workarounds_table[i].firmware_revision !=
1479 (firmware_revision & 0xffff00))
1481 if (sbp2_workarounds_table[i].model_id &&
1482 sbp2_workarounds_table[i].model_id != ud->model_id)
1484 workarounds |= sbp2_workarounds_table[i].workarounds;
1489 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1490 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1491 " model_id 0x%06x)",
1492 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1493 workarounds, firmware_revision,
1494 ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1497 /* We would need one SCSI host template for each target to adjust
1498 * max_sectors on the fly, therefore warn only. */
1499 if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1500 (max_sectors * 512) > (128 * 1024))
1501 SBP2_INFO("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1502 "max transfer size. WARNING: Current max_sectors "
1503 "setting is larger than 128KB (%d sectors)",
1504 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1507 /* If this is a logical unit directory entry, process the parent
1508 * to get the values. */
1509 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1510 struct unit_directory *parent_ud =
1511 container_of(ud->device.parent, struct unit_directory, device);
1512 sbp2_parse_unit_directory(scsi_id, parent_ud);
1514 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1515 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1516 scsi_id->sbp2_command_set = command_set;
1517 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1518 scsi_id->sbp2_firmware_revision = firmware_revision;
1519 scsi_id->workarounds = workarounds;
1520 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1521 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1525 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1528 * This function is called in order to determine the max speed and packet
1529 * size we can use in our ORBs. Note, that we (the driver and host) only
1530 * initiate the transaction. The SBP-2 device actually transfers the data
1531 * (by reading from the DMA area we tell it). This means that the SBP-2
1532 * device decides the actual maximum data it can transfer. We just tell it
1533 * the speed that it needs to use, and the max_rec the host supports, and
1534 * it takes care of the rest.
1536 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1538 struct sbp2scsi_host_info *hi = scsi_id->hi;
1541 scsi_id->speed_code =
1542 hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1544 /* Bump down our speed if the user requested it */
1545 if (scsi_id->speed_code > max_speed) {
1546 scsi_id->speed_code = max_speed;
1547 SBP2_INFO("Reducing speed to %s", hpsb_speedto_str[max_speed]);
1550 /* Payload size is the lesser of what our speed supports and what
1551 * our host supports. */
1552 payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1553 (u8) (hi->host->csr.max_rec - 1));
1555 /* If physical DMA is off, work around limitation in ohci1394:
1556 * packet size must not exceed PAGE_SIZE */
1557 if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1558 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1562 SBP2_INFO("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1563 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1564 hpsb_speedto_str[scsi_id->speed_code],
1565 SBP2_PAYLOAD_TO_BYTES(payload));
1567 scsi_id->max_payload_size = payload;
1572 * This function is called in order to perform a SBP-2 agent reset.
1574 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1579 unsigned long flags;
1581 cancel_delayed_work(&scsi_id->protocol_work);
1583 flush_scheduled_work();
1585 data = ntohl(SBP2_AGENT_RESET_DATA);
1586 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1589 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1591 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1594 SBP2_ERR("hpsb_node_write failed.\n");
1599 * Need to make sure orb pointer is written on next command
1601 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1602 scsi_id->last_orb = NULL;
1603 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1608 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1609 struct sbp2scsi_host_info *hi,
1610 struct sbp2_command_info *command,
1611 unsigned int scsi_use_sg,
1612 struct scatterlist *sgpnt,
1614 enum dma_data_direction dma_dir)
1616 command->dma_dir = dma_dir;
1617 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1618 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1620 /* Special case if only one element (and less than 64KB in size) */
1621 if ((scsi_use_sg == 1) &&
1622 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1624 command->dma_size = sgpnt[0].length;
1625 command->dma_type = CMD_DMA_PAGE;
1626 command->cmd_dma = pci_map_page(hi->host->pdev,
1632 orb->data_descriptor_lo = command->cmd_dma;
1633 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1636 struct sbp2_unrestricted_page_table *sg_element =
1637 &command->scatter_gather_element[0];
1638 u32 sg_count, sg_len;
1640 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1643 command->dma_size = scsi_use_sg;
1644 command->sge_buffer = sgpnt;
1646 /* use page tables (s/g) */
1647 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1648 orb->data_descriptor_lo = command->sge_dma;
1651 * Loop through and fill out our sbp-2 page tables
1652 * (and split up anything too large)
1654 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1655 sg_len = sg_dma_len(sgpnt);
1656 sg_addr = sg_dma_address(sgpnt);
1658 sg_element[sg_count].segment_base_lo = sg_addr;
1659 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1660 sg_element[sg_count].length_segment_base_hi =
1661 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1662 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1663 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1665 sg_element[sg_count].length_segment_base_hi =
1666 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1673 /* Number of page table (s/g) elements */
1674 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1676 /* Byte swap page tables if necessary */
1677 sbp2util_cpu_to_be32_buffer(sg_element,
1678 (sizeof(struct sbp2_unrestricted_page_table)) *
1683 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1684 struct sbp2scsi_host_info *hi,
1685 struct sbp2_command_info *command,
1686 struct scatterlist *sgpnt,
1688 unsigned int scsi_request_bufflen,
1689 void *scsi_request_buffer,
1690 enum dma_data_direction dma_dir)
1692 command->dma_dir = dma_dir;
1693 command->dma_size = scsi_request_bufflen;
1694 command->dma_type = CMD_DMA_SINGLE;
1695 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1696 command->dma_size, command->dma_dir);
1697 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1698 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1701 * Handle case where we get a command w/o s/g enabled (but
1702 * check for transfers larger than 64K)
1704 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1706 orb->data_descriptor_lo = command->cmd_dma;
1707 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1710 struct sbp2_unrestricted_page_table *sg_element =
1711 &command->scatter_gather_element[0];
1712 u32 sg_count, sg_len;
1716 * Need to turn this into page tables, since the
1717 * buffer is too large.
1719 orb->data_descriptor_lo = command->sge_dma;
1721 /* Use page tables (s/g) */
1722 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1725 * fill out our sbp-2 page tables (and split up
1729 sg_len = scsi_request_bufflen;
1730 sg_addr = command->cmd_dma;
1732 sg_element[sg_count].segment_base_lo = sg_addr;
1733 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1734 sg_element[sg_count].length_segment_base_hi =
1735 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1736 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1737 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1739 sg_element[sg_count].length_segment_base_hi =
1740 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1746 /* Number of page table (s/g) elements */
1747 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1749 /* Byte swap page tables if necessary */
1750 sbp2util_cpu_to_be32_buffer(sg_element,
1751 (sizeof(struct sbp2_unrestricted_page_table)) *
1757 * This function is called to create the actual command orb and s/g list
1758 * out of the scsi command itself.
1760 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1761 struct sbp2_command_info *command,
1763 unsigned int scsi_use_sg,
1764 unsigned int scsi_request_bufflen,
1765 void *scsi_request_buffer,
1766 enum dma_data_direction dma_dir)
1768 struct sbp2scsi_host_info *hi = scsi_id->hi;
1769 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1770 struct sbp2_command_orb *command_orb = &command->command_orb;
1774 * Set-up our command ORB..
1776 * NOTE: We're doing unrestricted page tables (s/g), as this is
1777 * best performance (at least with the devices I have). This means
1778 * that data_size becomes the number of s/g elements, and
1779 * page_size should be zero (for unrestricted).
1781 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1782 command_orb->next_ORB_lo = 0x0;
1783 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1784 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1785 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1787 if (dma_dir == DMA_NONE)
1788 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1789 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1790 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1791 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1792 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1794 SBP2_INFO("Falling back to DMA_NONE");
1795 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1798 /* Set-up our pagetable stuff */
1799 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1800 command_orb->data_descriptor_hi = 0x0;
1801 command_orb->data_descriptor_lo = 0x0;
1802 command_orb->misc |= ORB_SET_DIRECTION(1);
1803 } else if (scsi_use_sg)
1804 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1805 sgpnt, orb_direction, dma_dir);
1807 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1808 orb_direction, scsi_request_bufflen,
1809 scsi_request_buffer, dma_dir);
1811 /* Byte swap command ORB if necessary */
1812 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1814 /* Put our scsi command in the command ORB */
1815 memset(command_orb->cdb, 0, 12);
1816 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1820 * This function is called in order to begin a regular SBP-2 command.
1822 static void sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1823 struct sbp2_command_info *command)
1825 struct sbp2scsi_host_info *hi = scsi_id->hi;
1826 struct sbp2_command_orb *command_orb = &command->command_orb;
1827 struct sbp2_command_orb *last_orb;
1828 dma_addr_t last_orb_dma;
1829 u64 addr = scsi_id->sbp2_command_block_agent_addr;
1832 unsigned long flags;
1834 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1835 sizeof(struct sbp2_command_orb),
1837 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1838 sizeof(command->scatter_gather_element),
1839 PCI_DMA_BIDIRECTIONAL);
1841 * Check to see if there are any previous orbs to use
1843 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1844 last_orb = scsi_id->last_orb;
1845 last_orb_dma = scsi_id->last_orb_dma;
1848 * last_orb == NULL means: We know that the target's fetch agent
1849 * is not active right now.
1851 addr += SBP2_ORB_POINTER_OFFSET;
1852 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1853 data[1] = command->command_orb_dma;
1854 sbp2util_cpu_to_be32_buffer(data, 8);
1858 * last_orb != NULL means: We know that the target's fetch agent
1859 * is (very probably) not dead or in reset state right now.
1860 * We have an ORB already sent that we can append a new one to.
1861 * The target's fetch agent may or may not have read this
1864 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
1865 sizeof(struct sbp2_command_orb),
1867 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
1869 /* Tells hardware that this pointer is valid */
1870 last_orb->next_ORB_hi = 0;
1871 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
1872 sizeof(struct sbp2_command_orb),
1874 addr += SBP2_DOORBELL_OFFSET;
1878 scsi_id->last_orb = command_orb;
1879 scsi_id->last_orb_dma = command->command_orb_dma;
1880 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1882 if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length)) {
1884 * sbp2util_node_write_no_wait failed. We certainly ran out
1885 * of transaction labels, perhaps just because there were no
1886 * context switches which gave khpsbpkt a chance to collect
1887 * free tlabels. Try again in non-atomic context. If necessary,
1888 * the workqueue job will sleep to guaranteedly get a tlabel.
1889 * We do not accept new commands until the job is over.
1891 scsi_block_requests(scsi_id->scsi_host);
1892 PREPARE_DELAYED_WORK(&scsi_id->protocol_work,
1893 last_orb ? sbp2util_write_doorbell:
1894 sbp2util_write_orb_pointer);
1895 schedule_delayed_work(&scsi_id->protocol_work, 0);
1900 * This function is called in order to begin a regular SBP-2 command.
1902 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
1903 struct scsi_cmnd *SCpnt,
1904 void (*done)(struct scsi_cmnd *))
1906 unchar *cmd = (unchar *) SCpnt->cmnd;
1907 unsigned int request_bufflen = SCpnt->request_bufflen;
1908 struct sbp2_command_info *command;
1911 * Allocate a command orb and s/g structure
1913 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
1918 * Now actually fill in the comamnd orb and sbp2 s/g list
1920 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
1921 request_bufflen, SCpnt->request_buffer,
1922 SCpnt->sc_data_direction);
1925 * Link up the orb, and ring the doorbell if needed
1927 sbp2_link_orb_command(scsi_id, command);
1933 * Translates SBP-2 status into SCSI sense data for check conditions
1935 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
1938 * Ok, it's pretty ugly... ;-)
1940 sense_data[0] = 0x70;
1941 sense_data[1] = 0x0;
1942 sense_data[2] = sbp2_status[9];
1943 sense_data[3] = sbp2_status[12];
1944 sense_data[4] = sbp2_status[13];
1945 sense_data[5] = sbp2_status[14];
1946 sense_data[6] = sbp2_status[15];
1948 sense_data[8] = sbp2_status[16];
1949 sense_data[9] = sbp2_status[17];
1950 sense_data[10] = sbp2_status[18];
1951 sense_data[11] = sbp2_status[19];
1952 sense_data[12] = sbp2_status[10];
1953 sense_data[13] = sbp2_status[11];
1954 sense_data[14] = sbp2_status[20];
1955 sense_data[15] = sbp2_status[21];
1957 return sbp2_status[8] & 0x3f; /* return scsi status */
1961 * This function deals with status writes from the SBP-2 device
1963 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
1964 int destid, quadlet_t *data, u64 addr,
1965 size_t length, u16 fl)
1967 struct sbp2scsi_host_info *hi;
1968 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
1969 struct scsi_cmnd *SCpnt = NULL;
1970 struct sbp2_status_block *sb;
1971 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
1972 struct sbp2_command_info *command;
1973 unsigned long flags;
1975 if (unlikely(length < 8 || length > sizeof(struct sbp2_status_block))) {
1976 SBP2_ERR("Wrong size of status block");
1977 return RCODE_ADDRESS_ERROR;
1979 if (unlikely(!host)) {
1980 SBP2_ERR("host is NULL - this is bad!");
1981 return RCODE_ADDRESS_ERROR;
1983 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
1984 if (unlikely(!hi)) {
1985 SBP2_ERR("host info is NULL - this is bad!");
1986 return RCODE_ADDRESS_ERROR;
1989 * Find our scsi_id structure by looking at the status fifo address
1990 * written to by the sbp2 device.
1992 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
1993 if (scsi_id_tmp->ne->nodeid == nodeid &&
1994 scsi_id_tmp->status_fifo_addr == addr) {
1995 scsi_id = scsi_id_tmp;
1999 if (unlikely(!scsi_id)) {
2000 SBP2_ERR("scsi_id is NULL - device is gone?");
2001 return RCODE_ADDRESS_ERROR;
2005 * Put response into scsi_id status fifo buffer. The first two bytes
2006 * come in big endian bit order. Often the target writes only a
2007 * truncated status block, minimally the first two quadlets. The rest
2008 * is implied to be zeros.
2010 sb = &scsi_id->status_block;
2011 memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
2012 memcpy(sb, data, length);
2013 sbp2util_be32_to_cpu_buffer(sb, 8);
2016 * Ignore unsolicited status. Handle command ORB status.
2018 if (unlikely(STATUS_GET_SRC(sb->ORB_offset_hi_misc) == 2))
2021 command = sbp2util_find_command_for_orb(scsi_id,
2024 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2025 sizeof(struct sbp2_command_orb),
2027 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2028 sizeof(command->scatter_gather_element),
2029 PCI_DMA_BIDIRECTIONAL);
2031 * Matched status with command, now grab scsi command pointers
2035 * FIXME: If the src field in the status is 1, the ORB DMA must
2036 * not be reused until status for a subsequent ORB is received.
2038 SCpnt = command->Current_SCpnt;
2039 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2040 sbp2util_mark_command_completed(scsi_id, command);
2041 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2044 u32 h = sb->ORB_offset_hi_misc;
2045 u32 r = STATUS_GET_RESP(h);
2047 if (r != RESP_STATUS_REQUEST_COMPLETE) {
2048 SBP2_INFO("resp 0x%x, sbp_status 0x%x",
2049 r, STATUS_GET_SBP_STATUS(h));
2051 r == RESP_STATUS_TRANSPORT_FAILURE ?
2052 SBP2_SCSI_STATUS_BUSY :
2053 SBP2_SCSI_STATUS_COMMAND_TERMINATED;
2056 * See if the target stored any scsi status information.
2058 if (STATUS_GET_LEN(h) > 1)
2059 scsi_status = sbp2_status_to_sense_data(
2060 (unchar *)sb, SCpnt->sense_buffer);
2062 * Check to see if the dead bit is set. If so, we'll
2063 * have to initiate a fetch agent reset.
2065 if (STATUS_TEST_DEAD(h))
2066 sbp2_agent_reset(scsi_id, 0);
2070 * Check here to see if there are no commands in-use. If there
2071 * are none, we know that the fetch agent left the active state
2072 * _and_ that we did not reactivate it yet. Therefore clear
2073 * last_orb so that next time we write directly to the
2074 * ORB_POINTER register. That way the fetch agent does not need
2075 * to refetch the next_ORB.
2077 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2078 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
2079 scsi_id->last_orb = NULL;
2080 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2084 * It's probably a login/logout/reconnect status.
2086 if ((sb->ORB_offset_lo == scsi_id->reconnect_orb_dma) ||
2087 (sb->ORB_offset_lo == scsi_id->login_orb_dma) ||
2088 (sb->ORB_offset_lo == scsi_id->query_logins_orb_dma) ||
2089 (sb->ORB_offset_lo == scsi_id->logout_orb_dma)) {
2090 scsi_id->access_complete = 1;
2091 wake_up_interruptible(&access_wq);
2096 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2097 command->Current_done);
2098 return RCODE_COMPLETE;
2101 /**************************************
2102 * SCSI interface related section
2103 **************************************/
2106 * This routine is the main request entry routine for doing I/O. It is
2107 * called from the scsi stack directly.
2109 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2110 void (*done)(struct scsi_cmnd *))
2112 struct scsi_id_instance_data *scsi_id =
2113 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2114 struct sbp2scsi_host_info *hi;
2115 int result = DID_NO_CONNECT << 16;
2117 if (!sbp2util_node_is_available(scsi_id))
2123 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2128 * Until we handle multiple luns, just return selection time-out
2129 * to any IO directed at non-zero LUNs
2131 if (SCpnt->device->lun)
2135 * Check for request sense command, and handle it here
2136 * (autorequest sense)
2138 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2139 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2140 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2141 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2146 * Check to see if we are in the middle of a bus reset.
2148 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2149 SBP2_ERR("Bus reset in progress - rejecting command");
2150 result = DID_BUS_BUSY << 16;
2155 * Bidirectional commands are not yet implemented,
2156 * and unknown transfer direction not handled.
2158 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2159 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2160 result = DID_ERROR << 16;
2165 * Try and send our SCSI command
2167 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2168 SBP2_ERR("Error sending SCSI command");
2169 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2175 SCpnt->result = result;
2181 * This function is called in order to complete all outstanding SBP-2
2182 * commands (in case of resets, etc.).
2184 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2187 struct sbp2scsi_host_info *hi = scsi_id->hi;
2188 struct list_head *lh;
2189 struct sbp2_command_info *command;
2190 unsigned long flags;
2192 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2193 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2194 lh = scsi_id->sbp2_command_orb_inuse.next;
2195 command = list_entry(lh, struct sbp2_command_info, list);
2196 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2197 sizeof(struct sbp2_command_orb),
2199 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2200 sizeof(command->scatter_gather_element),
2201 PCI_DMA_BIDIRECTIONAL);
2202 sbp2util_mark_command_completed(scsi_id, command);
2203 if (command->Current_SCpnt) {
2204 command->Current_SCpnt->result = status << 16;
2205 command->Current_done(command->Current_SCpnt);
2208 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2214 * This function is called in order to complete a regular SBP-2 command.
2216 * This can be called in interrupt context.
2218 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2219 u32 scsi_status, struct scsi_cmnd *SCpnt,
2220 void (*done)(struct scsi_cmnd *))
2226 SBP2_ERR("SCpnt is NULL");
2231 * Switch on scsi status
2233 switch (scsi_status) {
2234 case SBP2_SCSI_STATUS_GOOD:
2235 SCpnt->result = DID_OK << 16;
2238 case SBP2_SCSI_STATUS_BUSY:
2239 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2240 SCpnt->result = DID_BUS_BUSY << 16;
2243 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2244 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2247 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2248 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2249 SCpnt->result = DID_NO_CONNECT << 16;
2250 scsi_print_command(SCpnt);
2253 case SBP2_SCSI_STATUS_CONDITION_MET:
2254 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2255 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2256 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2257 SCpnt->result = DID_ERROR << 16;
2258 scsi_print_command(SCpnt);
2262 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2263 SCpnt->result = DID_ERROR << 16;
2267 * If a bus reset is in progress and there was an error, complete
2268 * the command as busy so that it will get retried.
2270 if (!hpsb_node_entry_valid(scsi_id->ne)
2271 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2272 SBP2_ERR("Completing command with busy (bus reset)");
2273 SCpnt->result = DID_BUS_BUSY << 16;
2277 * Tell scsi stack that we're done with this command
2282 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2284 struct scsi_id_instance_data *scsi_id =
2285 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2287 scsi_id->sdev = sdev;
2288 sdev->allow_restart = 1;
2290 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2291 sdev->inquiry_len = 36;
2295 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2297 struct scsi_id_instance_data *scsi_id =
2298 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2300 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2301 sdev->use_10_for_rw = 1;
2303 if (sdev->type == TYPE_DISK &&
2304 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2305 sdev->skip_ms_page_8 = 1;
2306 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2307 sdev->fix_capacity = 1;
2311 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2313 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2318 * Called by scsi stack when something has really gone wrong. Usually
2319 * called when a command has timed-out for some reason.
2321 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2323 struct scsi_id_instance_data *scsi_id =
2324 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2325 struct sbp2scsi_host_info *hi = scsi_id->hi;
2326 struct sbp2_command_info *command;
2327 unsigned long flags;
2329 SBP2_INFO("aborting sbp2 command");
2330 scsi_print_command(SCpnt);
2332 if (sbp2util_node_is_available(scsi_id)) {
2333 sbp2_agent_reset(scsi_id, 1);
2335 /* Return a matching command structure to the free pool. */
2336 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2337 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2339 pci_dma_sync_single_for_cpu(hi->host->pdev,
2340 command->command_orb_dma,
2341 sizeof(struct sbp2_command_orb),
2343 pci_dma_sync_single_for_cpu(hi->host->pdev,
2345 sizeof(command->scatter_gather_element),
2346 PCI_DMA_BIDIRECTIONAL);
2347 sbp2util_mark_command_completed(scsi_id, command);
2348 if (command->Current_SCpnt) {
2349 command->Current_SCpnt->result = DID_ABORT << 16;
2350 command->Current_done(command->Current_SCpnt);
2353 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2355 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2362 * Called by scsi stack when something has really gone wrong.
2364 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2366 struct scsi_id_instance_data *scsi_id =
2367 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2369 SBP2_INFO("reset requested");
2371 if (sbp2util_node_is_available(scsi_id)) {
2372 SBP2_INFO("generating sbp2 fetch agent reset");
2373 sbp2_agent_reset(scsi_id, 1);
2379 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2380 struct device_attribute *attr,
2383 struct scsi_device *sdev;
2384 struct scsi_id_instance_data *scsi_id;
2387 if (!(sdev = to_scsi_device(dev)))
2390 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2393 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2395 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2396 scsi_id->ud->id, lun);
2399 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2400 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2401 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2402 MODULE_LICENSE("GPL");
2404 static int sbp2_module_init(void)
2408 /* Module load debug option to force one command at a time (serializing I/O) */
2410 scsi_driver_template.can_queue = 1;
2411 scsi_driver_template.cmd_per_lun = 1;
2414 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2415 (max_sectors * 512) > (128 * 1024))
2416 max_sectors = 128 * 1024 / 512;
2417 scsi_driver_template.max_sectors = max_sectors;
2419 /* Register our high level driver with 1394 stack */
2420 hpsb_register_highlevel(&sbp2_highlevel);
2422 ret = hpsb_register_protocol(&sbp2_driver);
2424 SBP2_ERR("Failed to register protocol");
2425 hpsb_unregister_highlevel(&sbp2_highlevel);
2432 static void __exit sbp2_module_exit(void)
2434 hpsb_unregister_protocol(&sbp2_driver);
2435 hpsb_unregister_highlevel(&sbp2_highlevel);
2438 module_init(sbp2_module_init);
2439 module_exit(sbp2_module_exit);