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/config.h>
42 #include <linux/kernel.h>
43 #include <linux/list.h>
44 #include <linux/string.h>
45 #include <linux/stringify.h>
46 #include <linux/slab.h>
47 #include <linux/interrupt.h>
49 #include <linux/poll.h>
50 #include <linux/module.h>
51 #include <linux/moduleparam.h>
52 #include <linux/types.h>
53 #include <linux/delay.h>
54 #include <linux/sched.h>
55 #include <linux/blkdev.h>
56 #include <linux/smp_lock.h>
57 #include <linux/init.h>
58 #include <linux/pci.h>
60 #include <asm/current.h>
61 #include <asm/uaccess.h>
63 #include <asm/byteorder.h>
64 #include <asm/atomic.h>
65 #include <asm/system.h>
66 #include <asm/scatterlist.h>
68 #include <scsi/scsi.h>
69 #include <scsi/scsi_cmnd.h>
70 #include <scsi/scsi_dbg.h>
71 #include <scsi/scsi_device.h>
72 #include <scsi/scsi_host.h>
76 #include "ieee1394_types.h"
77 #include "ieee1394_core.h"
80 #include "highlevel.h"
81 #include "ieee1394_transactions.h"
85 * Module load parameter definitions
89 * Change max_speed on module load if you have a bad IEEE-1394
90 * controller that has trouble running 2KB packets at 400mb.
92 * NOTE: On certain OHCI parts I have seen short packets on async transmit
93 * (probably due to PCI latency/throughput issues with the part). You can
94 * bump down the speed if you are running into problems.
96 static int max_speed = IEEE1394_SPEED_MAX;
97 module_param(max_speed, int, 0644);
98 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
101 * Set serialize_io to 1 if you'd like only one scsi command sent
102 * down to us at a time (debugging). This might be necessary for very
103 * badly behaved sbp2 devices.
105 * TODO: Make this configurable per device.
107 static int serialize_io = 1;
108 module_param(serialize_io, int, 0444);
109 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
112 * Bump up max_sectors if you'd like to support very large sized
113 * transfers. Please note that some older sbp2 bridge chips are broken for
114 * transfers greater or equal to 128KB. Default is a value of 255
115 * sectors, or just under 128KB (at 512 byte sector size). I can note that
116 * the Oxsemi sbp2 chipsets have no problems supporting very large
119 static int max_sectors = SBP2_MAX_SECTORS;
120 module_param(max_sectors, int, 0444);
121 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
122 __stringify(SBP2_MAX_SECTORS) ")");
125 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
126 * do an exclusive login, as it's generally unsafe to have two hosts
127 * talking to a single sbp2 device at the same time (filesystem coherency,
128 * etc.). If you're running an sbp2 device that supports multiple logins,
129 * and you're either running read-only filesystems or some sort of special
130 * filesystem supporting multiple hosts (one such filesystem is OpenGFS,
131 * see opengfs.sourceforge.net for more info), then set exclusive_login
132 * to zero. Note: The Oxsemi OXFW911 sbp2 chipset supports up to four
135 static int exclusive_login = 1;
136 module_param(exclusive_login, int, 0644);
137 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
140 * If any of the following workarounds is required for your device to work,
141 * please submit the kernel messages logged by sbp2 to the linux1394-devel
144 * - 128kB max transfer
145 * Limit transfer size. Necessary for some old bridges.
148 * When scsi_mod probes the device, let the inquiry command look like that
152 * Suppress sending of mode_sense for mode page 8 if the device pretends to
153 * support the SCSI Primary Block commands instead of Reduced Block Commands.
156 * Tell sd_mod to correct the last sector number reported by read_capacity.
157 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
158 * Don't use this with devices which don't have this bug.
160 * - override internal blacklist
161 * Instead of adding to the built-in blacklist, use only the workarounds
162 * specified in the module load parameter.
163 * Useful if a blacklist entry interfered with a non-broken device.
165 static int sbp2_default_workarounds;
166 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
167 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
168 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
169 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
170 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
171 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
172 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
173 ", or a combination)");
175 /* legacy parameter */
176 static int force_inquiry_hack;
177 module_param(force_inquiry_hack, int, 0644);
178 MODULE_PARM_DESC(force_inquiry_hack, "Deprecated, use 'workarounds'");
181 * Export information about protocols/devices supported by this driver.
183 static struct ieee1394_device_id sbp2_id_table[] = {
185 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
186 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
187 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
191 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
194 * Debug levels, configured via kernel config, or enable here.
197 #define CONFIG_IEEE1394_SBP2_DEBUG 0
198 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
199 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
200 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
201 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
202 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
204 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
205 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
206 static u32 global_outstanding_command_orbs = 0;
207 #define outstanding_orb_incr global_outstanding_command_orbs++
208 #define outstanding_orb_decr global_outstanding_command_orbs--
210 #define SBP2_ORB_DEBUG(fmt, args...)
211 #define outstanding_orb_incr
212 #define outstanding_orb_decr
215 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
216 #define SBP2_DMA_ALLOC(fmt, args...) \
217 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
218 ++global_outstanding_dmas, ## args)
219 #define SBP2_DMA_FREE(fmt, args...) \
220 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
221 --global_outstanding_dmas, ## args)
222 static u32 global_outstanding_dmas = 0;
224 #define SBP2_DMA_ALLOC(fmt, args...)
225 #define SBP2_DMA_FREE(fmt, args...)
228 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
229 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
230 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
231 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
232 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
233 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
234 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
235 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
236 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
237 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
239 #define SBP2_DEBUG(fmt, args...)
240 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
241 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
242 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
245 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
246 #define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
252 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
255 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
256 u32 scsi_status, struct scsi_cmnd *SCpnt,
257 void (*done)(struct scsi_cmnd *));
259 static struct scsi_host_template scsi_driver_template;
261 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
263 static void sbp2_host_reset(struct hpsb_host *host);
265 static int sbp2_probe(struct device *dev);
266 static int sbp2_remove(struct device *dev);
267 static int sbp2_update(struct unit_directory *ud);
269 static struct hpsb_highlevel sbp2_highlevel = {
270 .name = SBP2_DEVICE_NAME,
271 .host_reset = sbp2_host_reset,
274 static struct hpsb_address_ops sbp2_ops = {
275 .write = sbp2_handle_status_write
278 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
279 static struct hpsb_address_ops sbp2_physdma_ops = {
280 .read = sbp2_handle_physdma_read,
281 .write = sbp2_handle_physdma_write,
285 static struct hpsb_protocol_driver sbp2_driver = {
286 .name = "SBP2 Driver",
287 .id_table = sbp2_id_table,
288 .update = sbp2_update,
290 .name = SBP2_DEVICE_NAME,
291 .bus = &ieee1394_bus_type,
293 .remove = sbp2_remove,
298 * List of devices with known bugs.
300 * The firmware_revision field, masked with 0xffff00, is the best indicator
301 * for the type of bridge chip of a device. It yields a few false positives
302 * but this did not break correctly behaving devices so far.
304 static const struct {
305 u32 firmware_revision;
307 unsigned workarounds;
308 } sbp2_workarounds_table[] = {
310 .firmware_revision = 0x002800,
311 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
312 SBP2_WORKAROUND_MODE_SENSE_8,
314 /* Initio bridges, actually only needed for some older ones */ {
315 .firmware_revision = 0x000200,
316 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
318 /* Symbios bridge */ {
319 .firmware_revision = 0xa0b800,
320 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
323 * Note about the following Apple iPod blacklist entries:
325 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
326 * matching logic treats 0 as a wildcard, we cannot match this ID
327 * without rewriting the matching routine. Fortunately these iPods
328 * do not feature the read_capacity bug according to one report.
329 * Read_capacity behaviour as well as model_id could change due to
330 * Apple-supplied firmware updates though.
332 /* iPod 4th generation */ {
333 .firmware_revision = 0x0a2700,
334 .model_id = 0x000021,
335 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
338 .firmware_revision = 0x0a2700,
339 .model_id = 0x000023,
340 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
343 .firmware_revision = 0x0a2700,
344 .model_id = 0x00007e,
345 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
349 /**************************************
350 * General utility functions
351 **************************************/
355 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
357 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
361 for (length = (length >> 2); length--; )
362 temp[length] = be32_to_cpu(temp[length]);
368 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
370 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
374 for (length = (length >> 2); length--; )
375 temp[length] = cpu_to_be32(temp[length]);
379 #else /* BIG_ENDIAN */
380 /* Why waste the cpu cycles? */
381 #define sbp2util_be32_to_cpu_buffer(x,y)
382 #define sbp2util_cpu_to_be32_buffer(x,y)
385 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
387 * Debug packet dump routine. Length is in bytes.
389 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
393 unsigned char *dump = buffer;
395 if (!dump || !length || !dump_name)
399 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
401 printk("[%s]", dump_name);
402 for (i = 0; i < length; i++) {
411 printk("%02x ", (int)dump[i]);
418 #define sbp2util_packet_dump(w,x,y,z)
422 * Goofy routine that basically does a down_timeout function.
424 static int sbp2util_down_timeout(atomic_t *done, int timeout)
428 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
429 if (msleep_interruptible(100)) /* 100ms */
432 return (i > 0) ? 0 : 1;
435 /* Free's an allocated packet */
436 static void sbp2_free_packet(struct hpsb_packet *packet)
438 hpsb_free_tlabel(packet);
439 hpsb_free_packet(packet);
442 /* This is much like hpsb_node_write(), except it ignores the response
443 * subaction and returns immediately. Can be used from interrupts.
445 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
446 quadlet_t *buffer, size_t length)
448 struct hpsb_packet *packet;
450 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
451 addr, buffer, length);
455 hpsb_set_packet_complete_task(packet,
456 (void (*)(void *))sbp2_free_packet,
459 hpsb_node_fill_packet(ne, packet);
461 if (hpsb_send_packet(packet) < 0) {
462 sbp2_free_packet(packet);
470 * This function is called to create a pool of command orbs used for
471 * command processing. It is called when a new sbp2 device is detected.
473 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
475 struct sbp2scsi_host_info *hi = scsi_id->hi;
477 unsigned long flags, orbs;
478 struct sbp2_command_info *command;
480 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
482 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
483 for (i = 0; i < orbs; i++) {
484 command = kzalloc(sizeof(*command), GFP_ATOMIC);
486 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
490 command->command_orb_dma =
491 pci_map_single(hi->host->pdev, &command->command_orb,
492 sizeof(struct sbp2_command_orb),
493 PCI_DMA_BIDIRECTIONAL);
494 SBP2_DMA_ALLOC("single command orb DMA");
496 pci_map_single(hi->host->pdev,
497 &command->scatter_gather_element,
498 sizeof(command->scatter_gather_element),
499 PCI_DMA_BIDIRECTIONAL);
500 SBP2_DMA_ALLOC("scatter_gather_element");
501 INIT_LIST_HEAD(&command->list);
502 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
504 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
509 * This function is called to delete a pool of command orbs.
511 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
513 struct hpsb_host *host = scsi_id->hi->host;
514 struct list_head *lh, *next;
515 struct sbp2_command_info *command;
518 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
519 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
520 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
521 command = list_entry(lh, struct sbp2_command_info, list);
523 /* Release our generic DMA's */
524 pci_unmap_single(host->pdev, command->command_orb_dma,
525 sizeof(struct sbp2_command_orb),
526 PCI_DMA_BIDIRECTIONAL);
527 SBP2_DMA_FREE("single command orb DMA");
528 pci_unmap_single(host->pdev, command->sge_dma,
529 sizeof(command->scatter_gather_element),
530 PCI_DMA_BIDIRECTIONAL);
531 SBP2_DMA_FREE("scatter_gather_element");
536 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
541 * This function finds the sbp2_command for a given outstanding command
542 * orb.Only looks at the inuse list.
544 static struct sbp2_command_info *sbp2util_find_command_for_orb(
545 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
547 struct sbp2_command_info *command;
550 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
551 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
552 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
553 if (command->command_orb_dma == orb) {
554 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
559 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
561 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
567 * This function finds the sbp2_command for a given outstanding SCpnt.
568 * Only looks at the inuse list.
569 * Must be called with scsi_id->sbp2_command_orb_lock held.
571 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
572 struct scsi_id_instance_data *scsi_id, void *SCpnt)
574 struct sbp2_command_info *command;
576 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
577 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
578 if (command->Current_SCpnt == SCpnt)
584 * This function allocates a command orb used to send a scsi command.
586 static struct sbp2_command_info *sbp2util_allocate_command_orb(
587 struct scsi_id_instance_data *scsi_id,
588 struct scsi_cmnd *Current_SCpnt,
589 void (*Current_done)(struct scsi_cmnd *))
591 struct list_head *lh;
592 struct sbp2_command_info *command = NULL;
595 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
596 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
597 lh = scsi_id->sbp2_command_orb_completed.next;
599 command = list_entry(lh, struct sbp2_command_info, list);
600 command->Current_done = Current_done;
601 command->Current_SCpnt = Current_SCpnt;
602 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
604 SBP2_ERR("%s: no orbs available", __FUNCTION__);
606 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
611 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
613 struct scsi_id_instance_data *scsi_id =
614 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
615 struct hpsb_host *host;
618 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
622 host = scsi_id->ud->ne->host;
624 if (command->cmd_dma) {
625 if (command->dma_type == CMD_DMA_SINGLE) {
626 pci_unmap_single(host->pdev, command->cmd_dma,
627 command->dma_size, command->dma_dir);
628 SBP2_DMA_FREE("single bulk");
629 } else if (command->dma_type == CMD_DMA_PAGE) {
630 pci_unmap_page(host->pdev, command->cmd_dma,
631 command->dma_size, command->dma_dir);
632 SBP2_DMA_FREE("single page");
633 } /* XXX: Check for CMD_DMA_NONE bug */
634 command->dma_type = CMD_DMA_NONE;
635 command->cmd_dma = 0;
638 if (command->sge_buffer) {
639 pci_unmap_sg(host->pdev, command->sge_buffer,
640 command->dma_size, command->dma_dir);
641 SBP2_DMA_FREE("scatter list");
642 command->sge_buffer = NULL;
647 * This function moves a command to the completed orb list.
648 * Must be called with scsi_id->sbp2_command_orb_lock held.
650 static void sbp2util_mark_command_completed(
651 struct scsi_id_instance_data *scsi_id,
652 struct sbp2_command_info *command)
654 list_del(&command->list);
655 sbp2util_free_command_dma(command);
656 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
660 * Is scsi_id valid? Is the 1394 node still present?
662 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
664 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
667 /*********************************************
668 * IEEE-1394 core driver stack related section
669 *********************************************/
670 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
672 static int sbp2_probe(struct device *dev)
674 struct unit_directory *ud;
675 struct scsi_id_instance_data *scsi_id;
679 ud = container_of(dev, struct unit_directory, device);
681 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
683 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
686 scsi_id = sbp2_alloc_device(ud);
691 sbp2_parse_unit_directory(scsi_id, ud);
693 return sbp2_start_device(scsi_id);
696 static int sbp2_remove(struct device *dev)
698 struct unit_directory *ud;
699 struct scsi_id_instance_data *scsi_id;
700 struct scsi_device *sdev;
704 ud = container_of(dev, struct unit_directory, device);
705 scsi_id = ud->device.driver_data;
709 if (scsi_id->scsi_host) {
710 /* Get rid of enqueued commands if there is no chance to
712 if (!sbp2util_node_is_available(scsi_id))
713 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
714 /* scsi_remove_device() will trigger shutdown functions of SCSI
715 * highlevel drivers which would deadlock if blocked. */
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;
736 if (sbp2_reconnect_device(scsi_id)) {
739 * Ok, reconnect has failed. Perhaps we didn't
740 * reconnect fast enough. Try doing a regular login, but
741 * first do a logout just in case of any weirdness.
743 sbp2_logout_device(scsi_id);
745 if (sbp2_login_device(scsi_id)) {
746 /* Login failed too, just fail, and the backend
747 * will call our sbp2_remove for us */
748 SBP2_ERR("Failed to reconnect to sbp2 device!");
753 /* Set max retries to something large on the device. */
754 sbp2_set_busy_timeout(scsi_id);
756 /* Do a SBP-2 fetch agent reset. */
757 sbp2_agent_reset(scsi_id, 1);
759 /* Get the max speed and packet size that we can use. */
760 sbp2_max_speed_and_size(scsi_id);
762 /* Complete any pending commands with busy (so they get
763 * retried) and remove them from our queue
765 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
767 /* Make sure we unblock requests (since this is likely after a bus
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;
784 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
786 SBP2_ERR("failed to create scsi_id");
790 scsi_id->ne = ud->ne;
792 scsi_id->speed_code = IEEE1394_SPEED_100;
793 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
794 atomic_set(&scsi_id->sbp2_login_complete, 0);
795 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
796 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
797 INIT_LIST_HEAD(&scsi_id->scsi_list);
798 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
799 scsi_id->sbp2_lun = 0;
801 ud->device.driver_data = scsi_id;
803 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
805 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
807 SBP2_ERR("failed to allocate hostinfo");
810 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
811 hi->host = ud->ne->host;
812 INIT_LIST_HEAD(&hi->scsi_ids);
814 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
815 /* Handle data movement if physical dma is not
816 * enabled or not supported on host controller */
817 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
819 0x0ULL, 0xfffffffcULL)) {
820 SBP2_ERR("failed to register lower 4GB address range");
826 /* Prevent unloading of the 1394 host */
827 if (!try_module_get(hi->host->driver->owner)) {
828 SBP2_ERR("failed to get a reference on 1394 host driver");
834 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
836 /* Register the status FIFO address range. We could use the same FIFO
837 * for targets at different nodes. However we need different FIFOs per
838 * target in order to support multi-unit devices.
839 * The FIFO is located out of the local host controller's physical range
840 * but, if possible, within the posted write area. Status writes will
841 * then be performed as unified transactions. This slightly reduces
842 * bandwidth usage, and some Prolific based devices seem to require it.
844 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
845 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
846 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
847 0x010000000000ULL, CSR1212_ALL_SPACE_END);
848 if (scsi_id->status_fifo_addr == ~0ULL) {
849 SBP2_ERR("failed to allocate status FIFO address range");
853 /* Register our host with the SCSI stack. */
854 scsi_host = scsi_host_alloc(&scsi_driver_template,
855 sizeof(unsigned long));
857 SBP2_ERR("failed to register scsi host");
861 scsi_host->hostdata[0] = (unsigned long)scsi_id;
863 if (!scsi_add_host(scsi_host, &ud->device)) {
864 scsi_id->scsi_host = scsi_host;
868 SBP2_ERR("failed to add scsi host");
869 scsi_host_put(scsi_host);
872 sbp2_remove_device(scsi_id);
876 static void sbp2_host_reset(struct hpsb_host *host)
878 struct sbp2scsi_host_info *hi;
879 struct scsi_id_instance_data *scsi_id;
881 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
884 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
885 scsi_block_requests(scsi_id->scsi_host);
890 * This function is where we first pull the node unique ids, and then
891 * allocate memory and register a SBP-2 device.
893 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
895 struct sbp2scsi_host_info *hi = scsi_id->hi;
901 scsi_id->login_response =
902 pci_alloc_consistent(hi->host->pdev,
903 sizeof(struct sbp2_login_response),
904 &scsi_id->login_response_dma);
905 if (!scsi_id->login_response)
907 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
909 /* Query logins ORB DMA */
910 scsi_id->query_logins_orb =
911 pci_alloc_consistent(hi->host->pdev,
912 sizeof(struct sbp2_query_logins_orb),
913 &scsi_id->query_logins_orb_dma);
914 if (!scsi_id->query_logins_orb)
916 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
918 /* Query logins response DMA */
919 scsi_id->query_logins_response =
920 pci_alloc_consistent(hi->host->pdev,
921 sizeof(struct sbp2_query_logins_response),
922 &scsi_id->query_logins_response_dma);
923 if (!scsi_id->query_logins_response)
925 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
927 /* Reconnect ORB DMA */
928 scsi_id->reconnect_orb =
929 pci_alloc_consistent(hi->host->pdev,
930 sizeof(struct sbp2_reconnect_orb),
931 &scsi_id->reconnect_orb_dma);
932 if (!scsi_id->reconnect_orb)
934 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
937 scsi_id->logout_orb =
938 pci_alloc_consistent(hi->host->pdev,
939 sizeof(struct sbp2_logout_orb),
940 &scsi_id->logout_orb_dma);
941 if (!scsi_id->logout_orb)
943 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
947 pci_alloc_consistent(hi->host->pdev,
948 sizeof(struct sbp2_login_orb),
949 &scsi_id->login_orb_dma);
950 if (!scsi_id->login_orb)
952 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
954 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
957 * Create our command orb pool
959 if (sbp2util_create_command_orb_pool(scsi_id)) {
960 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
961 sbp2_remove_device(scsi_id);
965 /* Schedule a timeout here. The reason is that we may be so close
966 * to a bus reset, that the device is not available for logins.
967 * This can happen when the bus reset is caused by the host
968 * connected to the sbp2 device being removed. That host would
969 * have a certain amount of time to relogin before the sbp2 device
970 * allows someone else to login instead. One second makes sense. */
971 msleep_interruptible(1000);
972 if (signal_pending(current)) {
973 sbp2_remove_device(scsi_id);
978 * Login to the sbp-2 device
980 if (sbp2_login_device(scsi_id)) {
981 /* Login failed, just remove the device. */
982 sbp2_remove_device(scsi_id);
987 * Set max retries to something large on the device
989 sbp2_set_busy_timeout(scsi_id);
992 * Do a SBP-2 fetch agent reset
994 sbp2_agent_reset(scsi_id, 1);
997 * Get the max speed and packet size that we can use
999 sbp2_max_speed_and_size(scsi_id);
1001 /* Add this device to the scsi layer now */
1002 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1004 SBP2_ERR("scsi_add_device failed");
1005 sbp2_logout_device(scsi_id);
1006 sbp2_remove_device(scsi_id);
1013 SBP2_ERR("Could not allocate memory for scsi_id");
1014 sbp2_remove_device(scsi_id);
1019 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1021 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1023 struct sbp2scsi_host_info *hi;
1032 /* This will remove our scsi device aswell */
1033 if (scsi_id->scsi_host) {
1034 scsi_remove_host(scsi_id->scsi_host);
1035 scsi_host_put(scsi_id->scsi_host);
1038 sbp2util_remove_command_orb_pool(scsi_id);
1040 list_del(&scsi_id->scsi_list);
1042 if (scsi_id->login_response) {
1043 pci_free_consistent(hi->host->pdev,
1044 sizeof(struct sbp2_login_response),
1045 scsi_id->login_response,
1046 scsi_id->login_response_dma);
1047 SBP2_DMA_FREE("single login FIFO");
1050 if (scsi_id->login_orb) {
1051 pci_free_consistent(hi->host->pdev,
1052 sizeof(struct sbp2_login_orb),
1054 scsi_id->login_orb_dma);
1055 SBP2_DMA_FREE("single login ORB");
1058 if (scsi_id->reconnect_orb) {
1059 pci_free_consistent(hi->host->pdev,
1060 sizeof(struct sbp2_reconnect_orb),
1061 scsi_id->reconnect_orb,
1062 scsi_id->reconnect_orb_dma);
1063 SBP2_DMA_FREE("single reconnect orb");
1066 if (scsi_id->logout_orb) {
1067 pci_free_consistent(hi->host->pdev,
1068 sizeof(struct sbp2_logout_orb),
1069 scsi_id->logout_orb,
1070 scsi_id->logout_orb_dma);
1071 SBP2_DMA_FREE("single logout orb");
1074 if (scsi_id->query_logins_orb) {
1075 pci_free_consistent(hi->host->pdev,
1076 sizeof(struct sbp2_query_logins_orb),
1077 scsi_id->query_logins_orb,
1078 scsi_id->query_logins_orb_dma);
1079 SBP2_DMA_FREE("single query logins orb");
1082 if (scsi_id->query_logins_response) {
1083 pci_free_consistent(hi->host->pdev,
1084 sizeof(struct sbp2_query_logins_response),
1085 scsi_id->query_logins_response,
1086 scsi_id->query_logins_response_dma);
1087 SBP2_DMA_FREE("single query logins data");
1090 if (scsi_id->status_fifo_addr)
1091 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1092 scsi_id->status_fifo_addr);
1094 scsi_id->ud->device.driver_data = NULL;
1097 module_put(hi->host->driver->owner);
1099 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1104 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1106 * This function deals with physical dma write requests (for adapters that do not support
1107 * physical dma in hardware). Mostly just here for debugging...
1109 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1110 int destid, quadlet_t *data, u64 addr,
1111 size_t length, u16 flags)
1115 * Manually put the data in the right place.
1117 memcpy(bus_to_virt((u32) addr), data, length);
1118 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1120 return RCODE_COMPLETE;
1124 * This function deals with physical dma read requests (for adapters that do not support
1125 * physical dma in hardware). Mostly just here for debugging...
1127 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1128 quadlet_t *data, u64 addr, size_t length,
1133 * Grab data from memory and send a read response.
1135 memcpy(data, bus_to_virt((u32) addr), length);
1136 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1138 return RCODE_COMPLETE;
1142 /**************************************
1143 * SBP-2 protocol related section
1144 **************************************/
1147 * This function queries the device for the maximum concurrent logins it
1150 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1152 struct sbp2scsi_host_info *hi = scsi_id->hi;
1159 scsi_id->query_logins_orb->reserved1 = 0x0;
1160 scsi_id->query_logins_orb->reserved2 = 0x0;
1162 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1163 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1165 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1166 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1167 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1169 scsi_id->query_logins_orb->reserved_resp_length =
1170 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1172 scsi_id->query_logins_orb->status_fifo_hi =
1173 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1174 scsi_id->query_logins_orb->status_fifo_lo =
1175 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1177 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1179 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1180 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1182 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1183 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1185 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1186 data[1] = scsi_id->query_logins_orb_dma;
1187 sbp2util_cpu_to_be32_buffer(data, 8);
1189 atomic_set(&scsi_id->sbp2_login_complete, 0);
1191 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1193 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1194 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1198 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1199 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1203 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1204 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1205 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1207 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1211 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1213 SBP2_DEBUG("length_max_logins = %x",
1214 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1216 SBP2_DEBUG("Query logins to SBP-2 device successful");
1218 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1219 SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1221 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1222 SBP2_DEBUG("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);
1652 * This function is called in order to determine the max speed and packet
1653 * size we can use in our ORBs. Note, that we (the driver and host) only
1654 * initiate the transaction. The SBP-2 device actually transfers the data
1655 * (by reading from the DMA area we tell it). This means that the SBP-2
1656 * device decides the actual maximum data it can transfer. We just tell it
1657 * the speed that it needs to use, and the max_rec the host supports, and
1658 * it takes care of the rest.
1660 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1662 struct sbp2scsi_host_info *hi = scsi_id->hi;
1666 /* Initial setting comes from the hosts speed map */
1667 scsi_id->speed_code =
1668 hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64 +
1669 NODEID_TO_NODE(scsi_id->ne->nodeid)];
1671 /* Bump down our speed if the user requested it */
1672 if (scsi_id->speed_code > max_speed) {
1673 scsi_id->speed_code = max_speed;
1674 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1675 hpsb_speedto_str[scsi_id->speed_code]);
1678 /* Payload size is the lesser of what our speed supports and what
1679 * our host supports. */
1680 scsi_id->max_payload_size =
1681 min(sbp2_speedto_max_payload[scsi_id->speed_code],
1682 (u8) (hi->host->csr.max_rec - 1));
1684 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1685 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1686 hpsb_speedto_str[scsi_id->speed_code],
1687 1 << ((u32) scsi_id->max_payload_size + 2));
1693 * This function is called in order to perform a SBP-2 agent reset.
1695 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1703 data = ntohl(SBP2_AGENT_RESET_DATA);
1704 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1707 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1709 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1712 SBP2_ERR("hpsb_node_write failed.\n");
1717 * Need to make sure orb pointer is written on next command
1719 scsi_id->last_orb = NULL;
1724 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1725 struct sbp2scsi_host_info *hi,
1726 struct sbp2_command_info *command,
1727 unsigned int scsi_use_sg,
1728 struct scatterlist *sgpnt,
1730 enum dma_data_direction dma_dir)
1732 command->dma_dir = dma_dir;
1733 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1734 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1736 /* Special case if only one element (and less than 64KB in size) */
1737 if ((scsi_use_sg == 1) &&
1738 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1740 SBP2_DEBUG("Only one s/g element");
1741 command->dma_size = sgpnt[0].length;
1742 command->dma_type = CMD_DMA_PAGE;
1743 command->cmd_dma = pci_map_page(hi->host->pdev,
1748 SBP2_DMA_ALLOC("single page scatter element");
1750 orb->data_descriptor_lo = command->cmd_dma;
1751 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1754 struct sbp2_unrestricted_page_table *sg_element =
1755 &command->scatter_gather_element[0];
1756 u32 sg_count, sg_len;
1758 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1761 SBP2_DMA_ALLOC("scatter list");
1763 command->dma_size = scsi_use_sg;
1764 command->sge_buffer = sgpnt;
1766 /* use page tables (s/g) */
1767 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1768 orb->data_descriptor_lo = command->sge_dma;
1771 * Loop through and fill out our sbp-2 page tables
1772 * (and split up anything too large)
1774 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1775 sg_len = sg_dma_len(sgpnt);
1776 sg_addr = sg_dma_address(sgpnt);
1778 sg_element[sg_count].segment_base_lo = sg_addr;
1779 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1780 sg_element[sg_count].length_segment_base_hi =
1781 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1782 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1783 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1785 sg_element[sg_count].length_segment_base_hi =
1786 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1793 /* Number of page table (s/g) elements */
1794 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1796 sbp2util_packet_dump(sg_element,
1797 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1798 "sbp2 s/g list", command->sge_dma);
1800 /* Byte swap page tables if necessary */
1801 sbp2util_cpu_to_be32_buffer(sg_element,
1802 (sizeof(struct sbp2_unrestricted_page_table)) *
1807 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1808 struct sbp2scsi_host_info *hi,
1809 struct sbp2_command_info *command,
1810 struct scatterlist *sgpnt,
1812 unsigned int scsi_request_bufflen,
1813 void *scsi_request_buffer,
1814 enum dma_data_direction dma_dir)
1816 command->dma_dir = dma_dir;
1817 command->dma_size = scsi_request_bufflen;
1818 command->dma_type = CMD_DMA_SINGLE;
1819 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1820 command->dma_size, command->dma_dir);
1821 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1822 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1824 SBP2_DMA_ALLOC("single bulk");
1827 * Handle case where we get a command w/o s/g enabled (but
1828 * check for transfers larger than 64K)
1830 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1832 orb->data_descriptor_lo = command->cmd_dma;
1833 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1836 struct sbp2_unrestricted_page_table *sg_element =
1837 &command->scatter_gather_element[0];
1838 u32 sg_count, sg_len;
1842 * Need to turn this into page tables, since the
1843 * buffer is too large.
1845 orb->data_descriptor_lo = command->sge_dma;
1847 /* Use page tables (s/g) */
1848 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1851 * fill out our sbp-2 page tables (and split up
1855 sg_len = scsi_request_bufflen;
1856 sg_addr = command->cmd_dma;
1858 sg_element[sg_count].segment_base_lo = sg_addr;
1859 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1860 sg_element[sg_count].length_segment_base_hi =
1861 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1862 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1863 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1865 sg_element[sg_count].length_segment_base_hi =
1866 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1872 /* Number of page table (s/g) elements */
1873 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1875 sbp2util_packet_dump(sg_element,
1876 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1877 "sbp2 s/g list", command->sge_dma);
1879 /* Byte swap page tables if necessary */
1880 sbp2util_cpu_to_be32_buffer(sg_element,
1881 (sizeof(struct sbp2_unrestricted_page_table)) *
1887 * This function is called to create the actual command orb and s/g list
1888 * out of the scsi command itself.
1890 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1891 struct sbp2_command_info *command,
1893 unsigned int scsi_use_sg,
1894 unsigned int scsi_request_bufflen,
1895 void *scsi_request_buffer,
1896 enum dma_data_direction dma_dir)
1898 struct sbp2scsi_host_info *hi = scsi_id->hi;
1899 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1900 struct sbp2_command_orb *command_orb = &command->command_orb;
1904 * Set-up our command ORB..
1906 * NOTE: We're doing unrestricted page tables (s/g), as this is
1907 * best performance (at least with the devices I have). This means
1908 * that data_size becomes the number of s/g elements, and
1909 * page_size should be zero (for unrestricted).
1911 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1912 command_orb->next_ORB_lo = 0x0;
1913 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1914 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1915 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1917 if (dma_dir == DMA_NONE)
1918 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1919 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1920 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1921 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1922 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1924 SBP2_WARN("Falling back to DMA_NONE");
1925 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1928 /* Set-up our pagetable stuff */
1929 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1930 SBP2_DEBUG("No data transfer");
1931 command_orb->data_descriptor_hi = 0x0;
1932 command_orb->data_descriptor_lo = 0x0;
1933 command_orb->misc |= ORB_SET_DIRECTION(1);
1934 } else if (scsi_use_sg) {
1935 SBP2_DEBUG("Use scatter/gather");
1936 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1937 sgpnt, orb_direction, dma_dir);
1939 SBP2_DEBUG("No scatter/gather");
1940 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1941 orb_direction, scsi_request_bufflen,
1942 scsi_request_buffer, dma_dir);
1945 /* Byte swap command ORB if necessary */
1946 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1948 /* Put our scsi command in the command ORB */
1949 memset(command_orb->cdb, 0, 12);
1950 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1954 * This function is called in order to begin a regular SBP-2 command.
1956 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1957 struct sbp2_command_info *command)
1959 struct sbp2scsi_host_info *hi = scsi_id->hi;
1960 struct sbp2_command_orb *command_orb = &command->command_orb;
1961 struct node_entry *ne = scsi_id->ne;
1964 outstanding_orb_incr;
1965 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1966 command_orb, global_outstanding_command_orbs);
1968 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1969 sizeof(struct sbp2_command_orb),
1970 PCI_DMA_BIDIRECTIONAL);
1971 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1972 sizeof(command->scatter_gather_element),
1973 PCI_DMA_BIDIRECTIONAL);
1975 * Check to see if there are any previous orbs to use
1977 if (scsi_id->last_orb == NULL) {
1981 * Ok, let's write to the target's management agent register
1983 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
1984 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1985 data[1] = command->command_orb_dma;
1986 sbp2util_cpu_to_be32_buffer(data, 8);
1988 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
1990 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
1991 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1995 SBP2_ORB_DEBUG("write command agent complete");
1997 scsi_id->last_orb = command_orb;
1998 scsi_id->last_orb_dma = command->command_orb_dma;
2004 * We have an orb already sent (maybe or maybe not
2005 * processed) that we can append this orb to. So do so,
2006 * and ring the doorbell. Have to be very careful
2007 * modifying these next orb pointers, as they are accessed
2008 * both by the sbp2 device and us.
2010 scsi_id->last_orb->next_ORB_lo =
2011 cpu_to_be32(command->command_orb_dma);
2012 /* Tells hardware that this pointer is valid */
2013 scsi_id->last_orb->next_ORB_hi = 0x0;
2014 pci_dma_sync_single_for_device(hi->host->pdev,
2015 scsi_id->last_orb_dma,
2016 sizeof(struct sbp2_command_orb),
2017 PCI_DMA_BIDIRECTIONAL);
2022 data = cpu_to_be32(command->command_orb_dma);
2023 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
2025 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
2027 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
2028 SBP2_ERR("sbp2util_node_write_no_wait failed");
2032 scsi_id->last_orb = command_orb;
2033 scsi_id->last_orb_dma = command->command_orb_dma;
2040 * This function is called in order to begin a regular SBP-2 command.
2042 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2043 struct scsi_cmnd *SCpnt,
2044 void (*done)(struct scsi_cmnd *))
2046 unchar *cmd = (unchar *) SCpnt->cmnd;
2047 unsigned int request_bufflen = SCpnt->request_bufflen;
2048 struct sbp2_command_info *command;
2051 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2052 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2055 * Allocate a command orb and s/g structure
2057 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2063 * Now actually fill in the comamnd orb and sbp2 s/g list
2065 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2066 request_bufflen, SCpnt->request_buffer,
2067 SCpnt->sc_data_direction);
2069 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2070 "sbp2 command orb", command->command_orb_dma);
2073 * Initialize status fifo
2075 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2078 * Link up the orb, and ring the doorbell if needed
2080 sbp2_link_orb_command(scsi_id, command);
2086 * Translates SBP-2 status into SCSI sense data for check conditions
2088 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2093 * Ok, it's pretty ugly... ;-)
2095 sense_data[0] = 0x70;
2096 sense_data[1] = 0x0;
2097 sense_data[2] = sbp2_status[9];
2098 sense_data[3] = sbp2_status[12];
2099 sense_data[4] = sbp2_status[13];
2100 sense_data[5] = sbp2_status[14];
2101 sense_data[6] = sbp2_status[15];
2103 sense_data[8] = sbp2_status[16];
2104 sense_data[9] = sbp2_status[17];
2105 sense_data[10] = sbp2_status[18];
2106 sense_data[11] = sbp2_status[19];
2107 sense_data[12] = sbp2_status[10];
2108 sense_data[13] = sbp2_status[11];
2109 sense_data[14] = sbp2_status[20];
2110 sense_data[15] = sbp2_status[21];
2112 return sbp2_status[8] & 0x3f; /* return scsi status */
2116 * This function is called after a command is completed, in order to do any necessary SBP-2
2117 * response data translations for the SCSI stack
2119 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2120 struct scsi_cmnd *SCpnt)
2122 u8 *scsi_buf = SCpnt->request_buffer;
2126 if (SCpnt->cmnd[0] == INQUIRY && (SCpnt->cmnd[1] & 3) == 0) {
2128 * Make sure data length is ok. Minimum length is 36 bytes
2130 if (scsi_buf[4] == 0) {
2131 scsi_buf[4] = 36 - 5;
2135 * Fix ansi revision and response data format
2138 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2143 * This function deals with status writes from the SBP-2 device
2145 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2146 quadlet_t *data, u64 addr, size_t length, u16 fl)
2148 struct sbp2scsi_host_info *hi;
2149 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2150 struct scsi_cmnd *SCpnt = NULL;
2151 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2152 struct sbp2_command_info *command;
2153 unsigned long flags;
2157 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2160 SBP2_ERR("host is NULL - this is bad!");
2161 return RCODE_ADDRESS_ERROR;
2164 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2167 SBP2_ERR("host info is NULL - this is bad!");
2168 return RCODE_ADDRESS_ERROR;
2172 * Find our scsi_id structure by looking at the status fifo address
2173 * written to by the sbp2 device.
2175 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2176 if (scsi_id_tmp->ne->nodeid == nodeid &&
2177 scsi_id_tmp->status_fifo_addr == addr) {
2178 scsi_id = scsi_id_tmp;
2184 SBP2_ERR("scsi_id is NULL - device is gone?");
2185 return RCODE_ADDRESS_ERROR;
2189 * Put response into scsi_id status fifo...
2191 memcpy(&scsi_id->status_block, data, length);
2194 * Byte swap first two quadlets (8 bytes) of status for processing
2196 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2199 * Handle command ORB status here if necessary. First, need to match status with command.
2201 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2204 SBP2_DEBUG("Found status for command ORB");
2205 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2206 sizeof(struct sbp2_command_orb),
2207 PCI_DMA_BIDIRECTIONAL);
2208 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2209 sizeof(command->scatter_gather_element),
2210 PCI_DMA_BIDIRECTIONAL);
2212 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2213 outstanding_orb_decr;
2216 * Matched status with command, now grab scsi command pointers and check status
2218 SCpnt = command->Current_SCpnt;
2219 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2220 sbp2util_mark_command_completed(scsi_id, command);
2221 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2226 * See if the target stored any scsi status information
2228 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2230 * Translate SBP-2 status to SCSI sense data
2232 SBP2_DEBUG("CHECK CONDITION");
2233 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2237 * Check to see if the dead bit is set. If so, we'll have to initiate
2238 * a fetch agent reset.
2240 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2243 * Initiate a fetch agent reset.
2245 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2246 sbp2_agent_reset(scsi_id, 0);
2249 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2253 * Check here to see if there are no commands in-use. If there are none, we can
2254 * null out last orb so that next time around we write directly to the orb pointer...
2255 * Quick start saves one 1394 bus transaction.
2257 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2258 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2259 scsi_id->last_orb = NULL;
2261 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2266 * It's probably a login/logout/reconnect status.
2268 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2269 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2270 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2271 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2272 atomic_set(&scsi_id->sbp2_login_complete, 1);
2278 /* Complete the SCSI command. */
2279 SBP2_DEBUG("Completing SCSI command");
2280 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2281 command->Current_done);
2282 SBP2_ORB_DEBUG("command orb completed");
2285 return RCODE_COMPLETE;
2288 /**************************************
2289 * SCSI interface related section
2290 **************************************/
2293 * This routine is the main request entry routine for doing I/O. It is
2294 * called from the scsi stack directly.
2296 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2297 void (*done)(struct scsi_cmnd *))
2299 struct scsi_id_instance_data *scsi_id =
2300 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2301 struct sbp2scsi_host_info *hi;
2302 int result = DID_NO_CONNECT << 16;
2305 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2306 scsi_print_command(SCpnt);
2309 if (!sbp2util_node_is_available(scsi_id))
2315 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2320 * Until we handle multiple luns, just return selection time-out
2321 * to any IO directed at non-zero LUNs
2323 if (SCpnt->device->lun)
2327 * Check for request sense command, and handle it here
2328 * (autorequest sense)
2330 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2331 SBP2_DEBUG("REQUEST_SENSE");
2332 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2333 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2334 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2339 * Check to see if we are in the middle of a bus reset.
2341 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2342 SBP2_ERR("Bus reset in progress - rejecting command");
2343 result = DID_BUS_BUSY << 16;
2348 * Bidirectional commands are not yet implemented,
2349 * and unknown transfer direction not handled.
2351 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2352 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2353 result = DID_ERROR << 16;
2358 * Try and send our SCSI command
2360 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2361 SBP2_ERR("Error sending SCSI command");
2362 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2368 SCpnt->result = result;
2374 * This function is called in order to complete all outstanding SBP-2
2375 * commands (in case of resets, etc.).
2377 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2380 struct sbp2scsi_host_info *hi = scsi_id->hi;
2381 struct list_head *lh;
2382 struct sbp2_command_info *command;
2383 unsigned long flags;
2387 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2388 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2389 SBP2_DEBUG("Found pending command to complete");
2390 lh = scsi_id->sbp2_command_orb_inuse.next;
2391 command = list_entry(lh, struct sbp2_command_info, list);
2392 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2393 sizeof(struct sbp2_command_orb),
2394 PCI_DMA_BIDIRECTIONAL);
2395 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2396 sizeof(command->scatter_gather_element),
2397 PCI_DMA_BIDIRECTIONAL);
2398 sbp2util_mark_command_completed(scsi_id, command);
2399 if (command->Current_SCpnt) {
2400 command->Current_SCpnt->result = status << 16;
2401 command->Current_done(command->Current_SCpnt);
2404 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2410 * This function is called in order to complete a regular SBP-2 command.
2412 * This can be called in interrupt context.
2414 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2415 u32 scsi_status, struct scsi_cmnd *SCpnt,
2416 void (*done)(struct scsi_cmnd *))
2424 SBP2_ERR("SCpnt is NULL");
2429 * If a bus reset is in progress and there was an error, don't
2430 * complete the command, just let it get retried at the end of the
2433 if (!hpsb_node_entry_valid(scsi_id->ne)
2434 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2435 SBP2_ERR("Bus reset in progress - retry command later");
2440 * Switch on scsi status
2442 switch (scsi_status) {
2443 case SBP2_SCSI_STATUS_GOOD:
2444 SCpnt->result = DID_OK << 16;
2447 case SBP2_SCSI_STATUS_BUSY:
2448 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2449 SCpnt->result = DID_BUS_BUSY << 16;
2452 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2453 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2454 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2455 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2456 scsi_print_command(SCpnt);
2457 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
2461 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2462 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2463 SCpnt->result = DID_NO_CONNECT << 16;
2464 scsi_print_command(SCpnt);
2467 case SBP2_SCSI_STATUS_CONDITION_MET:
2468 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2469 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2470 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2471 SCpnt->result = DID_ERROR << 16;
2472 scsi_print_command(SCpnt);
2476 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2477 SCpnt->result = DID_ERROR << 16;
2481 * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2483 if (SCpnt->result == DID_OK << 16) {
2484 sbp2_check_sbp2_response(scsi_id, SCpnt);
2488 * If a bus reset is in progress and there was an error, complete
2489 * the command as busy so that it will get retried.
2491 if (!hpsb_node_entry_valid(scsi_id->ne)
2492 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2493 SBP2_ERR("Completing command with busy (bus reset)");
2494 SCpnt->result = DID_BUS_BUSY << 16;
2498 * If a unit attention occurs, return busy status so it gets
2499 * retried... it could have happened because of a 1394 bus reset
2501 * XXX DID_BUS_BUSY is actually a bad idea because it will defy
2502 * the scsi layer's retry logic.
2505 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2506 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2507 SBP2_DEBUG("UNIT ATTENTION - return busy");
2508 SCpnt->result = DID_BUS_BUSY << 16;
2513 * Tell scsi stack that we're done with this command
2518 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2520 struct scsi_id_instance_data *scsi_id =
2521 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2523 scsi_id->sdev = sdev;
2525 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2526 sdev->inquiry_len = 36;
2530 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2532 struct scsi_id_instance_data *scsi_id =
2533 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2535 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2536 sdev->use_10_for_rw = 1;
2537 sdev->use_10_for_ms = 1;
2539 if (sdev->type == TYPE_DISK &&
2540 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2541 sdev->skip_ms_page_8 = 1;
2542 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2543 sdev->fix_capacity = 1;
2547 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2549 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2554 * Called by scsi stack when something has really gone wrong. Usually
2555 * called when a command has timed-out for some reason.
2557 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2559 struct scsi_id_instance_data *scsi_id =
2560 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2561 struct sbp2scsi_host_info *hi = scsi_id->hi;
2562 struct sbp2_command_info *command;
2563 unsigned long flags;
2565 SBP2_ERR("aborting sbp2 command");
2566 scsi_print_command(SCpnt);
2568 if (sbp2util_node_is_available(scsi_id)) {
2571 * Right now, just return any matching command structures
2574 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2575 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2577 SBP2_DEBUG("Found command to abort");
2578 pci_dma_sync_single_for_cpu(hi->host->pdev,
2579 command->command_orb_dma,
2580 sizeof(struct sbp2_command_orb),
2581 PCI_DMA_BIDIRECTIONAL);
2582 pci_dma_sync_single_for_cpu(hi->host->pdev,
2584 sizeof(command->scatter_gather_element),
2585 PCI_DMA_BIDIRECTIONAL);
2586 sbp2util_mark_command_completed(scsi_id, command);
2587 if (command->Current_SCpnt) {
2588 command->Current_SCpnt->result = DID_ABORT << 16;
2589 command->Current_done(command->Current_SCpnt);
2592 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2595 * Initiate a fetch agent reset.
2597 sbp2_agent_reset(scsi_id, 0);
2598 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2605 * Called by scsi stack when something has really gone wrong.
2607 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2609 struct scsi_id_instance_data *scsi_id =
2610 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2612 SBP2_ERR("reset requested");
2614 if (sbp2util_node_is_available(scsi_id)) {
2615 SBP2_ERR("Generating sbp2 fetch agent reset");
2616 sbp2_agent_reset(scsi_id, 0);
2622 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2623 struct device_attribute *attr,
2626 struct scsi_device *sdev;
2627 struct scsi_id_instance_data *scsi_id;
2630 if (!(sdev = to_scsi_device(dev)))
2633 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2636 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2638 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2639 scsi_id->ud->id, lun);
2641 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2643 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2644 &dev_attr_ieee1394_id,
2648 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2649 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2650 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2651 MODULE_LICENSE("GPL");
2653 /* SCSI host template */
2654 static struct scsi_host_template scsi_driver_template = {
2655 .module = THIS_MODULE,
2656 .name = "SBP-2 IEEE-1394",
2657 .proc_name = SBP2_DEVICE_NAME,
2658 .queuecommand = sbp2scsi_queuecommand,
2659 .eh_abort_handler = sbp2scsi_abort,
2660 .eh_device_reset_handler = sbp2scsi_reset,
2661 .slave_alloc = sbp2scsi_slave_alloc,
2662 .slave_configure = sbp2scsi_slave_configure,
2663 .slave_destroy = sbp2scsi_slave_destroy,
2665 .sg_tablesize = SG_ALL,
2666 .use_clustering = ENABLE_CLUSTERING,
2667 .cmd_per_lun = SBP2_MAX_CMDS,
2668 .can_queue = SBP2_MAX_CMDS,
2670 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2673 static int sbp2_module_init(void)
2679 /* Module load debug option to force one command at a time (serializing I/O) */
2681 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2682 SBP2_INFO("Try serialize_io=0 for better performance");
2683 scsi_driver_template.can_queue = 1;
2684 scsi_driver_template.cmd_per_lun = 1;
2687 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2688 (max_sectors * 512) > (128 * 1024))
2689 max_sectors = 128 * 1024 / 512;
2690 scsi_driver_template.max_sectors = max_sectors;
2692 /* Register our high level driver with 1394 stack */
2693 hpsb_register_highlevel(&sbp2_highlevel);
2695 ret = hpsb_register_protocol(&sbp2_driver);
2697 SBP2_ERR("Failed to register protocol");
2698 hpsb_unregister_highlevel(&sbp2_highlevel);
2705 static void __exit sbp2_module_exit(void)
2709 hpsb_unregister_protocol(&sbp2_driver);
2711 hpsb_unregister_highlevel(&sbp2_highlevel);
2714 module_init(sbp2_module_init);
2715 module_exit(sbp2_module_exit);