2 * sbp2.c - SBP-2 protocol driver for IEEE-1394
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5 * jamesg@filanet.com (JSG)
7 * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 * This driver implements the Serial Bus Protocol 2 (SBP-2) over IEEE-1394
28 * under Linux. The SBP-2 driver is implemented as an IEEE-1394 high-level
29 * driver. It also registers as a SCSI lower-level driver in order to accept
30 * SCSI commands for transport using SBP-2.
32 * You may access any attached SBP-2 storage devices as if they were SCSI
33 * devices (e.g. mount /dev/sda1, fdisk, mkfs, etc.).
37 * - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38 * but the code needs additional debugging.
41 #include <linux/blkdev.h>
42 #include <linux/compiler.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/gfp.h>
47 #include <linux/init.h>
48 #include <linux/kernel.h>
49 #include <linux/list.h>
50 #include <linux/module.h>
51 #include <linux/moduleparam.h>
52 #include <linux/pci.h>
53 #include <linux/slab.h>
54 #include <linux/spinlock.h>
55 #include <linux/stat.h>
56 #include <linux/string.h>
57 #include <linux/stringify.h>
58 #include <linux/types.h>
59 #include <linux/wait.h>
61 #include <asm/byteorder.h>
62 #include <asm/errno.h>
63 #include <asm/param.h>
64 #include <asm/scatterlist.h>
65 #include <asm/system.h>
66 #include <asm/types.h>
68 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
69 #include <asm/io.h> /* for bus_to_virt */
72 #include <scsi/scsi.h>
73 #include <scsi/scsi_cmnd.h>
74 #include <scsi/scsi_dbg.h>
75 #include <scsi/scsi_device.h>
76 #include <scsi/scsi_host.h>
79 #include "highlevel.h"
82 #include "ieee1394_core.h"
83 #include "ieee1394_hotplug.h"
84 #include "ieee1394_transactions.h"
85 #include "ieee1394_types.h"
90 * Module load parameter definitions
94 * Change max_speed on module load if you have a bad IEEE-1394
95 * controller that has trouble running 2KB packets at 400mb.
97 * NOTE: On certain OHCI parts I have seen short packets on async transmit
98 * (probably due to PCI latency/throughput issues with the part). You can
99 * bump down the speed if you are running into problems.
101 static int max_speed = IEEE1394_SPEED_MAX;
102 module_param(max_speed, int, 0644);
103 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
106 * Set serialize_io to 1 if you'd like only one scsi command sent
107 * down to us at a time (debugging). This might be necessary for very
108 * badly behaved sbp2 devices.
110 * TODO: Make this configurable per device.
112 static int serialize_io = 1;
113 module_param(serialize_io, int, 0444);
114 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
117 * Bump up max_sectors if you'd like to support very large sized
118 * transfers. Please note that some older sbp2 bridge chips are broken for
119 * transfers greater or equal to 128KB. Default is a value of 255
120 * sectors, or just under 128KB (at 512 byte sector size). I can note that
121 * the Oxsemi sbp2 chipsets have no problems supporting very large
124 static int max_sectors = SBP2_MAX_SECTORS;
125 module_param(max_sectors, int, 0444);
126 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
127 __stringify(SBP2_MAX_SECTORS) ")");
130 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
131 * do an exclusive login, as it's generally unsafe to have two hosts
132 * talking to a single sbp2 device at the same time (filesystem coherency,
133 * etc.). If you're running an sbp2 device that supports multiple logins,
134 * and you're either running read-only filesystems or some sort of special
135 * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
136 * File System, or Lustre, then set exclusive_login to zero.
138 * So far only bridges from Oxford Semiconductor are known to support
139 * concurrent logins. Depending on firmware, four or two concurrent logins
140 * are possible on OXFW911 and newer Oxsemi bridges.
142 static int exclusive_login = 1;
143 module_param(exclusive_login, int, 0644);
144 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
147 * If any of the following workarounds is required for your device to work,
148 * please submit the kernel messages logged by sbp2 to the linux1394-devel
151 * - 128kB max transfer
152 * Limit transfer size. Necessary for some old bridges.
155 * When scsi_mod probes the device, let the inquiry command look like that
159 * Suppress sending of mode_sense for mode page 8 if the device pretends to
160 * support the SCSI Primary Block commands instead of Reduced Block Commands.
163 * Tell sd_mod to correct the last sector number reported by read_capacity.
164 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
165 * Don't use this with devices which don't have this bug.
167 * - override internal blacklist
168 * Instead of adding to the built-in blacklist, use only the workarounds
169 * specified in the module load parameter.
170 * Useful if a blacklist entry interfered with a non-broken device.
172 static int sbp2_default_workarounds;
173 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
174 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
175 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
176 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
177 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
178 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
179 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
180 ", or a combination)");
183 * Debug levels, configured via kernel config, or enable here.
186 #define CONFIG_IEEE1394_SBP2_DEBUG 0
187 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
188 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
189 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
190 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
191 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
193 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
194 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
195 static u32 global_outstanding_command_orbs = 0;
196 #define outstanding_orb_incr global_outstanding_command_orbs++
197 #define outstanding_orb_decr global_outstanding_command_orbs--
199 #define SBP2_ORB_DEBUG(fmt, args...) do {} while (0)
200 #define outstanding_orb_incr do {} while (0)
201 #define outstanding_orb_decr do {} while (0)
204 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
205 #define SBP2_DMA_ALLOC(fmt, args...) \
206 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
207 ++global_outstanding_dmas, ## args)
208 #define SBP2_DMA_FREE(fmt, args...) \
209 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
210 --global_outstanding_dmas, ## args)
211 static u32 global_outstanding_dmas = 0;
213 #define SBP2_DMA_ALLOC(fmt, args...) do {} while (0)
214 #define SBP2_DMA_FREE(fmt, args...) do {} while (0)
217 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
218 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
219 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
220 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
221 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
222 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
224 #define SBP2_DEBUG(fmt, args...) do {} while (0)
225 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
228 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
229 #define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
234 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *, u32);
235 static void sbp2scsi_complete_command(struct scsi_id_instance_data *, u32,
237 void (*)(struct scsi_cmnd *));
238 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *);
239 static int sbp2_start_device(struct scsi_id_instance_data *);
240 static void sbp2_remove_device(struct scsi_id_instance_data *);
241 static int sbp2_login_device(struct scsi_id_instance_data *);
242 static int sbp2_reconnect_device(struct scsi_id_instance_data *);
243 static int sbp2_logout_device(struct scsi_id_instance_data *);
244 static void sbp2_host_reset(struct hpsb_host *);
245 static int sbp2_handle_status_write(struct hpsb_host *, int, int, quadlet_t *,
247 static int sbp2_agent_reset(struct scsi_id_instance_data *, int);
248 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *,
249 struct unit_directory *);
250 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *);
251 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *);
254 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
256 static struct hpsb_highlevel sbp2_highlevel = {
257 .name = SBP2_DEVICE_NAME,
258 .host_reset = sbp2_host_reset,
261 static struct hpsb_address_ops sbp2_ops = {
262 .write = sbp2_handle_status_write
265 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
266 static int sbp2_handle_physdma_write(struct hpsb_host *, int, int, quadlet_t *,
268 static int sbp2_handle_physdma_read(struct hpsb_host *, int, quadlet_t *, u64,
271 static struct hpsb_address_ops sbp2_physdma_ops = {
272 .read = sbp2_handle_physdma_read,
273 .write = sbp2_handle_physdma_write,
279 * Interface to driver core and IEEE 1394 core
281 static struct ieee1394_device_id sbp2_id_table[] = {
283 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
284 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
285 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
288 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
290 static int sbp2_probe(struct device *);
291 static int sbp2_remove(struct device *);
292 static int sbp2_update(struct unit_directory *);
294 static struct hpsb_protocol_driver sbp2_driver = {
295 .name = "SBP2 Driver",
296 .id_table = sbp2_id_table,
297 .update = sbp2_update,
299 .name = SBP2_DEVICE_NAME,
300 .bus = &ieee1394_bus_type,
302 .remove = sbp2_remove,
308 * Interface to SCSI core
310 static int sbp2scsi_queuecommand(struct scsi_cmnd *,
311 void (*)(struct scsi_cmnd *));
312 static int sbp2scsi_abort(struct scsi_cmnd *);
313 static int sbp2scsi_reset(struct scsi_cmnd *);
314 static int sbp2scsi_slave_alloc(struct scsi_device *);
315 static int sbp2scsi_slave_configure(struct scsi_device *);
316 static void sbp2scsi_slave_destroy(struct scsi_device *);
317 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *,
318 struct device_attribute *, char *);
320 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
322 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
323 &dev_attr_ieee1394_id,
327 static struct scsi_host_template scsi_driver_template = {
328 .module = THIS_MODULE,
329 .name = "SBP-2 IEEE-1394",
330 .proc_name = SBP2_DEVICE_NAME,
331 .queuecommand = sbp2scsi_queuecommand,
332 .eh_abort_handler = sbp2scsi_abort,
333 .eh_device_reset_handler = sbp2scsi_reset,
334 .slave_alloc = sbp2scsi_slave_alloc,
335 .slave_configure = sbp2scsi_slave_configure,
336 .slave_destroy = sbp2scsi_slave_destroy,
338 .sg_tablesize = SG_ALL,
339 .use_clustering = ENABLE_CLUSTERING,
340 .cmd_per_lun = SBP2_MAX_CMDS,
341 .can_queue = SBP2_MAX_CMDS,
343 .sdev_attrs = sbp2_sysfs_sdev_attrs,
348 * List of devices with known bugs.
350 * The firmware_revision field, masked with 0xffff00, is the best indicator
351 * for the type of bridge chip of a device. It yields a few false positives
352 * but this did not break correctly behaving devices so far.
354 static const struct {
355 u32 firmware_revision;
357 unsigned workarounds;
358 } sbp2_workarounds_table[] = {
359 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
360 .firmware_revision = 0x002800,
361 .model_id = 0x001010,
362 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
363 SBP2_WORKAROUND_MODE_SENSE_8,
365 /* Initio bridges, actually only needed for some older ones */ {
366 .firmware_revision = 0x000200,
367 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
369 /* Symbios bridge */ {
370 .firmware_revision = 0xa0b800,
371 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
374 * Note about the following Apple iPod blacklist entries:
376 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
377 * matching logic treats 0 as a wildcard, we cannot match this ID
378 * without rewriting the matching routine. Fortunately these iPods
379 * do not feature the read_capacity bug according to one report.
380 * Read_capacity behaviour as well as model_id could change due to
381 * Apple-supplied firmware updates though.
383 /* iPod 4th generation */ {
384 .firmware_revision = 0x0a2700,
385 .model_id = 0x000021,
386 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
389 .firmware_revision = 0x0a2700,
390 .model_id = 0x000023,
391 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
394 .firmware_revision = 0x0a2700,
395 .model_id = 0x00007e,
396 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
400 /**************************************
401 * General utility functions
402 **************************************/
406 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
408 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
412 for (length = (length >> 2); length--; )
413 temp[length] = be32_to_cpu(temp[length]);
419 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
421 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
425 for (length = (length >> 2); length--; )
426 temp[length] = cpu_to_be32(temp[length]);
430 #else /* BIG_ENDIAN */
431 /* Why waste the cpu cycles? */
432 #define sbp2util_be32_to_cpu_buffer(x,y) do {} while (0)
433 #define sbp2util_cpu_to_be32_buffer(x,y) do {} while (0)
436 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
438 * Debug packet dump routine. Length is in bytes.
440 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
444 unsigned char *dump = buffer;
446 if (!dump || !length || !dump_name)
450 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
452 printk("[%s]", dump_name);
453 for (i = 0; i < length; i++) {
462 printk("%02x ", (int)dump[i]);
469 #define sbp2util_packet_dump(w,x,y,z) do {} while (0)
472 static DECLARE_WAIT_QUEUE_HEAD(access_wq);
475 * Waits for completion of an SBP-2 access request.
476 * Returns nonzero if timed out or prematurely interrupted.
478 static int sbp2util_access_timeout(struct scsi_id_instance_data *scsi_id,
481 long leftover = wait_event_interruptible_timeout(
482 access_wq, scsi_id->access_complete, timeout);
484 scsi_id->access_complete = 0;
485 return leftover <= 0;
488 /* Frees an allocated packet */
489 static void sbp2_free_packet(struct hpsb_packet *packet)
491 hpsb_free_tlabel(packet);
492 hpsb_free_packet(packet);
495 /* This is much like hpsb_node_write(), except it ignores the response
496 * subaction and returns immediately. Can be used from interrupts.
498 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
499 quadlet_t *buffer, size_t length)
501 struct hpsb_packet *packet;
503 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
504 addr, buffer, length);
508 hpsb_set_packet_complete_task(packet,
509 (void (*)(void *))sbp2_free_packet,
512 hpsb_node_fill_packet(ne, packet);
514 if (hpsb_send_packet(packet) < 0) {
515 sbp2_free_packet(packet);
522 static void sbp2util_notify_fetch_agent(struct scsi_id_instance_data *scsi_id,
523 u64 offset, quadlet_t *data, size_t len)
526 * There is a small window after a bus reset within which the node
527 * entry's generation is current but the reconnect wasn't completed.
529 if (unlikely(atomic_read(&scsi_id->state) == SBP2LU_STATE_IN_RESET))
532 if (hpsb_node_write(scsi_id->ne,
533 scsi_id->sbp2_command_block_agent_addr + offset,
535 SBP2_ERR("sbp2util_notify_fetch_agent failed.");
537 * Now accept new SCSI commands, unless a bus reset happended during
540 if (likely(atomic_read(&scsi_id->state) != SBP2LU_STATE_IN_RESET))
541 scsi_unblock_requests(scsi_id->scsi_host);
544 static void sbp2util_write_orb_pointer(struct work_struct *work)
546 struct scsi_id_instance_data *scsi_id =
547 container_of(work, struct scsi_id_instance_data,
551 data[0] = ORB_SET_NODE_ID(scsi_id->hi->host->node_id);
552 data[1] = scsi_id->last_orb_dma;
553 sbp2util_cpu_to_be32_buffer(data, 8);
554 sbp2util_notify_fetch_agent(scsi_id, SBP2_ORB_POINTER_OFFSET, data, 8);
557 static void sbp2util_write_doorbell(struct work_struct *work)
559 struct scsi_id_instance_data *scsi_id =
560 container_of(work, struct scsi_id_instance_data,
562 sbp2util_notify_fetch_agent(scsi_id, SBP2_DOORBELL_OFFSET, NULL, 4);
566 * This function is called to create a pool of command orbs used for
567 * command processing. It is called when a new sbp2 device is detected.
569 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
571 struct sbp2scsi_host_info *hi = scsi_id->hi;
573 unsigned long flags, orbs;
574 struct sbp2_command_info *command;
576 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
578 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
579 for (i = 0; i < orbs; i++) {
580 command = kzalloc(sizeof(*command), GFP_ATOMIC);
582 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
586 command->command_orb_dma =
587 pci_map_single(hi->host->pdev, &command->command_orb,
588 sizeof(struct sbp2_command_orb),
590 SBP2_DMA_ALLOC("single command orb DMA");
592 pci_map_single(hi->host->pdev,
593 &command->scatter_gather_element,
594 sizeof(command->scatter_gather_element),
595 PCI_DMA_BIDIRECTIONAL);
596 SBP2_DMA_ALLOC("scatter_gather_element");
597 INIT_LIST_HEAD(&command->list);
598 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
600 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
605 * This function is called to delete a pool of command orbs.
607 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
609 struct hpsb_host *host = scsi_id->hi->host;
610 struct list_head *lh, *next;
611 struct sbp2_command_info *command;
614 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
615 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
616 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
617 command = list_entry(lh, struct sbp2_command_info, list);
619 /* Release our generic DMA's */
620 pci_unmap_single(host->pdev, command->command_orb_dma,
621 sizeof(struct sbp2_command_orb),
623 SBP2_DMA_FREE("single command orb DMA");
624 pci_unmap_single(host->pdev, command->sge_dma,
625 sizeof(command->scatter_gather_element),
626 PCI_DMA_BIDIRECTIONAL);
627 SBP2_DMA_FREE("scatter_gather_element");
632 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
637 * This function finds the sbp2_command for a given outstanding command
638 * orb.Only looks at the inuse list.
640 static struct sbp2_command_info *sbp2util_find_command_for_orb(
641 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
643 struct sbp2_command_info *command;
646 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
647 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
648 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
649 if (command->command_orb_dma == orb) {
650 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
655 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
657 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
663 * This function finds the sbp2_command for a given outstanding SCpnt.
664 * Only looks at the inuse list.
665 * Must be called with scsi_id->sbp2_command_orb_lock held.
667 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
668 struct scsi_id_instance_data *scsi_id, void *SCpnt)
670 struct sbp2_command_info *command;
672 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
673 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
674 if (command->Current_SCpnt == SCpnt)
680 * This function allocates a command orb used to send a scsi command.
682 static struct sbp2_command_info *sbp2util_allocate_command_orb(
683 struct scsi_id_instance_data *scsi_id,
684 struct scsi_cmnd *Current_SCpnt,
685 void (*Current_done)(struct scsi_cmnd *))
687 struct list_head *lh;
688 struct sbp2_command_info *command = NULL;
691 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
692 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
693 lh = scsi_id->sbp2_command_orb_completed.next;
695 command = list_entry(lh, struct sbp2_command_info, list);
696 command->Current_done = Current_done;
697 command->Current_SCpnt = Current_SCpnt;
698 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
700 SBP2_ERR("%s: no orbs available", __FUNCTION__);
702 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
707 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
709 struct scsi_id_instance_data *scsi_id =
710 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
711 struct hpsb_host *host;
714 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
718 host = scsi_id->ud->ne->host;
720 if (command->cmd_dma) {
721 if (command->dma_type == CMD_DMA_SINGLE) {
722 pci_unmap_single(host->pdev, command->cmd_dma,
723 command->dma_size, command->dma_dir);
724 SBP2_DMA_FREE("single bulk");
725 } else if (command->dma_type == CMD_DMA_PAGE) {
726 pci_unmap_page(host->pdev, command->cmd_dma,
727 command->dma_size, command->dma_dir);
728 SBP2_DMA_FREE("single page");
729 } /* XXX: Check for CMD_DMA_NONE bug */
730 command->dma_type = CMD_DMA_NONE;
731 command->cmd_dma = 0;
734 if (command->sge_buffer) {
735 pci_unmap_sg(host->pdev, command->sge_buffer,
736 command->dma_size, command->dma_dir);
737 SBP2_DMA_FREE("scatter list");
738 command->sge_buffer = NULL;
743 * This function moves a command to the completed orb list.
744 * Must be called with scsi_id->sbp2_command_orb_lock held.
746 static void sbp2util_mark_command_completed(
747 struct scsi_id_instance_data *scsi_id,
748 struct sbp2_command_info *command)
750 list_del(&command->list);
751 sbp2util_free_command_dma(command);
752 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
756 * Is scsi_id valid? Is the 1394 node still present?
758 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
760 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
763 /*********************************************
764 * IEEE-1394 core driver stack related section
765 *********************************************/
767 static int sbp2_probe(struct device *dev)
769 struct unit_directory *ud;
770 struct scsi_id_instance_data *scsi_id;
774 ud = container_of(dev, struct unit_directory, device);
776 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
778 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
781 scsi_id = sbp2_alloc_device(ud);
786 sbp2_parse_unit_directory(scsi_id, ud);
788 return sbp2_start_device(scsi_id);
791 static int sbp2_remove(struct device *dev)
793 struct unit_directory *ud;
794 struct scsi_id_instance_data *scsi_id;
795 struct scsi_device *sdev;
799 ud = container_of(dev, struct unit_directory, device);
800 scsi_id = ud->device.driver_data;
804 if (scsi_id->scsi_host) {
805 /* Get rid of enqueued commands if there is no chance to
807 if (!sbp2util_node_is_available(scsi_id))
808 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
809 /* scsi_remove_device() will trigger shutdown functions of SCSI
810 * highlevel drivers which would deadlock if blocked. */
811 atomic_set(&scsi_id->state, SBP2LU_STATE_IN_SHUTDOWN);
812 scsi_unblock_requests(scsi_id->scsi_host);
814 sdev = scsi_id->sdev;
816 scsi_id->sdev = NULL;
817 scsi_remove_device(sdev);
820 sbp2_logout_device(scsi_id);
821 sbp2_remove_device(scsi_id);
826 static int sbp2_update(struct unit_directory *ud)
828 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
832 if (sbp2_reconnect_device(scsi_id)) {
835 * Ok, reconnect has failed. Perhaps we didn't
836 * reconnect fast enough. Try doing a regular login, but
837 * first do a logout just in case of any weirdness.
839 sbp2_logout_device(scsi_id);
841 if (sbp2_login_device(scsi_id)) {
842 /* Login failed too, just fail, and the backend
843 * will call our sbp2_remove for us */
844 SBP2_ERR("Failed to reconnect to sbp2 device!");
849 /* Set max retries to something large on the device. */
850 sbp2_set_busy_timeout(scsi_id);
852 /* Do a SBP-2 fetch agent reset. */
853 sbp2_agent_reset(scsi_id, 1);
855 /* Get the max speed and packet size that we can use. */
856 sbp2_max_speed_and_size(scsi_id);
858 /* Complete any pending commands with busy (so they get
859 * retried) and remove them from our queue
861 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
863 /* Accept new commands unless there was another bus reset in the
865 if (hpsb_node_entry_valid(scsi_id->ne)) {
866 atomic_set(&scsi_id->state, SBP2LU_STATE_RUNNING);
867 scsi_unblock_requests(scsi_id->scsi_host);
872 /* This functions is called by the sbp2_probe, for each new device. We now
873 * allocate one scsi host for each scsi_id (unit directory). */
874 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
876 struct sbp2scsi_host_info *hi;
877 struct Scsi_Host *scsi_host = NULL;
878 struct scsi_id_instance_data *scsi_id = NULL;
882 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
884 SBP2_ERR("failed to create scsi_id");
888 scsi_id->ne = ud->ne;
890 scsi_id->speed_code = IEEE1394_SPEED_100;
891 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
892 scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
893 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
894 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
895 INIT_LIST_HEAD(&scsi_id->scsi_list);
896 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
897 atomic_set(&scsi_id->state, SBP2LU_STATE_RUNNING);
898 INIT_DELAYED_WORK(&scsi_id->protocol_work, NULL);
900 ud->device.driver_data = scsi_id;
902 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
904 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
906 SBP2_ERR("failed to allocate hostinfo");
909 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
910 hi->host = ud->ne->host;
911 INIT_LIST_HEAD(&hi->scsi_ids);
913 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
914 /* Handle data movement if physical dma is not
915 * enabled or not supported on host controller */
916 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
918 0x0ULL, 0xfffffffcULL)) {
919 SBP2_ERR("failed to register lower 4GB address range");
925 /* Prevent unloading of the 1394 host */
926 if (!try_module_get(hi->host->driver->owner)) {
927 SBP2_ERR("failed to get a reference on 1394 host driver");
933 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
935 /* Register the status FIFO address range. We could use the same FIFO
936 * for targets at different nodes. However we need different FIFOs per
937 * target in order to support multi-unit devices.
938 * The FIFO is located out of the local host controller's physical range
939 * but, if possible, within the posted write area. Status writes will
940 * then be performed as unified transactions. This slightly reduces
941 * bandwidth usage, and some Prolific based devices seem to require it.
943 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
944 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
945 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
946 ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
947 if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
948 SBP2_ERR("failed to allocate status FIFO address range");
952 /* Register our host with the SCSI stack. */
953 scsi_host = scsi_host_alloc(&scsi_driver_template,
954 sizeof(unsigned long));
956 SBP2_ERR("failed to register scsi host");
960 scsi_host->hostdata[0] = (unsigned long)scsi_id;
962 if (!scsi_add_host(scsi_host, &ud->device)) {
963 scsi_id->scsi_host = scsi_host;
967 SBP2_ERR("failed to add scsi host");
968 scsi_host_put(scsi_host);
971 sbp2_remove_device(scsi_id);
975 static void sbp2_host_reset(struct hpsb_host *host)
977 struct sbp2scsi_host_info *hi;
978 struct scsi_id_instance_data *scsi_id;
980 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
983 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
984 if (likely(atomic_read(&scsi_id->state) !=
985 SBP2LU_STATE_IN_SHUTDOWN)) {
986 atomic_set(&scsi_id->state, SBP2LU_STATE_IN_RESET);
987 scsi_block_requests(scsi_id->scsi_host);
992 * This function is where we first pull the node unique ids, and then
993 * allocate memory and register a SBP-2 device.
995 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
997 struct sbp2scsi_host_info *hi = scsi_id->hi;
1002 /* Login FIFO DMA */
1003 scsi_id->login_response =
1004 pci_alloc_consistent(hi->host->pdev,
1005 sizeof(struct sbp2_login_response),
1006 &scsi_id->login_response_dma);
1007 if (!scsi_id->login_response)
1009 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
1011 /* Query logins ORB DMA */
1012 scsi_id->query_logins_orb =
1013 pci_alloc_consistent(hi->host->pdev,
1014 sizeof(struct sbp2_query_logins_orb),
1015 &scsi_id->query_logins_orb_dma);
1016 if (!scsi_id->query_logins_orb)
1018 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
1020 /* Query logins response DMA */
1021 scsi_id->query_logins_response =
1022 pci_alloc_consistent(hi->host->pdev,
1023 sizeof(struct sbp2_query_logins_response),
1024 &scsi_id->query_logins_response_dma);
1025 if (!scsi_id->query_logins_response)
1027 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
1029 /* Reconnect ORB DMA */
1030 scsi_id->reconnect_orb =
1031 pci_alloc_consistent(hi->host->pdev,
1032 sizeof(struct sbp2_reconnect_orb),
1033 &scsi_id->reconnect_orb_dma);
1034 if (!scsi_id->reconnect_orb)
1036 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
1038 /* Logout ORB DMA */
1039 scsi_id->logout_orb =
1040 pci_alloc_consistent(hi->host->pdev,
1041 sizeof(struct sbp2_logout_orb),
1042 &scsi_id->logout_orb_dma);
1043 if (!scsi_id->logout_orb)
1045 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
1048 scsi_id->login_orb =
1049 pci_alloc_consistent(hi->host->pdev,
1050 sizeof(struct sbp2_login_orb),
1051 &scsi_id->login_orb_dma);
1052 if (!scsi_id->login_orb)
1054 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
1056 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
1059 * Create our command orb pool
1061 if (sbp2util_create_command_orb_pool(scsi_id)) {
1062 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
1063 sbp2_remove_device(scsi_id);
1067 /* Schedule a timeout here. The reason is that we may be so close
1068 * to a bus reset, that the device is not available for logins.
1069 * This can happen when the bus reset is caused by the host
1070 * connected to the sbp2 device being removed. That host would
1071 * have a certain amount of time to relogin before the sbp2 device
1072 * allows someone else to login instead. One second makes sense. */
1073 if (msleep_interruptible(1000)) {
1074 sbp2_remove_device(scsi_id);
1079 * Login to the sbp-2 device
1081 if (sbp2_login_device(scsi_id)) {
1082 /* Login failed, just remove the device. */
1083 sbp2_remove_device(scsi_id);
1088 * Set max retries to something large on the device
1090 sbp2_set_busy_timeout(scsi_id);
1093 * Do a SBP-2 fetch agent reset
1095 sbp2_agent_reset(scsi_id, 1);
1098 * Get the max speed and packet size that we can use
1100 sbp2_max_speed_and_size(scsi_id);
1102 /* Add this device to the scsi layer now */
1103 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1105 SBP2_ERR("scsi_add_device failed");
1106 sbp2_logout_device(scsi_id);
1107 sbp2_remove_device(scsi_id);
1114 SBP2_ERR("Could not allocate memory for scsi_id");
1115 sbp2_remove_device(scsi_id);
1120 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1122 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1124 struct sbp2scsi_host_info *hi;
1133 /* This will remove our scsi device aswell */
1134 if (scsi_id->scsi_host) {
1135 scsi_remove_host(scsi_id->scsi_host);
1136 scsi_host_put(scsi_id->scsi_host);
1138 flush_scheduled_work();
1139 sbp2util_remove_command_orb_pool(scsi_id);
1141 list_del(&scsi_id->scsi_list);
1143 if (scsi_id->login_response) {
1144 pci_free_consistent(hi->host->pdev,
1145 sizeof(struct sbp2_login_response),
1146 scsi_id->login_response,
1147 scsi_id->login_response_dma);
1148 SBP2_DMA_FREE("single login FIFO");
1151 if (scsi_id->login_orb) {
1152 pci_free_consistent(hi->host->pdev,
1153 sizeof(struct sbp2_login_orb),
1155 scsi_id->login_orb_dma);
1156 SBP2_DMA_FREE("single login ORB");
1159 if (scsi_id->reconnect_orb) {
1160 pci_free_consistent(hi->host->pdev,
1161 sizeof(struct sbp2_reconnect_orb),
1162 scsi_id->reconnect_orb,
1163 scsi_id->reconnect_orb_dma);
1164 SBP2_DMA_FREE("single reconnect orb");
1167 if (scsi_id->logout_orb) {
1168 pci_free_consistent(hi->host->pdev,
1169 sizeof(struct sbp2_logout_orb),
1170 scsi_id->logout_orb,
1171 scsi_id->logout_orb_dma);
1172 SBP2_DMA_FREE("single logout orb");
1175 if (scsi_id->query_logins_orb) {
1176 pci_free_consistent(hi->host->pdev,
1177 sizeof(struct sbp2_query_logins_orb),
1178 scsi_id->query_logins_orb,
1179 scsi_id->query_logins_orb_dma);
1180 SBP2_DMA_FREE("single query logins orb");
1183 if (scsi_id->query_logins_response) {
1184 pci_free_consistent(hi->host->pdev,
1185 sizeof(struct sbp2_query_logins_response),
1186 scsi_id->query_logins_response,
1187 scsi_id->query_logins_response_dma);
1188 SBP2_DMA_FREE("single query logins data");
1191 if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
1192 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1193 scsi_id->status_fifo_addr);
1195 scsi_id->ud->device.driver_data = NULL;
1198 module_put(hi->host->driver->owner);
1200 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1205 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1207 * This function deals with physical dma write requests (for adapters that do not support
1208 * physical dma in hardware). Mostly just here for debugging...
1210 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1211 int destid, quadlet_t *data, u64 addr,
1212 size_t length, u16 flags)
1216 * Manually put the data in the right place.
1218 memcpy(bus_to_virt((u32) addr), data, length);
1219 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1221 return RCODE_COMPLETE;
1225 * This function deals with physical dma read requests (for adapters that do not support
1226 * physical dma in hardware). Mostly just here for debugging...
1228 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1229 quadlet_t *data, u64 addr, size_t length,
1234 * Grab data from memory and send a read response.
1236 memcpy(data, bus_to_virt((u32) addr), length);
1237 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1239 return RCODE_COMPLETE;
1243 /**************************************
1244 * SBP-2 protocol related section
1245 **************************************/
1248 * This function queries the device for the maximum concurrent logins it
1251 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1253 struct sbp2scsi_host_info *hi = scsi_id->hi;
1260 scsi_id->query_logins_orb->reserved1 = 0x0;
1261 scsi_id->query_logins_orb->reserved2 = 0x0;
1263 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1264 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1266 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1267 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1268 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1270 scsi_id->query_logins_orb->reserved_resp_length =
1271 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1273 scsi_id->query_logins_orb->status_fifo_hi =
1274 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1275 scsi_id->query_logins_orb->status_fifo_lo =
1276 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1278 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1280 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1281 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1283 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1285 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1286 data[1] = scsi_id->query_logins_orb_dma;
1287 sbp2util_cpu_to_be32_buffer(data, 8);
1289 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1291 if (sbp2util_access_timeout(scsi_id, 2*HZ)) {
1292 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1296 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1297 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1301 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1302 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1306 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1308 SBP2_DEBUG("length_max_logins = %x",
1309 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1311 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1312 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1314 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1315 SBP2_INFO("Number of active logins: %d", active_logins);
1317 if (active_logins >= max_logins) {
1325 * This function is called in order to login to a particular SBP-2 device,
1326 * after a bus reset.
1328 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1330 struct sbp2scsi_host_info *hi = scsi_id->hi;
1335 if (!scsi_id->login_orb) {
1336 SBP2_DEBUG("%s: login_orb not alloc'd!", __FUNCTION__);
1340 if (!exclusive_login) {
1341 if (sbp2_query_logins(scsi_id)) {
1342 SBP2_INFO("Device does not support any more concurrent logins");
1347 /* Set-up login ORB, assume no password */
1348 scsi_id->login_orb->password_hi = 0;
1349 scsi_id->login_orb->password_lo = 0;
1351 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1352 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1354 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1355 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1356 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1357 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1358 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1360 scsi_id->login_orb->passwd_resp_lengths =
1361 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1363 scsi_id->login_orb->status_fifo_hi =
1364 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1365 scsi_id->login_orb->status_fifo_lo =
1366 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1368 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1370 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1371 "sbp2 login orb", scsi_id->login_orb_dma);
1373 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1375 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1376 data[1] = scsi_id->login_orb_dma;
1377 sbp2util_cpu_to_be32_buffer(data, 8);
1379 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1382 * Wait for login status (up to 20 seconds)...
1384 if (sbp2util_access_timeout(scsi_id, 20*HZ)) {
1385 SBP2_ERR("Error logging into SBP-2 device - timed out");
1390 * Sanity. Make sure status returned matches login orb.
1392 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1393 SBP2_ERR("Error logging into SBP-2 device - timed out");
1397 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1398 SBP2_ERR("Error logging into SBP-2 device - failed");
1403 * Byte swap the login response, for use when reconnecting or
1406 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1409 * Grab our command block agent address from the login response.
1411 SBP2_DEBUG("command_block_agent_hi = %x",
1412 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1413 SBP2_DEBUG("command_block_agent_lo = %x",
1414 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1416 scsi_id->sbp2_command_block_agent_addr =
1417 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1418 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1419 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1421 SBP2_INFO("Logged into SBP-2 device");
1426 * This function is called in order to logout from a particular SBP-2
1427 * device, usually called during driver unload.
1429 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1431 struct sbp2scsi_host_info *hi = scsi_id->hi;
1440 scsi_id->logout_orb->reserved1 = 0x0;
1441 scsi_id->logout_orb->reserved2 = 0x0;
1442 scsi_id->logout_orb->reserved3 = 0x0;
1443 scsi_id->logout_orb->reserved4 = 0x0;
1445 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1446 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1448 /* Notify us when complete */
1449 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1451 scsi_id->logout_orb->reserved5 = 0x0;
1452 scsi_id->logout_orb->status_fifo_hi =
1453 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1454 scsi_id->logout_orb->status_fifo_lo =
1455 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1458 * Byte swap ORB if necessary
1460 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1462 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1463 "sbp2 logout orb", scsi_id->logout_orb_dma);
1466 * Ok, let's write to the target's management agent register
1468 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1469 data[1] = scsi_id->logout_orb_dma;
1470 sbp2util_cpu_to_be32_buffer(data, 8);
1472 error = hpsb_node_write(scsi_id->ne,
1473 scsi_id->sbp2_management_agent_addr, data, 8);
1477 /* Wait for device to logout...1 second. */
1478 if (sbp2util_access_timeout(scsi_id, HZ))
1481 SBP2_INFO("Logged out of SBP-2 device");
1486 * This function is called in order to reconnect to a particular SBP-2
1487 * device, after a bus reset.
1489 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1491 struct sbp2scsi_host_info *hi = scsi_id->hi;
1498 * Set-up reconnect ORB
1500 scsi_id->reconnect_orb->reserved1 = 0x0;
1501 scsi_id->reconnect_orb->reserved2 = 0x0;
1502 scsi_id->reconnect_orb->reserved3 = 0x0;
1503 scsi_id->reconnect_orb->reserved4 = 0x0;
1505 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1506 scsi_id->reconnect_orb->login_ID_misc |=
1507 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1509 /* Notify us when complete */
1510 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1512 scsi_id->reconnect_orb->reserved5 = 0x0;
1513 scsi_id->reconnect_orb->status_fifo_hi =
1514 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1515 scsi_id->reconnect_orb->status_fifo_lo =
1516 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1519 * Byte swap ORB if necessary
1521 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1523 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1524 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1526 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1527 data[1] = scsi_id->reconnect_orb_dma;
1528 sbp2util_cpu_to_be32_buffer(data, 8);
1530 error = hpsb_node_write(scsi_id->ne,
1531 scsi_id->sbp2_management_agent_addr, data, 8);
1536 * Wait for reconnect status (up to 1 second)...
1538 if (sbp2util_access_timeout(scsi_id, HZ)) {
1539 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1544 * Sanity. Make sure status returned matches reconnect orb.
1546 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1547 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1551 if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1552 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1556 SBP2_INFO("Reconnected to SBP-2 device");
1561 * This function is called in order to set the busy timeout (number of
1562 * retries to attempt) on the sbp2 device.
1564 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1570 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1571 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1572 SBP2_ERR("%s error", __FUNCTION__);
1577 * This function is called to parse sbp2 device's config rom unit
1578 * directory. Used to determine things like sbp2 management agent offset,
1579 * and command set used (SCSI or RBC).
1581 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1582 struct unit_directory *ud)
1584 struct csr1212_keyval *kv;
1585 struct csr1212_dentry *dentry;
1586 u64 management_agent_addr;
1587 u32 command_set_spec_id, command_set, unit_characteristics,
1589 unsigned workarounds;
1594 management_agent_addr = 0x0;
1595 command_set_spec_id = 0x0;
1597 unit_characteristics = 0x0;
1598 firmware_revision = 0x0;
1600 /* Handle different fields in the unit directory, based on keys */
1601 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1602 switch (kv->key.id) {
1603 case CSR1212_KV_ID_DEPENDENT_INFO:
1604 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1605 /* Save off the management agent address */
1606 management_agent_addr =
1607 CSR1212_REGISTER_SPACE_BASE +
1608 (kv->value.csr_offset << 2);
1610 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1611 (unsigned int)management_agent_addr);
1612 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1614 ORB_SET_LUN(kv->value.immediate);
1618 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1619 /* Command spec organization */
1620 command_set_spec_id = kv->value.immediate;
1621 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1622 (unsigned int)command_set_spec_id);
1625 case SBP2_COMMAND_SET_KEY:
1626 /* Command set used by sbp2 device */
1627 command_set = kv->value.immediate;
1628 SBP2_DEBUG("sbp2_command_set = %x",
1629 (unsigned int)command_set);
1632 case SBP2_UNIT_CHARACTERISTICS_KEY:
1634 * Unit characterisitcs (orb related stuff
1635 * that I'm not yet paying attention to)
1637 unit_characteristics = kv->value.immediate;
1638 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1639 (unsigned int)unit_characteristics);
1642 case SBP2_FIRMWARE_REVISION_KEY:
1643 /* Firmware revision */
1644 firmware_revision = kv->value.immediate;
1645 SBP2_DEBUG("sbp2_firmware_revision = %x",
1646 (unsigned int)firmware_revision);
1654 workarounds = sbp2_default_workarounds;
1656 if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1657 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1658 if (sbp2_workarounds_table[i].firmware_revision &&
1659 sbp2_workarounds_table[i].firmware_revision !=
1660 (firmware_revision & 0xffff00))
1662 if (sbp2_workarounds_table[i].model_id &&
1663 sbp2_workarounds_table[i].model_id != ud->model_id)
1665 workarounds |= sbp2_workarounds_table[i].workarounds;
1670 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1671 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1672 " model_id 0x%06x)",
1673 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1674 workarounds, firmware_revision,
1675 ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1678 /* We would need one SCSI host template for each target to adjust
1679 * max_sectors on the fly, therefore warn only. */
1680 if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1681 (max_sectors * 512) > (128 * 1024))
1682 SBP2_INFO("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1683 "max transfer size. WARNING: Current max_sectors "
1684 "setting is larger than 128KB (%d sectors)",
1685 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1688 /* If this is a logical unit directory entry, process the parent
1689 * to get the values. */
1690 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1691 struct unit_directory *parent_ud =
1692 container_of(ud->device.parent, struct unit_directory, device);
1693 sbp2_parse_unit_directory(scsi_id, parent_ud);
1695 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1696 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1697 scsi_id->sbp2_command_set = command_set;
1698 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1699 scsi_id->sbp2_firmware_revision = firmware_revision;
1700 scsi_id->workarounds = workarounds;
1701 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1702 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1706 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1709 * This function is called in order to determine the max speed and packet
1710 * size we can use in our ORBs. Note, that we (the driver and host) only
1711 * initiate the transaction. The SBP-2 device actually transfers the data
1712 * (by reading from the DMA area we tell it). This means that the SBP-2
1713 * device decides the actual maximum data it can transfer. We just tell it
1714 * the speed that it needs to use, and the max_rec the host supports, and
1715 * it takes care of the rest.
1717 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1719 struct sbp2scsi_host_info *hi = scsi_id->hi;
1724 scsi_id->speed_code =
1725 hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1727 /* Bump down our speed if the user requested it */
1728 if (scsi_id->speed_code > max_speed) {
1729 scsi_id->speed_code = max_speed;
1730 SBP2_INFO("Reducing speed to %s", hpsb_speedto_str[max_speed]);
1733 /* Payload size is the lesser of what our speed supports and what
1734 * our host supports. */
1735 payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1736 (u8) (hi->host->csr.max_rec - 1));
1738 /* If physical DMA is off, work around limitation in ohci1394:
1739 * packet size must not exceed PAGE_SIZE */
1740 if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1741 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1745 SBP2_INFO("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1746 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1747 hpsb_speedto_str[scsi_id->speed_code],
1748 SBP2_PAYLOAD_TO_BYTES(payload));
1750 scsi_id->max_payload_size = payload;
1755 * This function is called in order to perform a SBP-2 agent reset.
1757 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1762 unsigned long flags;
1766 cancel_delayed_work(&scsi_id->protocol_work);
1768 flush_scheduled_work();
1770 data = ntohl(SBP2_AGENT_RESET_DATA);
1771 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1774 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1776 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1779 SBP2_ERR("hpsb_node_write failed.\n");
1784 * Need to make sure orb pointer is written on next command
1786 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1787 scsi_id->last_orb = NULL;
1788 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1793 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1794 struct sbp2scsi_host_info *hi,
1795 struct sbp2_command_info *command,
1796 unsigned int scsi_use_sg,
1797 struct scatterlist *sgpnt,
1799 enum dma_data_direction dma_dir)
1801 command->dma_dir = dma_dir;
1802 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1803 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1805 /* Special case if only one element (and less than 64KB in size) */
1806 if ((scsi_use_sg == 1) &&
1807 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1809 SBP2_DEBUG("Only one s/g element");
1810 command->dma_size = sgpnt[0].length;
1811 command->dma_type = CMD_DMA_PAGE;
1812 command->cmd_dma = pci_map_page(hi->host->pdev,
1817 SBP2_DMA_ALLOC("single page scatter element");
1819 orb->data_descriptor_lo = command->cmd_dma;
1820 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1823 struct sbp2_unrestricted_page_table *sg_element =
1824 &command->scatter_gather_element[0];
1825 u32 sg_count, sg_len;
1827 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1830 SBP2_DMA_ALLOC("scatter list");
1832 command->dma_size = scsi_use_sg;
1833 command->sge_buffer = sgpnt;
1835 /* use page tables (s/g) */
1836 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1837 orb->data_descriptor_lo = command->sge_dma;
1840 * Loop through and fill out our sbp-2 page tables
1841 * (and split up anything too large)
1843 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1844 sg_len = sg_dma_len(sgpnt);
1845 sg_addr = sg_dma_address(sgpnt);
1847 sg_element[sg_count].segment_base_lo = sg_addr;
1848 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1849 sg_element[sg_count].length_segment_base_hi =
1850 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1851 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1852 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1854 sg_element[sg_count].length_segment_base_hi =
1855 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1862 /* Number of page table (s/g) elements */
1863 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1865 sbp2util_packet_dump(sg_element,
1866 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1867 "sbp2 s/g list", command->sge_dma);
1869 /* Byte swap page tables if necessary */
1870 sbp2util_cpu_to_be32_buffer(sg_element,
1871 (sizeof(struct sbp2_unrestricted_page_table)) *
1876 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1877 struct sbp2scsi_host_info *hi,
1878 struct sbp2_command_info *command,
1879 struct scatterlist *sgpnt,
1881 unsigned int scsi_request_bufflen,
1882 void *scsi_request_buffer,
1883 enum dma_data_direction dma_dir)
1885 command->dma_dir = dma_dir;
1886 command->dma_size = scsi_request_bufflen;
1887 command->dma_type = CMD_DMA_SINGLE;
1888 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1889 command->dma_size, command->dma_dir);
1890 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1891 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1893 SBP2_DMA_ALLOC("single bulk");
1896 * Handle case where we get a command w/o s/g enabled (but
1897 * check for transfers larger than 64K)
1899 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1901 orb->data_descriptor_lo = command->cmd_dma;
1902 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1905 struct sbp2_unrestricted_page_table *sg_element =
1906 &command->scatter_gather_element[0];
1907 u32 sg_count, sg_len;
1911 * Need to turn this into page tables, since the
1912 * buffer is too large.
1914 orb->data_descriptor_lo = command->sge_dma;
1916 /* Use page tables (s/g) */
1917 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1920 * fill out our sbp-2 page tables (and split up
1924 sg_len = scsi_request_bufflen;
1925 sg_addr = command->cmd_dma;
1927 sg_element[sg_count].segment_base_lo = sg_addr;
1928 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1929 sg_element[sg_count].length_segment_base_hi =
1930 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1931 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1932 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1934 sg_element[sg_count].length_segment_base_hi =
1935 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1941 /* Number of page table (s/g) elements */
1942 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1944 sbp2util_packet_dump(sg_element,
1945 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1946 "sbp2 s/g list", command->sge_dma);
1948 /* Byte swap page tables if necessary */
1949 sbp2util_cpu_to_be32_buffer(sg_element,
1950 (sizeof(struct sbp2_unrestricted_page_table)) *
1956 * This function is called to create the actual command orb and s/g list
1957 * out of the scsi command itself.
1959 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1960 struct sbp2_command_info *command,
1962 unsigned int scsi_use_sg,
1963 unsigned int scsi_request_bufflen,
1964 void *scsi_request_buffer,
1965 enum dma_data_direction dma_dir)
1967 struct sbp2scsi_host_info *hi = scsi_id->hi;
1968 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1969 struct sbp2_command_orb *command_orb = &command->command_orb;
1973 * Set-up our command ORB..
1975 * NOTE: We're doing unrestricted page tables (s/g), as this is
1976 * best performance (at least with the devices I have). This means
1977 * that data_size becomes the number of s/g elements, and
1978 * page_size should be zero (for unrestricted).
1980 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1981 command_orb->next_ORB_lo = 0x0;
1982 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1983 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1984 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1986 if (dma_dir == DMA_NONE)
1987 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1988 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1989 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1990 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1991 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1993 SBP2_INFO("Falling back to DMA_NONE");
1994 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1997 /* Set-up our pagetable stuff */
1998 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1999 SBP2_DEBUG("No data transfer");
2000 command_orb->data_descriptor_hi = 0x0;
2001 command_orb->data_descriptor_lo = 0x0;
2002 command_orb->misc |= ORB_SET_DIRECTION(1);
2003 } else if (scsi_use_sg) {
2004 SBP2_DEBUG("Use scatter/gather");
2005 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
2006 sgpnt, orb_direction, dma_dir);
2008 SBP2_DEBUG("No scatter/gather");
2009 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
2010 orb_direction, scsi_request_bufflen,
2011 scsi_request_buffer, dma_dir);
2014 /* Byte swap command ORB if necessary */
2015 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
2017 /* Put our scsi command in the command ORB */
2018 memset(command_orb->cdb, 0, 12);
2019 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
2023 * This function is called in order to begin a regular SBP-2 command.
2025 static void sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
2026 struct sbp2_command_info *command)
2028 struct sbp2scsi_host_info *hi = scsi_id->hi;
2029 struct sbp2_command_orb *command_orb = &command->command_orb;
2030 struct sbp2_command_orb *last_orb;
2031 dma_addr_t last_orb_dma;
2032 u64 addr = scsi_id->sbp2_command_block_agent_addr;
2035 unsigned long flags;
2037 outstanding_orb_incr;
2038 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
2039 command_orb, global_outstanding_command_orbs);
2041 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
2042 sizeof(struct sbp2_command_orb),
2044 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
2045 sizeof(command->scatter_gather_element),
2046 PCI_DMA_BIDIRECTIONAL);
2048 * Check to see if there are any previous orbs to use
2050 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2051 last_orb = scsi_id->last_orb;
2052 last_orb_dma = scsi_id->last_orb_dma;
2055 * last_orb == NULL means: We know that the target's fetch agent
2056 * is not active right now.
2058 addr += SBP2_ORB_POINTER_OFFSET;
2059 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
2060 data[1] = command->command_orb_dma;
2061 sbp2util_cpu_to_be32_buffer(data, 8);
2065 * last_orb != NULL means: We know that the target's fetch agent
2066 * is (very probably) not dead or in reset state right now.
2067 * We have an ORB already sent that we can append a new one to.
2068 * The target's fetch agent may or may not have read this
2071 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
2072 sizeof(struct sbp2_command_orb),
2074 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
2076 /* Tells hardware that this pointer is valid */
2077 last_orb->next_ORB_hi = 0;
2078 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
2079 sizeof(struct sbp2_command_orb),
2081 addr += SBP2_DOORBELL_OFFSET;
2085 scsi_id->last_orb = command_orb;
2086 scsi_id->last_orb_dma = command->command_orb_dma;
2087 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2089 SBP2_ORB_DEBUG("write to %s register, command orb %p",
2090 last_orb ? "DOORBELL" : "ORB_POINTER", command_orb);
2091 if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length)) {
2093 * sbp2util_node_write_no_wait failed. We certainly ran out
2094 * of transaction labels, perhaps just because there were no
2095 * context switches which gave khpsbpkt a chance to collect
2096 * free tlabels. Try again in non-atomic context. If necessary,
2097 * the workqueue job will sleep to guaranteedly get a tlabel.
2098 * We do not accept new commands until the job is over.
2100 scsi_block_requests(scsi_id->scsi_host);
2101 PREPARE_DELAYED_WORK(&scsi_id->protocol_work,
2102 last_orb ? sbp2util_write_doorbell:
2103 sbp2util_write_orb_pointer);
2104 schedule_delayed_work(&scsi_id->protocol_work, 0);
2109 * This function is called in order to begin a regular SBP-2 command.
2111 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2112 struct scsi_cmnd *SCpnt,
2113 void (*done)(struct scsi_cmnd *))
2115 unchar *cmd = (unchar *) SCpnt->cmnd;
2116 unsigned int request_bufflen = SCpnt->request_bufflen;
2117 struct sbp2_command_info *command;
2120 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2121 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2124 * Allocate a command orb and s/g structure
2126 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2132 * Now actually fill in the comamnd orb and sbp2 s/g list
2134 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2135 request_bufflen, SCpnt->request_buffer,
2136 SCpnt->sc_data_direction);
2138 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2139 "sbp2 command orb", command->command_orb_dma);
2142 * Link up the orb, and ring the doorbell if needed
2144 sbp2_link_orb_command(scsi_id, command);
2150 * Translates SBP-2 status into SCSI sense data for check conditions
2152 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2157 * Ok, it's pretty ugly... ;-)
2159 sense_data[0] = 0x70;
2160 sense_data[1] = 0x0;
2161 sense_data[2] = sbp2_status[9];
2162 sense_data[3] = sbp2_status[12];
2163 sense_data[4] = sbp2_status[13];
2164 sense_data[5] = sbp2_status[14];
2165 sense_data[6] = sbp2_status[15];
2167 sense_data[8] = sbp2_status[16];
2168 sense_data[9] = sbp2_status[17];
2169 sense_data[10] = sbp2_status[18];
2170 sense_data[11] = sbp2_status[19];
2171 sense_data[12] = sbp2_status[10];
2172 sense_data[13] = sbp2_status[11];
2173 sense_data[14] = sbp2_status[20];
2174 sense_data[15] = sbp2_status[21];
2176 return sbp2_status[8] & 0x3f; /* return scsi status */
2180 * This function deals with status writes from the SBP-2 device
2182 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
2183 int destid, quadlet_t *data, u64 addr,
2184 size_t length, u16 fl)
2186 struct sbp2scsi_host_info *hi;
2187 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2188 struct scsi_cmnd *SCpnt = NULL;
2189 struct sbp2_status_block *sb;
2190 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2191 struct sbp2_command_info *command;
2192 unsigned long flags;
2196 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2198 if (unlikely(length < 8 || length > sizeof(struct sbp2_status_block))) {
2199 SBP2_ERR("Wrong size of status block");
2200 return RCODE_ADDRESS_ERROR;
2202 if (unlikely(!host)) {
2203 SBP2_ERR("host is NULL - this is bad!");
2204 return RCODE_ADDRESS_ERROR;
2206 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2207 if (unlikely(!hi)) {
2208 SBP2_ERR("host info is NULL - this is bad!");
2209 return RCODE_ADDRESS_ERROR;
2212 * Find our scsi_id structure by looking at the status fifo address
2213 * written to by the sbp2 device.
2215 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2216 if (scsi_id_tmp->ne->nodeid == nodeid &&
2217 scsi_id_tmp->status_fifo_addr == addr) {
2218 scsi_id = scsi_id_tmp;
2222 if (unlikely(!scsi_id)) {
2223 SBP2_ERR("scsi_id is NULL - device is gone?");
2224 return RCODE_ADDRESS_ERROR;
2228 * Put response into scsi_id status fifo buffer. The first two bytes
2229 * come in big endian bit order. Often the target writes only a
2230 * truncated status block, minimally the first two quadlets. The rest
2231 * is implied to be zeros.
2233 sb = &scsi_id->status_block;
2234 memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
2235 memcpy(sb, data, length);
2236 sbp2util_be32_to_cpu_buffer(sb, 8);
2239 * Ignore unsolicited status. Handle command ORB status.
2241 if (unlikely(STATUS_GET_SRC(sb->ORB_offset_hi_misc) == 2))
2244 command = sbp2util_find_command_for_orb(scsi_id,
2247 SBP2_DEBUG("Found status for command ORB");
2248 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2249 sizeof(struct sbp2_command_orb),
2251 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2252 sizeof(command->scatter_gather_element),
2253 PCI_DMA_BIDIRECTIONAL);
2255 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2256 outstanding_orb_decr;
2259 * Matched status with command, now grab scsi command pointers
2263 * FIXME: If the src field in the status is 1, the ORB DMA must
2264 * not be reused until status for a subsequent ORB is received.
2266 SCpnt = command->Current_SCpnt;
2267 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2268 sbp2util_mark_command_completed(scsi_id, command);
2269 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2272 u32 h = sb->ORB_offset_hi_misc;
2273 u32 r = STATUS_GET_RESP(h);
2275 if (r != RESP_STATUS_REQUEST_COMPLETE) {
2276 SBP2_INFO("resp 0x%x, sbp_status 0x%x",
2277 r, STATUS_GET_SBP_STATUS(h));
2279 r == RESP_STATUS_TRANSPORT_FAILURE ?
2280 SBP2_SCSI_STATUS_BUSY :
2281 SBP2_SCSI_STATUS_COMMAND_TERMINATED;
2284 * See if the target stored any scsi status information.
2286 if (STATUS_GET_LEN(h) > 1) {
2287 SBP2_DEBUG("CHECK CONDITION");
2288 scsi_status = sbp2_status_to_sense_data(
2289 (unchar *)sb, SCpnt->sense_buffer);
2292 * Check to see if the dead bit is set. If so, we'll
2293 * have to initiate a fetch agent reset.
2295 if (STATUS_TEST_DEAD(h)) {
2296 SBP2_DEBUG("Dead bit set - "
2297 "initiating fetch agent reset");
2298 sbp2_agent_reset(scsi_id, 0);
2300 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2304 * Check here to see if there are no commands in-use. If there
2305 * are none, we know that the fetch agent left the active state
2306 * _and_ that we did not reactivate it yet. Therefore clear
2307 * last_orb so that next time we write directly to the
2308 * ORB_POINTER register. That way the fetch agent does not need
2309 * to refetch the next_ORB.
2311 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2312 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
2313 scsi_id->last_orb = NULL;
2314 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2318 * It's probably a login/logout/reconnect status.
2320 if ((sb->ORB_offset_lo == scsi_id->reconnect_orb_dma) ||
2321 (sb->ORB_offset_lo == scsi_id->login_orb_dma) ||
2322 (sb->ORB_offset_lo == scsi_id->query_logins_orb_dma) ||
2323 (sb->ORB_offset_lo == scsi_id->logout_orb_dma)) {
2324 scsi_id->access_complete = 1;
2325 wake_up_interruptible(&access_wq);
2330 SBP2_DEBUG("Completing SCSI command");
2331 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2332 command->Current_done);
2333 SBP2_ORB_DEBUG("command orb completed");
2336 return RCODE_COMPLETE;
2339 /**************************************
2340 * SCSI interface related section
2341 **************************************/
2344 * This routine is the main request entry routine for doing I/O. It is
2345 * called from the scsi stack directly.
2347 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2348 void (*done)(struct scsi_cmnd *))
2350 struct scsi_id_instance_data *scsi_id =
2351 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2352 struct sbp2scsi_host_info *hi;
2353 int result = DID_NO_CONNECT << 16;
2356 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2357 scsi_print_command(SCpnt);
2360 if (!sbp2util_node_is_available(scsi_id))
2366 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2371 * Until we handle multiple luns, just return selection time-out
2372 * to any IO directed at non-zero LUNs
2374 if (SCpnt->device->lun)
2378 * Check for request sense command, and handle it here
2379 * (autorequest sense)
2381 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2382 SBP2_DEBUG("REQUEST_SENSE");
2383 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2384 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2385 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2390 * Check to see if we are in the middle of a bus reset.
2392 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2393 SBP2_ERR("Bus reset in progress - rejecting command");
2394 result = DID_BUS_BUSY << 16;
2399 * Bidirectional commands are not yet implemented,
2400 * and unknown transfer direction not handled.
2402 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2403 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2404 result = DID_ERROR << 16;
2409 * Try and send our SCSI command
2411 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2412 SBP2_ERR("Error sending SCSI command");
2413 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2419 SCpnt->result = result;
2425 * This function is called in order to complete all outstanding SBP-2
2426 * commands (in case of resets, etc.).
2428 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2431 struct sbp2scsi_host_info *hi = scsi_id->hi;
2432 struct list_head *lh;
2433 struct sbp2_command_info *command;
2434 unsigned long flags;
2438 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2439 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2440 SBP2_DEBUG("Found pending command to complete");
2441 lh = scsi_id->sbp2_command_orb_inuse.next;
2442 command = list_entry(lh, struct sbp2_command_info, list);
2443 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2444 sizeof(struct sbp2_command_orb),
2446 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2447 sizeof(command->scatter_gather_element),
2448 PCI_DMA_BIDIRECTIONAL);
2449 sbp2util_mark_command_completed(scsi_id, command);
2450 if (command->Current_SCpnt) {
2451 command->Current_SCpnt->result = status << 16;
2452 command->Current_done(command->Current_SCpnt);
2455 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2461 * This function is called in order to complete a regular SBP-2 command.
2463 * This can be called in interrupt context.
2465 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2466 u32 scsi_status, struct scsi_cmnd *SCpnt,
2467 void (*done)(struct scsi_cmnd *))
2475 SBP2_ERR("SCpnt is NULL");
2480 * Switch on scsi status
2482 switch (scsi_status) {
2483 case SBP2_SCSI_STATUS_GOOD:
2484 SCpnt->result = DID_OK << 16;
2487 case SBP2_SCSI_STATUS_BUSY:
2488 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2489 SCpnt->result = DID_BUS_BUSY << 16;
2492 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2493 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2494 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2495 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2496 scsi_print_command(SCpnt);
2497 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
2501 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2502 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2503 SCpnt->result = DID_NO_CONNECT << 16;
2504 scsi_print_command(SCpnt);
2507 case SBP2_SCSI_STATUS_CONDITION_MET:
2508 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2509 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2510 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2511 SCpnt->result = DID_ERROR << 16;
2512 scsi_print_command(SCpnt);
2516 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2517 SCpnt->result = DID_ERROR << 16;
2521 * If a bus reset is in progress and there was an error, complete
2522 * the command as busy so that it will get retried.
2524 if (!hpsb_node_entry_valid(scsi_id->ne)
2525 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2526 SBP2_ERR("Completing command with busy (bus reset)");
2527 SCpnt->result = DID_BUS_BUSY << 16;
2531 * Tell scsi stack that we're done with this command
2536 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2538 struct scsi_id_instance_data *scsi_id =
2539 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2541 scsi_id->sdev = sdev;
2542 sdev->allow_restart = 1;
2544 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2545 sdev->inquiry_len = 36;
2549 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2551 struct scsi_id_instance_data *scsi_id =
2552 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2554 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2555 sdev->use_10_for_rw = 1;
2557 if (sdev->type == TYPE_DISK &&
2558 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2559 sdev->skip_ms_page_8 = 1;
2560 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2561 sdev->fix_capacity = 1;
2565 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2567 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2572 * Called by scsi stack when something has really gone wrong. Usually
2573 * called when a command has timed-out for some reason.
2575 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2577 struct scsi_id_instance_data *scsi_id =
2578 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2579 struct sbp2scsi_host_info *hi = scsi_id->hi;
2580 struct sbp2_command_info *command;
2581 unsigned long flags;
2583 SBP2_INFO("aborting sbp2 command");
2584 scsi_print_command(SCpnt);
2586 if (sbp2util_node_is_available(scsi_id)) {
2587 sbp2_agent_reset(scsi_id, 1);
2589 /* Return a matching command structure to the free pool. */
2590 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2591 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2593 SBP2_DEBUG("Found command to abort");
2594 pci_dma_sync_single_for_cpu(hi->host->pdev,
2595 command->command_orb_dma,
2596 sizeof(struct sbp2_command_orb),
2598 pci_dma_sync_single_for_cpu(hi->host->pdev,
2600 sizeof(command->scatter_gather_element),
2601 PCI_DMA_BIDIRECTIONAL);
2602 sbp2util_mark_command_completed(scsi_id, command);
2603 if (command->Current_SCpnt) {
2604 command->Current_SCpnt->result = DID_ABORT << 16;
2605 command->Current_done(command->Current_SCpnt);
2608 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2610 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2617 * Called by scsi stack when something has really gone wrong.
2619 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2621 struct scsi_id_instance_data *scsi_id =
2622 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2624 SBP2_INFO("reset requested");
2626 if (sbp2util_node_is_available(scsi_id)) {
2627 SBP2_INFO("generating sbp2 fetch agent reset");
2628 sbp2_agent_reset(scsi_id, 1);
2634 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2635 struct device_attribute *attr,
2638 struct scsi_device *sdev;
2639 struct scsi_id_instance_data *scsi_id;
2642 if (!(sdev = to_scsi_device(dev)))
2645 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2648 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2650 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2651 scsi_id->ud->id, lun);
2654 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2655 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2656 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2657 MODULE_LICENSE("GPL");
2659 static int sbp2_module_init(void)
2665 /* Module load debug option to force one command at a time (serializing I/O) */
2667 scsi_driver_template.can_queue = 1;
2668 scsi_driver_template.cmd_per_lun = 1;
2671 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2672 (max_sectors * 512) > (128 * 1024))
2673 max_sectors = 128 * 1024 / 512;
2674 scsi_driver_template.max_sectors = max_sectors;
2676 /* Register our high level driver with 1394 stack */
2677 hpsb_register_highlevel(&sbp2_highlevel);
2679 ret = hpsb_register_protocol(&sbp2_driver);
2681 SBP2_ERR("Failed to register protocol");
2682 hpsb_unregister_highlevel(&sbp2_highlevel);
2689 static void __exit sbp2_module_exit(void)
2693 hpsb_unregister_protocol(&sbp2_driver);
2695 hpsb_unregister_highlevel(&sbp2_highlevel);
2698 module_init(sbp2_module_init);
2699 module_exit(sbp2_module_exit);