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>
58 #include <linux/wait.h>
60 #include <asm/current.h>
61 #include <asm/uaccess.h>
63 #include <asm/byteorder.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)");
177 * Export information about protocols/devices supported by this driver.
179 static struct ieee1394_device_id sbp2_id_table[] = {
181 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
182 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
183 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
187 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
190 * Debug levels, configured via kernel config, or enable here.
193 #define CONFIG_IEEE1394_SBP2_DEBUG 0
194 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
195 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
196 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
197 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
198 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
200 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
201 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
202 static u32 global_outstanding_command_orbs = 0;
203 #define outstanding_orb_incr global_outstanding_command_orbs++
204 #define outstanding_orb_decr global_outstanding_command_orbs--
206 #define SBP2_ORB_DEBUG(fmt, args...)
207 #define outstanding_orb_incr
208 #define outstanding_orb_decr
211 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
212 #define SBP2_DMA_ALLOC(fmt, args...) \
213 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
214 ++global_outstanding_dmas, ## args)
215 #define SBP2_DMA_FREE(fmt, args...) \
216 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
217 --global_outstanding_dmas, ## args)
218 static u32 global_outstanding_dmas = 0;
220 #define SBP2_DMA_ALLOC(fmt, args...)
221 #define SBP2_DMA_FREE(fmt, args...)
224 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
225 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
226 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
227 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
228 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
229 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
230 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
231 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
232 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
233 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
235 #define SBP2_DEBUG(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)
241 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
242 #define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
248 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
251 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
252 u32 scsi_status, struct scsi_cmnd *SCpnt,
253 void (*done)(struct scsi_cmnd *));
255 static struct scsi_host_template scsi_driver_template;
257 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
259 static void sbp2_host_reset(struct hpsb_host *host);
261 static int sbp2_probe(struct device *dev);
262 static int sbp2_remove(struct device *dev);
263 static int sbp2_update(struct unit_directory *ud);
265 static struct hpsb_highlevel sbp2_highlevel = {
266 .name = SBP2_DEVICE_NAME,
267 .host_reset = sbp2_host_reset,
270 static struct hpsb_address_ops sbp2_ops = {
271 .write = sbp2_handle_status_write
274 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
275 static struct hpsb_address_ops sbp2_physdma_ops = {
276 .read = sbp2_handle_physdma_read,
277 .write = sbp2_handle_physdma_write,
281 static struct hpsb_protocol_driver sbp2_driver = {
282 .name = "SBP2 Driver",
283 .id_table = sbp2_id_table,
284 .update = sbp2_update,
286 .name = SBP2_DEVICE_NAME,
287 .bus = &ieee1394_bus_type,
289 .remove = sbp2_remove,
294 * List of devices with known bugs.
296 * The firmware_revision field, masked with 0xffff00, is the best indicator
297 * for the type of bridge chip of a device. It yields a few false positives
298 * but this did not break correctly behaving devices so far.
300 static const struct {
301 u32 firmware_revision;
303 unsigned workarounds;
304 } sbp2_workarounds_table[] = {
305 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
306 .firmware_revision = 0x002800,
307 .model_id = 0x001010,
308 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
309 SBP2_WORKAROUND_MODE_SENSE_8,
311 /* Initio bridges, actually only needed for some older ones */ {
312 .firmware_revision = 0x000200,
313 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
315 /* Symbios bridge */ {
316 .firmware_revision = 0xa0b800,
317 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
320 * Note about the following Apple iPod blacklist entries:
322 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
323 * matching logic treats 0 as a wildcard, we cannot match this ID
324 * without rewriting the matching routine. Fortunately these iPods
325 * do not feature the read_capacity bug according to one report.
326 * Read_capacity behaviour as well as model_id could change due to
327 * Apple-supplied firmware updates though.
329 /* iPod 4th generation */ {
330 .firmware_revision = 0x0a2700,
331 .model_id = 0x000021,
332 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
335 .firmware_revision = 0x0a2700,
336 .model_id = 0x000023,
337 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
340 .firmware_revision = 0x0a2700,
341 .model_id = 0x00007e,
342 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
346 /**************************************
347 * General utility functions
348 **************************************/
352 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
354 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
358 for (length = (length >> 2); length--; )
359 temp[length] = be32_to_cpu(temp[length]);
365 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
367 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
371 for (length = (length >> 2); length--; )
372 temp[length] = cpu_to_be32(temp[length]);
376 #else /* BIG_ENDIAN */
377 /* Why waste the cpu cycles? */
378 #define sbp2util_be32_to_cpu_buffer(x,y)
379 #define sbp2util_cpu_to_be32_buffer(x,y)
382 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
384 * Debug packet dump routine. Length is in bytes.
386 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
390 unsigned char *dump = buffer;
392 if (!dump || !length || !dump_name)
396 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
398 printk("[%s]", dump_name);
399 for (i = 0; i < length; i++) {
408 printk("%02x ", (int)dump[i]);
415 #define sbp2util_packet_dump(w,x,y,z)
418 static DECLARE_WAIT_QUEUE_HEAD(access_wq);
421 * Waits for completion of an SBP-2 access request.
422 * Returns nonzero if timed out or prematurely interrupted.
424 static int sbp2util_access_timeout(struct scsi_id_instance_data *scsi_id,
427 long leftover = wait_event_interruptible_timeout(
428 access_wq, scsi_id->access_complete, timeout);
430 scsi_id->access_complete = 0;
431 return leftover <= 0;
434 /* Frees an allocated packet */
435 static void sbp2_free_packet(struct hpsb_packet *packet)
437 hpsb_free_tlabel(packet);
438 hpsb_free_packet(packet);
441 /* This is much like hpsb_node_write(), except it ignores the response
442 * subaction and returns immediately. Can be used from interrupts.
444 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
445 quadlet_t *buffer, size_t length)
447 struct hpsb_packet *packet;
449 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
450 addr, buffer, length);
454 hpsb_set_packet_complete_task(packet,
455 (void (*)(void *))sbp2_free_packet,
458 hpsb_node_fill_packet(ne, packet);
460 if (hpsb_send_packet(packet) < 0) {
461 sbp2_free_packet(packet);
469 * This function is called to create a pool of command orbs used for
470 * command processing. It is called when a new sbp2 device is detected.
472 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
474 struct sbp2scsi_host_info *hi = scsi_id->hi;
476 unsigned long flags, orbs;
477 struct sbp2_command_info *command;
479 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
481 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
482 for (i = 0; i < orbs; i++) {
483 command = kzalloc(sizeof(*command), GFP_ATOMIC);
485 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
489 command->command_orb_dma =
490 pci_map_single(hi->host->pdev, &command->command_orb,
491 sizeof(struct sbp2_command_orb),
493 SBP2_DMA_ALLOC("single command orb DMA");
495 pci_map_single(hi->host->pdev,
496 &command->scatter_gather_element,
497 sizeof(command->scatter_gather_element),
498 PCI_DMA_BIDIRECTIONAL);
499 SBP2_DMA_ALLOC("scatter_gather_element");
500 INIT_LIST_HEAD(&command->list);
501 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
503 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
508 * This function is called to delete a pool of command orbs.
510 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
512 struct hpsb_host *host = scsi_id->hi->host;
513 struct list_head *lh, *next;
514 struct sbp2_command_info *command;
517 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
518 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
519 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
520 command = list_entry(lh, struct sbp2_command_info, list);
522 /* Release our generic DMA's */
523 pci_unmap_single(host->pdev, command->command_orb_dma,
524 sizeof(struct sbp2_command_orb),
526 SBP2_DMA_FREE("single command orb DMA");
527 pci_unmap_single(host->pdev, command->sge_dma,
528 sizeof(command->scatter_gather_element),
529 PCI_DMA_BIDIRECTIONAL);
530 SBP2_DMA_FREE("scatter_gather_element");
535 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
540 * This function finds the sbp2_command for a given outstanding command
541 * orb.Only looks at the inuse list.
543 static struct sbp2_command_info *sbp2util_find_command_for_orb(
544 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
546 struct sbp2_command_info *command;
549 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
550 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
551 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
552 if (command->command_orb_dma == orb) {
553 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
558 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
560 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
566 * This function finds the sbp2_command for a given outstanding SCpnt.
567 * Only looks at the inuse list.
568 * Must be called with scsi_id->sbp2_command_orb_lock held.
570 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
571 struct scsi_id_instance_data *scsi_id, void *SCpnt)
573 struct sbp2_command_info *command;
575 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
576 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
577 if (command->Current_SCpnt == SCpnt)
583 * This function allocates a command orb used to send a scsi command.
585 static struct sbp2_command_info *sbp2util_allocate_command_orb(
586 struct scsi_id_instance_data *scsi_id,
587 struct scsi_cmnd *Current_SCpnt,
588 void (*Current_done)(struct scsi_cmnd *))
590 struct list_head *lh;
591 struct sbp2_command_info *command = NULL;
594 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
595 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
596 lh = scsi_id->sbp2_command_orb_completed.next;
598 command = list_entry(lh, struct sbp2_command_info, list);
599 command->Current_done = Current_done;
600 command->Current_SCpnt = Current_SCpnt;
601 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
603 SBP2_ERR("%s: no orbs available", __FUNCTION__);
605 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
610 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
612 struct scsi_id_instance_data *scsi_id =
613 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
614 struct hpsb_host *host;
617 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
621 host = scsi_id->ud->ne->host;
623 if (command->cmd_dma) {
624 if (command->dma_type == CMD_DMA_SINGLE) {
625 pci_unmap_single(host->pdev, command->cmd_dma,
626 command->dma_size, command->dma_dir);
627 SBP2_DMA_FREE("single bulk");
628 } else if (command->dma_type == CMD_DMA_PAGE) {
629 pci_unmap_page(host->pdev, command->cmd_dma,
630 command->dma_size, command->dma_dir);
631 SBP2_DMA_FREE("single page");
632 } /* XXX: Check for CMD_DMA_NONE bug */
633 command->dma_type = CMD_DMA_NONE;
634 command->cmd_dma = 0;
637 if (command->sge_buffer) {
638 pci_unmap_sg(host->pdev, command->sge_buffer,
639 command->dma_size, command->dma_dir);
640 SBP2_DMA_FREE("scatter list");
641 command->sge_buffer = NULL;
646 * This function moves a command to the completed orb list.
647 * Must be called with scsi_id->sbp2_command_orb_lock held.
649 static void sbp2util_mark_command_completed(
650 struct scsi_id_instance_data *scsi_id,
651 struct sbp2_command_info *command)
653 list_del(&command->list);
654 sbp2util_free_command_dma(command);
655 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
659 * Is scsi_id valid? Is the 1394 node still present?
661 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
663 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
666 /*********************************************
667 * IEEE-1394 core driver stack related section
668 *********************************************/
669 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
671 static int sbp2_probe(struct device *dev)
673 struct unit_directory *ud;
674 struct scsi_id_instance_data *scsi_id;
678 ud = container_of(dev, struct unit_directory, device);
680 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
682 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
685 scsi_id = sbp2_alloc_device(ud);
690 sbp2_parse_unit_directory(scsi_id, ud);
692 return sbp2_start_device(scsi_id);
695 static int sbp2_remove(struct device *dev)
697 struct unit_directory *ud;
698 struct scsi_id_instance_data *scsi_id;
699 struct scsi_device *sdev;
703 ud = container_of(dev, struct unit_directory, device);
704 scsi_id = ud->device.driver_data;
708 if (scsi_id->scsi_host) {
709 /* Get rid of enqueued commands if there is no chance to
711 if (!sbp2util_node_is_available(scsi_id))
712 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
713 /* scsi_remove_device() will trigger shutdown functions of SCSI
714 * highlevel drivers which would deadlock if blocked. */
715 scsi_unblock_requests(scsi_id->scsi_host);
717 sdev = scsi_id->sdev;
719 scsi_id->sdev = NULL;
720 scsi_remove_device(sdev);
723 sbp2_logout_device(scsi_id);
724 sbp2_remove_device(scsi_id);
729 static int sbp2_update(struct unit_directory *ud)
731 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
735 if (sbp2_reconnect_device(scsi_id)) {
738 * Ok, reconnect has failed. Perhaps we didn't
739 * reconnect fast enough. Try doing a regular login, but
740 * first do a logout just in case of any weirdness.
742 sbp2_logout_device(scsi_id);
744 if (sbp2_login_device(scsi_id)) {
745 /* Login failed too, just fail, and the backend
746 * will call our sbp2_remove for us */
747 SBP2_ERR("Failed to reconnect to sbp2 device!");
752 /* Set max retries to something large on the device. */
753 sbp2_set_busy_timeout(scsi_id);
755 /* Do a SBP-2 fetch agent reset. */
756 sbp2_agent_reset(scsi_id, 1);
758 /* Get the max speed and packet size that we can use. */
759 sbp2_max_speed_and_size(scsi_id);
761 /* Complete any pending commands with busy (so they get
762 * retried) and remove them from our queue
764 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
766 /* Make sure we unblock requests (since this is likely after a bus
768 scsi_unblock_requests(scsi_id->scsi_host);
773 /* This functions is called by the sbp2_probe, for each new device. We now
774 * allocate one scsi host for each scsi_id (unit directory). */
775 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
777 struct sbp2scsi_host_info *hi;
778 struct Scsi_Host *scsi_host = NULL;
779 struct scsi_id_instance_data *scsi_id = NULL;
783 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
785 SBP2_ERR("failed to create scsi_id");
789 scsi_id->ne = ud->ne;
791 scsi_id->speed_code = IEEE1394_SPEED_100;
792 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
793 scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
794 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
795 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
796 INIT_LIST_HEAD(&scsi_id->scsi_list);
797 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
799 ud->device.driver_data = scsi_id;
801 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
803 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
805 SBP2_ERR("failed to allocate hostinfo");
808 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
809 hi->host = ud->ne->host;
810 INIT_LIST_HEAD(&hi->scsi_ids);
812 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
813 /* Handle data movement if physical dma is not
814 * enabled or not supported on host controller */
815 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
817 0x0ULL, 0xfffffffcULL)) {
818 SBP2_ERR("failed to register lower 4GB address range");
824 /* Prevent unloading of the 1394 host */
825 if (!try_module_get(hi->host->driver->owner)) {
826 SBP2_ERR("failed to get a reference on 1394 host driver");
832 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
834 /* Register the status FIFO address range. We could use the same FIFO
835 * for targets at different nodes. However we need different FIFOs per
836 * target in order to support multi-unit devices.
837 * The FIFO is located out of the local host controller's physical range
838 * but, if possible, within the posted write area. Status writes will
839 * then be performed as unified transactions. This slightly reduces
840 * bandwidth usage, and some Prolific based devices seem to require it.
842 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
843 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
844 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
845 ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
846 if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
847 SBP2_ERR("failed to allocate status FIFO address range");
851 /* Register our host with the SCSI stack. */
852 scsi_host = scsi_host_alloc(&scsi_driver_template,
853 sizeof(unsigned long));
855 SBP2_ERR("failed to register scsi host");
859 scsi_host->hostdata[0] = (unsigned long)scsi_id;
861 if (!scsi_add_host(scsi_host, &ud->device)) {
862 scsi_id->scsi_host = scsi_host;
866 SBP2_ERR("failed to add scsi host");
867 scsi_host_put(scsi_host);
870 sbp2_remove_device(scsi_id);
874 static void sbp2_host_reset(struct hpsb_host *host)
876 struct sbp2scsi_host_info *hi;
877 struct scsi_id_instance_data *scsi_id;
879 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
882 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
883 scsi_block_requests(scsi_id->scsi_host);
888 * This function is where we first pull the node unique ids, and then
889 * allocate memory and register a SBP-2 device.
891 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
893 struct sbp2scsi_host_info *hi = scsi_id->hi;
899 scsi_id->login_response =
900 pci_alloc_consistent(hi->host->pdev,
901 sizeof(struct sbp2_login_response),
902 &scsi_id->login_response_dma);
903 if (!scsi_id->login_response)
905 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
907 /* Query logins ORB DMA */
908 scsi_id->query_logins_orb =
909 pci_alloc_consistent(hi->host->pdev,
910 sizeof(struct sbp2_query_logins_orb),
911 &scsi_id->query_logins_orb_dma);
912 if (!scsi_id->query_logins_orb)
914 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
916 /* Query logins response DMA */
917 scsi_id->query_logins_response =
918 pci_alloc_consistent(hi->host->pdev,
919 sizeof(struct sbp2_query_logins_response),
920 &scsi_id->query_logins_response_dma);
921 if (!scsi_id->query_logins_response)
923 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
925 /* Reconnect ORB DMA */
926 scsi_id->reconnect_orb =
927 pci_alloc_consistent(hi->host->pdev,
928 sizeof(struct sbp2_reconnect_orb),
929 &scsi_id->reconnect_orb_dma);
930 if (!scsi_id->reconnect_orb)
932 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
935 scsi_id->logout_orb =
936 pci_alloc_consistent(hi->host->pdev,
937 sizeof(struct sbp2_logout_orb),
938 &scsi_id->logout_orb_dma);
939 if (!scsi_id->logout_orb)
941 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
945 pci_alloc_consistent(hi->host->pdev,
946 sizeof(struct sbp2_login_orb),
947 &scsi_id->login_orb_dma);
948 if (!scsi_id->login_orb)
950 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
952 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
955 * Create our command orb pool
957 if (sbp2util_create_command_orb_pool(scsi_id)) {
958 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
959 sbp2_remove_device(scsi_id);
963 /* Schedule a timeout here. The reason is that we may be so close
964 * to a bus reset, that the device is not available for logins.
965 * This can happen when the bus reset is caused by the host
966 * connected to the sbp2 device being removed. That host would
967 * have a certain amount of time to relogin before the sbp2 device
968 * allows someone else to login instead. One second makes sense. */
969 msleep_interruptible(1000);
970 if (signal_pending(current)) {
971 sbp2_remove_device(scsi_id);
976 * Login to the sbp-2 device
978 if (sbp2_login_device(scsi_id)) {
979 /* Login failed, just remove the device. */
980 sbp2_remove_device(scsi_id);
985 * Set max retries to something large on the device
987 sbp2_set_busy_timeout(scsi_id);
990 * Do a SBP-2 fetch agent reset
992 sbp2_agent_reset(scsi_id, 1);
995 * Get the max speed and packet size that we can use
997 sbp2_max_speed_and_size(scsi_id);
999 /* Add this device to the scsi layer now */
1000 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1002 SBP2_ERR("scsi_add_device failed");
1003 sbp2_logout_device(scsi_id);
1004 sbp2_remove_device(scsi_id);
1011 SBP2_ERR("Could not allocate memory for scsi_id");
1012 sbp2_remove_device(scsi_id);
1017 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1019 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1021 struct sbp2scsi_host_info *hi;
1030 /* This will remove our scsi device aswell */
1031 if (scsi_id->scsi_host) {
1032 scsi_remove_host(scsi_id->scsi_host);
1033 scsi_host_put(scsi_id->scsi_host);
1036 sbp2util_remove_command_orb_pool(scsi_id);
1038 list_del(&scsi_id->scsi_list);
1040 if (scsi_id->login_response) {
1041 pci_free_consistent(hi->host->pdev,
1042 sizeof(struct sbp2_login_response),
1043 scsi_id->login_response,
1044 scsi_id->login_response_dma);
1045 SBP2_DMA_FREE("single login FIFO");
1048 if (scsi_id->login_orb) {
1049 pci_free_consistent(hi->host->pdev,
1050 sizeof(struct sbp2_login_orb),
1052 scsi_id->login_orb_dma);
1053 SBP2_DMA_FREE("single login ORB");
1056 if (scsi_id->reconnect_orb) {
1057 pci_free_consistent(hi->host->pdev,
1058 sizeof(struct sbp2_reconnect_orb),
1059 scsi_id->reconnect_orb,
1060 scsi_id->reconnect_orb_dma);
1061 SBP2_DMA_FREE("single reconnect orb");
1064 if (scsi_id->logout_orb) {
1065 pci_free_consistent(hi->host->pdev,
1066 sizeof(struct sbp2_logout_orb),
1067 scsi_id->logout_orb,
1068 scsi_id->logout_orb_dma);
1069 SBP2_DMA_FREE("single logout orb");
1072 if (scsi_id->query_logins_orb) {
1073 pci_free_consistent(hi->host->pdev,
1074 sizeof(struct sbp2_query_logins_orb),
1075 scsi_id->query_logins_orb,
1076 scsi_id->query_logins_orb_dma);
1077 SBP2_DMA_FREE("single query logins orb");
1080 if (scsi_id->query_logins_response) {
1081 pci_free_consistent(hi->host->pdev,
1082 sizeof(struct sbp2_query_logins_response),
1083 scsi_id->query_logins_response,
1084 scsi_id->query_logins_response_dma);
1085 SBP2_DMA_FREE("single query logins data");
1088 if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
1089 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1090 scsi_id->status_fifo_addr);
1092 scsi_id->ud->device.driver_data = NULL;
1095 module_put(hi->host->driver->owner);
1097 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1102 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1104 * This function deals with physical dma write requests (for adapters that do not support
1105 * physical dma in hardware). Mostly just here for debugging...
1107 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1108 int destid, quadlet_t *data, u64 addr,
1109 size_t length, u16 flags)
1113 * Manually put the data in the right place.
1115 memcpy(bus_to_virt((u32) addr), data, length);
1116 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1118 return RCODE_COMPLETE;
1122 * This function deals with physical dma read requests (for adapters that do not support
1123 * physical dma in hardware). Mostly just here for debugging...
1125 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1126 quadlet_t *data, u64 addr, size_t length,
1131 * Grab data from memory and send a read response.
1133 memcpy(data, bus_to_virt((u32) addr), length);
1134 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1136 return RCODE_COMPLETE;
1140 /**************************************
1141 * SBP-2 protocol related section
1142 **************************************/
1145 * This function queries the device for the maximum concurrent logins it
1148 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1150 struct sbp2scsi_host_info *hi = scsi_id->hi;
1157 scsi_id->query_logins_orb->reserved1 = 0x0;
1158 scsi_id->query_logins_orb->reserved2 = 0x0;
1160 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1161 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1163 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1164 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1165 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1167 scsi_id->query_logins_orb->reserved_resp_length =
1168 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1170 scsi_id->query_logins_orb->status_fifo_hi =
1171 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1172 scsi_id->query_logins_orb->status_fifo_lo =
1173 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1175 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1177 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1178 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1180 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1182 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1183 data[1] = scsi_id->query_logins_orb_dma;
1184 sbp2util_cpu_to_be32_buffer(data, 8);
1186 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1188 if (sbp2util_access_timeout(scsi_id, 2*HZ)) {
1189 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1193 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1194 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1198 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1199 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1203 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1205 SBP2_DEBUG("length_max_logins = %x",
1206 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1208 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1209 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1211 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1212 SBP2_INFO("Number of active logins: %d", active_logins);
1214 if (active_logins >= max_logins) {
1222 * This function is called in order to login to a particular SBP-2 device,
1223 * after a bus reset.
1225 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1227 struct sbp2scsi_host_info *hi = scsi_id->hi;
1232 if (!scsi_id->login_orb) {
1233 SBP2_DEBUG("%s: login_orb not alloc'd!", __FUNCTION__);
1237 if (!exclusive_login) {
1238 if (sbp2_query_logins(scsi_id)) {
1239 SBP2_INFO("Device does not support any more concurrent logins");
1244 /* Set-up login ORB, assume no password */
1245 scsi_id->login_orb->password_hi = 0;
1246 scsi_id->login_orb->password_lo = 0;
1248 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1249 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1251 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1252 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1253 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1254 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1255 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1257 scsi_id->login_orb->passwd_resp_lengths =
1258 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1260 scsi_id->login_orb->status_fifo_hi =
1261 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1262 scsi_id->login_orb->status_fifo_lo =
1263 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1265 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1267 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1268 "sbp2 login orb", scsi_id->login_orb_dma);
1270 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1272 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1273 data[1] = scsi_id->login_orb_dma;
1274 sbp2util_cpu_to_be32_buffer(data, 8);
1276 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1279 * Wait for login status (up to 20 seconds)...
1281 if (sbp2util_access_timeout(scsi_id, 20*HZ)) {
1282 SBP2_ERR("Error logging into SBP-2 device - timed out");
1287 * Sanity. Make sure status returned matches login orb.
1289 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1290 SBP2_ERR("Error logging into SBP-2 device - timed out");
1294 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1295 SBP2_ERR("Error logging into SBP-2 device - failed");
1300 * Byte swap the login response, for use when reconnecting or
1303 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1306 * Grab our command block agent address from the login response.
1308 SBP2_DEBUG("command_block_agent_hi = %x",
1309 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1310 SBP2_DEBUG("command_block_agent_lo = %x",
1311 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1313 scsi_id->sbp2_command_block_agent_addr =
1314 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1315 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1316 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1318 SBP2_INFO("Logged into SBP-2 device");
1323 * This function is called in order to logout from a particular SBP-2
1324 * device, usually called during driver unload.
1326 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1328 struct sbp2scsi_host_info *hi = scsi_id->hi;
1337 scsi_id->logout_orb->reserved1 = 0x0;
1338 scsi_id->logout_orb->reserved2 = 0x0;
1339 scsi_id->logout_orb->reserved3 = 0x0;
1340 scsi_id->logout_orb->reserved4 = 0x0;
1342 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1343 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1345 /* Notify us when complete */
1346 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1348 scsi_id->logout_orb->reserved5 = 0x0;
1349 scsi_id->logout_orb->status_fifo_hi =
1350 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1351 scsi_id->logout_orb->status_fifo_lo =
1352 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1355 * Byte swap ORB if necessary
1357 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1359 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1360 "sbp2 logout orb", scsi_id->logout_orb_dma);
1363 * Ok, let's write to the target's management agent register
1365 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1366 data[1] = scsi_id->logout_orb_dma;
1367 sbp2util_cpu_to_be32_buffer(data, 8);
1369 error = hpsb_node_write(scsi_id->ne,
1370 scsi_id->sbp2_management_agent_addr, data, 8);
1374 /* Wait for device to logout...1 second. */
1375 if (sbp2util_access_timeout(scsi_id, HZ))
1378 SBP2_INFO("Logged out of SBP-2 device");
1383 * This function is called in order to reconnect to a particular SBP-2
1384 * device, after a bus reset.
1386 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1388 struct sbp2scsi_host_info *hi = scsi_id->hi;
1395 * Set-up reconnect ORB
1397 scsi_id->reconnect_orb->reserved1 = 0x0;
1398 scsi_id->reconnect_orb->reserved2 = 0x0;
1399 scsi_id->reconnect_orb->reserved3 = 0x0;
1400 scsi_id->reconnect_orb->reserved4 = 0x0;
1402 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1403 scsi_id->reconnect_orb->login_ID_misc |=
1404 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1406 /* Notify us when complete */
1407 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1409 scsi_id->reconnect_orb->reserved5 = 0x0;
1410 scsi_id->reconnect_orb->status_fifo_hi =
1411 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1412 scsi_id->reconnect_orb->status_fifo_lo =
1413 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1416 * Byte swap ORB if necessary
1418 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1420 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1421 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1423 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1424 data[1] = scsi_id->reconnect_orb_dma;
1425 sbp2util_cpu_to_be32_buffer(data, 8);
1427 error = hpsb_node_write(scsi_id->ne,
1428 scsi_id->sbp2_management_agent_addr, data, 8);
1433 * Wait for reconnect status (up to 1 second)...
1435 if (sbp2util_access_timeout(scsi_id, HZ)) {
1436 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1441 * Sanity. Make sure status returned matches reconnect orb.
1443 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1444 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1448 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1449 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1453 HPSB_DEBUG("Reconnected to SBP-2 device");
1458 * This function is called in order to set the busy timeout (number of
1459 * retries to attempt) on the sbp2 device.
1461 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1467 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1468 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1469 SBP2_ERR("%s error", __FUNCTION__);
1474 * This function is called to parse sbp2 device's config rom unit
1475 * directory. Used to determine things like sbp2 management agent offset,
1476 * and command set used (SCSI or RBC).
1478 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1479 struct unit_directory *ud)
1481 struct csr1212_keyval *kv;
1482 struct csr1212_dentry *dentry;
1483 u64 management_agent_addr;
1484 u32 command_set_spec_id, command_set, unit_characteristics,
1486 unsigned workarounds;
1491 management_agent_addr = 0x0;
1492 command_set_spec_id = 0x0;
1494 unit_characteristics = 0x0;
1495 firmware_revision = 0x0;
1497 /* Handle different fields in the unit directory, based on keys */
1498 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1499 switch (kv->key.id) {
1500 case CSR1212_KV_ID_DEPENDENT_INFO:
1501 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1502 /* Save off the management agent address */
1503 management_agent_addr =
1504 CSR1212_REGISTER_SPACE_BASE +
1505 (kv->value.csr_offset << 2);
1507 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1508 (unsigned int)management_agent_addr);
1509 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1511 ORB_SET_LUN(kv->value.immediate);
1515 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1516 /* Command spec organization */
1517 command_set_spec_id = kv->value.immediate;
1518 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1519 (unsigned int)command_set_spec_id);
1522 case SBP2_COMMAND_SET_KEY:
1523 /* Command set used by sbp2 device */
1524 command_set = kv->value.immediate;
1525 SBP2_DEBUG("sbp2_command_set = %x",
1526 (unsigned int)command_set);
1529 case SBP2_UNIT_CHARACTERISTICS_KEY:
1531 * Unit characterisitcs (orb related stuff
1532 * that I'm not yet paying attention to)
1534 unit_characteristics = kv->value.immediate;
1535 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1536 (unsigned int)unit_characteristics);
1539 case SBP2_FIRMWARE_REVISION_KEY:
1540 /* Firmware revision */
1541 firmware_revision = kv->value.immediate;
1542 SBP2_DEBUG("sbp2_firmware_revision = %x",
1543 (unsigned int)firmware_revision);
1551 workarounds = sbp2_default_workarounds;
1553 if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1554 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1555 if (sbp2_workarounds_table[i].firmware_revision &&
1556 sbp2_workarounds_table[i].firmware_revision !=
1557 (firmware_revision & 0xffff00))
1559 if (sbp2_workarounds_table[i].model_id &&
1560 sbp2_workarounds_table[i].model_id != ud->model_id)
1562 workarounds |= sbp2_workarounds_table[i].workarounds;
1567 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1568 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1569 " model_id 0x%06x)",
1570 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1571 workarounds, firmware_revision,
1572 ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1575 /* We would need one SCSI host template for each target to adjust
1576 * max_sectors on the fly, therefore warn only. */
1577 if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1578 (max_sectors * 512) > (128 * 1024))
1579 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1580 "max transfer size. WARNING: Current max_sectors "
1581 "setting is larger than 128KB (%d sectors)",
1582 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1585 /* If this is a logical unit directory entry, process the parent
1586 * to get the values. */
1587 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1588 struct unit_directory *parent_ud =
1589 container_of(ud->device.parent, struct unit_directory, device);
1590 sbp2_parse_unit_directory(scsi_id, parent_ud);
1592 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1593 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1594 scsi_id->sbp2_command_set = command_set;
1595 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1596 scsi_id->sbp2_firmware_revision = firmware_revision;
1597 scsi_id->workarounds = workarounds;
1598 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1599 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1603 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1606 * This function is called in order to determine the max speed and packet
1607 * size we can use in our ORBs. Note, that we (the driver and host) only
1608 * initiate the transaction. The SBP-2 device actually transfers the data
1609 * (by reading from the DMA area we tell it). This means that the SBP-2
1610 * device decides the actual maximum data it can transfer. We just tell it
1611 * the speed that it needs to use, and the max_rec the host supports, and
1612 * it takes care of the rest.
1614 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1616 struct sbp2scsi_host_info *hi = scsi_id->hi;
1621 scsi_id->speed_code =
1622 hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1624 /* Bump down our speed if the user requested it */
1625 if (scsi_id->speed_code > max_speed) {
1626 scsi_id->speed_code = max_speed;
1627 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1628 hpsb_speedto_str[scsi_id->speed_code]);
1631 /* Payload size is the lesser of what our speed supports and what
1632 * our host supports. */
1633 payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1634 (u8) (hi->host->csr.max_rec - 1));
1636 /* If physical DMA is off, work around limitation in ohci1394:
1637 * packet size must not exceed PAGE_SIZE */
1638 if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1639 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1643 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1644 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1645 hpsb_speedto_str[scsi_id->speed_code],
1646 SBP2_PAYLOAD_TO_BYTES(payload));
1648 scsi_id->max_payload_size = payload;
1653 * This function is called in order to perform a SBP-2 agent reset.
1655 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1660 unsigned long flags;
1664 data = ntohl(SBP2_AGENT_RESET_DATA);
1665 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1668 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1670 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1673 SBP2_ERR("hpsb_node_write failed.\n");
1678 * Need to make sure orb pointer is written on next command
1680 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1681 scsi_id->last_orb = NULL;
1682 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1687 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1688 struct sbp2scsi_host_info *hi,
1689 struct sbp2_command_info *command,
1690 unsigned int scsi_use_sg,
1691 struct scatterlist *sgpnt,
1693 enum dma_data_direction dma_dir)
1695 command->dma_dir = dma_dir;
1696 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1697 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1699 /* Special case if only one element (and less than 64KB in size) */
1700 if ((scsi_use_sg == 1) &&
1701 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1703 SBP2_DEBUG("Only one s/g element");
1704 command->dma_size = sgpnt[0].length;
1705 command->dma_type = CMD_DMA_PAGE;
1706 command->cmd_dma = pci_map_page(hi->host->pdev,
1711 SBP2_DMA_ALLOC("single page scatter element");
1713 orb->data_descriptor_lo = command->cmd_dma;
1714 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1717 struct sbp2_unrestricted_page_table *sg_element =
1718 &command->scatter_gather_element[0];
1719 u32 sg_count, sg_len;
1721 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1724 SBP2_DMA_ALLOC("scatter list");
1726 command->dma_size = scsi_use_sg;
1727 command->sge_buffer = sgpnt;
1729 /* use page tables (s/g) */
1730 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1731 orb->data_descriptor_lo = command->sge_dma;
1734 * Loop through and fill out our sbp-2 page tables
1735 * (and split up anything too large)
1737 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1738 sg_len = sg_dma_len(sgpnt);
1739 sg_addr = sg_dma_address(sgpnt);
1741 sg_element[sg_count].segment_base_lo = sg_addr;
1742 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1743 sg_element[sg_count].length_segment_base_hi =
1744 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1745 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1746 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1748 sg_element[sg_count].length_segment_base_hi =
1749 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1756 /* Number of page table (s/g) elements */
1757 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1759 sbp2util_packet_dump(sg_element,
1760 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1761 "sbp2 s/g list", command->sge_dma);
1763 /* Byte swap page tables if necessary */
1764 sbp2util_cpu_to_be32_buffer(sg_element,
1765 (sizeof(struct sbp2_unrestricted_page_table)) *
1770 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1771 struct sbp2scsi_host_info *hi,
1772 struct sbp2_command_info *command,
1773 struct scatterlist *sgpnt,
1775 unsigned int scsi_request_bufflen,
1776 void *scsi_request_buffer,
1777 enum dma_data_direction dma_dir)
1779 command->dma_dir = dma_dir;
1780 command->dma_size = scsi_request_bufflen;
1781 command->dma_type = CMD_DMA_SINGLE;
1782 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1783 command->dma_size, command->dma_dir);
1784 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1785 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1787 SBP2_DMA_ALLOC("single bulk");
1790 * Handle case where we get a command w/o s/g enabled (but
1791 * check for transfers larger than 64K)
1793 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1795 orb->data_descriptor_lo = command->cmd_dma;
1796 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1799 struct sbp2_unrestricted_page_table *sg_element =
1800 &command->scatter_gather_element[0];
1801 u32 sg_count, sg_len;
1805 * Need to turn this into page tables, since the
1806 * buffer is too large.
1808 orb->data_descriptor_lo = command->sge_dma;
1810 /* Use page tables (s/g) */
1811 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1814 * fill out our sbp-2 page tables (and split up
1818 sg_len = scsi_request_bufflen;
1819 sg_addr = command->cmd_dma;
1821 sg_element[sg_count].segment_base_lo = sg_addr;
1822 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1823 sg_element[sg_count].length_segment_base_hi =
1824 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1825 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1826 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1828 sg_element[sg_count].length_segment_base_hi =
1829 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1835 /* Number of page table (s/g) elements */
1836 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1838 sbp2util_packet_dump(sg_element,
1839 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1840 "sbp2 s/g list", command->sge_dma);
1842 /* Byte swap page tables if necessary */
1843 sbp2util_cpu_to_be32_buffer(sg_element,
1844 (sizeof(struct sbp2_unrestricted_page_table)) *
1850 * This function is called to create the actual command orb and s/g list
1851 * out of the scsi command itself.
1853 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1854 struct sbp2_command_info *command,
1856 unsigned int scsi_use_sg,
1857 unsigned int scsi_request_bufflen,
1858 void *scsi_request_buffer,
1859 enum dma_data_direction dma_dir)
1861 struct sbp2scsi_host_info *hi = scsi_id->hi;
1862 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1863 struct sbp2_command_orb *command_orb = &command->command_orb;
1867 * Set-up our command ORB..
1869 * NOTE: We're doing unrestricted page tables (s/g), as this is
1870 * best performance (at least with the devices I have). This means
1871 * that data_size becomes the number of s/g elements, and
1872 * page_size should be zero (for unrestricted).
1874 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1875 command_orb->next_ORB_lo = 0x0;
1876 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1877 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1878 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1880 if (dma_dir == DMA_NONE)
1881 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1882 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1883 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1884 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1885 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1887 SBP2_WARN("Falling back to DMA_NONE");
1888 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1891 /* Set-up our pagetable stuff */
1892 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1893 SBP2_DEBUG("No data transfer");
1894 command_orb->data_descriptor_hi = 0x0;
1895 command_orb->data_descriptor_lo = 0x0;
1896 command_orb->misc |= ORB_SET_DIRECTION(1);
1897 } else if (scsi_use_sg) {
1898 SBP2_DEBUG("Use scatter/gather");
1899 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1900 sgpnt, orb_direction, dma_dir);
1902 SBP2_DEBUG("No scatter/gather");
1903 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1904 orb_direction, scsi_request_bufflen,
1905 scsi_request_buffer, dma_dir);
1908 /* Byte swap command ORB if necessary */
1909 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1911 /* Put our scsi command in the command ORB */
1912 memset(command_orb->cdb, 0, 12);
1913 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1917 * This function is called in order to begin a regular SBP-2 command.
1919 static void sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1920 struct sbp2_command_info *command)
1922 struct sbp2scsi_host_info *hi = scsi_id->hi;
1923 struct sbp2_command_orb *command_orb = &command->command_orb;
1924 struct sbp2_command_orb *last_orb;
1925 dma_addr_t last_orb_dma;
1926 u64 addr = scsi_id->sbp2_command_block_agent_addr;
1929 unsigned long flags;
1931 outstanding_orb_incr;
1932 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1933 command_orb, global_outstanding_command_orbs);
1935 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1936 sizeof(struct sbp2_command_orb),
1938 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1939 sizeof(command->scatter_gather_element),
1940 PCI_DMA_BIDIRECTIONAL);
1942 * Check to see if there are any previous orbs to use
1944 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1945 last_orb = scsi_id->last_orb;
1946 last_orb_dma = scsi_id->last_orb_dma;
1949 * last_orb == NULL means: We know that the target's fetch agent
1950 * is not active right now.
1952 addr += SBP2_ORB_POINTER_OFFSET;
1953 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1954 data[1] = command->command_orb_dma;
1955 sbp2util_cpu_to_be32_buffer(data, 8);
1959 * last_orb != NULL means: We know that the target's fetch agent
1960 * is (very probably) not dead or in reset state right now.
1961 * We have an ORB already sent that we can append a new one to.
1962 * The target's fetch agent may or may not have read this
1965 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
1966 sizeof(struct sbp2_command_orb),
1968 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
1970 /* Tells hardware that this pointer is valid */
1971 last_orb->next_ORB_hi = 0;
1972 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
1973 sizeof(struct sbp2_command_orb),
1975 addr += SBP2_DOORBELL_OFFSET;
1979 scsi_id->last_orb = command_orb;
1980 scsi_id->last_orb_dma = command->command_orb_dma;
1981 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1983 SBP2_ORB_DEBUG("write to %s register, command orb %p",
1984 last_orb ? "DOORBELL" : "ORB_POINTER", command_orb);
1985 if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length))
1986 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1987 /* We rely on SCSI EH to deal with _node_write_ failures. */
1991 * This function is called in order to begin a regular SBP-2 command.
1993 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
1994 struct scsi_cmnd *SCpnt,
1995 void (*done)(struct scsi_cmnd *))
1997 unchar *cmd = (unchar *) SCpnt->cmnd;
1998 unsigned int request_bufflen = SCpnt->request_bufflen;
1999 struct sbp2_command_info *command;
2002 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2003 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2006 * Allocate a command orb and s/g structure
2008 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2014 * Now actually fill in the comamnd orb and sbp2 s/g list
2016 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2017 request_bufflen, SCpnt->request_buffer,
2018 SCpnt->sc_data_direction);
2020 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2021 "sbp2 command orb", command->command_orb_dma);
2024 * Link up the orb, and ring the doorbell if needed
2026 sbp2_link_orb_command(scsi_id, command);
2032 * Translates SBP-2 status into SCSI sense data for check conditions
2034 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2039 * Ok, it's pretty ugly... ;-)
2041 sense_data[0] = 0x70;
2042 sense_data[1] = 0x0;
2043 sense_data[2] = sbp2_status[9];
2044 sense_data[3] = sbp2_status[12];
2045 sense_data[4] = sbp2_status[13];
2046 sense_data[5] = sbp2_status[14];
2047 sense_data[6] = sbp2_status[15];
2049 sense_data[8] = sbp2_status[16];
2050 sense_data[9] = sbp2_status[17];
2051 sense_data[10] = sbp2_status[18];
2052 sense_data[11] = sbp2_status[19];
2053 sense_data[12] = sbp2_status[10];
2054 sense_data[13] = sbp2_status[11];
2055 sense_data[14] = sbp2_status[20];
2056 sense_data[15] = sbp2_status[21];
2058 return sbp2_status[8] & 0x3f; /* return scsi status */
2062 * This function deals with status writes from the SBP-2 device
2064 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
2065 int destid, quadlet_t *data, u64 addr,
2066 size_t length, u16 fl)
2068 struct sbp2scsi_host_info *hi;
2069 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2070 struct scsi_cmnd *SCpnt = NULL;
2071 struct sbp2_status_block *sb;
2072 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2073 struct sbp2_command_info *command;
2074 unsigned long flags;
2078 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2080 if (unlikely(length < 8 || length > sizeof(struct sbp2_status_block))) {
2081 SBP2_ERR("Wrong size of status block");
2082 return RCODE_ADDRESS_ERROR;
2084 if (unlikely(!host)) {
2085 SBP2_ERR("host is NULL - this is bad!");
2086 return RCODE_ADDRESS_ERROR;
2088 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2089 if (unlikely(!hi)) {
2090 SBP2_ERR("host info is NULL - this is bad!");
2091 return RCODE_ADDRESS_ERROR;
2094 * Find our scsi_id structure by looking at the status fifo address
2095 * written to by the sbp2 device.
2097 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2098 if (scsi_id_tmp->ne->nodeid == nodeid &&
2099 scsi_id_tmp->status_fifo_addr == addr) {
2100 scsi_id = scsi_id_tmp;
2104 if (unlikely(!scsi_id)) {
2105 SBP2_ERR("scsi_id is NULL - device is gone?");
2106 return RCODE_ADDRESS_ERROR;
2110 * Put response into scsi_id status fifo buffer. The first two bytes
2111 * come in big endian bit order. Often the target writes only a
2112 * truncated status block, minimally the first two quadlets. The rest
2113 * is implied to be zeros.
2115 sb = &scsi_id->status_block;
2116 memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
2117 memcpy(sb, data, length);
2118 sbp2util_be32_to_cpu_buffer(sb, 8);
2121 * Ignore unsolicited status. Handle command ORB status.
2123 if (unlikely(STATUS_GET_SRC(sb->ORB_offset_hi_misc) == 2))
2126 command = sbp2util_find_command_for_orb(scsi_id,
2129 SBP2_DEBUG("Found status for command ORB");
2130 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2131 sizeof(struct sbp2_command_orb),
2133 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2134 sizeof(command->scatter_gather_element),
2135 PCI_DMA_BIDIRECTIONAL);
2137 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2138 outstanding_orb_decr;
2141 * Matched status with command, now grab scsi command pointers
2145 * FIXME: If the src field in the status is 1, the ORB DMA must
2146 * not be reused until status for a subsequent ORB is received.
2148 SCpnt = command->Current_SCpnt;
2149 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2150 sbp2util_mark_command_completed(scsi_id, command);
2151 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2154 if (STATUS_TEST_RS(sb->ORB_offset_hi_misc))
2156 SBP2_SCSI_STATUS_COMMAND_TERMINATED;
2158 * See if the target stored any scsi status information.
2160 if (STATUS_GET_LEN(sb->ORB_offset_hi_misc) > 1) {
2161 SBP2_DEBUG("CHECK CONDITION");
2162 scsi_status = sbp2_status_to_sense_data(
2163 (unchar *)sb, SCpnt->sense_buffer);
2167 * Check to see if the dead bit is set. If so, we'll
2168 * have to initiate a fetch agent reset.
2170 if (STATUS_TEST_D(sb->ORB_offset_hi_misc)) {
2171 SBP2_DEBUG("Dead bit set - "
2172 "initiating fetch agent reset");
2173 sbp2_agent_reset(scsi_id, 0);
2176 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2180 * Check here to see if there are no commands in-use. If there
2181 * are none, we know that the fetch agent left the active state
2182 * _and_ that we did not reactivate it yet. Therefore clear
2183 * last_orb so that next time we write directly to the
2184 * ORB_POINTER register. That way the fetch agent does not need
2185 * to refetch the next_ORB.
2187 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2188 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
2189 scsi_id->last_orb = NULL;
2190 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2194 * It's probably a login/logout/reconnect status.
2196 if ((sb->ORB_offset_lo == scsi_id->reconnect_orb_dma) ||
2197 (sb->ORB_offset_lo == scsi_id->login_orb_dma) ||
2198 (sb->ORB_offset_lo == scsi_id->query_logins_orb_dma) ||
2199 (sb->ORB_offset_lo == scsi_id->logout_orb_dma)) {
2200 scsi_id->access_complete = 1;
2201 wake_up_interruptible(&access_wq);
2206 SBP2_DEBUG("Completing SCSI command");
2207 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2208 command->Current_done);
2209 SBP2_ORB_DEBUG("command orb completed");
2212 return RCODE_COMPLETE;
2215 /**************************************
2216 * SCSI interface related section
2217 **************************************/
2220 * This routine is the main request entry routine for doing I/O. It is
2221 * called from the scsi stack directly.
2223 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2224 void (*done)(struct scsi_cmnd *))
2226 struct scsi_id_instance_data *scsi_id =
2227 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2228 struct sbp2scsi_host_info *hi;
2229 int result = DID_NO_CONNECT << 16;
2232 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2233 scsi_print_command(SCpnt);
2236 if (!sbp2util_node_is_available(scsi_id))
2242 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2247 * Until we handle multiple luns, just return selection time-out
2248 * to any IO directed at non-zero LUNs
2250 if (SCpnt->device->lun)
2254 * Check for request sense command, and handle it here
2255 * (autorequest sense)
2257 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2258 SBP2_DEBUG("REQUEST_SENSE");
2259 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2260 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2261 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2266 * Check to see if we are in the middle of a bus reset.
2268 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2269 SBP2_ERR("Bus reset in progress - rejecting command");
2270 result = DID_BUS_BUSY << 16;
2275 * Bidirectional commands are not yet implemented,
2276 * and unknown transfer direction not handled.
2278 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2279 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2280 result = DID_ERROR << 16;
2285 * Try and send our SCSI command
2287 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2288 SBP2_ERR("Error sending SCSI command");
2289 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2295 SCpnt->result = result;
2301 * This function is called in order to complete all outstanding SBP-2
2302 * commands (in case of resets, etc.).
2304 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2307 struct sbp2scsi_host_info *hi = scsi_id->hi;
2308 struct list_head *lh;
2309 struct sbp2_command_info *command;
2310 unsigned long flags;
2314 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2315 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2316 SBP2_DEBUG("Found pending command to complete");
2317 lh = scsi_id->sbp2_command_orb_inuse.next;
2318 command = list_entry(lh, struct sbp2_command_info, list);
2319 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2320 sizeof(struct sbp2_command_orb),
2322 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2323 sizeof(command->scatter_gather_element),
2324 PCI_DMA_BIDIRECTIONAL);
2325 sbp2util_mark_command_completed(scsi_id, command);
2326 if (command->Current_SCpnt) {
2327 command->Current_SCpnt->result = status << 16;
2328 command->Current_done(command->Current_SCpnt);
2331 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2337 * This function is called in order to complete a regular SBP-2 command.
2339 * This can be called in interrupt context.
2341 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2342 u32 scsi_status, struct scsi_cmnd *SCpnt,
2343 void (*done)(struct scsi_cmnd *))
2351 SBP2_ERR("SCpnt is NULL");
2356 * If a bus reset is in progress and there was an error, don't
2357 * complete the command, just let it get retried at the end of the
2360 if (!hpsb_node_entry_valid(scsi_id->ne)
2361 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2362 SBP2_ERR("Bus reset in progress - retry command later");
2367 * Switch on scsi status
2369 switch (scsi_status) {
2370 case SBP2_SCSI_STATUS_GOOD:
2371 SCpnt->result = DID_OK << 16;
2374 case SBP2_SCSI_STATUS_BUSY:
2375 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2376 SCpnt->result = DID_BUS_BUSY << 16;
2379 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2380 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2381 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2382 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2383 scsi_print_command(SCpnt);
2384 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
2388 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2389 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2390 SCpnt->result = DID_NO_CONNECT << 16;
2391 scsi_print_command(SCpnt);
2394 case SBP2_SCSI_STATUS_CONDITION_MET:
2395 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2396 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2397 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2398 SCpnt->result = DID_ERROR << 16;
2399 scsi_print_command(SCpnt);
2403 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2404 SCpnt->result = DID_ERROR << 16;
2408 * If a bus reset is in progress and there was an error, complete
2409 * the command as busy so that it will get retried.
2411 if (!hpsb_node_entry_valid(scsi_id->ne)
2412 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2413 SBP2_ERR("Completing command with busy (bus reset)");
2414 SCpnt->result = DID_BUS_BUSY << 16;
2418 * If a unit attention occurs, return busy status so it gets
2419 * retried... it could have happened because of a 1394 bus reset
2421 * XXX DID_BUS_BUSY is actually a bad idea because it will defy
2422 * the scsi layer's retry logic.
2425 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2426 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2427 SBP2_DEBUG("UNIT ATTENTION - return busy");
2428 SCpnt->result = DID_BUS_BUSY << 16;
2433 * Tell scsi stack that we're done with this command
2438 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2440 struct scsi_id_instance_data *scsi_id =
2441 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2443 scsi_id->sdev = sdev;
2445 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2446 sdev->inquiry_len = 36;
2450 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2452 struct scsi_id_instance_data *scsi_id =
2453 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2455 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2456 sdev->use_10_for_rw = 1;
2457 sdev->use_10_for_ms = 1;
2459 if (sdev->type == TYPE_DISK &&
2460 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2461 sdev->skip_ms_page_8 = 1;
2462 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2463 sdev->fix_capacity = 1;
2464 if (scsi_id->ne->guid_vendor_id == 0x0010b9 && /* Maxtor's OUI */
2465 (sdev->type == TYPE_DISK || sdev->type == TYPE_RBC))
2466 sdev->allow_restart = 1;
2470 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2472 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2477 * Called by scsi stack when something has really gone wrong. Usually
2478 * called when a command has timed-out for some reason.
2480 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2482 struct scsi_id_instance_data *scsi_id =
2483 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2484 struct sbp2scsi_host_info *hi = scsi_id->hi;
2485 struct sbp2_command_info *command;
2486 unsigned long flags;
2488 SBP2_ERR("aborting sbp2 command");
2489 scsi_print_command(SCpnt);
2491 if (sbp2util_node_is_available(scsi_id)) {
2494 * Right now, just return any matching command structures
2497 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2498 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2500 SBP2_DEBUG("Found command to abort");
2501 pci_dma_sync_single_for_cpu(hi->host->pdev,
2502 command->command_orb_dma,
2503 sizeof(struct sbp2_command_orb),
2505 pci_dma_sync_single_for_cpu(hi->host->pdev,
2507 sizeof(command->scatter_gather_element),
2508 PCI_DMA_BIDIRECTIONAL);
2509 sbp2util_mark_command_completed(scsi_id, command);
2510 if (command->Current_SCpnt) {
2511 command->Current_SCpnt->result = DID_ABORT << 16;
2512 command->Current_done(command->Current_SCpnt);
2515 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2518 * Initiate a fetch agent reset.
2520 sbp2_agent_reset(scsi_id, 0);
2521 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2528 * Called by scsi stack when something has really gone wrong.
2530 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2532 struct scsi_id_instance_data *scsi_id =
2533 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2535 SBP2_ERR("reset requested");
2537 if (sbp2util_node_is_available(scsi_id)) {
2538 SBP2_ERR("Generating sbp2 fetch agent reset");
2539 sbp2_agent_reset(scsi_id, 0);
2545 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2546 struct device_attribute *attr,
2549 struct scsi_device *sdev;
2550 struct scsi_id_instance_data *scsi_id;
2553 if (!(sdev = to_scsi_device(dev)))
2556 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2559 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2561 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2562 scsi_id->ud->id, lun);
2564 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2566 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2567 &dev_attr_ieee1394_id,
2571 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2572 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2573 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2574 MODULE_LICENSE("GPL");
2576 /* SCSI host template */
2577 static struct scsi_host_template scsi_driver_template = {
2578 .module = THIS_MODULE,
2579 .name = "SBP-2 IEEE-1394",
2580 .proc_name = SBP2_DEVICE_NAME,
2581 .queuecommand = sbp2scsi_queuecommand,
2582 .eh_abort_handler = sbp2scsi_abort,
2583 .eh_device_reset_handler = sbp2scsi_reset,
2584 .slave_alloc = sbp2scsi_slave_alloc,
2585 .slave_configure = sbp2scsi_slave_configure,
2586 .slave_destroy = sbp2scsi_slave_destroy,
2588 .sg_tablesize = SG_ALL,
2589 .use_clustering = ENABLE_CLUSTERING,
2590 .cmd_per_lun = SBP2_MAX_CMDS,
2591 .can_queue = SBP2_MAX_CMDS,
2593 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2596 static int sbp2_module_init(void)
2602 /* Module load debug option to force one command at a time (serializing I/O) */
2604 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2605 SBP2_INFO("Try serialize_io=0 for better performance");
2606 scsi_driver_template.can_queue = 1;
2607 scsi_driver_template.cmd_per_lun = 1;
2610 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2611 (max_sectors * 512) > (128 * 1024))
2612 max_sectors = 128 * 1024 / 512;
2613 scsi_driver_template.max_sectors = max_sectors;
2615 /* Register our high level driver with 1394 stack */
2616 hpsb_register_highlevel(&sbp2_highlevel);
2618 ret = hpsb_register_protocol(&sbp2_driver);
2620 SBP2_ERR("Failed to register protocol");
2621 hpsb_unregister_highlevel(&sbp2_highlevel);
2628 static void __exit sbp2_module_exit(void)
2632 hpsb_unregister_protocol(&sbp2_driver);
2634 hpsb_unregister_highlevel(&sbp2_highlevel);
2637 module_init(sbp2_module_init);
2638 module_exit(sbp2_module_exit);