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
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, 0444);
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 firmware's that require a forced 36 byte inquiry. */
269 static u32 sbp2_broken_inquiry_list[] = {
270 0x00002800, /* Stefan Richter <richtest@bauwesen.tu-cottbus.de> */
271 /* DViCO Momobay CX-1 */
272 0x00000200 /* Andreas Plesch <plesch@fas.harvard.edu> */
273 /* QPS Fire DVDBurner */
276 #define NUM_BROKEN_INQUIRY_DEVS \
277 (sizeof(sbp2_broken_inquiry_list)/sizeof(*sbp2_broken_inquiry_list))
279 /**************************************
280 * General utility functions
281 **************************************/
285 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
287 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
291 for (length = (length >> 2); length--; )
292 temp[length] = be32_to_cpu(temp[length]);
298 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
300 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
304 for (length = (length >> 2); length--; )
305 temp[length] = cpu_to_be32(temp[length]);
309 #else /* BIG_ENDIAN */
310 /* Why waste the cpu cycles? */
311 #define sbp2util_be32_to_cpu_buffer(x,y)
312 #define sbp2util_cpu_to_be32_buffer(x,y)
315 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
317 * Debug packet dump routine. Length is in bytes.
319 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
323 unsigned char *dump = buffer;
325 if (!dump || !length || !dump_name)
329 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
331 printk("[%s]", dump_name);
332 for (i = 0; i < length; i++) {
341 printk("%02x ", (int)dump[i]);
348 #define sbp2util_packet_dump(w,x,y,z)
352 * Goofy routine that basically does a down_timeout function.
354 static int sbp2util_down_timeout(atomic_t *done, int timeout)
358 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
359 if (msleep_interruptible(100)) /* 100ms */
362 return (i > 0) ? 0 : 1;
365 /* Free's an allocated packet */
366 static void sbp2_free_packet(struct hpsb_packet *packet)
368 hpsb_free_tlabel(packet);
369 hpsb_free_packet(packet);
372 /* This is much like hpsb_node_write(), except it ignores the response
373 * subaction and returns immediately. Can be used from interrupts.
375 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
376 quadlet_t *buffer, size_t length)
378 struct hpsb_packet *packet;
380 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
381 addr, buffer, length);
385 hpsb_set_packet_complete_task(packet,
386 (void (*)(void *))sbp2_free_packet,
389 hpsb_node_fill_packet(ne, packet);
391 if (hpsb_send_packet(packet) < 0) {
392 sbp2_free_packet(packet);
400 * This function is called to create a pool of command orbs used for
401 * command processing. It is called when a new sbp2 device is detected.
403 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
405 struct sbp2scsi_host_info *hi = scsi_id->hi;
407 unsigned long flags, orbs;
408 struct sbp2_command_info *command;
410 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
412 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
413 for (i = 0; i < orbs; i++) {
414 command = kzalloc(sizeof(*command), GFP_ATOMIC);
416 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
420 command->command_orb_dma =
421 pci_map_single(hi->host->pdev, &command->command_orb,
422 sizeof(struct sbp2_command_orb),
423 PCI_DMA_BIDIRECTIONAL);
424 SBP2_DMA_ALLOC("single command orb DMA");
426 pci_map_single(hi->host->pdev,
427 &command->scatter_gather_element,
428 sizeof(command->scatter_gather_element),
429 PCI_DMA_BIDIRECTIONAL);
430 SBP2_DMA_ALLOC("scatter_gather_element");
431 INIT_LIST_HEAD(&command->list);
432 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
434 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
439 * This function is called to delete a pool of command orbs.
441 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
443 struct hpsb_host *host = scsi_id->hi->host;
444 struct list_head *lh, *next;
445 struct sbp2_command_info *command;
448 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
449 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
450 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
451 command = list_entry(lh, struct sbp2_command_info, list);
453 /* Release our generic DMA's */
454 pci_unmap_single(host->pdev, command->command_orb_dma,
455 sizeof(struct sbp2_command_orb),
456 PCI_DMA_BIDIRECTIONAL);
457 SBP2_DMA_FREE("single command orb DMA");
458 pci_unmap_single(host->pdev, command->sge_dma,
459 sizeof(command->scatter_gather_element),
460 PCI_DMA_BIDIRECTIONAL);
461 SBP2_DMA_FREE("scatter_gather_element");
466 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
471 * This function finds the sbp2_command for a given outstanding command
472 * orb.Only looks at the inuse list.
474 static struct sbp2_command_info *sbp2util_find_command_for_orb(
475 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
477 struct sbp2_command_info *command;
480 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
481 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
482 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
483 if (command->command_orb_dma == orb) {
484 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
489 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
491 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
497 * This function finds the sbp2_command for a given outstanding SCpnt.
498 * Only looks at the inuse list.
500 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt)
502 struct sbp2_command_info *command;
505 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
506 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
507 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
508 if (command->Current_SCpnt == SCpnt) {
509 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
514 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
519 * This function allocates a command orb used to send a scsi command.
521 static struct sbp2_command_info *sbp2util_allocate_command_orb(
522 struct scsi_id_instance_data *scsi_id,
523 struct scsi_cmnd *Current_SCpnt,
524 void (*Current_done)(struct scsi_cmnd *))
526 struct list_head *lh;
527 struct sbp2_command_info *command = NULL;
530 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
531 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
532 lh = scsi_id->sbp2_command_orb_completed.next;
534 command = list_entry(lh, struct sbp2_command_info, list);
535 command->Current_done = Current_done;
536 command->Current_SCpnt = Current_SCpnt;
537 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
539 SBP2_ERR("sbp2util_allocate_command_orb - No orbs available!");
541 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
546 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
548 struct scsi_id_instance_data *scsi_id =
549 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
550 struct hpsb_host *host;
553 printk(KERN_ERR "%s: scsi_id == NULL\n", __FUNCTION__);
557 host = scsi_id->ud->ne->host;
559 if (command->cmd_dma) {
560 if (command->dma_type == CMD_DMA_SINGLE) {
561 pci_unmap_single(host->pdev, command->cmd_dma,
562 command->dma_size, command->dma_dir);
563 SBP2_DMA_FREE("single bulk");
564 } else if (command->dma_type == CMD_DMA_PAGE) {
565 pci_unmap_page(host->pdev, command->cmd_dma,
566 command->dma_size, command->dma_dir);
567 SBP2_DMA_FREE("single page");
568 } /* XXX: Check for CMD_DMA_NONE bug */
569 command->dma_type = CMD_DMA_NONE;
570 command->cmd_dma = 0;
573 if (command->sge_buffer) {
574 pci_unmap_sg(host->pdev, command->sge_buffer,
575 command->dma_size, command->dma_dir);
576 SBP2_DMA_FREE("scatter list");
577 command->sge_buffer = NULL;
582 * This function moves a command to the completed orb list.
584 static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id,
585 struct sbp2_command_info *command)
589 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
590 list_del(&command->list);
591 sbp2util_free_command_dma(command);
592 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
593 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
597 * Is scsi_id valid? Is the 1394 node still present?
599 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
601 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
604 /*********************************************
605 * IEEE-1394 core driver stack related section
606 *********************************************/
607 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
609 static int sbp2_probe(struct device *dev)
611 struct unit_directory *ud;
612 struct scsi_id_instance_data *scsi_id;
614 SBP2_DEBUG("sbp2_probe");
616 ud = container_of(dev, struct unit_directory, device);
618 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
620 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
623 scsi_id = sbp2_alloc_device(ud);
628 sbp2_parse_unit_directory(scsi_id, ud);
630 return sbp2_start_device(scsi_id);
633 static int sbp2_remove(struct device *dev)
635 struct unit_directory *ud;
636 struct scsi_id_instance_data *scsi_id;
637 struct scsi_device *sdev;
639 SBP2_DEBUG("sbp2_remove");
641 ud = container_of(dev, struct unit_directory, device);
642 scsi_id = ud->device.driver_data;
646 if (scsi_id->scsi_host) {
647 /* Get rid of enqueued commands if there is no chance to
649 if (!sbp2util_node_is_available(scsi_id))
650 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
651 /* scsi_remove_device() will trigger shutdown functions of SCSI
652 * highlevel drivers which would deadlock if blocked. */
653 scsi_unblock_requests(scsi_id->scsi_host);
655 sdev = scsi_id->sdev;
657 scsi_id->sdev = NULL;
658 scsi_remove_device(sdev);
661 sbp2_logout_device(scsi_id);
662 sbp2_remove_device(scsi_id);
667 static int sbp2_update(struct unit_directory *ud)
669 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
671 SBP2_DEBUG("sbp2_update");
673 if (sbp2_reconnect_device(scsi_id)) {
676 * Ok, reconnect has failed. Perhaps we didn't
677 * reconnect fast enough. Try doing a regular login, but
678 * first do a logout just in case of any weirdness.
680 sbp2_logout_device(scsi_id);
682 if (sbp2_login_device(scsi_id)) {
683 /* Login failed too, just fail, and the backend
684 * will call our sbp2_remove for us */
685 SBP2_ERR("Failed to reconnect to sbp2 device!");
690 /* Set max retries to something large on the device. */
691 sbp2_set_busy_timeout(scsi_id);
693 /* Do a SBP-2 fetch agent reset. */
694 sbp2_agent_reset(scsi_id, 1);
696 /* Get the max speed and packet size that we can use. */
697 sbp2_max_speed_and_size(scsi_id);
699 /* Complete any pending commands with busy (so they get
700 * retried) and remove them from our queue
702 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
704 /* Make sure we unblock requests (since this is likely after a bus
706 scsi_unblock_requests(scsi_id->scsi_host);
711 /* This functions is called by the sbp2_probe, for each new device. We now
712 * allocate one scsi host for each scsi_id (unit directory). */
713 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
715 struct sbp2scsi_host_info *hi;
716 struct Scsi_Host *scsi_host = NULL;
717 struct scsi_id_instance_data *scsi_id = NULL;
719 SBP2_DEBUG("sbp2_alloc_device");
721 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
723 SBP2_ERR("failed to create scsi_id");
727 scsi_id->ne = ud->ne;
729 scsi_id->speed_code = IEEE1394_SPEED_100;
730 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
731 atomic_set(&scsi_id->sbp2_login_complete, 0);
732 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
733 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
734 INIT_LIST_HEAD(&scsi_id->scsi_list);
735 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
736 scsi_id->sbp2_lun = 0;
738 ud->device.driver_data = scsi_id;
740 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
742 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
744 SBP2_ERR("failed to allocate hostinfo");
747 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
748 hi->host = ud->ne->host;
749 INIT_LIST_HEAD(&hi->scsi_ids);
751 /* Register our sbp2 status address space... */
752 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_ops,
753 SBP2_STATUS_FIFO_ADDRESS,
754 SBP2_STATUS_FIFO_ADDRESS +
755 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(SBP2_MAX_UDS_PER_NODE+1));
756 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
757 /* Handle data movement if physical dma is not
758 * enabled/supportedon host controller */
759 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_physdma_ops,
760 0x0ULL, 0xfffffffcULL);
766 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
768 /* Register our host with the SCSI stack. */
769 scsi_host = scsi_host_alloc(&scsi_driver_template,
770 sizeof(unsigned long));
772 SBP2_ERR("failed to register scsi host");
776 scsi_host->hostdata[0] = (unsigned long)scsi_id;
778 if (!scsi_add_host(scsi_host, &ud->device)) {
779 scsi_id->scsi_host = scsi_host;
783 SBP2_ERR("failed to add scsi host");
784 scsi_host_put(scsi_host);
787 sbp2_remove_device(scsi_id);
791 static void sbp2_host_reset(struct hpsb_host *host)
793 struct sbp2scsi_host_info *hi;
794 struct scsi_id_instance_data *scsi_id;
796 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
799 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
800 scsi_block_requests(scsi_id->scsi_host);
805 * This function is where we first pull the node unique ids, and then
806 * allocate memory and register a SBP-2 device.
808 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
810 struct sbp2scsi_host_info *hi = scsi_id->hi;
813 SBP2_DEBUG("sbp2_start_device");
816 scsi_id->login_response =
817 pci_alloc_consistent(hi->host->pdev,
818 sizeof(struct sbp2_login_response),
819 &scsi_id->login_response_dma);
820 if (!scsi_id->login_response)
822 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
824 /* Query logins ORB DMA */
825 scsi_id->query_logins_orb =
826 pci_alloc_consistent(hi->host->pdev,
827 sizeof(struct sbp2_query_logins_orb),
828 &scsi_id->query_logins_orb_dma);
829 if (!scsi_id->query_logins_orb)
831 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
833 /* Query logins response DMA */
834 scsi_id->query_logins_response =
835 pci_alloc_consistent(hi->host->pdev,
836 sizeof(struct sbp2_query_logins_response),
837 &scsi_id->query_logins_response_dma);
838 if (!scsi_id->query_logins_response)
840 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
842 /* Reconnect ORB DMA */
843 scsi_id->reconnect_orb =
844 pci_alloc_consistent(hi->host->pdev,
845 sizeof(struct sbp2_reconnect_orb),
846 &scsi_id->reconnect_orb_dma);
847 if (!scsi_id->reconnect_orb)
849 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
852 scsi_id->logout_orb =
853 pci_alloc_consistent(hi->host->pdev,
854 sizeof(struct sbp2_logout_orb),
855 &scsi_id->logout_orb_dma);
856 if (!scsi_id->logout_orb)
858 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
862 pci_alloc_consistent(hi->host->pdev,
863 sizeof(struct sbp2_login_orb),
864 &scsi_id->login_orb_dma);
865 if (!scsi_id->login_orb)
867 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
869 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
872 * Create our command orb pool
874 if (sbp2util_create_command_orb_pool(scsi_id)) {
875 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
876 sbp2_remove_device(scsi_id);
880 /* Schedule a timeout here. The reason is that we may be so close
881 * to a bus reset, that the device is not available for logins.
882 * This can happen when the bus reset is caused by the host
883 * connected to the sbp2 device being removed. That host would
884 * have a certain amount of time to relogin before the sbp2 device
885 * allows someone else to login instead. One second makes sense. */
886 msleep_interruptible(1000);
887 if (signal_pending(current)) {
888 SBP2_WARN("aborting sbp2_start_device due to event");
889 sbp2_remove_device(scsi_id);
894 * Login to the sbp-2 device
896 if (sbp2_login_device(scsi_id)) {
897 /* Login failed, just remove the device. */
898 sbp2_remove_device(scsi_id);
903 * Set max retries to something large on the device
905 sbp2_set_busy_timeout(scsi_id);
908 * Do a SBP-2 fetch agent reset
910 sbp2_agent_reset(scsi_id, 1);
913 * Get the max speed and packet size that we can use
915 sbp2_max_speed_and_size(scsi_id);
917 /* Add this device to the scsi layer now */
918 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
920 SBP2_ERR("scsi_add_device failed");
921 sbp2_logout_device(scsi_id);
922 sbp2_remove_device(scsi_id);
929 SBP2_ERR("Could not allocate memory for scsi_id");
930 sbp2_remove_device(scsi_id);
935 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
937 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
939 struct sbp2scsi_host_info *hi;
941 SBP2_DEBUG("sbp2_remove_device");
948 /* This will remove our scsi device aswell */
949 if (scsi_id->scsi_host) {
950 scsi_remove_host(scsi_id->scsi_host);
951 scsi_host_put(scsi_id->scsi_host);
954 sbp2util_remove_command_orb_pool(scsi_id);
956 list_del(&scsi_id->scsi_list);
958 if (scsi_id->login_response) {
959 pci_free_consistent(hi->host->pdev,
960 sizeof(struct sbp2_login_response),
961 scsi_id->login_response,
962 scsi_id->login_response_dma);
963 SBP2_DMA_FREE("single login FIFO");
966 if (scsi_id->login_orb) {
967 pci_free_consistent(hi->host->pdev,
968 sizeof(struct sbp2_login_orb),
970 scsi_id->login_orb_dma);
971 SBP2_DMA_FREE("single login ORB");
974 if (scsi_id->reconnect_orb) {
975 pci_free_consistent(hi->host->pdev,
976 sizeof(struct sbp2_reconnect_orb),
977 scsi_id->reconnect_orb,
978 scsi_id->reconnect_orb_dma);
979 SBP2_DMA_FREE("single reconnect orb");
982 if (scsi_id->logout_orb) {
983 pci_free_consistent(hi->host->pdev,
984 sizeof(struct sbp2_logout_orb),
986 scsi_id->logout_orb_dma);
987 SBP2_DMA_FREE("single logout orb");
990 if (scsi_id->query_logins_orb) {
991 pci_free_consistent(hi->host->pdev,
992 sizeof(struct sbp2_query_logins_orb),
993 scsi_id->query_logins_orb,
994 scsi_id->query_logins_orb_dma);
995 SBP2_DMA_FREE("single query logins orb");
998 if (scsi_id->query_logins_response) {
999 pci_free_consistent(hi->host->pdev,
1000 sizeof(struct sbp2_query_logins_response),
1001 scsi_id->query_logins_response,
1002 scsi_id->query_logins_response_dma);
1003 SBP2_DMA_FREE("single query logins data");
1006 scsi_id->ud->device.driver_data = NULL;
1008 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1013 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1015 * This function deals with physical dma write requests (for adapters that do not support
1016 * physical dma in hardware). Mostly just here for debugging...
1018 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1019 int destid, quadlet_t *data, u64 addr,
1020 size_t length, u16 flags)
1024 * Manually put the data in the right place.
1026 memcpy(bus_to_virt((u32) addr), data, length);
1027 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1029 return RCODE_COMPLETE;
1033 * This function deals with physical dma read requests (for adapters that do not support
1034 * physical dma in hardware). Mostly just here for debugging...
1036 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1037 quadlet_t *data, u64 addr, size_t length,
1042 * Grab data from memory and send a read response.
1044 memcpy(data, bus_to_virt((u32) addr), length);
1045 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1047 return RCODE_COMPLETE;
1051 /**************************************
1052 * SBP-2 protocol related section
1053 **************************************/
1056 * This function queries the device for the maximum concurrent logins it
1059 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1061 struct sbp2scsi_host_info *hi = scsi_id->hi;
1066 SBP2_DEBUG("sbp2_query_logins");
1068 scsi_id->query_logins_orb->reserved1 = 0x0;
1069 scsi_id->query_logins_orb->reserved2 = 0x0;
1071 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1072 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1073 SBP2_DEBUG("sbp2_query_logins: query_response_hi/lo initialized");
1075 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1076 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1077 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1078 SBP2_DEBUG("sbp2_query_logins: lun_misc initialized");
1080 scsi_id->query_logins_orb->reserved_resp_length =
1081 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1082 SBP2_DEBUG("sbp2_query_logins: reserved_resp_length initialized");
1084 scsi_id->query_logins_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1085 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1086 scsi_id->query_logins_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1087 SBP2_STATUS_FIFO_ADDRESS_HI);
1088 SBP2_DEBUG("sbp2_query_logins: status FIFO initialized");
1090 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1092 SBP2_DEBUG("sbp2_query_logins: orb byte-swapped");
1094 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1095 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1097 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1098 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1100 SBP2_DEBUG("sbp2_query_logins: query_logins_response/status FIFO memset");
1102 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1103 data[1] = scsi_id->query_logins_orb_dma;
1104 sbp2util_cpu_to_be32_buffer(data, 8);
1106 atomic_set(&scsi_id->sbp2_login_complete, 0);
1108 SBP2_DEBUG("sbp2_query_logins: prepared to write");
1109 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1110 SBP2_DEBUG("sbp2_query_logins: written");
1112 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1113 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1117 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1118 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1122 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1123 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1124 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1126 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1130 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1132 SBP2_DEBUG("length_max_logins = %x",
1133 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1135 SBP2_DEBUG("Query logins to SBP-2 device successful");
1137 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1138 SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1140 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1141 SBP2_DEBUG("Number of active logins: %d", active_logins);
1143 if (active_logins >= max_logins) {
1151 * This function is called in order to login to a particular SBP-2 device,
1152 * after a bus reset.
1154 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1156 struct sbp2scsi_host_info *hi = scsi_id->hi;
1159 SBP2_DEBUG("sbp2_login_device");
1161 if (!scsi_id->login_orb) {
1162 SBP2_DEBUG("sbp2_login_device: login_orb not alloc'd!");
1166 if (!exclusive_login) {
1167 if (sbp2_query_logins(scsi_id)) {
1168 SBP2_INFO("Device does not support any more concurrent logins");
1173 /* Set-up login ORB, assume no password */
1174 scsi_id->login_orb->password_hi = 0;
1175 scsi_id->login_orb->password_lo = 0;
1176 SBP2_DEBUG("sbp2_login_device: password_hi/lo initialized");
1178 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1179 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1180 SBP2_DEBUG("sbp2_login_device: login_response_hi/lo initialized");
1182 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1183 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1184 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1185 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1186 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1187 SBP2_DEBUG("sbp2_login_device: lun_misc initialized");
1189 scsi_id->login_orb->passwd_resp_lengths =
1190 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1191 SBP2_DEBUG("sbp2_login_device: passwd_resp_lengths initialized");
1193 scsi_id->login_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1194 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1195 scsi_id->login_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1196 SBP2_STATUS_FIFO_ADDRESS_HI);
1197 SBP2_DEBUG("sbp2_login_device: status FIFO initialized");
1200 * Byte swap ORB if necessary
1202 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1204 SBP2_DEBUG("sbp2_login_device: orb byte-swapped");
1206 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1207 "sbp2 login orb", scsi_id->login_orb_dma);
1210 * Initialize login response and status fifo
1212 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1213 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1215 SBP2_DEBUG("sbp2_login_device: login_response/status FIFO memset");
1218 * Ok, let's write to the target's management agent register
1220 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1221 data[1] = scsi_id->login_orb_dma;
1222 sbp2util_cpu_to_be32_buffer(data, 8);
1224 atomic_set(&scsi_id->sbp2_login_complete, 0);
1226 SBP2_DEBUG("sbp2_login_device: prepared to write to %08x",
1227 (unsigned int)scsi_id->sbp2_management_agent_addr);
1228 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1229 SBP2_DEBUG("sbp2_login_device: written");
1232 * Wait for login status (up to 20 seconds)...
1234 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1235 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1240 * Sanity. Make sure status returned matches login orb.
1242 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1243 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1250 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1251 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1252 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1254 SBP2_ERR("Error logging into SBP-2 device - login failed");
1259 * Byte swap the login response, for use when reconnecting or
1262 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1265 * Grab our command block agent address from the login response.
1267 SBP2_DEBUG("command_block_agent_hi = %x",
1268 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1269 SBP2_DEBUG("command_block_agent_lo = %x",
1270 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1272 scsi_id->sbp2_command_block_agent_addr =
1273 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1274 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1275 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1277 SBP2_INFO("Logged into SBP-2 device");
1284 * This function is called in order to logout from a particular SBP-2
1285 * device, usually called during driver unload.
1287 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1289 struct sbp2scsi_host_info *hi = scsi_id->hi;
1293 SBP2_DEBUG("sbp2_logout_device");
1298 scsi_id->logout_orb->reserved1 = 0x0;
1299 scsi_id->logout_orb->reserved2 = 0x0;
1300 scsi_id->logout_orb->reserved3 = 0x0;
1301 scsi_id->logout_orb->reserved4 = 0x0;
1303 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1304 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1306 /* Notify us when complete */
1307 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1309 scsi_id->logout_orb->reserved5 = 0x0;
1310 scsi_id->logout_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1311 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1312 scsi_id->logout_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1313 SBP2_STATUS_FIFO_ADDRESS_HI);
1316 * Byte swap ORB if necessary
1318 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1320 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1321 "sbp2 logout orb", scsi_id->logout_orb_dma);
1324 * Ok, let's write to the target's management agent register
1326 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1327 data[1] = scsi_id->logout_orb_dma;
1328 sbp2util_cpu_to_be32_buffer(data, 8);
1330 atomic_set(&scsi_id->sbp2_login_complete, 0);
1332 error = hpsb_node_write(scsi_id->ne,
1333 scsi_id->sbp2_management_agent_addr, data, 8);
1337 /* Wait for device to logout...1 second. */
1338 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1341 SBP2_INFO("Logged out of SBP-2 device");
1348 * This function is called in order to reconnect to a particular SBP-2
1349 * device, after a bus reset.
1351 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1353 struct sbp2scsi_host_info *hi = scsi_id->hi;
1357 SBP2_DEBUG("sbp2_reconnect_device");
1360 * Set-up reconnect ORB
1362 scsi_id->reconnect_orb->reserved1 = 0x0;
1363 scsi_id->reconnect_orb->reserved2 = 0x0;
1364 scsi_id->reconnect_orb->reserved3 = 0x0;
1365 scsi_id->reconnect_orb->reserved4 = 0x0;
1367 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1368 scsi_id->reconnect_orb->login_ID_misc |=
1369 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1371 /* Notify us when complete */
1372 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1374 scsi_id->reconnect_orb->reserved5 = 0x0;
1375 scsi_id->reconnect_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1376 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1377 scsi_id->reconnect_orb->status_FIFO_hi =
1378 (ORB_SET_NODE_ID(hi->host->node_id) | SBP2_STATUS_FIFO_ADDRESS_HI);
1381 * Byte swap ORB if necessary
1383 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1385 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1386 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1389 * Initialize status fifo
1391 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1394 * Ok, let's write to the target's management agent register
1396 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1397 data[1] = scsi_id->reconnect_orb_dma;
1398 sbp2util_cpu_to_be32_buffer(data, 8);
1400 atomic_set(&scsi_id->sbp2_login_complete, 0);
1402 error = hpsb_node_write(scsi_id->ne,
1403 scsi_id->sbp2_management_agent_addr, data, 8);
1408 * Wait for reconnect status (up to 1 second)...
1410 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1411 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1416 * Sanity. Make sure status returned matches reconnect orb.
1418 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1419 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1426 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1427 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1428 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1430 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1434 HPSB_DEBUG("Reconnected to SBP-2 device");
1441 * This function is called in order to set the busy timeout (number of
1442 * retries to attempt) on the sbp2 device.
1444 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1448 SBP2_DEBUG("sbp2_set_busy_timeout");
1451 * Ok, let's write to the target's busy timeout register
1453 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1455 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4)) {
1456 SBP2_ERR("sbp2_set_busy_timeout error");
1463 * This function is called to parse sbp2 device's config rom unit
1464 * directory. Used to determine things like sbp2 management agent offset,
1465 * and command set used (SCSI or RBC).
1467 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1468 struct unit_directory *ud)
1470 struct csr1212_keyval *kv;
1471 struct csr1212_dentry *dentry;
1472 u64 management_agent_addr;
1473 u32 command_set_spec_id, command_set, unit_characteristics,
1474 firmware_revision, workarounds;
1477 SBP2_DEBUG("sbp2_parse_unit_directory");
1479 management_agent_addr = 0x0;
1480 command_set_spec_id = 0x0;
1482 unit_characteristics = 0x0;
1483 firmware_revision = 0x0;
1485 /* Handle different fields in the unit directory, based on keys */
1486 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1487 switch (kv->key.id) {
1488 case CSR1212_KV_ID_DEPENDENT_INFO:
1489 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1490 /* Save off the management agent address */
1491 management_agent_addr =
1492 CSR1212_REGISTER_SPACE_BASE +
1493 (kv->value.csr_offset << 2);
1495 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1496 (unsigned int)management_agent_addr);
1497 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1499 ORB_SET_LUN(kv->value.immediate);
1503 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1504 /* Command spec organization */
1505 command_set_spec_id = kv->value.immediate;
1506 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1507 (unsigned int)command_set_spec_id);
1510 case SBP2_COMMAND_SET_KEY:
1511 /* Command set used by sbp2 device */
1512 command_set = kv->value.immediate;
1513 SBP2_DEBUG("sbp2_command_set = %x",
1514 (unsigned int)command_set);
1517 case SBP2_UNIT_CHARACTERISTICS_KEY:
1519 * Unit characterisitcs (orb related stuff
1520 * that I'm not yet paying attention to)
1522 unit_characteristics = kv->value.immediate;
1523 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1524 (unsigned int)unit_characteristics);
1527 case SBP2_FIRMWARE_REVISION_KEY:
1528 /* Firmware revision */
1529 firmware_revision = kv->value.immediate;
1530 if (force_inquiry_hack)
1531 SBP2_INFO("sbp2_firmware_revision = %x",
1532 (unsigned int)firmware_revision);
1534 SBP2_DEBUG("sbp2_firmware_revision = %x",
1535 (unsigned int)firmware_revision);
1543 /* This is the start of our broken device checking. We try to hack
1544 * around oddities and known defects. */
1547 /* If the vendor id is 0xa0b8 (Symbios vendor id), then we have a
1548 * bridge with 128KB max transfer size limitation. For sanity, we
1549 * only voice this when the current max_sectors setting
1550 * exceeds the 128k limit. By default, that is not the case.
1552 * It would be really nice if we could detect this before the scsi
1553 * host gets initialized. That way we can down-force the
1554 * max_sectors to account for it. That is not currently
1556 if ((firmware_revision & 0xffff00) ==
1557 SBP2_128KB_BROKEN_FIRMWARE &&
1558 (max_sectors * 512) > (128*1024)) {
1559 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB max transfer size.",
1560 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1561 SBP2_WARN("WARNING: Current max_sectors setting is larger than 128KB (%d sectors)!",
1563 workarounds |= SBP2_BREAKAGE_128K_MAX_TRANSFER;
1566 /* Check for a blacklisted set of devices that require us to force
1567 * a 36 byte host inquiry. This can be overriden as a module param
1568 * (to force all hosts). */
1569 for (i = 0; i < NUM_BROKEN_INQUIRY_DEVS; i++) {
1570 if ((firmware_revision & 0xffff00) ==
1571 sbp2_broken_inquiry_list[i]) {
1572 SBP2_WARN("Node " NODE_BUS_FMT ": Using 36byte inquiry workaround",
1573 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1574 workarounds |= SBP2_BREAKAGE_INQUIRY_HACK;
1575 break; /* No need to continue. */
1579 /* If this is a logical unit directory entry, process the parent
1580 * to get the values. */
1581 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1582 struct unit_directory *parent_ud =
1583 container_of(ud->device.parent, struct unit_directory, device);
1584 sbp2_parse_unit_directory(scsi_id, parent_ud);
1586 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1587 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1588 scsi_id->sbp2_command_set = command_set;
1589 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1590 scsi_id->sbp2_firmware_revision = firmware_revision;
1591 scsi_id->workarounds = workarounds;
1592 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1593 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1598 * This function is called in order to determine the max speed and packet
1599 * size we can use in our ORBs. Note, that we (the driver and host) only
1600 * initiate the transaction. The SBP-2 device actually transfers the data
1601 * (by reading from the DMA area we tell it). This means that the SBP-2
1602 * device decides the actual maximum data it can transfer. We just tell it
1603 * the speed that it needs to use, and the max_rec the host supports, and
1604 * it takes care of the rest.
1606 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1608 struct sbp2scsi_host_info *hi = scsi_id->hi;
1610 SBP2_DEBUG("sbp2_max_speed_and_size");
1612 /* Initial setting comes from the hosts speed map */
1613 scsi_id->speed_code =
1614 hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64 +
1615 NODEID_TO_NODE(scsi_id->ne->nodeid)];
1617 /* Bump down our speed if the user requested it */
1618 if (scsi_id->speed_code > max_speed) {
1619 scsi_id->speed_code = max_speed;
1620 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1621 hpsb_speedto_str[scsi_id->speed_code]);
1624 /* Payload size is the lesser of what our speed supports and what
1625 * our host supports. */
1626 scsi_id->max_payload_size =
1627 min(sbp2_speedto_max_payload[scsi_id->speed_code],
1628 (u8) (hi->host->csr.max_rec - 1));
1630 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1631 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1632 hpsb_speedto_str[scsi_id->speed_code],
1633 1 << ((u32) scsi_id->max_payload_size + 2));
1639 * This function is called in order to perform a SBP-2 agent reset.
1641 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1647 SBP2_DEBUG("sbp2_agent_reset");
1650 * Ok, let's write to the target's management agent register
1652 data = ntohl(SBP2_AGENT_RESET_DATA);
1653 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1656 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1658 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1661 SBP2_ERR("hpsb_node_write failed.\n");
1666 * Need to make sure orb pointer is written on next command
1668 scsi_id->last_orb = NULL;
1673 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1674 struct sbp2scsi_host_info *hi,
1675 struct sbp2_command_info *command,
1676 unsigned int scsi_use_sg,
1677 struct scatterlist *sgpnt,
1679 enum dma_data_direction dma_dir)
1681 command->dma_dir = dma_dir;
1682 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1683 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1685 /* Special case if only one element (and less than 64KB in size) */
1686 if ((scsi_use_sg == 1) &&
1687 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1689 SBP2_DEBUG("Only one s/g element");
1690 command->dma_size = sgpnt[0].length;
1691 command->dma_type = CMD_DMA_PAGE;
1692 command->cmd_dma = pci_map_page(hi->host->pdev,
1697 SBP2_DMA_ALLOC("single page scatter element");
1699 orb->data_descriptor_lo = command->cmd_dma;
1700 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1703 struct sbp2_unrestricted_page_table *sg_element =
1704 &command->scatter_gather_element[0];
1705 u32 sg_count, sg_len;
1707 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1710 SBP2_DMA_ALLOC("scatter list");
1712 command->dma_size = scsi_use_sg;
1713 command->sge_buffer = sgpnt;
1715 /* use page tables (s/g) */
1716 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1717 orb->data_descriptor_lo = command->sge_dma;
1720 * Loop through and fill out our sbp-2 page tables
1721 * (and split up anything too large)
1723 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1724 sg_len = sg_dma_len(sgpnt);
1725 sg_addr = sg_dma_address(sgpnt);
1727 sg_element[sg_count].segment_base_lo = sg_addr;
1728 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1729 sg_element[sg_count].length_segment_base_hi =
1730 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1731 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1732 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1734 sg_element[sg_count].length_segment_base_hi =
1735 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1742 /* Number of page table (s/g) elements */
1743 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1745 sbp2util_packet_dump(sg_element,
1746 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1747 "sbp2 s/g list", command->sge_dma);
1749 /* Byte swap page tables if necessary */
1750 sbp2util_cpu_to_be32_buffer(sg_element,
1751 (sizeof(struct sbp2_unrestricted_page_table)) *
1756 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1757 struct sbp2scsi_host_info *hi,
1758 struct sbp2_command_info *command,
1759 struct scatterlist *sgpnt,
1761 unsigned int scsi_request_bufflen,
1762 void *scsi_request_buffer,
1763 enum dma_data_direction dma_dir)
1765 command->dma_dir = dma_dir;
1766 command->dma_size = scsi_request_bufflen;
1767 command->dma_type = CMD_DMA_SINGLE;
1768 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1769 command->dma_size, command->dma_dir);
1770 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1771 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1773 SBP2_DMA_ALLOC("single bulk");
1776 * Handle case where we get a command w/o s/g enabled (but
1777 * check for transfers larger than 64K)
1779 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1781 orb->data_descriptor_lo = command->cmd_dma;
1782 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1785 struct sbp2_unrestricted_page_table *sg_element =
1786 &command->scatter_gather_element[0];
1787 u32 sg_count, sg_len;
1791 * Need to turn this into page tables, since the
1792 * buffer is too large.
1794 orb->data_descriptor_lo = command->sge_dma;
1796 /* Use page tables (s/g) */
1797 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1800 * fill out our sbp-2 page tables (and split up
1804 sg_len = scsi_request_bufflen;
1805 sg_addr = command->cmd_dma;
1807 sg_element[sg_count].segment_base_lo = sg_addr;
1808 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1809 sg_element[sg_count].length_segment_base_hi =
1810 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1811 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1812 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1814 sg_element[sg_count].length_segment_base_hi =
1815 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1821 /* Number of page table (s/g) elements */
1822 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1824 sbp2util_packet_dump(sg_element,
1825 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1826 "sbp2 s/g list", command->sge_dma);
1828 /* Byte swap page tables if necessary */
1829 sbp2util_cpu_to_be32_buffer(sg_element,
1830 (sizeof(struct sbp2_unrestricted_page_table)) *
1836 * This function is called to create the actual command orb and s/g list
1837 * out of the scsi command itself.
1839 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1840 struct sbp2_command_info *command,
1842 unsigned int scsi_use_sg,
1843 unsigned int scsi_request_bufflen,
1844 void *scsi_request_buffer,
1845 enum dma_data_direction dma_dir)
1847 struct sbp2scsi_host_info *hi = scsi_id->hi;
1848 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1849 struct sbp2_command_orb *command_orb = &command->command_orb;
1853 * Set-up our command ORB..
1855 * NOTE: We're doing unrestricted page tables (s/g), as this is
1856 * best performance (at least with the devices I have). This means
1857 * that data_size becomes the number of s/g elements, and
1858 * page_size should be zero (for unrestricted).
1860 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1861 command_orb->next_ORB_lo = 0x0;
1862 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1863 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1864 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1866 if (dma_dir == DMA_NONE)
1867 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1868 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1869 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1870 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1871 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1873 SBP2_WARN("Falling back to DMA_NONE");
1874 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1877 /* Set-up our pagetable stuff */
1878 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1879 SBP2_DEBUG("No data transfer");
1880 command_orb->data_descriptor_hi = 0x0;
1881 command_orb->data_descriptor_lo = 0x0;
1882 command_orb->misc |= ORB_SET_DIRECTION(1);
1883 } else if (scsi_use_sg) {
1884 SBP2_DEBUG("Use scatter/gather");
1885 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1886 sgpnt, orb_direction, dma_dir);
1888 SBP2_DEBUG("No scatter/gather");
1889 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1890 orb_direction, scsi_request_bufflen,
1891 scsi_request_buffer, dma_dir);
1894 /* Byte swap command ORB if necessary */
1895 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1897 /* Put our scsi command in the command ORB */
1898 memset(command_orb->cdb, 0, 12);
1899 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1903 * This function is called in order to begin a regular SBP-2 command.
1905 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1906 struct sbp2_command_info *command)
1908 struct sbp2scsi_host_info *hi = scsi_id->hi;
1909 struct sbp2_command_orb *command_orb = &command->command_orb;
1910 struct node_entry *ne = scsi_id->ne;
1913 outstanding_orb_incr;
1914 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1915 command_orb, global_outstanding_command_orbs);
1917 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1918 sizeof(struct sbp2_command_orb),
1919 PCI_DMA_BIDIRECTIONAL);
1920 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1921 sizeof(command->scatter_gather_element),
1922 PCI_DMA_BIDIRECTIONAL);
1924 * Check to see if there are any previous orbs to use
1926 if (scsi_id->last_orb == NULL) {
1930 * Ok, let's write to the target's management agent register
1932 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
1933 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1934 data[1] = command->command_orb_dma;
1935 sbp2util_cpu_to_be32_buffer(data, 8);
1937 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
1939 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
1940 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1944 SBP2_ORB_DEBUG("write command agent complete");
1946 scsi_id->last_orb = command_orb;
1947 scsi_id->last_orb_dma = command->command_orb_dma;
1953 * We have an orb already sent (maybe or maybe not
1954 * processed) that we can append this orb to. So do so,
1955 * and ring the doorbell. Have to be very careful
1956 * modifying these next orb pointers, as they are accessed
1957 * both by the sbp2 device and us.
1959 scsi_id->last_orb->next_ORB_lo =
1960 cpu_to_be32(command->command_orb_dma);
1961 /* Tells hardware that this pointer is valid */
1962 scsi_id->last_orb->next_ORB_hi = 0x0;
1963 pci_dma_sync_single_for_device(hi->host->pdev,
1964 scsi_id->last_orb_dma,
1965 sizeof(struct sbp2_command_orb),
1966 PCI_DMA_BIDIRECTIONAL);
1971 data = cpu_to_be32(command->command_orb_dma);
1972 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
1974 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
1976 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
1977 SBP2_ERR("sbp2util_node_write_no_wait failed");
1981 scsi_id->last_orb = command_orb;
1982 scsi_id->last_orb_dma = command->command_orb_dma;
1989 * This function is called in order to begin a regular SBP-2 command.
1991 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
1992 struct scsi_cmnd *SCpnt,
1993 void (*done)(struct scsi_cmnd *))
1995 unchar *cmd = (unchar *) SCpnt->cmnd;
1996 unsigned int request_bufflen = SCpnt->request_bufflen;
1997 struct sbp2_command_info *command;
1999 SBP2_DEBUG("sbp2_send_command");
2000 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2001 printk("[scsi command]\n ");
2002 scsi_print_command(SCpnt);
2004 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2005 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2008 * Allocate a command orb and s/g structure
2010 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2016 * The scsi stack sends down a request_bufflen which does not match the
2017 * length field in the scsi cdb. This causes some sbp2 devices to
2018 * reject this inquiry command. Fix the request_bufflen.
2020 if (*cmd == INQUIRY) {
2021 if (force_inquiry_hack || scsi_id->workarounds & SBP2_BREAKAGE_INQUIRY_HACK)
2022 request_bufflen = cmd[4] = 0x24;
2024 request_bufflen = cmd[4];
2028 * Now actually fill in the comamnd orb and sbp2 s/g list
2030 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2031 request_bufflen, SCpnt->request_buffer,
2032 SCpnt->sc_data_direction);
2034 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2035 "sbp2 command orb", command->command_orb_dma);
2038 * Initialize status fifo
2040 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2043 * Link up the orb, and ring the doorbell if needed
2045 sbp2_link_orb_command(scsi_id, command);
2051 * Translates SBP-2 status into SCSI sense data for check conditions
2053 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2055 SBP2_DEBUG("sbp2_status_to_sense_data");
2058 * Ok, it's pretty ugly... ;-)
2060 sense_data[0] = 0x70;
2061 sense_data[1] = 0x0;
2062 sense_data[2] = sbp2_status[9];
2063 sense_data[3] = sbp2_status[12];
2064 sense_data[4] = sbp2_status[13];
2065 sense_data[5] = sbp2_status[14];
2066 sense_data[6] = sbp2_status[15];
2068 sense_data[8] = sbp2_status[16];
2069 sense_data[9] = sbp2_status[17];
2070 sense_data[10] = sbp2_status[18];
2071 sense_data[11] = sbp2_status[19];
2072 sense_data[12] = sbp2_status[10];
2073 sense_data[13] = sbp2_status[11];
2074 sense_data[14] = sbp2_status[20];
2075 sense_data[15] = sbp2_status[21];
2077 return sbp2_status[8] & 0x3f; /* return scsi status */
2081 * This function is called after a command is completed, in order to do any necessary SBP-2
2082 * response data translations for the SCSI stack
2084 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2085 struct scsi_cmnd *SCpnt)
2087 u8 *scsi_buf = SCpnt->request_buffer;
2089 SBP2_DEBUG("sbp2_check_sbp2_response");
2091 if (SCpnt->cmnd[0] == INQUIRY && (SCpnt->cmnd[1] & 3) == 0) {
2093 * Make sure data length is ok. Minimum length is 36 bytes
2095 if (scsi_buf[4] == 0) {
2096 scsi_buf[4] = 36 - 5;
2100 * Fix ansi revision and response data format
2103 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2108 * This function deals with status writes from the SBP-2 device
2110 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2111 quadlet_t *data, u64 addr, size_t length, u16 fl)
2113 struct sbp2scsi_host_info *hi;
2114 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2116 struct scsi_cmnd *SCpnt = NULL;
2117 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2118 struct sbp2_command_info *command;
2119 unsigned long flags;
2121 SBP2_DEBUG("sbp2_handle_status_write");
2123 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2126 SBP2_ERR("host is NULL - this is bad!");
2127 return RCODE_ADDRESS_ERROR;
2130 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2133 SBP2_ERR("host info is NULL - this is bad!");
2134 return RCODE_ADDRESS_ERROR;
2138 * Find our scsi_id structure by looking at the status fifo address written to by
2141 id = SBP2_STATUS_FIFO_OFFSET_TO_ENTRY((u32)(addr - SBP2_STATUS_FIFO_ADDRESS));
2142 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2143 if (scsi_id_tmp->ne->nodeid == nodeid && scsi_id_tmp->ud->id == id) {
2144 scsi_id = scsi_id_tmp;
2150 SBP2_ERR("scsi_id is NULL - device is gone?");
2151 return RCODE_ADDRESS_ERROR;
2155 * Put response into scsi_id status fifo...
2157 memcpy(&scsi_id->status_block, data, length);
2160 * Byte swap first two quadlets (8 bytes) of status for processing
2162 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2165 * Handle command ORB status here if necessary. First, need to match status with command.
2167 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2170 SBP2_DEBUG("Found status for command ORB");
2171 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2172 sizeof(struct sbp2_command_orb),
2173 PCI_DMA_BIDIRECTIONAL);
2174 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2175 sizeof(command->scatter_gather_element),
2176 PCI_DMA_BIDIRECTIONAL);
2178 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2179 outstanding_orb_decr;
2182 * Matched status with command, now grab scsi command pointers and check status
2184 SCpnt = command->Current_SCpnt;
2185 sbp2util_mark_command_completed(scsi_id, command);
2190 * See if the target stored any scsi status information
2192 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2194 * Translate SBP-2 status to SCSI sense data
2196 SBP2_DEBUG("CHECK CONDITION");
2197 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2201 * Check to see if the dead bit is set. If so, we'll have to initiate
2202 * a fetch agent reset.
2204 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2207 * Initiate a fetch agent reset.
2209 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2210 sbp2_agent_reset(scsi_id, 0);
2213 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2217 * Check here to see if there are no commands in-use. If there are none, we can
2218 * null out last orb so that next time around we write directly to the orb pointer...
2219 * Quick start saves one 1394 bus transaction.
2221 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2222 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2223 scsi_id->last_orb = NULL;
2225 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2230 * It's probably a login/logout/reconnect status.
2232 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2233 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2234 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2235 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2236 atomic_set(&scsi_id->sbp2_login_complete, 1);
2242 /* Complete the SCSI command. */
2243 SBP2_DEBUG("Completing SCSI command");
2244 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2245 command->Current_done);
2246 SBP2_ORB_DEBUG("command orb completed");
2249 return RCODE_COMPLETE;
2252 /**************************************
2253 * SCSI interface related section
2254 **************************************/
2257 * This routine is the main request entry routine for doing I/O. It is
2258 * called from the scsi stack directly.
2260 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2261 void (*done)(struct scsi_cmnd *))
2263 struct scsi_id_instance_data *scsi_id =
2264 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2265 struct sbp2scsi_host_info *hi;
2266 int result = DID_NO_CONNECT << 16;
2268 SBP2_DEBUG("sbp2scsi_queuecommand");
2270 if (!sbp2util_node_is_available(scsi_id))
2276 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2281 * Until we handle multiple luns, just return selection time-out
2282 * to any IO directed at non-zero LUNs
2284 if (SCpnt->device->lun)
2288 * Check for request sense command, and handle it here
2289 * (autorequest sense)
2291 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2292 SBP2_DEBUG("REQUEST_SENSE");
2293 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2294 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2295 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2300 * Check to see if we are in the middle of a bus reset.
2302 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2303 SBP2_ERR("Bus reset in progress - rejecting command");
2304 result = DID_BUS_BUSY << 16;
2309 * Bidirectional commands are not yet implemented,
2310 * and unknown transfer direction not handled.
2312 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2313 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2314 result = DID_ERROR << 16;
2319 * Try and send our SCSI command
2321 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2322 SBP2_ERR("Error sending SCSI command");
2323 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2329 SCpnt->result = result;
2335 * This function is called in order to complete all outstanding SBP-2
2336 * commands (in case of resets, etc.).
2338 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2341 struct sbp2scsi_host_info *hi = scsi_id->hi;
2342 struct list_head *lh;
2343 struct sbp2_command_info *command;
2344 unsigned long flags;
2346 SBP2_DEBUG("sbp2scsi_complete_all_commands");
2348 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2349 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2350 SBP2_DEBUG("Found pending command to complete");
2351 lh = scsi_id->sbp2_command_orb_inuse.next;
2352 command = list_entry(lh, struct sbp2_command_info, list);
2353 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2354 sizeof(struct sbp2_command_orb),
2355 PCI_DMA_BIDIRECTIONAL);
2356 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2357 sizeof(command->scatter_gather_element),
2358 PCI_DMA_BIDIRECTIONAL);
2359 sbp2util_mark_command_completed(scsi_id, command);
2360 if (command->Current_SCpnt) {
2361 command->Current_SCpnt->result = status << 16;
2362 command->Current_done(command->Current_SCpnt);
2365 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2371 * This function is called in order to complete a regular SBP-2 command.
2373 * This can be called in interrupt context.
2375 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2376 u32 scsi_status, struct scsi_cmnd *SCpnt,
2377 void (*done)(struct scsi_cmnd *))
2379 SBP2_DEBUG("sbp2scsi_complete_command");
2385 SBP2_ERR("SCpnt is NULL");
2390 * If a bus reset is in progress and there was an error, don't
2391 * complete the command, just let it get retried at the end of the
2394 if (!hpsb_node_entry_valid(scsi_id->ne)
2395 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2396 SBP2_ERR("Bus reset in progress - retry command later");
2401 * Switch on scsi status
2403 switch (scsi_status) {
2404 case SBP2_SCSI_STATUS_GOOD:
2405 SCpnt->result = DID_OK;
2408 case SBP2_SCSI_STATUS_BUSY:
2409 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2410 SCpnt->result = DID_BUS_BUSY << 16;
2413 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2414 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2415 SCpnt->result = CHECK_CONDITION << 1;
2420 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2421 scsi_print_command(SCpnt);
2422 scsi_print_sense("bh", SCpnt);
2427 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2428 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2429 SCpnt->result = DID_NO_CONNECT << 16;
2430 scsi_print_command(SCpnt);
2433 case SBP2_SCSI_STATUS_CONDITION_MET:
2434 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2435 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2436 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2437 SCpnt->result = DID_ERROR << 16;
2438 scsi_print_command(SCpnt);
2442 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2443 SCpnt->result = DID_ERROR << 16;
2447 * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2449 if (SCpnt->result == DID_OK) {
2450 sbp2_check_sbp2_response(scsi_id, SCpnt);
2454 * If a bus reset is in progress and there was an error, complete
2455 * the command as busy so that it will get retried.
2457 if (!hpsb_node_entry_valid(scsi_id->ne)
2458 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2459 SBP2_ERR("Completing command with busy (bus reset)");
2460 SCpnt->result = DID_BUS_BUSY << 16;
2464 * If a unit attention occurs, return busy status so it gets
2465 * retried... it could have happened because of a 1394 bus reset
2469 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2470 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2471 SBP2_DEBUG("UNIT ATTENTION - return busy");
2472 SCpnt->result = DID_BUS_BUSY << 16;
2477 * Tell scsi stack that we're done with this command
2482 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2484 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = sdev;
2488 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2490 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2491 sdev->use_10_for_rw = 1;
2492 sdev->use_10_for_ms = 1;
2496 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2498 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2503 * Called by scsi stack when something has really gone wrong. Usually
2504 * called when a command has timed-out for some reason.
2506 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2508 struct scsi_id_instance_data *scsi_id =
2509 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2510 struct sbp2scsi_host_info *hi = scsi_id->hi;
2511 struct sbp2_command_info *command;
2513 SBP2_ERR("aborting sbp2 command");
2514 scsi_print_command(SCpnt);
2516 if (sbp2util_node_is_available(scsi_id)) {
2519 * Right now, just return any matching command structures
2522 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2524 SBP2_DEBUG("Found command to abort");
2525 pci_dma_sync_single_for_cpu(hi->host->pdev,
2526 command->command_orb_dma,
2527 sizeof(struct sbp2_command_orb),
2528 PCI_DMA_BIDIRECTIONAL);
2529 pci_dma_sync_single_for_cpu(hi->host->pdev,
2531 sizeof(command->scatter_gather_element),
2532 PCI_DMA_BIDIRECTIONAL);
2533 sbp2util_mark_command_completed(scsi_id, command);
2534 if (command->Current_SCpnt) {
2535 command->Current_SCpnt->result = DID_ABORT << 16;
2536 command->Current_done(command->Current_SCpnt);
2541 * Initiate a fetch agent reset.
2543 sbp2_agent_reset(scsi_id, 0);
2544 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2551 * Called by scsi stack when something has really gone wrong.
2553 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2555 struct scsi_id_instance_data *scsi_id =
2556 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2558 SBP2_ERR("reset requested");
2560 if (sbp2util_node_is_available(scsi_id)) {
2561 SBP2_ERR("Generating sbp2 fetch agent reset");
2562 sbp2_agent_reset(scsi_id, 0);
2568 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2569 struct device_attribute *attr,
2572 struct scsi_device *sdev;
2573 struct scsi_id_instance_data *scsi_id;
2576 if (!(sdev = to_scsi_device(dev)))
2579 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2582 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2584 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2585 scsi_id->ud->id, lun);
2587 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2589 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2590 &dev_attr_ieee1394_id,
2594 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2595 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2596 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2597 MODULE_LICENSE("GPL");
2599 /* SCSI host template */
2600 static struct scsi_host_template scsi_driver_template = {
2601 .module = THIS_MODULE,
2602 .name = "SBP-2 IEEE-1394",
2603 .proc_name = SBP2_DEVICE_NAME,
2604 .queuecommand = sbp2scsi_queuecommand,
2605 .eh_abort_handler = sbp2scsi_abort,
2606 .eh_device_reset_handler = sbp2scsi_reset,
2607 .slave_alloc = sbp2scsi_slave_alloc,
2608 .slave_configure = sbp2scsi_slave_configure,
2609 .slave_destroy = sbp2scsi_slave_destroy,
2611 .sg_tablesize = SG_ALL,
2612 .use_clustering = ENABLE_CLUSTERING,
2613 .cmd_per_lun = SBP2_MAX_CMDS,
2614 .can_queue = SBP2_MAX_CMDS,
2616 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2619 static int sbp2_module_init(void)
2623 SBP2_DEBUG("sbp2_module_init");
2625 /* Module load debug option to force one command at a time (serializing I/O) */
2627 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2628 SBP2_INFO("Try serialize_io=0 for better performance");
2629 scsi_driver_template.can_queue = 1;
2630 scsi_driver_template.cmd_per_lun = 1;
2633 /* Set max sectors (module load option). Default is 255 sectors. */
2634 scsi_driver_template.max_sectors = max_sectors;
2636 /* Register our high level driver with 1394 stack */
2637 hpsb_register_highlevel(&sbp2_highlevel);
2639 ret = hpsb_register_protocol(&sbp2_driver);
2641 SBP2_ERR("Failed to register protocol");
2642 hpsb_unregister_highlevel(&sbp2_highlevel);
2649 static void __exit sbp2_module_exit(void)
2651 SBP2_DEBUG("sbp2_module_exit");
2653 hpsb_unregister_protocol(&sbp2_driver);
2655 hpsb_unregister_highlevel(&sbp2_highlevel);
2658 module_init(sbp2_module_init);
2659 module_exit(sbp2_module_exit);