2 * sbp2.c - SBP-2 protocol driver for IEEE-1394
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5 * jamesg@filanet.com (JSG)
7 * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 * This driver implements the Serial Bus Protocol 2 (SBP-2) over IEEE-1394
28 * under Linux. The SBP-2 driver is implemented as an IEEE-1394 high-level
29 * driver. It also registers as a SCSI lower-level driver in order to accept
30 * SCSI commands for transport using SBP-2.
32 * You may access any attached SBP-2 storage devices as if they were SCSI
33 * devices (e.g. mount /dev/sda1, fdisk, mkfs, etc.).
37 * - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38 * but the code needs additional debugging.
41 #include <linux/config.h>
42 #include <linux/kernel.h>
43 #include <linux/list.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/interrupt.h>
48 #include <linux/poll.h>
49 #include <linux/module.h>
50 #include <linux/moduleparam.h>
51 #include <linux/types.h>
52 #include <linux/delay.h>
53 #include <linux/sched.h>
54 #include <linux/blkdev.h>
55 #include <linux/smp_lock.h>
56 #include <linux/init.h>
57 #include <linux/pci.h>
59 #include <asm/current.h>
60 #include <asm/uaccess.h>
62 #include <asm/byteorder.h>
63 #include <asm/atomic.h>
64 #include <asm/system.h>
65 #include <asm/scatterlist.h>
67 #include <scsi/scsi.h>
68 #include <scsi/scsi_cmnd.h>
69 #include <scsi/scsi_dbg.h>
70 #include <scsi/scsi_device.h>
71 #include <scsi/scsi_host.h>
75 #include "ieee1394_types.h"
76 #include "ieee1394_core.h"
79 #include "highlevel.h"
80 #include "ieee1394_transactions.h"
84 * Module load parameter definitions
88 * Change max_speed on module load if you have a bad IEEE-1394
89 * controller that has trouble running 2KB packets at 400mb.
91 * NOTE: On certain OHCI parts I have seen short packets on async transmit
92 * (probably due to PCI latency/throughput issues with the part). You can
93 * bump down the speed if you are running into problems.
95 static int max_speed = IEEE1394_SPEED_MAX;
96 module_param(max_speed, int, 0644);
97 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
100 * Set serialize_io to 1 if you'd like only one scsi command sent
101 * down to us at a time (debugging). This might be necessary for very
102 * badly behaved sbp2 devices.
104 * TODO: Make this configurable per device.
106 static int serialize_io = 1;
107 module_param(serialize_io, int, 0444);
108 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
111 * Bump up max_sectors if you'd like to support very large sized
112 * transfers. Please note that some older sbp2 bridge chips are broken for
113 * transfers greater or equal to 128KB. Default is a value of 255
114 * sectors, or just under 128KB (at 512 byte sector size). I can note that
115 * the Oxsemi sbp2 chipsets have no problems supporting very large
118 static int max_sectors = SBP2_MAX_SECTORS;
119 module_param(max_sectors, int, 0444);
120 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = 255)");
123 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
124 * do an exclusive login, as it's generally unsafe to have two hosts
125 * talking to a single sbp2 device at the same time (filesystem coherency,
126 * etc.). If you're running an sbp2 device that supports multiple logins,
127 * and you're either running read-only filesystems or some sort of special
128 * filesystem supporting multiple hosts (one such filesystem is OpenGFS,
129 * see opengfs.sourceforge.net for more info), then set exclusive_login
130 * to zero. Note: The Oxsemi OXFW911 sbp2 chipset supports up to four
133 static int exclusive_login = 1;
134 module_param(exclusive_login, int, 0644);
135 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
138 * SCSI inquiry hack for really badly behaved sbp2 devices. Turn this on
139 * if your sbp2 device is not properly handling the SCSI inquiry command.
140 * This hack makes the inquiry look more like a typical MS Windows inquiry
141 * by enforcing 36 byte inquiry and avoiding access to mode_sense page 8.
143 * If force_inquiry_hack=1 is required for your device to work,
144 * please submit the logged sbp2_firmware_revision value of this device to
145 * the linux1394-devel mailing list.
147 static int force_inquiry_hack;
148 module_param(force_inquiry_hack, int, 0644);
149 MODULE_PARM_DESC(force_inquiry_hack, "Force SCSI inquiry hack (default = 0)");
152 * Export information about protocols/devices supported by this driver.
154 static struct ieee1394_device_id sbp2_id_table[] = {
156 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
157 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
158 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
162 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
165 * Debug levels, configured via kernel config, or enable here.
168 #define CONFIG_IEEE1394_SBP2_DEBUG 0
169 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
170 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
171 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
172 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
173 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
175 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
176 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
177 static u32 global_outstanding_command_orbs = 0;
178 #define outstanding_orb_incr global_outstanding_command_orbs++
179 #define outstanding_orb_decr global_outstanding_command_orbs--
181 #define SBP2_ORB_DEBUG(fmt, args...)
182 #define outstanding_orb_incr
183 #define outstanding_orb_decr
186 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
187 #define SBP2_DMA_ALLOC(fmt, args...) \
188 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
189 ++global_outstanding_dmas, ## args)
190 #define SBP2_DMA_FREE(fmt, args...) \
191 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
192 --global_outstanding_dmas, ## args)
193 static u32 global_outstanding_dmas = 0;
195 #define SBP2_DMA_ALLOC(fmt, args...)
196 #define SBP2_DMA_FREE(fmt, args...)
199 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
200 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
201 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
202 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
203 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
204 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
205 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
206 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
207 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
208 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
210 #define SBP2_DEBUG(fmt, args...)
211 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
212 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
213 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
216 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
222 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
225 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
226 u32 scsi_status, struct scsi_cmnd *SCpnt,
227 void (*done)(struct scsi_cmnd *));
229 static struct scsi_host_template scsi_driver_template;
231 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
233 static void sbp2_host_reset(struct hpsb_host *host);
235 static int sbp2_probe(struct device *dev);
236 static int sbp2_remove(struct device *dev);
237 static int sbp2_update(struct unit_directory *ud);
239 static struct hpsb_highlevel sbp2_highlevel = {
240 .name = SBP2_DEVICE_NAME,
241 .host_reset = sbp2_host_reset,
244 static struct hpsb_address_ops sbp2_ops = {
245 .write = sbp2_handle_status_write
248 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
249 static struct hpsb_address_ops sbp2_physdma_ops = {
250 .read = sbp2_handle_physdma_read,
251 .write = sbp2_handle_physdma_write,
255 static struct hpsb_protocol_driver sbp2_driver = {
256 .name = "SBP2 Driver",
257 .id_table = sbp2_id_table,
258 .update = sbp2_update,
260 .name = SBP2_DEVICE_NAME,
261 .bus = &ieee1394_bus_type,
263 .remove = sbp2_remove,
268 * List of device firmwares that require the inquiry hack.
269 * Yields a few false positives but did not break other devices so far.
271 static u32 sbp2_broken_inquiry_list[] = {
272 0x00002800, /* Stefan Richter <stefanr@s5r6.in-berlin.de> */
273 /* DViCO Momobay CX-1 */
274 0x00000200 /* Andreas Plesch <plesch@fas.harvard.edu> */
275 /* QPS Fire DVDBurner */
278 /**************************************
279 * General utility functions
280 **************************************/
284 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
286 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
290 for (length = (length >> 2); length--; )
291 temp[length] = be32_to_cpu(temp[length]);
297 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
299 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
303 for (length = (length >> 2); length--; )
304 temp[length] = cpu_to_be32(temp[length]);
308 #else /* BIG_ENDIAN */
309 /* Why waste the cpu cycles? */
310 #define sbp2util_be32_to_cpu_buffer(x,y)
311 #define sbp2util_cpu_to_be32_buffer(x,y)
314 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
316 * Debug packet dump routine. Length is in bytes.
318 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
322 unsigned char *dump = buffer;
324 if (!dump || !length || !dump_name)
328 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
330 printk("[%s]", dump_name);
331 for (i = 0; i < length; i++) {
340 printk("%02x ", (int)dump[i]);
347 #define sbp2util_packet_dump(w,x,y,z)
351 * Goofy routine that basically does a down_timeout function.
353 static int sbp2util_down_timeout(atomic_t *done, int timeout)
357 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
358 if (msleep_interruptible(100)) /* 100ms */
361 return (i > 0) ? 0 : 1;
364 /* Free's an allocated packet */
365 static void sbp2_free_packet(struct hpsb_packet *packet)
367 hpsb_free_tlabel(packet);
368 hpsb_free_packet(packet);
371 /* This is much like hpsb_node_write(), except it ignores the response
372 * subaction and returns immediately. Can be used from interrupts.
374 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
375 quadlet_t *buffer, size_t length)
377 struct hpsb_packet *packet;
379 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
380 addr, buffer, length);
384 hpsb_set_packet_complete_task(packet,
385 (void (*)(void *))sbp2_free_packet,
388 hpsb_node_fill_packet(ne, packet);
390 if (hpsb_send_packet(packet) < 0) {
391 sbp2_free_packet(packet);
399 * This function is called to create a pool of command orbs used for
400 * command processing. It is called when a new sbp2 device is detected.
402 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
404 struct sbp2scsi_host_info *hi = scsi_id->hi;
406 unsigned long flags, orbs;
407 struct sbp2_command_info *command;
409 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
411 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
412 for (i = 0; i < orbs; i++) {
413 command = kzalloc(sizeof(*command), GFP_ATOMIC);
415 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
419 command->command_orb_dma =
420 pci_map_single(hi->host->pdev, &command->command_orb,
421 sizeof(struct sbp2_command_orb),
422 PCI_DMA_BIDIRECTIONAL);
423 SBP2_DMA_ALLOC("single command orb DMA");
425 pci_map_single(hi->host->pdev,
426 &command->scatter_gather_element,
427 sizeof(command->scatter_gather_element),
428 PCI_DMA_BIDIRECTIONAL);
429 SBP2_DMA_ALLOC("scatter_gather_element");
430 INIT_LIST_HEAD(&command->list);
431 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
433 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
438 * This function is called to delete a pool of command orbs.
440 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
442 struct hpsb_host *host = scsi_id->hi->host;
443 struct list_head *lh, *next;
444 struct sbp2_command_info *command;
447 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
448 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
449 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
450 command = list_entry(lh, struct sbp2_command_info, list);
452 /* Release our generic DMA's */
453 pci_unmap_single(host->pdev, command->command_orb_dma,
454 sizeof(struct sbp2_command_orb),
455 PCI_DMA_BIDIRECTIONAL);
456 SBP2_DMA_FREE("single command orb DMA");
457 pci_unmap_single(host->pdev, command->sge_dma,
458 sizeof(command->scatter_gather_element),
459 PCI_DMA_BIDIRECTIONAL);
460 SBP2_DMA_FREE("scatter_gather_element");
465 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
470 * This function finds the sbp2_command for a given outstanding command
471 * orb.Only looks at the inuse list.
473 static struct sbp2_command_info *sbp2util_find_command_for_orb(
474 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
476 struct sbp2_command_info *command;
479 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
480 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
481 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
482 if (command->command_orb_dma == orb) {
483 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
488 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
490 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
496 * This function finds the sbp2_command for a given outstanding SCpnt.
497 * Only looks at the inuse list.
498 * Must be called with scsi_id->sbp2_command_orb_lock held.
500 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
501 struct scsi_id_instance_data *scsi_id, void *SCpnt)
503 struct sbp2_command_info *command;
505 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
506 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
507 if (command->Current_SCpnt == SCpnt)
513 * This function allocates a command orb used to send a scsi command.
515 static struct sbp2_command_info *sbp2util_allocate_command_orb(
516 struct scsi_id_instance_data *scsi_id,
517 struct scsi_cmnd *Current_SCpnt,
518 void (*Current_done)(struct scsi_cmnd *))
520 struct list_head *lh;
521 struct sbp2_command_info *command = NULL;
524 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
525 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
526 lh = scsi_id->sbp2_command_orb_completed.next;
528 command = list_entry(lh, struct sbp2_command_info, list);
529 command->Current_done = Current_done;
530 command->Current_SCpnt = Current_SCpnt;
531 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
533 SBP2_ERR("sbp2util_allocate_command_orb - No orbs available!");
535 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
540 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
542 struct scsi_id_instance_data *scsi_id =
543 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
544 struct hpsb_host *host;
547 printk(KERN_ERR "%s: scsi_id == NULL\n", __FUNCTION__);
551 host = scsi_id->ud->ne->host;
553 if (command->cmd_dma) {
554 if (command->dma_type == CMD_DMA_SINGLE) {
555 pci_unmap_single(host->pdev, command->cmd_dma,
556 command->dma_size, command->dma_dir);
557 SBP2_DMA_FREE("single bulk");
558 } else if (command->dma_type == CMD_DMA_PAGE) {
559 pci_unmap_page(host->pdev, command->cmd_dma,
560 command->dma_size, command->dma_dir);
561 SBP2_DMA_FREE("single page");
562 } /* XXX: Check for CMD_DMA_NONE bug */
563 command->dma_type = CMD_DMA_NONE;
564 command->cmd_dma = 0;
567 if (command->sge_buffer) {
568 pci_unmap_sg(host->pdev, command->sge_buffer,
569 command->dma_size, command->dma_dir);
570 SBP2_DMA_FREE("scatter list");
571 command->sge_buffer = NULL;
576 * This function moves a command to the completed orb list.
577 * Must be called with scsi_id->sbp2_command_orb_lock held.
579 static void sbp2util_mark_command_completed(
580 struct scsi_id_instance_data *scsi_id,
581 struct sbp2_command_info *command)
583 list_del(&command->list);
584 sbp2util_free_command_dma(command);
585 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
589 * Is scsi_id valid? Is the 1394 node still present?
591 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
593 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
596 /*********************************************
597 * IEEE-1394 core driver stack related section
598 *********************************************/
599 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
601 static int sbp2_probe(struct device *dev)
603 struct unit_directory *ud;
604 struct scsi_id_instance_data *scsi_id;
606 SBP2_DEBUG("sbp2_probe");
608 ud = container_of(dev, struct unit_directory, device);
610 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
612 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
615 scsi_id = sbp2_alloc_device(ud);
620 sbp2_parse_unit_directory(scsi_id, ud);
622 return sbp2_start_device(scsi_id);
625 static int sbp2_remove(struct device *dev)
627 struct unit_directory *ud;
628 struct scsi_id_instance_data *scsi_id;
629 struct scsi_device *sdev;
631 SBP2_DEBUG("sbp2_remove");
633 ud = container_of(dev, struct unit_directory, device);
634 scsi_id = ud->device.driver_data;
638 if (scsi_id->scsi_host) {
639 /* Get rid of enqueued commands if there is no chance to
641 if (!sbp2util_node_is_available(scsi_id))
642 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
643 /* scsi_remove_device() will trigger shutdown functions of SCSI
644 * highlevel drivers which would deadlock if blocked. */
645 scsi_unblock_requests(scsi_id->scsi_host);
647 sdev = scsi_id->sdev;
649 scsi_id->sdev = NULL;
650 scsi_remove_device(sdev);
653 sbp2_logout_device(scsi_id);
654 sbp2_remove_device(scsi_id);
659 static int sbp2_update(struct unit_directory *ud)
661 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
663 SBP2_DEBUG("sbp2_update");
665 if (sbp2_reconnect_device(scsi_id)) {
668 * Ok, reconnect has failed. Perhaps we didn't
669 * reconnect fast enough. Try doing a regular login, but
670 * first do a logout just in case of any weirdness.
672 sbp2_logout_device(scsi_id);
674 if (sbp2_login_device(scsi_id)) {
675 /* Login failed too, just fail, and the backend
676 * will call our sbp2_remove for us */
677 SBP2_ERR("Failed to reconnect to sbp2 device!");
682 /* Set max retries to something large on the device. */
683 sbp2_set_busy_timeout(scsi_id);
685 /* Do a SBP-2 fetch agent reset. */
686 sbp2_agent_reset(scsi_id, 1);
688 /* Get the max speed and packet size that we can use. */
689 sbp2_max_speed_and_size(scsi_id);
691 /* Complete any pending commands with busy (so they get
692 * retried) and remove them from our queue
694 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
696 /* Make sure we unblock requests (since this is likely after a bus
698 scsi_unblock_requests(scsi_id->scsi_host);
703 /* This functions is called by the sbp2_probe, for each new device. We now
704 * allocate one scsi host for each scsi_id (unit directory). */
705 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
707 struct sbp2scsi_host_info *hi;
708 struct Scsi_Host *scsi_host = NULL;
709 struct scsi_id_instance_data *scsi_id = NULL;
711 SBP2_DEBUG("sbp2_alloc_device");
713 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
715 SBP2_ERR("failed to create scsi_id");
719 scsi_id->ne = ud->ne;
721 scsi_id->speed_code = IEEE1394_SPEED_100;
722 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
723 atomic_set(&scsi_id->sbp2_login_complete, 0);
724 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
725 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
726 INIT_LIST_HEAD(&scsi_id->scsi_list);
727 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
728 scsi_id->sbp2_lun = 0;
730 ud->device.driver_data = scsi_id;
732 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
734 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
736 SBP2_ERR("failed to allocate hostinfo");
739 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
740 hi->host = ud->ne->host;
741 INIT_LIST_HEAD(&hi->scsi_ids);
743 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
744 /* Handle data movement if physical dma is not
745 * enabled/supportedon host controller */
746 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_physdma_ops,
747 0x0ULL, 0xfffffffcULL);
753 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
755 /* Register the status FIFO address range. We could use the same FIFO
756 * for targets at different nodes. However we need different FIFOs per
757 * target in order to support multi-unit devices.
758 * The FIFO is located out of the local host controller's physical range
759 * but, if possible, within the posted write area. Status writes will
760 * then be performed as unified transactions. This slightly reduces
761 * bandwidth usage, and some Prolific based devices seem to require it.
763 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
764 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
765 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
766 0x010000000000ULL, CSR1212_ALL_SPACE_END);
767 if (scsi_id->status_fifo_addr == ~0ULL) {
768 SBP2_ERR("failed to allocate status FIFO address range");
772 /* Register our host with the SCSI stack. */
773 scsi_host = scsi_host_alloc(&scsi_driver_template,
774 sizeof(unsigned long));
776 SBP2_ERR("failed to register scsi host");
780 scsi_host->hostdata[0] = (unsigned long)scsi_id;
782 if (!scsi_add_host(scsi_host, &ud->device)) {
783 scsi_id->scsi_host = scsi_host;
787 SBP2_ERR("failed to add scsi host");
788 scsi_host_put(scsi_host);
791 sbp2_remove_device(scsi_id);
795 static void sbp2_host_reset(struct hpsb_host *host)
797 struct sbp2scsi_host_info *hi;
798 struct scsi_id_instance_data *scsi_id;
800 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
803 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
804 scsi_block_requests(scsi_id->scsi_host);
809 * This function is where we first pull the node unique ids, and then
810 * allocate memory and register a SBP-2 device.
812 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
814 struct sbp2scsi_host_info *hi = scsi_id->hi;
817 SBP2_DEBUG("sbp2_start_device");
820 scsi_id->login_response =
821 pci_alloc_consistent(hi->host->pdev,
822 sizeof(struct sbp2_login_response),
823 &scsi_id->login_response_dma);
824 if (!scsi_id->login_response)
826 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
828 /* Query logins ORB DMA */
829 scsi_id->query_logins_orb =
830 pci_alloc_consistent(hi->host->pdev,
831 sizeof(struct sbp2_query_logins_orb),
832 &scsi_id->query_logins_orb_dma);
833 if (!scsi_id->query_logins_orb)
835 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
837 /* Query logins response DMA */
838 scsi_id->query_logins_response =
839 pci_alloc_consistent(hi->host->pdev,
840 sizeof(struct sbp2_query_logins_response),
841 &scsi_id->query_logins_response_dma);
842 if (!scsi_id->query_logins_response)
844 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
846 /* Reconnect ORB DMA */
847 scsi_id->reconnect_orb =
848 pci_alloc_consistent(hi->host->pdev,
849 sizeof(struct sbp2_reconnect_orb),
850 &scsi_id->reconnect_orb_dma);
851 if (!scsi_id->reconnect_orb)
853 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
856 scsi_id->logout_orb =
857 pci_alloc_consistent(hi->host->pdev,
858 sizeof(struct sbp2_logout_orb),
859 &scsi_id->logout_orb_dma);
860 if (!scsi_id->logout_orb)
862 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
866 pci_alloc_consistent(hi->host->pdev,
867 sizeof(struct sbp2_login_orb),
868 &scsi_id->login_orb_dma);
869 if (!scsi_id->login_orb)
871 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
873 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
876 * Create our command orb pool
878 if (sbp2util_create_command_orb_pool(scsi_id)) {
879 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
880 sbp2_remove_device(scsi_id);
884 /* Schedule a timeout here. The reason is that we may be so close
885 * to a bus reset, that the device is not available for logins.
886 * This can happen when the bus reset is caused by the host
887 * connected to the sbp2 device being removed. That host would
888 * have a certain amount of time to relogin before the sbp2 device
889 * allows someone else to login instead. One second makes sense. */
890 msleep_interruptible(1000);
891 if (signal_pending(current)) {
892 SBP2_WARN("aborting sbp2_start_device due to event");
893 sbp2_remove_device(scsi_id);
898 * Login to the sbp-2 device
900 if (sbp2_login_device(scsi_id)) {
901 /* Login failed, just remove the device. */
902 sbp2_remove_device(scsi_id);
907 * Set max retries to something large on the device
909 sbp2_set_busy_timeout(scsi_id);
912 * Do a SBP-2 fetch agent reset
914 sbp2_agent_reset(scsi_id, 1);
917 * Get the max speed and packet size that we can use
919 sbp2_max_speed_and_size(scsi_id);
921 /* Add this device to the scsi layer now */
922 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
924 SBP2_ERR("scsi_add_device failed");
925 sbp2_logout_device(scsi_id);
926 sbp2_remove_device(scsi_id);
933 SBP2_ERR("Could not allocate memory for scsi_id");
934 sbp2_remove_device(scsi_id);
939 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
941 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
943 struct sbp2scsi_host_info *hi;
945 SBP2_DEBUG("sbp2_remove_device");
952 /* This will remove our scsi device aswell */
953 if (scsi_id->scsi_host) {
954 scsi_remove_host(scsi_id->scsi_host);
955 scsi_host_put(scsi_id->scsi_host);
958 sbp2util_remove_command_orb_pool(scsi_id);
960 list_del(&scsi_id->scsi_list);
962 if (scsi_id->login_response) {
963 pci_free_consistent(hi->host->pdev,
964 sizeof(struct sbp2_login_response),
965 scsi_id->login_response,
966 scsi_id->login_response_dma);
967 SBP2_DMA_FREE("single login FIFO");
970 if (scsi_id->login_orb) {
971 pci_free_consistent(hi->host->pdev,
972 sizeof(struct sbp2_login_orb),
974 scsi_id->login_orb_dma);
975 SBP2_DMA_FREE("single login ORB");
978 if (scsi_id->reconnect_orb) {
979 pci_free_consistent(hi->host->pdev,
980 sizeof(struct sbp2_reconnect_orb),
981 scsi_id->reconnect_orb,
982 scsi_id->reconnect_orb_dma);
983 SBP2_DMA_FREE("single reconnect orb");
986 if (scsi_id->logout_orb) {
987 pci_free_consistent(hi->host->pdev,
988 sizeof(struct sbp2_logout_orb),
990 scsi_id->logout_orb_dma);
991 SBP2_DMA_FREE("single logout orb");
994 if (scsi_id->query_logins_orb) {
995 pci_free_consistent(hi->host->pdev,
996 sizeof(struct sbp2_query_logins_orb),
997 scsi_id->query_logins_orb,
998 scsi_id->query_logins_orb_dma);
999 SBP2_DMA_FREE("single query logins orb");
1002 if (scsi_id->query_logins_response) {
1003 pci_free_consistent(hi->host->pdev,
1004 sizeof(struct sbp2_query_logins_response),
1005 scsi_id->query_logins_response,
1006 scsi_id->query_logins_response_dma);
1007 SBP2_DMA_FREE("single query logins data");
1010 if (scsi_id->status_fifo_addr)
1011 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1012 scsi_id->status_fifo_addr);
1014 scsi_id->ud->device.driver_data = NULL;
1016 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1021 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1023 * This function deals with physical dma write requests (for adapters that do not support
1024 * physical dma in hardware). Mostly just here for debugging...
1026 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1027 int destid, quadlet_t *data, u64 addr,
1028 size_t length, u16 flags)
1032 * Manually put the data in the right place.
1034 memcpy(bus_to_virt((u32) addr), data, length);
1035 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1037 return RCODE_COMPLETE;
1041 * This function deals with physical dma read requests (for adapters that do not support
1042 * physical dma in hardware). Mostly just here for debugging...
1044 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1045 quadlet_t *data, u64 addr, size_t length,
1050 * Grab data from memory and send a read response.
1052 memcpy(data, bus_to_virt((u32) addr), length);
1053 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1055 return RCODE_COMPLETE;
1059 /**************************************
1060 * SBP-2 protocol related section
1061 **************************************/
1064 * This function queries the device for the maximum concurrent logins it
1067 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1069 struct sbp2scsi_host_info *hi = scsi_id->hi;
1074 SBP2_DEBUG("sbp2_query_logins");
1076 scsi_id->query_logins_orb->reserved1 = 0x0;
1077 scsi_id->query_logins_orb->reserved2 = 0x0;
1079 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1080 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1081 SBP2_DEBUG("sbp2_query_logins: query_response_hi/lo initialized");
1083 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1084 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1085 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1086 SBP2_DEBUG("sbp2_query_logins: lun_misc initialized");
1088 scsi_id->query_logins_orb->reserved_resp_length =
1089 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1090 SBP2_DEBUG("sbp2_query_logins: reserved_resp_length initialized");
1092 scsi_id->query_logins_orb->status_fifo_hi =
1093 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1094 scsi_id->query_logins_orb->status_fifo_lo =
1095 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1097 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1099 SBP2_DEBUG("sbp2_query_logins: orb byte-swapped");
1101 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1102 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1104 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1105 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1107 SBP2_DEBUG("sbp2_query_logins: query_logins_response/status FIFO memset");
1109 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1110 data[1] = scsi_id->query_logins_orb_dma;
1111 sbp2util_cpu_to_be32_buffer(data, 8);
1113 atomic_set(&scsi_id->sbp2_login_complete, 0);
1115 SBP2_DEBUG("sbp2_query_logins: prepared to write");
1116 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1117 SBP2_DEBUG("sbp2_query_logins: written");
1119 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1120 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1124 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1125 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1129 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1130 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1131 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1133 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1137 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1139 SBP2_DEBUG("length_max_logins = %x",
1140 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1142 SBP2_DEBUG("Query logins to SBP-2 device successful");
1144 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1145 SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1147 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1148 SBP2_DEBUG("Number of active logins: %d", active_logins);
1150 if (active_logins >= max_logins) {
1158 * This function is called in order to login to a particular SBP-2 device,
1159 * after a bus reset.
1161 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1163 struct sbp2scsi_host_info *hi = scsi_id->hi;
1166 SBP2_DEBUG("sbp2_login_device");
1168 if (!scsi_id->login_orb) {
1169 SBP2_DEBUG("sbp2_login_device: login_orb not alloc'd!");
1173 if (!exclusive_login) {
1174 if (sbp2_query_logins(scsi_id)) {
1175 SBP2_INFO("Device does not support any more concurrent logins");
1180 /* Set-up login ORB, assume no password */
1181 scsi_id->login_orb->password_hi = 0;
1182 scsi_id->login_orb->password_lo = 0;
1183 SBP2_DEBUG("sbp2_login_device: password_hi/lo initialized");
1185 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1186 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1187 SBP2_DEBUG("sbp2_login_device: login_response_hi/lo initialized");
1189 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1190 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1191 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1192 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1193 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1194 SBP2_DEBUG("sbp2_login_device: lun_misc initialized");
1196 scsi_id->login_orb->passwd_resp_lengths =
1197 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1198 SBP2_DEBUG("sbp2_login_device: passwd_resp_lengths initialized");
1200 scsi_id->login_orb->status_fifo_hi =
1201 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1202 scsi_id->login_orb->status_fifo_lo =
1203 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1206 * Byte swap ORB if necessary
1208 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1210 SBP2_DEBUG("sbp2_login_device: orb byte-swapped");
1212 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1213 "sbp2 login orb", scsi_id->login_orb_dma);
1216 * Initialize login response and status fifo
1218 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1219 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1221 SBP2_DEBUG("sbp2_login_device: login_response/status FIFO memset");
1224 * Ok, let's write to the target's management agent register
1226 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1227 data[1] = scsi_id->login_orb_dma;
1228 sbp2util_cpu_to_be32_buffer(data, 8);
1230 atomic_set(&scsi_id->sbp2_login_complete, 0);
1232 SBP2_DEBUG("sbp2_login_device: prepared to write to %08x",
1233 (unsigned int)scsi_id->sbp2_management_agent_addr);
1234 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1235 SBP2_DEBUG("sbp2_login_device: written");
1238 * Wait for login status (up to 20 seconds)...
1240 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1241 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1246 * Sanity. Make sure status returned matches login orb.
1248 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1249 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1256 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1257 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1258 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1260 SBP2_ERR("Error logging into SBP-2 device - login failed");
1265 * Byte swap the login response, for use when reconnecting or
1268 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1271 * Grab our command block agent address from the login response.
1273 SBP2_DEBUG("command_block_agent_hi = %x",
1274 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1275 SBP2_DEBUG("command_block_agent_lo = %x",
1276 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1278 scsi_id->sbp2_command_block_agent_addr =
1279 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1280 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1281 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1283 SBP2_INFO("Logged into SBP-2 device");
1290 * This function is called in order to logout from a particular SBP-2
1291 * device, usually called during driver unload.
1293 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1295 struct sbp2scsi_host_info *hi = scsi_id->hi;
1299 SBP2_DEBUG("sbp2_logout_device");
1304 scsi_id->logout_orb->reserved1 = 0x0;
1305 scsi_id->logout_orb->reserved2 = 0x0;
1306 scsi_id->logout_orb->reserved3 = 0x0;
1307 scsi_id->logout_orb->reserved4 = 0x0;
1309 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1310 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1312 /* Notify us when complete */
1313 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1315 scsi_id->logout_orb->reserved5 = 0x0;
1316 scsi_id->logout_orb->status_fifo_hi =
1317 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1318 scsi_id->logout_orb->status_fifo_lo =
1319 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1322 * Byte swap ORB if necessary
1324 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1326 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1327 "sbp2 logout orb", scsi_id->logout_orb_dma);
1330 * Ok, let's write to the target's management agent register
1332 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1333 data[1] = scsi_id->logout_orb_dma;
1334 sbp2util_cpu_to_be32_buffer(data, 8);
1336 atomic_set(&scsi_id->sbp2_login_complete, 0);
1338 error = hpsb_node_write(scsi_id->ne,
1339 scsi_id->sbp2_management_agent_addr, data, 8);
1343 /* Wait for device to logout...1 second. */
1344 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1347 SBP2_INFO("Logged out of SBP-2 device");
1354 * This function is called in order to reconnect to a particular SBP-2
1355 * device, after a bus reset.
1357 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1359 struct sbp2scsi_host_info *hi = scsi_id->hi;
1363 SBP2_DEBUG("sbp2_reconnect_device");
1366 * Set-up reconnect ORB
1368 scsi_id->reconnect_orb->reserved1 = 0x0;
1369 scsi_id->reconnect_orb->reserved2 = 0x0;
1370 scsi_id->reconnect_orb->reserved3 = 0x0;
1371 scsi_id->reconnect_orb->reserved4 = 0x0;
1373 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1374 scsi_id->reconnect_orb->login_ID_misc |=
1375 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1377 /* Notify us when complete */
1378 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1380 scsi_id->reconnect_orb->reserved5 = 0x0;
1381 scsi_id->reconnect_orb->status_fifo_hi =
1382 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1383 scsi_id->reconnect_orb->status_fifo_lo =
1384 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1387 * Byte swap ORB if necessary
1389 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1391 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1392 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1395 * Initialize status fifo
1397 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1400 * Ok, let's write to the target's management agent register
1402 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1403 data[1] = scsi_id->reconnect_orb_dma;
1404 sbp2util_cpu_to_be32_buffer(data, 8);
1406 atomic_set(&scsi_id->sbp2_login_complete, 0);
1408 error = hpsb_node_write(scsi_id->ne,
1409 scsi_id->sbp2_management_agent_addr, data, 8);
1414 * Wait for reconnect status (up to 1 second)...
1416 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1417 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1422 * Sanity. Make sure status returned matches reconnect orb.
1424 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1425 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1432 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1433 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1434 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1436 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1440 HPSB_DEBUG("Reconnected to SBP-2 device");
1447 * This function is called in order to set the busy timeout (number of
1448 * retries to attempt) on the sbp2 device.
1450 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1454 SBP2_DEBUG("sbp2_set_busy_timeout");
1457 * Ok, let's write to the target's busy timeout register
1459 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1461 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4)) {
1462 SBP2_ERR("sbp2_set_busy_timeout error");
1469 * This function is called to parse sbp2 device's config rom unit
1470 * directory. Used to determine things like sbp2 management agent offset,
1471 * and command set used (SCSI or RBC).
1473 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1474 struct unit_directory *ud)
1476 struct csr1212_keyval *kv;
1477 struct csr1212_dentry *dentry;
1478 u64 management_agent_addr;
1479 u32 command_set_spec_id, command_set, unit_characteristics,
1480 firmware_revision, workarounds;
1483 SBP2_DEBUG("sbp2_parse_unit_directory");
1485 management_agent_addr = 0x0;
1486 command_set_spec_id = 0x0;
1488 unit_characteristics = 0x0;
1489 firmware_revision = 0x0;
1491 /* Handle different fields in the unit directory, based on keys */
1492 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1493 switch (kv->key.id) {
1494 case CSR1212_KV_ID_DEPENDENT_INFO:
1495 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1496 /* Save off the management agent address */
1497 management_agent_addr =
1498 CSR1212_REGISTER_SPACE_BASE +
1499 (kv->value.csr_offset << 2);
1501 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1502 (unsigned int)management_agent_addr);
1503 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1505 ORB_SET_LUN(kv->value.immediate);
1509 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1510 /* Command spec organization */
1511 command_set_spec_id = kv->value.immediate;
1512 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1513 (unsigned int)command_set_spec_id);
1516 case SBP2_COMMAND_SET_KEY:
1517 /* Command set used by sbp2 device */
1518 command_set = kv->value.immediate;
1519 SBP2_DEBUG("sbp2_command_set = %x",
1520 (unsigned int)command_set);
1523 case SBP2_UNIT_CHARACTERISTICS_KEY:
1525 * Unit characterisitcs (orb related stuff
1526 * that I'm not yet paying attention to)
1528 unit_characteristics = kv->value.immediate;
1529 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1530 (unsigned int)unit_characteristics);
1533 case SBP2_FIRMWARE_REVISION_KEY:
1534 /* Firmware revision */
1535 firmware_revision = kv->value.immediate;
1536 if (force_inquiry_hack)
1537 SBP2_INFO("sbp2_firmware_revision = %x",
1538 (unsigned int)firmware_revision);
1540 SBP2_DEBUG("sbp2_firmware_revision = %x",
1541 (unsigned int)firmware_revision);
1549 /* This is the start of our broken device checking. We try to hack
1550 * around oddities and known defects. */
1553 /* If the vendor id is 0xa0b8 (Symbios vendor id), then we have a
1554 * bridge with 128KB max transfer size limitation. For sanity, we
1555 * only voice this when the current max_sectors setting
1556 * exceeds the 128k limit. By default, that is not the case.
1558 * It would be really nice if we could detect this before the scsi
1559 * host gets initialized. That way we can down-force the
1560 * max_sectors to account for it. That is not currently
1562 if ((firmware_revision & 0xffff00) ==
1563 SBP2_128KB_BROKEN_FIRMWARE &&
1564 (max_sectors * 512) > (128*1024)) {
1565 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB max transfer size.",
1566 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1567 SBP2_WARN("WARNING: Current max_sectors setting is larger than 128KB (%d sectors)!",
1569 workarounds |= SBP2_BREAKAGE_128K_MAX_TRANSFER;
1572 /* Check for a blacklisted set of devices that require us to force
1573 * a 36 byte host inquiry. This can be overriden as a module param
1574 * (to force all hosts). */
1575 for (i = 0; i < ARRAY_SIZE(sbp2_broken_inquiry_list); i++) {
1576 if ((firmware_revision & 0xffff00) ==
1577 sbp2_broken_inquiry_list[i]) {
1578 SBP2_WARN("Node " NODE_BUS_FMT ": Using 36byte inquiry workaround",
1579 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1580 workarounds |= SBP2_BREAKAGE_INQUIRY_HACK;
1581 break; /* No need to continue. */
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);
1604 * This function is called in order to determine the max speed and packet
1605 * size we can use in our ORBs. Note, that we (the driver and host) only
1606 * initiate the transaction. The SBP-2 device actually transfers the data
1607 * (by reading from the DMA area we tell it). This means that the SBP-2
1608 * device decides the actual maximum data it can transfer. We just tell it
1609 * the speed that it needs to use, and the max_rec the host supports, and
1610 * it takes care of the rest.
1612 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1614 struct sbp2scsi_host_info *hi = scsi_id->hi;
1616 SBP2_DEBUG("sbp2_max_speed_and_size");
1618 /* Initial setting comes from the hosts speed map */
1619 scsi_id->speed_code =
1620 hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64 +
1621 NODEID_TO_NODE(scsi_id->ne->nodeid)];
1623 /* Bump down our speed if the user requested it */
1624 if (scsi_id->speed_code > max_speed) {
1625 scsi_id->speed_code = max_speed;
1626 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1627 hpsb_speedto_str[scsi_id->speed_code]);
1630 /* Payload size is the lesser of what our speed supports and what
1631 * our host supports. */
1632 scsi_id->max_payload_size =
1633 min(sbp2_speedto_max_payload[scsi_id->speed_code],
1634 (u8) (hi->host->csr.max_rec - 1));
1636 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1637 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1638 hpsb_speedto_str[scsi_id->speed_code],
1639 1 << ((u32) scsi_id->max_payload_size + 2));
1645 * This function is called in order to perform a SBP-2 agent reset.
1647 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1653 SBP2_DEBUG("sbp2_agent_reset");
1656 * Ok, let's write to the target's management agent register
1658 data = ntohl(SBP2_AGENT_RESET_DATA);
1659 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1662 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1664 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1667 SBP2_ERR("hpsb_node_write failed.\n");
1672 * Need to make sure orb pointer is written on next command
1674 scsi_id->last_orb = NULL;
1679 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1680 struct sbp2scsi_host_info *hi,
1681 struct sbp2_command_info *command,
1682 unsigned int scsi_use_sg,
1683 struct scatterlist *sgpnt,
1685 enum dma_data_direction dma_dir)
1687 command->dma_dir = dma_dir;
1688 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1689 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1691 /* Special case if only one element (and less than 64KB in size) */
1692 if ((scsi_use_sg == 1) &&
1693 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1695 SBP2_DEBUG("Only one s/g element");
1696 command->dma_size = sgpnt[0].length;
1697 command->dma_type = CMD_DMA_PAGE;
1698 command->cmd_dma = pci_map_page(hi->host->pdev,
1703 SBP2_DMA_ALLOC("single page scatter element");
1705 orb->data_descriptor_lo = command->cmd_dma;
1706 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1709 struct sbp2_unrestricted_page_table *sg_element =
1710 &command->scatter_gather_element[0];
1711 u32 sg_count, sg_len;
1713 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1716 SBP2_DMA_ALLOC("scatter list");
1718 command->dma_size = scsi_use_sg;
1719 command->sge_buffer = sgpnt;
1721 /* use page tables (s/g) */
1722 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1723 orb->data_descriptor_lo = command->sge_dma;
1726 * Loop through and fill out our sbp-2 page tables
1727 * (and split up anything too large)
1729 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1730 sg_len = sg_dma_len(sgpnt);
1731 sg_addr = sg_dma_address(sgpnt);
1733 sg_element[sg_count].segment_base_lo = sg_addr;
1734 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1735 sg_element[sg_count].length_segment_base_hi =
1736 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1737 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1738 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1740 sg_element[sg_count].length_segment_base_hi =
1741 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1748 /* Number of page table (s/g) elements */
1749 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1751 sbp2util_packet_dump(sg_element,
1752 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1753 "sbp2 s/g list", command->sge_dma);
1755 /* Byte swap page tables if necessary */
1756 sbp2util_cpu_to_be32_buffer(sg_element,
1757 (sizeof(struct sbp2_unrestricted_page_table)) *
1762 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1763 struct sbp2scsi_host_info *hi,
1764 struct sbp2_command_info *command,
1765 struct scatterlist *sgpnt,
1767 unsigned int scsi_request_bufflen,
1768 void *scsi_request_buffer,
1769 enum dma_data_direction dma_dir)
1771 command->dma_dir = dma_dir;
1772 command->dma_size = scsi_request_bufflen;
1773 command->dma_type = CMD_DMA_SINGLE;
1774 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1775 command->dma_size, command->dma_dir);
1776 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1777 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1779 SBP2_DMA_ALLOC("single bulk");
1782 * Handle case where we get a command w/o s/g enabled (but
1783 * check for transfers larger than 64K)
1785 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1787 orb->data_descriptor_lo = command->cmd_dma;
1788 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1791 struct sbp2_unrestricted_page_table *sg_element =
1792 &command->scatter_gather_element[0];
1793 u32 sg_count, sg_len;
1797 * Need to turn this into page tables, since the
1798 * buffer is too large.
1800 orb->data_descriptor_lo = command->sge_dma;
1802 /* Use page tables (s/g) */
1803 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1806 * fill out our sbp-2 page tables (and split up
1810 sg_len = scsi_request_bufflen;
1811 sg_addr = command->cmd_dma;
1813 sg_element[sg_count].segment_base_lo = sg_addr;
1814 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1815 sg_element[sg_count].length_segment_base_hi =
1816 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1817 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1818 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1820 sg_element[sg_count].length_segment_base_hi =
1821 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1827 /* Number of page table (s/g) elements */
1828 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1830 sbp2util_packet_dump(sg_element,
1831 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1832 "sbp2 s/g list", command->sge_dma);
1834 /* Byte swap page tables if necessary */
1835 sbp2util_cpu_to_be32_buffer(sg_element,
1836 (sizeof(struct sbp2_unrestricted_page_table)) *
1842 * This function is called to create the actual command orb and s/g list
1843 * out of the scsi command itself.
1845 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1846 struct sbp2_command_info *command,
1848 unsigned int scsi_use_sg,
1849 unsigned int scsi_request_bufflen,
1850 void *scsi_request_buffer,
1851 enum dma_data_direction dma_dir)
1853 struct sbp2scsi_host_info *hi = scsi_id->hi;
1854 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1855 struct sbp2_command_orb *command_orb = &command->command_orb;
1859 * Set-up our command ORB..
1861 * NOTE: We're doing unrestricted page tables (s/g), as this is
1862 * best performance (at least with the devices I have). This means
1863 * that data_size becomes the number of s/g elements, and
1864 * page_size should be zero (for unrestricted).
1866 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1867 command_orb->next_ORB_lo = 0x0;
1868 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1869 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1870 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1872 if (dma_dir == DMA_NONE)
1873 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1874 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1875 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1876 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1877 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1879 SBP2_WARN("Falling back to DMA_NONE");
1880 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1883 /* Set-up our pagetable stuff */
1884 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1885 SBP2_DEBUG("No data transfer");
1886 command_orb->data_descriptor_hi = 0x0;
1887 command_orb->data_descriptor_lo = 0x0;
1888 command_orb->misc |= ORB_SET_DIRECTION(1);
1889 } else if (scsi_use_sg) {
1890 SBP2_DEBUG("Use scatter/gather");
1891 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1892 sgpnt, orb_direction, dma_dir);
1894 SBP2_DEBUG("No scatter/gather");
1895 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1896 orb_direction, scsi_request_bufflen,
1897 scsi_request_buffer, dma_dir);
1900 /* Byte swap command ORB if necessary */
1901 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1903 /* Put our scsi command in the command ORB */
1904 memset(command_orb->cdb, 0, 12);
1905 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1909 * This function is called in order to begin a regular SBP-2 command.
1911 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1912 struct sbp2_command_info *command)
1914 struct sbp2scsi_host_info *hi = scsi_id->hi;
1915 struct sbp2_command_orb *command_orb = &command->command_orb;
1916 struct node_entry *ne = scsi_id->ne;
1919 outstanding_orb_incr;
1920 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1921 command_orb, global_outstanding_command_orbs);
1923 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1924 sizeof(struct sbp2_command_orb),
1925 PCI_DMA_BIDIRECTIONAL);
1926 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1927 sizeof(command->scatter_gather_element),
1928 PCI_DMA_BIDIRECTIONAL);
1930 * Check to see if there are any previous orbs to use
1932 if (scsi_id->last_orb == NULL) {
1936 * Ok, let's write to the target's management agent register
1938 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
1939 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1940 data[1] = command->command_orb_dma;
1941 sbp2util_cpu_to_be32_buffer(data, 8);
1943 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
1945 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
1946 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1950 SBP2_ORB_DEBUG("write command agent complete");
1952 scsi_id->last_orb = command_orb;
1953 scsi_id->last_orb_dma = command->command_orb_dma;
1959 * We have an orb already sent (maybe or maybe not
1960 * processed) that we can append this orb to. So do so,
1961 * and ring the doorbell. Have to be very careful
1962 * modifying these next orb pointers, as they are accessed
1963 * both by the sbp2 device and us.
1965 scsi_id->last_orb->next_ORB_lo =
1966 cpu_to_be32(command->command_orb_dma);
1967 /* Tells hardware that this pointer is valid */
1968 scsi_id->last_orb->next_ORB_hi = 0x0;
1969 pci_dma_sync_single_for_device(hi->host->pdev,
1970 scsi_id->last_orb_dma,
1971 sizeof(struct sbp2_command_orb),
1972 PCI_DMA_BIDIRECTIONAL);
1977 data = cpu_to_be32(command->command_orb_dma);
1978 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
1980 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
1982 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
1983 SBP2_ERR("sbp2util_node_write_no_wait failed");
1987 scsi_id->last_orb = command_orb;
1988 scsi_id->last_orb_dma = command->command_orb_dma;
1995 * This function is called in order to begin a regular SBP-2 command.
1997 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
1998 struct scsi_cmnd *SCpnt,
1999 void (*done)(struct scsi_cmnd *))
2001 unchar *cmd = (unchar *) SCpnt->cmnd;
2002 unsigned int request_bufflen = SCpnt->request_bufflen;
2003 struct sbp2_command_info *command;
2005 SBP2_DEBUG("sbp2_send_command");
2006 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2007 printk("[scsi command]\n ");
2008 scsi_print_command(SCpnt);
2010 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2011 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2014 * Allocate a command orb and s/g structure
2016 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2022 * Now actually fill in the comamnd orb and sbp2 s/g list
2024 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2025 request_bufflen, SCpnt->request_buffer,
2026 SCpnt->sc_data_direction);
2028 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2029 "sbp2 command orb", command->command_orb_dma);
2032 * Initialize status fifo
2034 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2037 * Link up the orb, and ring the doorbell if needed
2039 sbp2_link_orb_command(scsi_id, command);
2045 * Translates SBP-2 status into SCSI sense data for check conditions
2047 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2049 SBP2_DEBUG("sbp2_status_to_sense_data");
2052 * Ok, it's pretty ugly... ;-)
2054 sense_data[0] = 0x70;
2055 sense_data[1] = 0x0;
2056 sense_data[2] = sbp2_status[9];
2057 sense_data[3] = sbp2_status[12];
2058 sense_data[4] = sbp2_status[13];
2059 sense_data[5] = sbp2_status[14];
2060 sense_data[6] = sbp2_status[15];
2062 sense_data[8] = sbp2_status[16];
2063 sense_data[9] = sbp2_status[17];
2064 sense_data[10] = sbp2_status[18];
2065 sense_data[11] = sbp2_status[19];
2066 sense_data[12] = sbp2_status[10];
2067 sense_data[13] = sbp2_status[11];
2068 sense_data[14] = sbp2_status[20];
2069 sense_data[15] = sbp2_status[21];
2071 return sbp2_status[8] & 0x3f; /* return scsi status */
2075 * This function is called after a command is completed, in order to do any necessary SBP-2
2076 * response data translations for the SCSI stack
2078 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2079 struct scsi_cmnd *SCpnt)
2081 u8 *scsi_buf = SCpnt->request_buffer;
2083 SBP2_DEBUG("sbp2_check_sbp2_response");
2085 if (SCpnt->cmnd[0] == INQUIRY && (SCpnt->cmnd[1] & 3) == 0) {
2087 * Make sure data length is ok. Minimum length is 36 bytes
2089 if (scsi_buf[4] == 0) {
2090 scsi_buf[4] = 36 - 5;
2094 * Fix ansi revision and response data format
2097 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2102 * This function deals with status writes from the SBP-2 device
2104 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2105 quadlet_t *data, u64 addr, size_t length, u16 fl)
2107 struct sbp2scsi_host_info *hi;
2108 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2109 struct scsi_cmnd *SCpnt = NULL;
2110 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2111 struct sbp2_command_info *command;
2112 unsigned long flags;
2114 SBP2_DEBUG("sbp2_handle_status_write");
2116 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2119 SBP2_ERR("host is NULL - this is bad!");
2120 return RCODE_ADDRESS_ERROR;
2123 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2126 SBP2_ERR("host info is NULL - this is bad!");
2127 return RCODE_ADDRESS_ERROR;
2131 * Find our scsi_id structure by looking at the status fifo address
2132 * written to by the sbp2 device.
2134 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2135 if (scsi_id_tmp->ne->nodeid == nodeid &&
2136 scsi_id_tmp->status_fifo_addr == addr) {
2137 scsi_id = scsi_id_tmp;
2143 SBP2_ERR("scsi_id is NULL - device is gone?");
2144 return RCODE_ADDRESS_ERROR;
2148 * Put response into scsi_id status fifo...
2150 memcpy(&scsi_id->status_block, data, length);
2153 * Byte swap first two quadlets (8 bytes) of status for processing
2155 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2158 * Handle command ORB status here if necessary. First, need to match status with command.
2160 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2163 SBP2_DEBUG("Found status for command ORB");
2164 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2165 sizeof(struct sbp2_command_orb),
2166 PCI_DMA_BIDIRECTIONAL);
2167 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2168 sizeof(command->scatter_gather_element),
2169 PCI_DMA_BIDIRECTIONAL);
2171 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2172 outstanding_orb_decr;
2175 * Matched status with command, now grab scsi command pointers and check status
2177 SCpnt = command->Current_SCpnt;
2178 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2179 sbp2util_mark_command_completed(scsi_id, command);
2180 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2185 * See if the target stored any scsi status information
2187 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2189 * Translate SBP-2 status to SCSI sense data
2191 SBP2_DEBUG("CHECK CONDITION");
2192 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2196 * Check to see if the dead bit is set. If so, we'll have to initiate
2197 * a fetch agent reset.
2199 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2202 * Initiate a fetch agent reset.
2204 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2205 sbp2_agent_reset(scsi_id, 0);
2208 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2212 * Check here to see if there are no commands in-use. If there are none, we can
2213 * null out last orb so that next time around we write directly to the orb pointer...
2214 * Quick start saves one 1394 bus transaction.
2216 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2217 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2218 scsi_id->last_orb = NULL;
2220 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2225 * It's probably a login/logout/reconnect status.
2227 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2228 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2229 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2230 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2231 atomic_set(&scsi_id->sbp2_login_complete, 1);
2237 /* Complete the SCSI command. */
2238 SBP2_DEBUG("Completing SCSI command");
2239 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2240 command->Current_done);
2241 SBP2_ORB_DEBUG("command orb completed");
2244 return RCODE_COMPLETE;
2247 /**************************************
2248 * SCSI interface related section
2249 **************************************/
2252 * This routine is the main request entry routine for doing I/O. It is
2253 * called from the scsi stack directly.
2255 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2256 void (*done)(struct scsi_cmnd *))
2258 struct scsi_id_instance_data *scsi_id =
2259 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2260 struct sbp2scsi_host_info *hi;
2261 int result = DID_NO_CONNECT << 16;
2263 SBP2_DEBUG("sbp2scsi_queuecommand");
2265 if (!sbp2util_node_is_available(scsi_id))
2271 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2276 * Until we handle multiple luns, just return selection time-out
2277 * to any IO directed at non-zero LUNs
2279 if (SCpnt->device->lun)
2283 * Check for request sense command, and handle it here
2284 * (autorequest sense)
2286 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2287 SBP2_DEBUG("REQUEST_SENSE");
2288 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2289 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2290 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2295 * Check to see if we are in the middle of a bus reset.
2297 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2298 SBP2_ERR("Bus reset in progress - rejecting command");
2299 result = DID_BUS_BUSY << 16;
2304 * Bidirectional commands are not yet implemented,
2305 * and unknown transfer direction not handled.
2307 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2308 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2309 result = DID_ERROR << 16;
2314 * Try and send our SCSI command
2316 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2317 SBP2_ERR("Error sending SCSI command");
2318 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2324 SCpnt->result = result;
2330 * This function is called in order to complete all outstanding SBP-2
2331 * commands (in case of resets, etc.).
2333 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2336 struct sbp2scsi_host_info *hi = scsi_id->hi;
2337 struct list_head *lh;
2338 struct sbp2_command_info *command;
2339 unsigned long flags;
2341 SBP2_DEBUG("sbp2scsi_complete_all_commands");
2343 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2344 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2345 SBP2_DEBUG("Found pending command to complete");
2346 lh = scsi_id->sbp2_command_orb_inuse.next;
2347 command = list_entry(lh, struct sbp2_command_info, list);
2348 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2349 sizeof(struct sbp2_command_orb),
2350 PCI_DMA_BIDIRECTIONAL);
2351 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2352 sizeof(command->scatter_gather_element),
2353 PCI_DMA_BIDIRECTIONAL);
2354 sbp2util_mark_command_completed(scsi_id, command);
2355 if (command->Current_SCpnt) {
2356 command->Current_SCpnt->result = status << 16;
2357 command->Current_done(command->Current_SCpnt);
2360 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2366 * This function is called in order to complete a regular SBP-2 command.
2368 * This can be called in interrupt context.
2370 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2371 u32 scsi_status, struct scsi_cmnd *SCpnt,
2372 void (*done)(struct scsi_cmnd *))
2374 SBP2_DEBUG("sbp2scsi_complete_command");
2380 SBP2_ERR("SCpnt is NULL");
2385 * If a bus reset is in progress and there was an error, don't
2386 * complete the command, just let it get retried at the end of the
2389 if (!hpsb_node_entry_valid(scsi_id->ne)
2390 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2391 SBP2_ERR("Bus reset in progress - retry command later");
2396 * Switch on scsi status
2398 switch (scsi_status) {
2399 case SBP2_SCSI_STATUS_GOOD:
2400 SCpnt->result = DID_OK;
2403 case SBP2_SCSI_STATUS_BUSY:
2404 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2405 SCpnt->result = DID_BUS_BUSY << 16;
2408 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2409 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2410 SCpnt->result = CHECK_CONDITION << 1;
2415 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2416 scsi_print_command(SCpnt);
2417 scsi_print_sense("bh", SCpnt);
2422 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2423 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2424 SCpnt->result = DID_NO_CONNECT << 16;
2425 scsi_print_command(SCpnt);
2428 case SBP2_SCSI_STATUS_CONDITION_MET:
2429 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2430 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2431 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2432 SCpnt->result = DID_ERROR << 16;
2433 scsi_print_command(SCpnt);
2437 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2438 SCpnt->result = DID_ERROR << 16;
2442 * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2444 if (SCpnt->result == DID_OK) {
2445 sbp2_check_sbp2_response(scsi_id, SCpnt);
2449 * If a bus reset is in progress and there was an error, complete
2450 * the command as busy so that it will get retried.
2452 if (!hpsb_node_entry_valid(scsi_id->ne)
2453 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2454 SBP2_ERR("Completing command with busy (bus reset)");
2455 SCpnt->result = DID_BUS_BUSY << 16;
2459 * If a unit attention occurs, return busy status so it gets
2460 * retried... it could have happened because of a 1394 bus reset
2464 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2465 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2466 SBP2_DEBUG("UNIT ATTENTION - return busy");
2467 SCpnt->result = DID_BUS_BUSY << 16;
2472 * Tell scsi stack that we're done with this command
2477 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2479 struct scsi_id_instance_data *scsi_id =
2480 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2482 scsi_id->sdev = sdev;
2484 if (force_inquiry_hack ||
2485 scsi_id->workarounds & SBP2_BREAKAGE_INQUIRY_HACK) {
2486 sdev->inquiry_len = 36;
2487 sdev->skip_ms_page_8 = 1;
2492 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2494 struct scsi_id_instance_data *scsi_id =
2495 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2497 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2498 sdev->use_10_for_rw = 1;
2499 sdev->use_10_for_ms = 1;
2501 if ((scsi_id->sbp2_firmware_revision & 0xffff00) == 0x0a2700 &&
2502 (scsi_id->ud->model_id == 0x000021 /* gen.4 iPod */ ||
2503 scsi_id->ud->model_id == 0x000023 /* iPod mini */ ||
2504 scsi_id->ud->model_id == 0x00007e /* iPod Photo */ )) {
2505 SBP2_INFO("enabling iPod workaround: decrement disk capacity");
2506 sdev->fix_capacity = 1;
2508 if (scsi_id->ne->guid_vendor_id == 0x0010b9 && /* Maxtor's OUI */
2509 (sdev->type == TYPE_DISK || sdev->type == TYPE_RBC))
2510 sdev->allow_restart = 1;
2514 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2516 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2521 * Called by scsi stack when something has really gone wrong. Usually
2522 * called when a command has timed-out for some reason.
2524 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2526 struct scsi_id_instance_data *scsi_id =
2527 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2528 struct sbp2scsi_host_info *hi = scsi_id->hi;
2529 struct sbp2_command_info *command;
2530 unsigned long flags;
2532 SBP2_ERR("aborting sbp2 command");
2533 scsi_print_command(SCpnt);
2535 if (sbp2util_node_is_available(scsi_id)) {
2538 * Right now, just return any matching command structures
2541 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2542 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2544 SBP2_DEBUG("Found command to abort");
2545 pci_dma_sync_single_for_cpu(hi->host->pdev,
2546 command->command_orb_dma,
2547 sizeof(struct sbp2_command_orb),
2548 PCI_DMA_BIDIRECTIONAL);
2549 pci_dma_sync_single_for_cpu(hi->host->pdev,
2551 sizeof(command->scatter_gather_element),
2552 PCI_DMA_BIDIRECTIONAL);
2553 sbp2util_mark_command_completed(scsi_id, command);
2554 if (command->Current_SCpnt) {
2555 command->Current_SCpnt->result = DID_ABORT << 16;
2556 command->Current_done(command->Current_SCpnt);
2559 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2562 * Initiate a fetch agent reset.
2564 sbp2_agent_reset(scsi_id, 0);
2565 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2572 * Called by scsi stack when something has really gone wrong.
2574 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2576 struct scsi_id_instance_data *scsi_id =
2577 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2579 SBP2_ERR("reset requested");
2581 if (sbp2util_node_is_available(scsi_id)) {
2582 SBP2_ERR("Generating sbp2 fetch agent reset");
2583 sbp2_agent_reset(scsi_id, 0);
2589 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2590 struct device_attribute *attr,
2593 struct scsi_device *sdev;
2594 struct scsi_id_instance_data *scsi_id;
2597 if (!(sdev = to_scsi_device(dev)))
2600 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2603 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2605 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2606 scsi_id->ud->id, lun);
2608 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2610 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2611 &dev_attr_ieee1394_id,
2615 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2616 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2617 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2618 MODULE_LICENSE("GPL");
2620 /* SCSI host template */
2621 static struct scsi_host_template scsi_driver_template = {
2622 .module = THIS_MODULE,
2623 .name = "SBP-2 IEEE-1394",
2624 .proc_name = SBP2_DEVICE_NAME,
2625 .queuecommand = sbp2scsi_queuecommand,
2626 .eh_abort_handler = sbp2scsi_abort,
2627 .eh_device_reset_handler = sbp2scsi_reset,
2628 .slave_alloc = sbp2scsi_slave_alloc,
2629 .slave_configure = sbp2scsi_slave_configure,
2630 .slave_destroy = sbp2scsi_slave_destroy,
2632 .sg_tablesize = SG_ALL,
2633 .use_clustering = ENABLE_CLUSTERING,
2634 .cmd_per_lun = SBP2_MAX_CMDS,
2635 .can_queue = SBP2_MAX_CMDS,
2637 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2640 static int sbp2_module_init(void)
2644 SBP2_DEBUG("sbp2_module_init");
2646 /* Module load debug option to force one command at a time (serializing I/O) */
2648 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2649 SBP2_INFO("Try serialize_io=0 for better performance");
2650 scsi_driver_template.can_queue = 1;
2651 scsi_driver_template.cmd_per_lun = 1;
2654 /* Set max sectors (module load option). Default is 255 sectors. */
2655 scsi_driver_template.max_sectors = max_sectors;
2657 /* Register our high level driver with 1394 stack */
2658 hpsb_register_highlevel(&sbp2_highlevel);
2660 ret = hpsb_register_protocol(&sbp2_driver);
2662 SBP2_ERR("Failed to register protocol");
2663 hpsb_unregister_highlevel(&sbp2_highlevel);
2670 static void __exit sbp2_module_exit(void)
2672 SBP2_DEBUG("sbp2_module_exit");
2674 hpsb_unregister_protocol(&sbp2_driver);
2676 hpsb_unregister_highlevel(&sbp2_highlevel);
2679 module_init(sbp2_module_init);
2680 module_exit(sbp2_module_exit);