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/kernel.h>
42 #include <linux/list.h>
43 #include <linux/string.h>
44 #include <linux/stringify.h>
45 #include <linux/slab.h>
46 #include <linux/interrupt.h>
48 #include <linux/poll.h>
49 #include <linux/module.h>
50 #include <linux/moduleparam.h>
51 #include <linux/types.h>
52 #include <linux/delay.h>
53 #include <linux/sched.h>
54 #include <linux/blkdev.h>
55 #include <linux/smp_lock.h>
56 #include <linux/init.h>
57 #include <linux/pci.h>
59 #include <asm/current.h>
60 #include <asm/uaccess.h>
62 #include <asm/byteorder.h>
63 #include <asm/atomic.h>
64 #include <asm/system.h>
65 #include <asm/scatterlist.h>
67 #include <scsi/scsi.h>
68 #include <scsi/scsi_cmnd.h>
69 #include <scsi/scsi_dbg.h>
70 #include <scsi/scsi_device.h>
71 #include <scsi/scsi_host.h>
75 #include "ieee1394_types.h"
76 #include "ieee1394_core.h"
79 #include "highlevel.h"
80 #include "ieee1394_transactions.h"
84 * Module load parameter definitions
88 * Change max_speed on module load if you have a bad IEEE-1394
89 * controller that has trouble running 2KB packets at 400mb.
91 * NOTE: On certain OHCI parts I have seen short packets on async transmit
92 * (probably due to PCI latency/throughput issues with the part). You can
93 * bump down the speed if you are running into problems.
95 static int max_speed = IEEE1394_SPEED_MAX;
96 module_param(max_speed, int, 0644);
97 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
100 * Set serialize_io to 1 if you'd like only one scsi command sent
101 * down to us at a time (debugging). This might be necessary for very
102 * badly behaved sbp2 devices.
104 * TODO: Make this configurable per device.
106 static int serialize_io = 1;
107 module_param(serialize_io, int, 0444);
108 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
111 * Bump up max_sectors if you'd like to support very large sized
112 * transfers. Please note that some older sbp2 bridge chips are broken for
113 * transfers greater or equal to 128KB. Default is a value of 255
114 * sectors, or just under 128KB (at 512 byte sector size). I can note that
115 * the Oxsemi sbp2 chipsets have no problems supporting very large
118 static int max_sectors = SBP2_MAX_SECTORS;
119 module_param(max_sectors, int, 0444);
120 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
121 __stringify(SBP2_MAX_SECTORS) ")");
124 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
125 * do an exclusive login, as it's generally unsafe to have two hosts
126 * talking to a single sbp2 device at the same time (filesystem coherency,
127 * etc.). If you're running an sbp2 device that supports multiple logins,
128 * and you're either running read-only filesystems or some sort of special
129 * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
130 * File System, or Lustre, then set exclusive_login to zero.
132 * So far only bridges from Oxford Semiconductor are known to support
133 * concurrent logins. Depending on firmware, four or two concurrent logins
134 * are possible on OXFW911 and newer Oxsemi bridges.
136 static int exclusive_login = 1;
137 module_param(exclusive_login, int, 0644);
138 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
141 * If any of the following workarounds is required for your device to work,
142 * please submit the kernel messages logged by sbp2 to the linux1394-devel
145 * - 128kB max transfer
146 * Limit transfer size. Necessary for some old bridges.
149 * When scsi_mod probes the device, let the inquiry command look like that
153 * Suppress sending of mode_sense for mode page 8 if the device pretends to
154 * support the SCSI Primary Block commands instead of Reduced Block Commands.
157 * Tell sd_mod to correct the last sector number reported by read_capacity.
158 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
159 * Don't use this with devices which don't have this bug.
161 * - override internal blacklist
162 * Instead of adding to the built-in blacklist, use only the workarounds
163 * specified in the module load parameter.
164 * Useful if a blacklist entry interfered with a non-broken device.
166 static int sbp2_default_workarounds;
167 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
168 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
169 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
170 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
171 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
172 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
173 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
174 ", or a combination)");
176 /* legacy parameter */
177 static int force_inquiry_hack;
178 module_param(force_inquiry_hack, int, 0644);
179 MODULE_PARM_DESC(force_inquiry_hack, "Deprecated, use 'workarounds'");
182 * Export information about protocols/devices supported by this driver.
184 static struct ieee1394_device_id sbp2_id_table[] = {
186 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
187 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
188 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
192 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
195 * Debug levels, configured via kernel config, or enable here.
198 #define CONFIG_IEEE1394_SBP2_DEBUG 0
199 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
200 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
201 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
202 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
203 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
205 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
206 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
207 static u32 global_outstanding_command_orbs = 0;
208 #define outstanding_orb_incr global_outstanding_command_orbs++
209 #define outstanding_orb_decr global_outstanding_command_orbs--
211 #define SBP2_ORB_DEBUG(fmt, args...)
212 #define outstanding_orb_incr
213 #define outstanding_orb_decr
216 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
217 #define SBP2_DMA_ALLOC(fmt, args...) \
218 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
219 ++global_outstanding_dmas, ## args)
220 #define SBP2_DMA_FREE(fmt, args...) \
221 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
222 --global_outstanding_dmas, ## args)
223 static u32 global_outstanding_dmas = 0;
225 #define SBP2_DMA_ALLOC(fmt, args...)
226 #define SBP2_DMA_FREE(fmt, args...)
229 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
230 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
231 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
232 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
233 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
234 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
235 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
236 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
237 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
238 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
240 #define SBP2_DEBUG(fmt, args...)
241 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
242 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
243 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
246 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
247 #define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
253 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
256 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
257 u32 scsi_status, struct scsi_cmnd *SCpnt,
258 void (*done)(struct scsi_cmnd *));
260 static struct scsi_host_template scsi_driver_template;
262 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
264 static void sbp2_host_reset(struct hpsb_host *host);
266 static int sbp2_probe(struct device *dev);
267 static int sbp2_remove(struct device *dev);
268 static int sbp2_update(struct unit_directory *ud);
270 static struct hpsb_highlevel sbp2_highlevel = {
271 .name = SBP2_DEVICE_NAME,
272 .host_reset = sbp2_host_reset,
275 static struct hpsb_address_ops sbp2_ops = {
276 .write = sbp2_handle_status_write
279 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
280 static struct hpsb_address_ops sbp2_physdma_ops = {
281 .read = sbp2_handle_physdma_read,
282 .write = sbp2_handle_physdma_write,
286 static struct hpsb_protocol_driver sbp2_driver = {
287 .name = "SBP2 Driver",
288 .id_table = sbp2_id_table,
289 .update = sbp2_update,
291 .name = SBP2_DEVICE_NAME,
292 .bus = &ieee1394_bus_type,
294 .remove = sbp2_remove,
299 * List of devices with known bugs.
301 * The firmware_revision field, masked with 0xffff00, is the best indicator
302 * for the type of bridge chip of a device. It yields a few false positives
303 * but this did not break correctly behaving devices so far.
305 static const struct {
306 u32 firmware_revision;
308 unsigned workarounds;
309 } sbp2_workarounds_table[] = {
310 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
311 .firmware_revision = 0x002800,
312 .model_id = 0x001010,
313 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
314 SBP2_WORKAROUND_MODE_SENSE_8,
316 /* Initio bridges, actually only needed for some older ones */ {
317 .firmware_revision = 0x000200,
318 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
320 /* Symbios bridge */ {
321 .firmware_revision = 0xa0b800,
322 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
325 * Note about the following Apple iPod blacklist entries:
327 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
328 * matching logic treats 0 as a wildcard, we cannot match this ID
329 * without rewriting the matching routine. Fortunately these iPods
330 * do not feature the read_capacity bug according to one report.
331 * Read_capacity behaviour as well as model_id could change due to
332 * Apple-supplied firmware updates though.
334 /* iPod 4th generation */ {
335 .firmware_revision = 0x0a2700,
336 .model_id = 0x000021,
337 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
340 .firmware_revision = 0x0a2700,
341 .model_id = 0x000023,
342 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
345 .firmware_revision = 0x0a2700,
346 .model_id = 0x00007e,
347 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
351 /**************************************
352 * General utility functions
353 **************************************/
357 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
359 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
363 for (length = (length >> 2); length--; )
364 temp[length] = be32_to_cpu(temp[length]);
370 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
372 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
376 for (length = (length >> 2); length--; )
377 temp[length] = cpu_to_be32(temp[length]);
381 #else /* BIG_ENDIAN */
382 /* Why waste the cpu cycles? */
383 #define sbp2util_be32_to_cpu_buffer(x,y)
384 #define sbp2util_cpu_to_be32_buffer(x,y)
387 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
389 * Debug packet dump routine. Length is in bytes.
391 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
395 unsigned char *dump = buffer;
397 if (!dump || !length || !dump_name)
401 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
403 printk("[%s]", dump_name);
404 for (i = 0; i < length; i++) {
413 printk("%02x ", (int)dump[i]);
420 #define sbp2util_packet_dump(w,x,y,z)
424 * Goofy routine that basically does a down_timeout function.
426 static int sbp2util_down_timeout(atomic_t *done, int timeout)
430 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
431 if (msleep_interruptible(100)) /* 100ms */
434 return (i > 0) ? 0 : 1;
437 /* Free's an allocated packet */
438 static void sbp2_free_packet(struct hpsb_packet *packet)
440 hpsb_free_tlabel(packet);
441 hpsb_free_packet(packet);
444 /* This is much like hpsb_node_write(), except it ignores the response
445 * subaction and returns immediately. Can be used from interrupts.
447 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
448 quadlet_t *buffer, size_t length)
450 struct hpsb_packet *packet;
452 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
453 addr, buffer, length);
457 hpsb_set_packet_complete_task(packet,
458 (void (*)(void *))sbp2_free_packet,
461 hpsb_node_fill_packet(ne, packet);
463 if (hpsb_send_packet(packet) < 0) {
464 sbp2_free_packet(packet);
472 * This function is called to create a pool of command orbs used for
473 * command processing. It is called when a new sbp2 device is detected.
475 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
477 struct sbp2scsi_host_info *hi = scsi_id->hi;
479 unsigned long flags, orbs;
480 struct sbp2_command_info *command;
482 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
484 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
485 for (i = 0; i < orbs; i++) {
486 command = kzalloc(sizeof(*command), GFP_ATOMIC);
488 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
492 command->command_orb_dma =
493 pci_map_single(hi->host->pdev, &command->command_orb,
494 sizeof(struct sbp2_command_orb),
495 PCI_DMA_BIDIRECTIONAL);
496 SBP2_DMA_ALLOC("single command orb DMA");
498 pci_map_single(hi->host->pdev,
499 &command->scatter_gather_element,
500 sizeof(command->scatter_gather_element),
501 PCI_DMA_BIDIRECTIONAL);
502 SBP2_DMA_ALLOC("scatter_gather_element");
503 INIT_LIST_HEAD(&command->list);
504 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
506 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
511 * This function is called to delete a pool of command orbs.
513 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
515 struct hpsb_host *host = scsi_id->hi->host;
516 struct list_head *lh, *next;
517 struct sbp2_command_info *command;
520 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
521 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
522 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
523 command = list_entry(lh, struct sbp2_command_info, list);
525 /* Release our generic DMA's */
526 pci_unmap_single(host->pdev, command->command_orb_dma,
527 sizeof(struct sbp2_command_orb),
528 PCI_DMA_BIDIRECTIONAL);
529 SBP2_DMA_FREE("single command orb DMA");
530 pci_unmap_single(host->pdev, command->sge_dma,
531 sizeof(command->scatter_gather_element),
532 PCI_DMA_BIDIRECTIONAL);
533 SBP2_DMA_FREE("scatter_gather_element");
538 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
543 * This function finds the sbp2_command for a given outstanding command
544 * orb.Only looks at the inuse list.
546 static struct sbp2_command_info *sbp2util_find_command_for_orb(
547 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
549 struct sbp2_command_info *command;
552 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
553 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
554 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
555 if (command->command_orb_dma == orb) {
556 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
561 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
563 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
569 * This function finds the sbp2_command for a given outstanding SCpnt.
570 * Only looks at the inuse list.
571 * Must be called with scsi_id->sbp2_command_orb_lock held.
573 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
574 struct scsi_id_instance_data *scsi_id, void *SCpnt)
576 struct sbp2_command_info *command;
578 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
579 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
580 if (command->Current_SCpnt == SCpnt)
586 * This function allocates a command orb used to send a scsi command.
588 static struct sbp2_command_info *sbp2util_allocate_command_orb(
589 struct scsi_id_instance_data *scsi_id,
590 struct scsi_cmnd *Current_SCpnt,
591 void (*Current_done)(struct scsi_cmnd *))
593 struct list_head *lh;
594 struct sbp2_command_info *command = NULL;
597 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
598 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
599 lh = scsi_id->sbp2_command_orb_completed.next;
601 command = list_entry(lh, struct sbp2_command_info, list);
602 command->Current_done = Current_done;
603 command->Current_SCpnt = Current_SCpnt;
604 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
606 SBP2_ERR("%s: no orbs available", __FUNCTION__);
608 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
613 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
615 struct scsi_id_instance_data *scsi_id =
616 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
617 struct hpsb_host *host;
620 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
624 host = scsi_id->ud->ne->host;
626 if (command->cmd_dma) {
627 if (command->dma_type == CMD_DMA_SINGLE) {
628 pci_unmap_single(host->pdev, command->cmd_dma,
629 command->dma_size, command->dma_dir);
630 SBP2_DMA_FREE("single bulk");
631 } else if (command->dma_type == CMD_DMA_PAGE) {
632 pci_unmap_page(host->pdev, command->cmd_dma,
633 command->dma_size, command->dma_dir);
634 SBP2_DMA_FREE("single page");
635 } /* XXX: Check for CMD_DMA_NONE bug */
636 command->dma_type = CMD_DMA_NONE;
637 command->cmd_dma = 0;
640 if (command->sge_buffer) {
641 pci_unmap_sg(host->pdev, command->sge_buffer,
642 command->dma_size, command->dma_dir);
643 SBP2_DMA_FREE("scatter list");
644 command->sge_buffer = NULL;
649 * This function moves a command to the completed orb list.
650 * Must be called with scsi_id->sbp2_command_orb_lock held.
652 static void sbp2util_mark_command_completed(
653 struct scsi_id_instance_data *scsi_id,
654 struct sbp2_command_info *command)
656 list_del(&command->list);
657 sbp2util_free_command_dma(command);
658 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
662 * Is scsi_id valid? Is the 1394 node still present?
664 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
666 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
669 /*********************************************
670 * IEEE-1394 core driver stack related section
671 *********************************************/
672 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
674 static int sbp2_probe(struct device *dev)
676 struct unit_directory *ud;
677 struct scsi_id_instance_data *scsi_id;
681 ud = container_of(dev, struct unit_directory, device);
683 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
685 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
688 scsi_id = sbp2_alloc_device(ud);
693 sbp2_parse_unit_directory(scsi_id, ud);
695 return sbp2_start_device(scsi_id);
698 static int sbp2_remove(struct device *dev)
700 struct unit_directory *ud;
701 struct scsi_id_instance_data *scsi_id;
702 struct scsi_device *sdev;
706 ud = container_of(dev, struct unit_directory, device);
707 scsi_id = ud->device.driver_data;
711 if (scsi_id->scsi_host) {
712 /* Get rid of enqueued commands if there is no chance to
714 if (!sbp2util_node_is_available(scsi_id))
715 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
716 /* scsi_remove_device() will trigger shutdown functions of SCSI
717 * highlevel drivers which would deadlock if blocked. */
718 scsi_unblock_requests(scsi_id->scsi_host);
720 sdev = scsi_id->sdev;
722 scsi_id->sdev = NULL;
723 scsi_remove_device(sdev);
726 sbp2_logout_device(scsi_id);
727 sbp2_remove_device(scsi_id);
732 static int sbp2_update(struct unit_directory *ud)
734 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
738 if (sbp2_reconnect_device(scsi_id)) {
741 * Ok, reconnect has failed. Perhaps we didn't
742 * reconnect fast enough. Try doing a regular login, but
743 * first do a logout just in case of any weirdness.
745 sbp2_logout_device(scsi_id);
747 if (sbp2_login_device(scsi_id)) {
748 /* Login failed too, just fail, and the backend
749 * will call our sbp2_remove for us */
750 SBP2_ERR("Failed to reconnect to sbp2 device!");
755 /* Set max retries to something large on the device. */
756 sbp2_set_busy_timeout(scsi_id);
758 /* Do a SBP-2 fetch agent reset. */
759 sbp2_agent_reset(scsi_id, 1);
761 /* Get the max speed and packet size that we can use. */
762 sbp2_max_speed_and_size(scsi_id);
764 /* Complete any pending commands with busy (so they get
765 * retried) and remove them from our queue
767 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
769 /* Make sure we unblock requests (since this is likely after a bus
771 scsi_unblock_requests(scsi_id->scsi_host);
776 /* This functions is called by the sbp2_probe, for each new device. We now
777 * allocate one scsi host for each scsi_id (unit directory). */
778 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
780 struct sbp2scsi_host_info *hi;
781 struct Scsi_Host *scsi_host = NULL;
782 struct scsi_id_instance_data *scsi_id = NULL;
786 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
788 SBP2_ERR("failed to create scsi_id");
792 scsi_id->ne = ud->ne;
794 scsi_id->speed_code = IEEE1394_SPEED_100;
795 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
796 scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
797 atomic_set(&scsi_id->sbp2_login_complete, 0);
798 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
799 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
800 INIT_LIST_HEAD(&scsi_id->scsi_list);
801 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
803 ud->device.driver_data = scsi_id;
805 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
807 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
809 SBP2_ERR("failed to allocate hostinfo");
812 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
813 hi->host = ud->ne->host;
814 INIT_LIST_HEAD(&hi->scsi_ids);
816 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
817 /* Handle data movement if physical dma is not
818 * enabled or not supported on host controller */
819 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
821 0x0ULL, 0xfffffffcULL)) {
822 SBP2_ERR("failed to register lower 4GB address range");
828 /* Prevent unloading of the 1394 host */
829 if (!try_module_get(hi->host->driver->owner)) {
830 SBP2_ERR("failed to get a reference on 1394 host driver");
836 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
838 /* Register the status FIFO address range. We could use the same FIFO
839 * for targets at different nodes. However we need different FIFOs per
840 * target in order to support multi-unit devices.
841 * The FIFO is located out of the local host controller's physical range
842 * but, if possible, within the posted write area. Status writes will
843 * then be performed as unified transactions. This slightly reduces
844 * bandwidth usage, and some Prolific based devices seem to require it.
846 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
847 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
848 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
849 ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
850 if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
851 SBP2_ERR("failed to allocate status FIFO address range");
855 /* Register our host with the SCSI stack. */
856 scsi_host = scsi_host_alloc(&scsi_driver_template,
857 sizeof(unsigned long));
859 SBP2_ERR("failed to register scsi host");
863 scsi_host->hostdata[0] = (unsigned long)scsi_id;
865 if (!scsi_add_host(scsi_host, &ud->device)) {
866 scsi_id->scsi_host = scsi_host;
870 SBP2_ERR("failed to add scsi host");
871 scsi_host_put(scsi_host);
874 sbp2_remove_device(scsi_id);
878 static void sbp2_host_reset(struct hpsb_host *host)
880 struct sbp2scsi_host_info *hi;
881 struct scsi_id_instance_data *scsi_id;
883 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
886 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
887 scsi_block_requests(scsi_id->scsi_host);
892 * This function is where we first pull the node unique ids, and then
893 * allocate memory and register a SBP-2 device.
895 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
897 struct sbp2scsi_host_info *hi = scsi_id->hi;
903 scsi_id->login_response =
904 pci_alloc_consistent(hi->host->pdev,
905 sizeof(struct sbp2_login_response),
906 &scsi_id->login_response_dma);
907 if (!scsi_id->login_response)
909 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
911 /* Query logins ORB DMA */
912 scsi_id->query_logins_orb =
913 pci_alloc_consistent(hi->host->pdev,
914 sizeof(struct sbp2_query_logins_orb),
915 &scsi_id->query_logins_orb_dma);
916 if (!scsi_id->query_logins_orb)
918 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
920 /* Query logins response DMA */
921 scsi_id->query_logins_response =
922 pci_alloc_consistent(hi->host->pdev,
923 sizeof(struct sbp2_query_logins_response),
924 &scsi_id->query_logins_response_dma);
925 if (!scsi_id->query_logins_response)
927 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
929 /* Reconnect ORB DMA */
930 scsi_id->reconnect_orb =
931 pci_alloc_consistent(hi->host->pdev,
932 sizeof(struct sbp2_reconnect_orb),
933 &scsi_id->reconnect_orb_dma);
934 if (!scsi_id->reconnect_orb)
936 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
939 scsi_id->logout_orb =
940 pci_alloc_consistent(hi->host->pdev,
941 sizeof(struct sbp2_logout_orb),
942 &scsi_id->logout_orb_dma);
943 if (!scsi_id->logout_orb)
945 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
949 pci_alloc_consistent(hi->host->pdev,
950 sizeof(struct sbp2_login_orb),
951 &scsi_id->login_orb_dma);
952 if (!scsi_id->login_orb)
954 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
956 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
959 * Create our command orb pool
961 if (sbp2util_create_command_orb_pool(scsi_id)) {
962 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
963 sbp2_remove_device(scsi_id);
967 /* Schedule a timeout here. The reason is that we may be so close
968 * to a bus reset, that the device is not available for logins.
969 * This can happen when the bus reset is caused by the host
970 * connected to the sbp2 device being removed. That host would
971 * have a certain amount of time to relogin before the sbp2 device
972 * allows someone else to login instead. One second makes sense. */
973 msleep_interruptible(1000);
974 if (signal_pending(current)) {
975 sbp2_remove_device(scsi_id);
980 * Login to the sbp-2 device
982 if (sbp2_login_device(scsi_id)) {
983 /* Login failed, just remove the device. */
984 sbp2_remove_device(scsi_id);
989 * Set max retries to something large on the device
991 sbp2_set_busy_timeout(scsi_id);
994 * Do a SBP-2 fetch agent reset
996 sbp2_agent_reset(scsi_id, 1);
999 * Get the max speed and packet size that we can use
1001 sbp2_max_speed_and_size(scsi_id);
1003 /* Add this device to the scsi layer now */
1004 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1006 SBP2_ERR("scsi_add_device failed");
1007 sbp2_logout_device(scsi_id);
1008 sbp2_remove_device(scsi_id);
1015 SBP2_ERR("Could not allocate memory for scsi_id");
1016 sbp2_remove_device(scsi_id);
1021 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1023 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1025 struct sbp2scsi_host_info *hi;
1034 /* This will remove our scsi device aswell */
1035 if (scsi_id->scsi_host) {
1036 scsi_remove_host(scsi_id->scsi_host);
1037 scsi_host_put(scsi_id->scsi_host);
1040 sbp2util_remove_command_orb_pool(scsi_id);
1042 list_del(&scsi_id->scsi_list);
1044 if (scsi_id->login_response) {
1045 pci_free_consistent(hi->host->pdev,
1046 sizeof(struct sbp2_login_response),
1047 scsi_id->login_response,
1048 scsi_id->login_response_dma);
1049 SBP2_DMA_FREE("single login FIFO");
1052 if (scsi_id->login_orb) {
1053 pci_free_consistent(hi->host->pdev,
1054 sizeof(struct sbp2_login_orb),
1056 scsi_id->login_orb_dma);
1057 SBP2_DMA_FREE("single login ORB");
1060 if (scsi_id->reconnect_orb) {
1061 pci_free_consistent(hi->host->pdev,
1062 sizeof(struct sbp2_reconnect_orb),
1063 scsi_id->reconnect_orb,
1064 scsi_id->reconnect_orb_dma);
1065 SBP2_DMA_FREE("single reconnect orb");
1068 if (scsi_id->logout_orb) {
1069 pci_free_consistent(hi->host->pdev,
1070 sizeof(struct sbp2_logout_orb),
1071 scsi_id->logout_orb,
1072 scsi_id->logout_orb_dma);
1073 SBP2_DMA_FREE("single logout orb");
1076 if (scsi_id->query_logins_orb) {
1077 pci_free_consistent(hi->host->pdev,
1078 sizeof(struct sbp2_query_logins_orb),
1079 scsi_id->query_logins_orb,
1080 scsi_id->query_logins_orb_dma);
1081 SBP2_DMA_FREE("single query logins orb");
1084 if (scsi_id->query_logins_response) {
1085 pci_free_consistent(hi->host->pdev,
1086 sizeof(struct sbp2_query_logins_response),
1087 scsi_id->query_logins_response,
1088 scsi_id->query_logins_response_dma);
1089 SBP2_DMA_FREE("single query logins data");
1092 if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
1093 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1094 scsi_id->status_fifo_addr);
1096 scsi_id->ud->device.driver_data = NULL;
1099 module_put(hi->host->driver->owner);
1101 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1106 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1108 * This function deals with physical dma write requests (for adapters that do not support
1109 * physical dma in hardware). Mostly just here for debugging...
1111 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1112 int destid, quadlet_t *data, u64 addr,
1113 size_t length, u16 flags)
1117 * Manually put the data in the right place.
1119 memcpy(bus_to_virt((u32) addr), data, length);
1120 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1122 return RCODE_COMPLETE;
1126 * This function deals with physical dma read requests (for adapters that do not support
1127 * physical dma in hardware). Mostly just here for debugging...
1129 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1130 quadlet_t *data, u64 addr, size_t length,
1135 * Grab data from memory and send a read response.
1137 memcpy(data, bus_to_virt((u32) addr), length);
1138 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1140 return RCODE_COMPLETE;
1144 /**************************************
1145 * SBP-2 protocol related section
1146 **************************************/
1149 * This function queries the device for the maximum concurrent logins it
1152 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1154 struct sbp2scsi_host_info *hi = scsi_id->hi;
1161 scsi_id->query_logins_orb->reserved1 = 0x0;
1162 scsi_id->query_logins_orb->reserved2 = 0x0;
1164 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1165 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1167 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1168 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1169 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1171 scsi_id->query_logins_orb->reserved_resp_length =
1172 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1174 scsi_id->query_logins_orb->status_fifo_hi =
1175 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1176 scsi_id->query_logins_orb->status_fifo_lo =
1177 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1179 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1181 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1182 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1184 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1185 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1187 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1188 data[1] = scsi_id->query_logins_orb_dma;
1189 sbp2util_cpu_to_be32_buffer(data, 8);
1191 atomic_set(&scsi_id->sbp2_login_complete, 0);
1193 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1195 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1196 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1200 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1201 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1205 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1206 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1207 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1209 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1213 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1215 SBP2_DEBUG("length_max_logins = %x",
1216 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1218 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1219 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1221 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1222 SBP2_INFO("Number of active logins: %d", active_logins);
1224 if (active_logins >= max_logins) {
1232 * This function is called in order to login to a particular SBP-2 device,
1233 * after a bus reset.
1235 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1237 struct sbp2scsi_host_info *hi = scsi_id->hi;
1242 if (!scsi_id->login_orb) {
1243 SBP2_DEBUG("%s: login_orb not alloc'd!", __FUNCTION__);
1247 if (!exclusive_login) {
1248 if (sbp2_query_logins(scsi_id)) {
1249 SBP2_INFO("Device does not support any more concurrent logins");
1254 /* Set-up login ORB, assume no password */
1255 scsi_id->login_orb->password_hi = 0;
1256 scsi_id->login_orb->password_lo = 0;
1258 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1259 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1261 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1262 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1263 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1264 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1265 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1267 scsi_id->login_orb->passwd_resp_lengths =
1268 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1270 scsi_id->login_orb->status_fifo_hi =
1271 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1272 scsi_id->login_orb->status_fifo_lo =
1273 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1275 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1277 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1278 "sbp2 login orb", scsi_id->login_orb_dma);
1280 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1281 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1283 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1284 data[1] = scsi_id->login_orb_dma;
1285 sbp2util_cpu_to_be32_buffer(data, 8);
1287 atomic_set(&scsi_id->sbp2_login_complete, 0);
1289 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1292 * Wait for login status (up to 20 seconds)...
1294 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1295 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1300 * Sanity. Make sure status returned matches login orb.
1302 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1303 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1310 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1311 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1312 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1314 SBP2_ERR("Error logging into SBP-2 device - login failed");
1319 * Byte swap the login response, for use when reconnecting or
1322 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1325 * Grab our command block agent address from the login response.
1327 SBP2_DEBUG("command_block_agent_hi = %x",
1328 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1329 SBP2_DEBUG("command_block_agent_lo = %x",
1330 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1332 scsi_id->sbp2_command_block_agent_addr =
1333 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1334 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1335 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1337 SBP2_INFO("Logged into SBP-2 device");
1344 * This function is called in order to logout from a particular SBP-2
1345 * device, usually called during driver unload.
1347 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1349 struct sbp2scsi_host_info *hi = scsi_id->hi;
1358 scsi_id->logout_orb->reserved1 = 0x0;
1359 scsi_id->logout_orb->reserved2 = 0x0;
1360 scsi_id->logout_orb->reserved3 = 0x0;
1361 scsi_id->logout_orb->reserved4 = 0x0;
1363 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1364 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1366 /* Notify us when complete */
1367 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1369 scsi_id->logout_orb->reserved5 = 0x0;
1370 scsi_id->logout_orb->status_fifo_hi =
1371 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1372 scsi_id->logout_orb->status_fifo_lo =
1373 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1376 * Byte swap ORB if necessary
1378 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1380 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1381 "sbp2 logout orb", scsi_id->logout_orb_dma);
1384 * Ok, let's write to the target's management agent register
1386 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1387 data[1] = scsi_id->logout_orb_dma;
1388 sbp2util_cpu_to_be32_buffer(data, 8);
1390 atomic_set(&scsi_id->sbp2_login_complete, 0);
1392 error = hpsb_node_write(scsi_id->ne,
1393 scsi_id->sbp2_management_agent_addr, data, 8);
1397 /* Wait for device to logout...1 second. */
1398 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1401 SBP2_INFO("Logged out of SBP-2 device");
1408 * This function is called in order to reconnect to a particular SBP-2
1409 * device, after a bus reset.
1411 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1413 struct sbp2scsi_host_info *hi = scsi_id->hi;
1420 * Set-up reconnect ORB
1422 scsi_id->reconnect_orb->reserved1 = 0x0;
1423 scsi_id->reconnect_orb->reserved2 = 0x0;
1424 scsi_id->reconnect_orb->reserved3 = 0x0;
1425 scsi_id->reconnect_orb->reserved4 = 0x0;
1427 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1428 scsi_id->reconnect_orb->login_ID_misc |=
1429 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1431 /* Notify us when complete */
1432 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1434 scsi_id->reconnect_orb->reserved5 = 0x0;
1435 scsi_id->reconnect_orb->status_fifo_hi =
1436 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1437 scsi_id->reconnect_orb->status_fifo_lo =
1438 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1441 * Byte swap ORB if necessary
1443 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1445 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1446 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1449 * Initialize status fifo
1451 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1454 * Ok, let's write to the target's management agent register
1456 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1457 data[1] = scsi_id->reconnect_orb_dma;
1458 sbp2util_cpu_to_be32_buffer(data, 8);
1460 atomic_set(&scsi_id->sbp2_login_complete, 0);
1462 error = hpsb_node_write(scsi_id->ne,
1463 scsi_id->sbp2_management_agent_addr, data, 8);
1468 * Wait for reconnect status (up to 1 second)...
1470 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1471 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1476 * Sanity. Make sure status returned matches reconnect orb.
1478 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1479 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1486 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1487 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1488 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1490 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1494 HPSB_DEBUG("Reconnected to SBP-2 device");
1501 * This function is called in order to set the busy timeout (number of
1502 * retries to attempt) on the sbp2 device.
1504 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1510 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1511 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1512 SBP2_ERR("%s error", __FUNCTION__);
1517 * This function is called to parse sbp2 device's config rom unit
1518 * directory. Used to determine things like sbp2 management agent offset,
1519 * and command set used (SCSI or RBC).
1521 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1522 struct unit_directory *ud)
1524 struct csr1212_keyval *kv;
1525 struct csr1212_dentry *dentry;
1526 u64 management_agent_addr;
1527 u32 command_set_spec_id, command_set, unit_characteristics,
1529 unsigned workarounds;
1534 management_agent_addr = 0x0;
1535 command_set_spec_id = 0x0;
1537 unit_characteristics = 0x0;
1538 firmware_revision = 0x0;
1540 /* Handle different fields in the unit directory, based on keys */
1541 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1542 switch (kv->key.id) {
1543 case CSR1212_KV_ID_DEPENDENT_INFO:
1544 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1545 /* Save off the management agent address */
1546 management_agent_addr =
1547 CSR1212_REGISTER_SPACE_BASE +
1548 (kv->value.csr_offset << 2);
1550 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1551 (unsigned int)management_agent_addr);
1552 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1554 ORB_SET_LUN(kv->value.immediate);
1558 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1559 /* Command spec organization */
1560 command_set_spec_id = kv->value.immediate;
1561 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1562 (unsigned int)command_set_spec_id);
1565 case SBP2_COMMAND_SET_KEY:
1566 /* Command set used by sbp2 device */
1567 command_set = kv->value.immediate;
1568 SBP2_DEBUG("sbp2_command_set = %x",
1569 (unsigned int)command_set);
1572 case SBP2_UNIT_CHARACTERISTICS_KEY:
1574 * Unit characterisitcs (orb related stuff
1575 * that I'm not yet paying attention to)
1577 unit_characteristics = kv->value.immediate;
1578 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1579 (unsigned int)unit_characteristics);
1582 case SBP2_FIRMWARE_REVISION_KEY:
1583 /* Firmware revision */
1584 firmware_revision = kv->value.immediate;
1585 SBP2_DEBUG("sbp2_firmware_revision = %x",
1586 (unsigned int)firmware_revision);
1594 workarounds = sbp2_default_workarounds;
1595 if (force_inquiry_hack) {
1596 SBP2_WARN("force_inquiry_hack is deprecated. "
1597 "Use parameter 'workarounds' instead.");
1598 workarounds |= SBP2_WORKAROUND_INQUIRY_36;
1601 if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1602 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1603 if (sbp2_workarounds_table[i].firmware_revision &&
1604 sbp2_workarounds_table[i].firmware_revision !=
1605 (firmware_revision & 0xffff00))
1607 if (sbp2_workarounds_table[i].model_id &&
1608 sbp2_workarounds_table[i].model_id != ud->model_id)
1610 workarounds |= sbp2_workarounds_table[i].workarounds;
1615 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1616 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1617 " model_id 0x%06x)",
1618 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1619 workarounds, firmware_revision,
1620 ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1623 /* We would need one SCSI host template for each target to adjust
1624 * max_sectors on the fly, therefore warn only. */
1625 if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1626 (max_sectors * 512) > (128 * 1024))
1627 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1628 "max transfer size. WARNING: Current max_sectors "
1629 "setting is larger than 128KB (%d sectors)",
1630 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1633 /* If this is a logical unit directory entry, process the parent
1634 * to get the values. */
1635 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1636 struct unit_directory *parent_ud =
1637 container_of(ud->device.parent, struct unit_directory, device);
1638 sbp2_parse_unit_directory(scsi_id, parent_ud);
1640 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1641 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1642 scsi_id->sbp2_command_set = command_set;
1643 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1644 scsi_id->sbp2_firmware_revision = firmware_revision;
1645 scsi_id->workarounds = workarounds;
1646 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1647 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1651 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1654 * This function is called in order to determine the max speed and packet
1655 * size we can use in our ORBs. Note, that we (the driver and host) only
1656 * initiate the transaction. The SBP-2 device actually transfers the data
1657 * (by reading from the DMA area we tell it). This means that the SBP-2
1658 * device decides the actual maximum data it can transfer. We just tell it
1659 * the speed that it needs to use, and the max_rec the host supports, and
1660 * it takes care of the rest.
1662 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1664 struct sbp2scsi_host_info *hi = scsi_id->hi;
1669 scsi_id->speed_code =
1670 hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1672 /* Bump down our speed if the user requested it */
1673 if (scsi_id->speed_code > max_speed) {
1674 scsi_id->speed_code = max_speed;
1675 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1676 hpsb_speedto_str[scsi_id->speed_code]);
1679 /* Payload size is the lesser of what our speed supports and what
1680 * our host supports. */
1681 payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1682 (u8) (hi->host->csr.max_rec - 1));
1684 /* If physical DMA is off, work around limitation in ohci1394:
1685 * packet size must not exceed PAGE_SIZE */
1686 if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1687 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1691 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1692 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1693 hpsb_speedto_str[scsi_id->speed_code],
1694 SBP2_PAYLOAD_TO_BYTES(payload));
1696 scsi_id->max_payload_size = payload;
1701 * This function is called in order to perform a SBP-2 agent reset.
1703 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1708 unsigned long flags;
1712 data = ntohl(SBP2_AGENT_RESET_DATA);
1713 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1716 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1718 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1721 SBP2_ERR("hpsb_node_write failed.\n");
1726 * Need to make sure orb pointer is written on next command
1728 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1729 scsi_id->last_orb = NULL;
1730 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1735 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1736 struct sbp2scsi_host_info *hi,
1737 struct sbp2_command_info *command,
1738 unsigned int scsi_use_sg,
1739 struct scatterlist *sgpnt,
1741 enum dma_data_direction dma_dir)
1743 command->dma_dir = dma_dir;
1744 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1745 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1747 /* Special case if only one element (and less than 64KB in size) */
1748 if ((scsi_use_sg == 1) &&
1749 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1751 SBP2_DEBUG("Only one s/g element");
1752 command->dma_size = sgpnt[0].length;
1753 command->dma_type = CMD_DMA_PAGE;
1754 command->cmd_dma = pci_map_page(hi->host->pdev,
1759 SBP2_DMA_ALLOC("single page scatter element");
1761 orb->data_descriptor_lo = command->cmd_dma;
1762 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1765 struct sbp2_unrestricted_page_table *sg_element =
1766 &command->scatter_gather_element[0];
1767 u32 sg_count, sg_len;
1769 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1772 SBP2_DMA_ALLOC("scatter list");
1774 command->dma_size = scsi_use_sg;
1775 command->sge_buffer = sgpnt;
1777 /* use page tables (s/g) */
1778 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1779 orb->data_descriptor_lo = command->sge_dma;
1782 * Loop through and fill out our sbp-2 page tables
1783 * (and split up anything too large)
1785 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1786 sg_len = sg_dma_len(sgpnt);
1787 sg_addr = sg_dma_address(sgpnt);
1789 sg_element[sg_count].segment_base_lo = sg_addr;
1790 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1791 sg_element[sg_count].length_segment_base_hi =
1792 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1793 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1794 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1796 sg_element[sg_count].length_segment_base_hi =
1797 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1804 /* Number of page table (s/g) elements */
1805 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1807 sbp2util_packet_dump(sg_element,
1808 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1809 "sbp2 s/g list", command->sge_dma);
1811 /* Byte swap page tables if necessary */
1812 sbp2util_cpu_to_be32_buffer(sg_element,
1813 (sizeof(struct sbp2_unrestricted_page_table)) *
1818 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1819 struct sbp2scsi_host_info *hi,
1820 struct sbp2_command_info *command,
1821 struct scatterlist *sgpnt,
1823 unsigned int scsi_request_bufflen,
1824 void *scsi_request_buffer,
1825 enum dma_data_direction dma_dir)
1827 command->dma_dir = dma_dir;
1828 command->dma_size = scsi_request_bufflen;
1829 command->dma_type = CMD_DMA_SINGLE;
1830 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1831 command->dma_size, command->dma_dir);
1832 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1833 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1835 SBP2_DMA_ALLOC("single bulk");
1838 * Handle case where we get a command w/o s/g enabled (but
1839 * check for transfers larger than 64K)
1841 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1843 orb->data_descriptor_lo = command->cmd_dma;
1844 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1847 struct sbp2_unrestricted_page_table *sg_element =
1848 &command->scatter_gather_element[0];
1849 u32 sg_count, sg_len;
1853 * Need to turn this into page tables, since the
1854 * buffer is too large.
1856 orb->data_descriptor_lo = command->sge_dma;
1858 /* Use page tables (s/g) */
1859 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1862 * fill out our sbp-2 page tables (and split up
1866 sg_len = scsi_request_bufflen;
1867 sg_addr = command->cmd_dma;
1869 sg_element[sg_count].segment_base_lo = sg_addr;
1870 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1871 sg_element[sg_count].length_segment_base_hi =
1872 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1873 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1874 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1876 sg_element[sg_count].length_segment_base_hi =
1877 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1883 /* Number of page table (s/g) elements */
1884 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1886 sbp2util_packet_dump(sg_element,
1887 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1888 "sbp2 s/g list", command->sge_dma);
1890 /* Byte swap page tables if necessary */
1891 sbp2util_cpu_to_be32_buffer(sg_element,
1892 (sizeof(struct sbp2_unrestricted_page_table)) *
1898 * This function is called to create the actual command orb and s/g list
1899 * out of the scsi command itself.
1901 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1902 struct sbp2_command_info *command,
1904 unsigned int scsi_use_sg,
1905 unsigned int scsi_request_bufflen,
1906 void *scsi_request_buffer,
1907 enum dma_data_direction dma_dir)
1909 struct sbp2scsi_host_info *hi = scsi_id->hi;
1910 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1911 struct sbp2_command_orb *command_orb = &command->command_orb;
1915 * Set-up our command ORB..
1917 * NOTE: We're doing unrestricted page tables (s/g), as this is
1918 * best performance (at least with the devices I have). This means
1919 * that data_size becomes the number of s/g elements, and
1920 * page_size should be zero (for unrestricted).
1922 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1923 command_orb->next_ORB_lo = 0x0;
1924 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1925 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1926 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1928 if (dma_dir == DMA_NONE)
1929 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1930 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1931 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1932 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1933 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1935 SBP2_WARN("Falling back to DMA_NONE");
1936 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1939 /* Set-up our pagetable stuff */
1940 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1941 SBP2_DEBUG("No data transfer");
1942 command_orb->data_descriptor_hi = 0x0;
1943 command_orb->data_descriptor_lo = 0x0;
1944 command_orb->misc |= ORB_SET_DIRECTION(1);
1945 } else if (scsi_use_sg) {
1946 SBP2_DEBUG("Use scatter/gather");
1947 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1948 sgpnt, orb_direction, dma_dir);
1950 SBP2_DEBUG("No scatter/gather");
1951 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1952 orb_direction, scsi_request_bufflen,
1953 scsi_request_buffer, dma_dir);
1956 /* Byte swap command ORB if necessary */
1957 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1959 /* Put our scsi command in the command ORB */
1960 memset(command_orb->cdb, 0, 12);
1961 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1965 * This function is called in order to begin a regular SBP-2 command.
1967 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1968 struct sbp2_command_info *command)
1970 struct sbp2scsi_host_info *hi = scsi_id->hi;
1971 struct sbp2_command_orb *command_orb = &command->command_orb;
1972 struct sbp2_command_orb *last_orb;
1973 dma_addr_t last_orb_dma;
1974 u64 addr = scsi_id->sbp2_command_block_agent_addr;
1977 unsigned long flags;
1979 outstanding_orb_incr;
1980 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1981 command_orb, global_outstanding_command_orbs);
1983 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1984 sizeof(struct sbp2_command_orb),
1985 PCI_DMA_BIDIRECTIONAL);
1986 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1987 sizeof(command->scatter_gather_element),
1988 PCI_DMA_BIDIRECTIONAL);
1990 * Check to see if there are any previous orbs to use
1992 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1993 last_orb = scsi_id->last_orb;
1994 last_orb_dma = scsi_id->last_orb_dma;
1997 * last_orb == NULL means: We know that the target's fetch agent
1998 * is not active right now.
2000 addr += SBP2_ORB_POINTER_OFFSET;
2001 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
2002 data[1] = command->command_orb_dma;
2003 sbp2util_cpu_to_be32_buffer(data, 8);
2007 * last_orb != NULL means: We know that the target's fetch agent
2008 * is (very probably) not dead or in reset state right now.
2009 * We have an ORB already sent that we can append a new one to.
2010 * The target's fetch agent may or may not have read this
2013 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
2014 sizeof(struct sbp2_command_orb),
2015 PCI_DMA_BIDIRECTIONAL);
2016 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
2018 /* Tells hardware that this pointer is valid */
2019 last_orb->next_ORB_hi = 0;
2020 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
2021 sizeof(struct sbp2_command_orb),
2022 PCI_DMA_BIDIRECTIONAL);
2023 addr += SBP2_DOORBELL_OFFSET;
2027 scsi_id->last_orb = command_orb;
2028 scsi_id->last_orb_dma = command->command_orb_dma;
2029 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2031 SBP2_ORB_DEBUG("write to %s register, command orb %p",
2032 last_orb ? "DOORBELL" : "ORB_POINTER", command_orb);
2033 if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length) < 0) {
2034 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
2041 * This function is called in order to begin a regular SBP-2 command.
2043 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2044 struct scsi_cmnd *SCpnt,
2045 void (*done)(struct scsi_cmnd *))
2047 unchar *cmd = (unchar *) SCpnt->cmnd;
2048 unsigned int request_bufflen = SCpnt->request_bufflen;
2049 struct sbp2_command_info *command;
2052 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2053 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2056 * Allocate a command orb and s/g structure
2058 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2064 * Now actually fill in the comamnd orb and sbp2 s/g list
2066 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2067 request_bufflen, SCpnt->request_buffer,
2068 SCpnt->sc_data_direction);
2070 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2071 "sbp2 command orb", command->command_orb_dma);
2074 * Initialize status fifo
2076 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2079 * Link up the orb, and ring the doorbell if needed
2081 sbp2_link_orb_command(scsi_id, command);
2087 * Translates SBP-2 status into SCSI sense data for check conditions
2089 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2094 * Ok, it's pretty ugly... ;-)
2096 sense_data[0] = 0x70;
2097 sense_data[1] = 0x0;
2098 sense_data[2] = sbp2_status[9];
2099 sense_data[3] = sbp2_status[12];
2100 sense_data[4] = sbp2_status[13];
2101 sense_data[5] = sbp2_status[14];
2102 sense_data[6] = sbp2_status[15];
2104 sense_data[8] = sbp2_status[16];
2105 sense_data[9] = sbp2_status[17];
2106 sense_data[10] = sbp2_status[18];
2107 sense_data[11] = sbp2_status[19];
2108 sense_data[12] = sbp2_status[10];
2109 sense_data[13] = sbp2_status[11];
2110 sense_data[14] = sbp2_status[20];
2111 sense_data[15] = sbp2_status[21];
2113 return sbp2_status[8] & 0x3f; /* return scsi status */
2117 * This function deals with status writes from the SBP-2 device
2119 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2120 quadlet_t *data, u64 addr, size_t length, u16 fl)
2122 struct sbp2scsi_host_info *hi;
2123 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2124 struct scsi_cmnd *SCpnt = NULL;
2125 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2126 struct sbp2_command_info *command;
2127 unsigned long flags;
2131 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2134 SBP2_ERR("host is NULL - this is bad!");
2135 return RCODE_ADDRESS_ERROR;
2138 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2141 SBP2_ERR("host info is NULL - this is bad!");
2142 return RCODE_ADDRESS_ERROR;
2146 * Find our scsi_id structure by looking at the status fifo address
2147 * written to by the sbp2 device.
2149 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2150 if (scsi_id_tmp->ne->nodeid == nodeid &&
2151 scsi_id_tmp->status_fifo_addr == addr) {
2152 scsi_id = scsi_id_tmp;
2158 SBP2_ERR("scsi_id is NULL - device is gone?");
2159 return RCODE_ADDRESS_ERROR;
2163 * Put response into scsi_id status fifo...
2165 memcpy(&scsi_id->status_block, data, length);
2168 * Byte swap first two quadlets (8 bytes) of status for processing
2170 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2173 * Handle command ORB status here if necessary. First, need to match status with command.
2175 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2178 SBP2_DEBUG("Found status for command ORB");
2179 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2180 sizeof(struct sbp2_command_orb),
2181 PCI_DMA_BIDIRECTIONAL);
2182 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2183 sizeof(command->scatter_gather_element),
2184 PCI_DMA_BIDIRECTIONAL);
2186 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2187 outstanding_orb_decr;
2190 * Matched status with command, now grab scsi command pointers and check status
2192 SCpnt = command->Current_SCpnt;
2193 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2194 sbp2util_mark_command_completed(scsi_id, command);
2195 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2200 * See if the target stored any scsi status information
2202 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2204 * Translate SBP-2 status to SCSI sense data
2206 SBP2_DEBUG("CHECK CONDITION");
2207 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2211 * Check to see if the dead bit is set. If so, we'll have to initiate
2212 * a fetch agent reset.
2214 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2217 * Initiate a fetch agent reset.
2219 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2220 sbp2_agent_reset(scsi_id, 0);
2223 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2227 * Check here to see if there are no commands in-use. If there
2228 * are none, we know that the fetch agent left the active state
2229 * _and_ that we did not reactivate it yet. Therefore clear
2230 * last_orb so that next time we write directly to the
2231 * ORB_POINTER register. That way the fetch agent does not need
2232 * to refetch the next_ORB.
2234 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2235 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
2236 scsi_id->last_orb = NULL;
2237 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2242 * It's probably a login/logout/reconnect status.
2244 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2245 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2246 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2247 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2248 atomic_set(&scsi_id->sbp2_login_complete, 1);
2254 /* Complete the SCSI command. */
2255 SBP2_DEBUG("Completing SCSI command");
2256 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2257 command->Current_done);
2258 SBP2_ORB_DEBUG("command orb completed");
2261 return RCODE_COMPLETE;
2264 /**************************************
2265 * SCSI interface related section
2266 **************************************/
2269 * This routine is the main request entry routine for doing I/O. It is
2270 * called from the scsi stack directly.
2272 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2273 void (*done)(struct scsi_cmnd *))
2275 struct scsi_id_instance_data *scsi_id =
2276 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2277 struct sbp2scsi_host_info *hi;
2278 int result = DID_NO_CONNECT << 16;
2281 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2282 scsi_print_command(SCpnt);
2285 if (!sbp2util_node_is_available(scsi_id))
2291 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2296 * Until we handle multiple luns, just return selection time-out
2297 * to any IO directed at non-zero LUNs
2299 if (SCpnt->device->lun)
2303 * Check for request sense command, and handle it here
2304 * (autorequest sense)
2306 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2307 SBP2_DEBUG("REQUEST_SENSE");
2308 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2309 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2310 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2315 * Check to see if we are in the middle of a bus reset.
2317 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2318 SBP2_ERR("Bus reset in progress - rejecting command");
2319 result = DID_BUS_BUSY << 16;
2324 * Bidirectional commands are not yet implemented,
2325 * and unknown transfer direction not handled.
2327 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2328 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2329 result = DID_ERROR << 16;
2334 * Try and send our SCSI command
2336 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2337 SBP2_ERR("Error sending SCSI command");
2338 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2344 SCpnt->result = result;
2350 * This function is called in order to complete all outstanding SBP-2
2351 * commands (in case of resets, etc.).
2353 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2356 struct sbp2scsi_host_info *hi = scsi_id->hi;
2357 struct list_head *lh;
2358 struct sbp2_command_info *command;
2359 unsigned long flags;
2363 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2364 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2365 SBP2_DEBUG("Found pending command to complete");
2366 lh = scsi_id->sbp2_command_orb_inuse.next;
2367 command = list_entry(lh, struct sbp2_command_info, list);
2368 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2369 sizeof(struct sbp2_command_orb),
2370 PCI_DMA_BIDIRECTIONAL);
2371 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2372 sizeof(command->scatter_gather_element),
2373 PCI_DMA_BIDIRECTIONAL);
2374 sbp2util_mark_command_completed(scsi_id, command);
2375 if (command->Current_SCpnt) {
2376 command->Current_SCpnt->result = status << 16;
2377 command->Current_done(command->Current_SCpnt);
2380 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2386 * This function is called in order to complete a regular SBP-2 command.
2388 * This can be called in interrupt context.
2390 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2391 u32 scsi_status, struct scsi_cmnd *SCpnt,
2392 void (*done)(struct scsi_cmnd *))
2400 SBP2_ERR("SCpnt is NULL");
2405 * If a bus reset is in progress and there was an error, don't
2406 * complete the command, just let it get retried at the end of the
2409 if (!hpsb_node_entry_valid(scsi_id->ne)
2410 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2411 SBP2_ERR("Bus reset in progress - retry command later");
2416 * Switch on scsi status
2418 switch (scsi_status) {
2419 case SBP2_SCSI_STATUS_GOOD:
2420 SCpnt->result = DID_OK << 16;
2423 case SBP2_SCSI_STATUS_BUSY:
2424 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2425 SCpnt->result = DID_BUS_BUSY << 16;
2428 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2429 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2430 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2431 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2432 scsi_print_command(SCpnt);
2433 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
2437 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2438 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2439 SCpnt->result = DID_NO_CONNECT << 16;
2440 scsi_print_command(SCpnt);
2443 case SBP2_SCSI_STATUS_CONDITION_MET:
2444 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2445 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2446 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2447 SCpnt->result = DID_ERROR << 16;
2448 scsi_print_command(SCpnt);
2452 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2453 SCpnt->result = DID_ERROR << 16;
2457 * If a bus reset is in progress and there was an error, complete
2458 * the command as busy so that it will get retried.
2460 if (!hpsb_node_entry_valid(scsi_id->ne)
2461 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2462 SBP2_ERR("Completing command with busy (bus reset)");
2463 SCpnt->result = DID_BUS_BUSY << 16;
2467 * If a unit attention occurs, return busy status so it gets
2468 * retried... it could have happened because of a 1394 bus reset
2470 * XXX DID_BUS_BUSY is actually a bad idea because it will defy
2471 * the scsi layer's retry logic.
2474 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2475 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2476 SBP2_DEBUG("UNIT ATTENTION - return busy");
2477 SCpnt->result = DID_BUS_BUSY << 16;
2482 * Tell scsi stack that we're done with this command
2487 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2489 struct scsi_id_instance_data *scsi_id =
2490 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2492 scsi_id->sdev = sdev;
2494 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2495 sdev->inquiry_len = 36;
2499 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2501 struct scsi_id_instance_data *scsi_id =
2502 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2504 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2505 sdev->use_10_for_rw = 1;
2506 sdev->use_10_for_ms = 1;
2508 if (sdev->type == TYPE_DISK &&
2509 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2510 sdev->skip_ms_page_8 = 1;
2511 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2512 sdev->fix_capacity = 1;
2513 if (scsi_id->ne->guid_vendor_id == 0x0010b9 && /* Maxtor's OUI */
2514 (sdev->type == TYPE_DISK || sdev->type == TYPE_RBC))
2515 sdev->allow_restart = 1;
2519 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2521 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2526 * Called by scsi stack when something has really gone wrong. Usually
2527 * called when a command has timed-out for some reason.
2529 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2531 struct scsi_id_instance_data *scsi_id =
2532 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2533 struct sbp2scsi_host_info *hi = scsi_id->hi;
2534 struct sbp2_command_info *command;
2535 unsigned long flags;
2537 SBP2_ERR("aborting sbp2 command");
2538 scsi_print_command(SCpnt);
2540 if (sbp2util_node_is_available(scsi_id)) {
2543 * Right now, just return any matching command structures
2546 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2547 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2549 SBP2_DEBUG("Found command to abort");
2550 pci_dma_sync_single_for_cpu(hi->host->pdev,
2551 command->command_orb_dma,
2552 sizeof(struct sbp2_command_orb),
2553 PCI_DMA_BIDIRECTIONAL);
2554 pci_dma_sync_single_for_cpu(hi->host->pdev,
2556 sizeof(command->scatter_gather_element),
2557 PCI_DMA_BIDIRECTIONAL);
2558 sbp2util_mark_command_completed(scsi_id, command);
2559 if (command->Current_SCpnt) {
2560 command->Current_SCpnt->result = DID_ABORT << 16;
2561 command->Current_done(command->Current_SCpnt);
2564 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2567 * Initiate a fetch agent reset.
2569 sbp2_agent_reset(scsi_id, 0);
2570 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2577 * Called by scsi stack when something has really gone wrong.
2579 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2581 struct scsi_id_instance_data *scsi_id =
2582 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2584 SBP2_ERR("reset requested");
2586 if (sbp2util_node_is_available(scsi_id)) {
2587 SBP2_ERR("Generating sbp2 fetch agent reset");
2588 sbp2_agent_reset(scsi_id, 0);
2594 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2595 struct device_attribute *attr,
2598 struct scsi_device *sdev;
2599 struct scsi_id_instance_data *scsi_id;
2602 if (!(sdev = to_scsi_device(dev)))
2605 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2608 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2610 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2611 scsi_id->ud->id, lun);
2613 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2615 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2616 &dev_attr_ieee1394_id,
2620 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2621 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2622 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2623 MODULE_LICENSE("GPL");
2625 /* SCSI host template */
2626 static struct scsi_host_template scsi_driver_template = {
2627 .module = THIS_MODULE,
2628 .name = "SBP-2 IEEE-1394",
2629 .proc_name = SBP2_DEVICE_NAME,
2630 .queuecommand = sbp2scsi_queuecommand,
2631 .eh_abort_handler = sbp2scsi_abort,
2632 .eh_device_reset_handler = sbp2scsi_reset,
2633 .slave_alloc = sbp2scsi_slave_alloc,
2634 .slave_configure = sbp2scsi_slave_configure,
2635 .slave_destroy = sbp2scsi_slave_destroy,
2637 .sg_tablesize = SG_ALL,
2638 .use_clustering = ENABLE_CLUSTERING,
2639 .cmd_per_lun = SBP2_MAX_CMDS,
2640 .can_queue = SBP2_MAX_CMDS,
2642 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2645 static int sbp2_module_init(void)
2651 /* Module load debug option to force one command at a time (serializing I/O) */
2653 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2654 SBP2_INFO("Try serialize_io=0 for better performance");
2655 scsi_driver_template.can_queue = 1;
2656 scsi_driver_template.cmd_per_lun = 1;
2659 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2660 (max_sectors * 512) > (128 * 1024))
2661 max_sectors = 128 * 1024 / 512;
2662 scsi_driver_template.max_sectors = max_sectors;
2664 /* Register our high level driver with 1394 stack */
2665 hpsb_register_highlevel(&sbp2_highlevel);
2667 ret = hpsb_register_protocol(&sbp2_driver);
2669 SBP2_ERR("Failed to register protocol");
2670 hpsb_unregister_highlevel(&sbp2_highlevel);
2677 static void __exit sbp2_module_exit(void)
2681 hpsb_unregister_protocol(&sbp2_driver);
2683 hpsb_unregister_highlevel(&sbp2_highlevel);
2686 module_init(sbp2_module_init);
2687 module_exit(sbp2_module_exit);