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"
83 static char version[] __devinitdata =
84 "$Rev: 1219 $ Ben Collins <bcollins@debian.org>";
87 * Module load parameter definitions
91 * Change max_speed on module load if you have a bad IEEE-1394
92 * controller that has trouble running 2KB packets at 400mb.
94 * NOTE: On certain OHCI parts I have seen short packets on async transmit
95 * (probably due to PCI latency/throughput issues with the part). You can
96 * bump down the speed if you are running into problems.
98 static int max_speed = IEEE1394_SPEED_MAX;
99 module_param(max_speed, int, 0644);
100 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb default, 1 = 200mb, 0 = 100mb)");
103 * Set serialize_io to 1 if you'd like only one scsi command sent
104 * down to us at a time (debugging). This might be necessary for very
105 * badly behaved sbp2 devices.
107 static int serialize_io = 0;
108 module_param(serialize_io, int, 0444);
109 MODULE_PARM_DESC(serialize_io, "Serialize all I/O coming down from the scsi drivers (default = 0)");
112 * Bump up max_sectors if you'd like to support very large sized
113 * transfers. Please note that some older sbp2 bridge chips are broken for
114 * transfers greater or equal to 128KB. Default is a value of 255
115 * sectors, or just under 128KB (at 512 byte sector size). I can note that
116 * the Oxsemi sbp2 chipsets have no problems supporting very large
119 static int max_sectors = SBP2_MAX_SECTORS;
120 module_param(max_sectors, int, 0444);
121 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = 255)");
124 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
125 * do an exclusive login, as it's generally unsafe to have two hosts
126 * talking to a single sbp2 device at the same time (filesystem coherency,
127 * etc.). If you're running an sbp2 device that supports multiple logins,
128 * and you're either running read-only filesystems or some sort of special
129 * filesystem supporting multiple hosts (one such filesystem is OpenGFS,
130 * see opengfs.sourceforge.net for more info), then set exclusive_login
131 * to zero. Note: The Oxsemi OXFW911 sbp2 chipset supports up to four
134 static int exclusive_login = 1;
135 module_param(exclusive_login, int, 0644);
136 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
139 * SCSI inquiry hack for really badly behaved sbp2 devices. Turn this on
140 * if your sbp2 device is not properly handling the SCSI inquiry command.
141 * This hack makes the inquiry look more like a typical MS Windows
144 * If force_inquiry_hack=1 is required for your device to work,
145 * please submit the logged sbp2_firmware_revision value of this device to
146 * the linux1394-devel mailing list.
148 static int force_inquiry_hack = 0;
149 module_param(force_inquiry_hack, int, 0444);
150 MODULE_PARM_DESC(force_inquiry_hack, "Force SCSI inquiry hack (default = 0)");
154 * Export information about protocols/devices supported by this driver.
156 static struct ieee1394_device_id sbp2_id_table[] = {
158 .match_flags =IEEE1394_MATCH_SPECIFIER_ID |
159 IEEE1394_MATCH_VERSION,
160 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
161 .version = SBP2_SW_VERSION_ENTRY & 0xffffff
166 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
169 * Debug levels, configured via kernel config, or enable here.
172 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
173 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
174 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
175 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
176 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
178 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
179 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
180 static u32 global_outstanding_command_orbs = 0;
181 #define outstanding_orb_incr global_outstanding_command_orbs++
182 #define outstanding_orb_decr global_outstanding_command_orbs--
184 #define SBP2_ORB_DEBUG(fmt, args...)
185 #define outstanding_orb_incr
186 #define outstanding_orb_decr
189 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
190 #define SBP2_DMA_ALLOC(fmt, args...) \
191 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
192 ++global_outstanding_dmas, ## args)
193 #define SBP2_DMA_FREE(fmt, args...) \
194 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
195 --global_outstanding_dmas, ## args)
196 static u32 global_outstanding_dmas = 0;
198 #define SBP2_DMA_ALLOC(fmt, args...)
199 #define SBP2_DMA_FREE(fmt, args...)
202 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
203 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
204 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
205 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
206 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
207 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
208 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
209 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
210 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
211 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
213 #define SBP2_DEBUG(fmt, args...)
214 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
215 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
216 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
219 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
226 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
229 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
230 u32 scsi_status, struct scsi_cmnd *SCpnt,
231 void (*done)(struct scsi_cmnd *));
233 static struct scsi_host_template scsi_driver_template;
235 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
237 static void sbp2_host_reset(struct hpsb_host *host);
239 static int sbp2_probe(struct device *dev);
240 static int sbp2_remove(struct device *dev);
241 static int sbp2_update(struct unit_directory *ud);
243 static struct hpsb_highlevel sbp2_highlevel = {
244 .name = SBP2_DEVICE_NAME,
245 .host_reset = sbp2_host_reset,
248 static struct hpsb_address_ops sbp2_ops = {
249 .write = sbp2_handle_status_write
252 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
253 static struct hpsb_address_ops sbp2_physdma_ops = {
254 .read = sbp2_handle_physdma_read,
255 .write = sbp2_handle_physdma_write,
259 static struct hpsb_protocol_driver sbp2_driver = {
260 .name = "SBP2 Driver",
261 .id_table = sbp2_id_table,
262 .update = sbp2_update,
264 .name = SBP2_DEVICE_NAME,
265 .bus = &ieee1394_bus_type,
267 .remove = sbp2_remove,
272 /* List of device firmware's that require a forced 36 byte inquiry. */
273 static u32 sbp2_broken_inquiry_list[] = {
274 0x00002800, /* Stefan Richter <richtest@bauwesen.tu-cottbus.de> */
275 /* DViCO Momobay CX-1 */
276 0x00000200 /* Andreas Plesch <plesch@fas.harvard.edu> */
277 /* QPS Fire DVDBurner */
280 #define NUM_BROKEN_INQUIRY_DEVS \
281 (sizeof(sbp2_broken_inquiry_list)/sizeof(*sbp2_broken_inquiry_list))
283 /**************************************
284 * General utility functions
285 **************************************/
290 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
292 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
296 for (length = (length >> 2); length--; )
297 temp[length] = be32_to_cpu(temp[length]);
303 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
305 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
309 for (length = (length >> 2); length--; )
310 temp[length] = cpu_to_be32(temp[length]);
314 #else /* BIG_ENDIAN */
315 /* Why waste the cpu cycles? */
316 #define sbp2util_be32_to_cpu_buffer(x,y)
317 #define sbp2util_cpu_to_be32_buffer(x,y)
320 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
322 * Debug packet dump routine. Length is in bytes.
324 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name, u32 dump_phys_addr)
327 unsigned char *dump = buffer;
329 if (!dump || !length || !dump_name)
333 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
335 printk("[%s]", dump_name);
336 for (i = 0; i < length; i++) {
345 printk("%02x ", (int) dump[i]);
352 #define sbp2util_packet_dump(w,x,y,z)
356 * Goofy routine that basically does a down_timeout function.
358 static int sbp2util_down_timeout(atomic_t *done, int timeout)
362 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
363 if (msleep_interruptible(100)) /* 100ms */
366 return ((i > 0) ? 0:1);
369 /* Free's an allocated packet */
370 static void sbp2_free_packet(struct hpsb_packet *packet)
372 hpsb_free_tlabel(packet);
373 hpsb_free_packet(packet);
376 /* This is much like hpsb_node_write(), except it ignores the response
377 * subaction and returns immediately. Can be used from interrupts.
379 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
380 quadlet_t *buffer, size_t length)
382 struct hpsb_packet *packet;
384 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
385 addr, buffer, length);
389 hpsb_set_packet_complete_task(packet, (void (*)(void*))sbp2_free_packet,
392 hpsb_node_fill_packet(ne, packet);
394 if (hpsb_send_packet(packet) < 0) {
395 sbp2_free_packet(packet);
403 * This function is called to create a pool of command orbs used for
404 * command processing. It is called when a new sbp2 device is detected.
406 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
408 struct sbp2scsi_host_info *hi = scsi_id->hi;
410 unsigned long flags, orbs;
411 struct sbp2_command_info *command;
413 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
415 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
416 for (i = 0; i < orbs; i++) {
417 command = (struct sbp2_command_info *)
418 kmalloc(sizeof(struct sbp2_command_info), GFP_ATOMIC);
420 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
423 memset(command, '\0', sizeof(struct sbp2_command_info));
424 command->command_orb_dma =
425 pci_map_single (hi->host->pdev, &command->command_orb,
426 sizeof(struct sbp2_command_orb),
427 PCI_DMA_BIDIRECTIONAL);
428 SBP2_DMA_ALLOC("single command orb DMA");
430 pci_map_single (hi->host->pdev, &command->scatter_gather_element,
431 sizeof(command->scatter_gather_element),
432 PCI_DMA_BIDIRECTIONAL);
433 SBP2_DMA_ALLOC("scatter_gather_element");
434 INIT_LIST_HEAD(&command->list);
435 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
437 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
442 * This function is called to delete a pool of command orbs.
444 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
446 struct hpsb_host *host = scsi_id->hi->host;
447 struct list_head *lh, *next;
448 struct sbp2_command_info *command;
451 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
452 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
453 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
454 command = list_entry(lh, struct sbp2_command_info, list);
456 /* Release our generic DMA's */
457 pci_unmap_single(host->pdev, command->command_orb_dma,
458 sizeof(struct sbp2_command_orb),
459 PCI_DMA_BIDIRECTIONAL);
460 SBP2_DMA_FREE("single command orb DMA");
461 pci_unmap_single(host->pdev, command->sge_dma,
462 sizeof(command->scatter_gather_element),
463 PCI_DMA_BIDIRECTIONAL);
464 SBP2_DMA_FREE("scatter_gather_element");
469 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
474 * This function finds the sbp2_command for a given outstanding command
475 * orb.Only looks at the inuse list.
477 static struct sbp2_command_info *sbp2util_find_command_for_orb(
478 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
480 struct sbp2_command_info *command;
483 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
484 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
485 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
486 if (command->command_orb_dma == orb) {
487 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
492 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
494 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
500 * This function finds the sbp2_command for a given outstanding SCpnt.
501 * Only looks at the inuse list.
503 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt)
505 struct sbp2_command_info *command;
508 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
509 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
510 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
511 if (command->Current_SCpnt == SCpnt) {
512 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
517 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
522 * This function allocates a command orb used to send a scsi command.
524 static struct sbp2_command_info *sbp2util_allocate_command_orb(
525 struct scsi_id_instance_data *scsi_id,
526 struct scsi_cmnd *Current_SCpnt,
527 void (*Current_done)(struct scsi_cmnd *))
529 struct list_head *lh;
530 struct sbp2_command_info *command = NULL;
533 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
534 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
535 lh = scsi_id->sbp2_command_orb_completed.next;
537 command = list_entry(lh, struct sbp2_command_info, list);
538 command->Current_done = Current_done;
539 command->Current_SCpnt = Current_SCpnt;
540 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
542 SBP2_ERR("sbp2util_allocate_command_orb - No orbs available!");
544 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
549 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
551 struct scsi_id_instance_data *scsi_id =
552 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
553 struct hpsb_host *host;
556 printk(KERN_ERR "%s: scsi_id == NULL\n", __FUNCTION__);
560 host = scsi_id->ud->ne->host;
562 if (command->cmd_dma) {
563 if (command->dma_type == CMD_DMA_SINGLE) {
564 pci_unmap_single(host->pdev, command->cmd_dma,
565 command->dma_size, command->dma_dir);
566 SBP2_DMA_FREE("single bulk");
567 } else if (command->dma_type == CMD_DMA_PAGE) {
568 pci_unmap_page(host->pdev, command->cmd_dma,
569 command->dma_size, command->dma_dir);
570 SBP2_DMA_FREE("single page");
571 } /* XXX: Check for CMD_DMA_NONE bug */
572 command->dma_type = CMD_DMA_NONE;
573 command->cmd_dma = 0;
576 if (command->sge_buffer) {
577 pci_unmap_sg(host->pdev, command->sge_buffer,
578 command->dma_size, command->dma_dir);
579 SBP2_DMA_FREE("scatter list");
580 command->sge_buffer = NULL;
585 * This function moves a command to the completed orb list.
587 static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id, struct sbp2_command_info *command)
591 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
592 list_del(&command->list);
593 sbp2util_free_command_dma(command);
594 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
595 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
600 /*********************************************
601 * IEEE-1394 core driver stack related section
602 *********************************************/
603 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
605 static int sbp2_probe(struct device *dev)
607 struct unit_directory *ud;
608 struct scsi_id_instance_data *scsi_id;
610 SBP2_DEBUG("sbp2_probe");
612 ud = container_of(dev, struct unit_directory, device);
614 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
616 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
619 scsi_id = sbp2_alloc_device(ud);
624 sbp2_parse_unit_directory(scsi_id, ud);
626 return sbp2_start_device(scsi_id);
629 static int sbp2_remove(struct device *dev)
631 struct unit_directory *ud;
632 struct scsi_id_instance_data *scsi_id;
634 SBP2_DEBUG("sbp2_remove");
636 ud = container_of(dev, struct unit_directory, device);
637 scsi_id = ud->device.driver_data;
639 sbp2_logout_device(scsi_id);
640 sbp2_remove_device(scsi_id);
645 static int sbp2_update(struct unit_directory *ud)
647 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
649 SBP2_DEBUG("sbp2_update");
651 if (sbp2_reconnect_device(scsi_id)) {
654 * Ok, reconnect has failed. Perhaps we didn't
655 * reconnect fast enough. Try doing a regular login, but
656 * first do a logout just in case of any weirdness.
658 sbp2_logout_device(scsi_id);
660 if (sbp2_login_device(scsi_id)) {
661 /* Login failed too, just fail, and the backend
662 * will call our sbp2_remove for us */
663 SBP2_ERR("Failed to reconnect to sbp2 device!");
668 /* Set max retries to something large on the device. */
669 sbp2_set_busy_timeout(scsi_id);
671 /* Do a SBP-2 fetch agent reset. */
672 sbp2_agent_reset(scsi_id, 1);
674 /* Get the max speed and packet size that we can use. */
675 sbp2_max_speed_and_size(scsi_id);
677 /* Complete any pending commands with busy (so they get
678 * retried) and remove them from our queue
680 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
682 /* Make sure we unblock requests (since this is likely after a bus
684 scsi_unblock_requests(scsi_id->scsi_host);
689 /* This functions is called by the sbp2_probe, for each new device. We now
690 * allocate one scsi host for each scsi_id (unit directory). */
691 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
693 struct sbp2scsi_host_info *hi;
694 struct Scsi_Host *scsi_host = NULL;
695 struct scsi_id_instance_data *scsi_id = NULL;
697 SBP2_DEBUG("sbp2_alloc_device");
699 scsi_id = kmalloc(sizeof(*scsi_id), GFP_KERNEL);
701 SBP2_ERR("failed to create scsi_id");
704 memset(scsi_id, 0, sizeof(*scsi_id));
706 scsi_id->ne = ud->ne;
708 scsi_id->speed_code = IEEE1394_SPEED_100;
709 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
710 atomic_set(&scsi_id->sbp2_login_complete, 0);
711 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
712 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
713 INIT_LIST_HEAD(&scsi_id->scsi_list);
714 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
715 scsi_id->sbp2_device_type_and_lun = SBP2_DEVICE_TYPE_LUN_UNINITIALIZED;
717 ud->device.driver_data = scsi_id;
719 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
721 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
723 SBP2_ERR("failed to allocate hostinfo");
726 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
727 hi->host = ud->ne->host;
728 INIT_LIST_HEAD(&hi->scsi_ids);
730 /* Register our sbp2 status address space... */
731 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_ops,
732 SBP2_STATUS_FIFO_ADDRESS,
733 SBP2_STATUS_FIFO_ADDRESS +
734 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(SBP2_MAX_UDS_PER_NODE+1));
735 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
736 /* Handle data movement if physical dma is not
737 * enabled/supportedon host controller */
738 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_physdma_ops,
739 0x0ULL, 0xfffffffcULL);
745 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
747 /* Register our host with the SCSI stack. */
748 scsi_host = scsi_host_alloc(&scsi_driver_template, 0);
750 SBP2_ERR("failed to register scsi host");
754 scsi_host->hostdata[0] = (unsigned long)scsi_id;
756 if (!scsi_add_host(scsi_host, &ud->device)) {
757 scsi_id->scsi_host = scsi_host;
761 SBP2_ERR("failed to add scsi host");
762 scsi_host_put(scsi_host);
765 sbp2_remove_device(scsi_id);
770 static void sbp2_host_reset(struct hpsb_host *host)
772 struct sbp2scsi_host_info *hi;
773 struct scsi_id_instance_data *scsi_id;
775 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
778 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
779 scsi_block_requests(scsi_id->scsi_host);
785 * This function is where we first pull the node unique ids, and then
786 * allocate memory and register a SBP-2 device.
788 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
790 struct sbp2scsi_host_info *hi = scsi_id->hi;
791 struct scsi_device *sdev;
793 SBP2_DEBUG("sbp2_start_device");
796 scsi_id->login_response =
797 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_login_response),
798 &scsi_id->login_response_dma);
799 if (!scsi_id->login_response)
801 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
803 /* Query logins ORB DMA */
804 scsi_id->query_logins_orb =
805 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_query_logins_orb),
806 &scsi_id->query_logins_orb_dma);
807 if (!scsi_id->query_logins_orb)
809 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
811 /* Query logins response DMA */
812 scsi_id->query_logins_response =
813 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_query_logins_response),
814 &scsi_id->query_logins_response_dma);
815 if (!scsi_id->query_logins_response)
817 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
819 /* Reconnect ORB DMA */
820 scsi_id->reconnect_orb =
821 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_reconnect_orb),
822 &scsi_id->reconnect_orb_dma);
823 if (!scsi_id->reconnect_orb)
825 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
828 scsi_id->logout_orb =
829 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_logout_orb),
830 &scsi_id->logout_orb_dma);
831 if (!scsi_id->logout_orb)
833 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
837 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_login_orb),
838 &scsi_id->login_orb_dma);
839 if (!scsi_id->login_orb) {
841 if (scsi_id->query_logins_response) {
842 pci_free_consistent(hi->host->pdev,
843 sizeof(struct sbp2_query_logins_response),
844 scsi_id->query_logins_response,
845 scsi_id->query_logins_response_dma);
846 SBP2_DMA_FREE("query logins response DMA");
849 if (scsi_id->query_logins_orb) {
850 pci_free_consistent(hi->host->pdev,
851 sizeof(struct sbp2_query_logins_orb),
852 scsi_id->query_logins_orb,
853 scsi_id->query_logins_orb_dma);
854 SBP2_DMA_FREE("query logins ORB DMA");
857 if (scsi_id->logout_orb) {
858 pci_free_consistent(hi->host->pdev,
859 sizeof(struct sbp2_logout_orb),
861 scsi_id->logout_orb_dma);
862 SBP2_DMA_FREE("logout ORB DMA");
865 if (scsi_id->reconnect_orb) {
866 pci_free_consistent(hi->host->pdev,
867 sizeof(struct sbp2_reconnect_orb),
868 scsi_id->reconnect_orb,
869 scsi_id->reconnect_orb_dma);
870 SBP2_DMA_FREE("reconnect ORB DMA");
873 if (scsi_id->login_response) {
874 pci_free_consistent(hi->host->pdev,
875 sizeof(struct sbp2_login_response),
876 scsi_id->login_response,
877 scsi_id->login_response_dma);
878 SBP2_DMA_FREE("login FIFO DMA");
881 list_del(&scsi_id->scsi_list);
885 SBP2_ERR ("Could not allocate memory for scsi_id");
889 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
891 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
894 * Create our command orb pool
896 if (sbp2util_create_command_orb_pool(scsi_id)) {
897 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
898 sbp2_remove_device(scsi_id);
902 /* Schedule a timeout here. The reason is that we may be so close
903 * to a bus reset, that the device is not available for logins.
904 * This can happen when the bus reset is caused by the host
905 * connected to the sbp2 device being removed. That host would
906 * have a certain amount of time to relogin before the sbp2 device
907 * allows someone else to login instead. One second makes sense. */
908 msleep_interruptible(1000);
909 if (signal_pending(current)) {
910 SBP2_WARN("aborting sbp2_start_device due to event");
911 sbp2_remove_device(scsi_id);
916 * Login to the sbp-2 device
918 if (sbp2_login_device(scsi_id)) {
919 /* Login failed, just remove the device. */
920 sbp2_remove_device(scsi_id);
925 * Set max retries to something large on the device
927 sbp2_set_busy_timeout(scsi_id);
930 * Do a SBP-2 fetch agent reset
932 sbp2_agent_reset(scsi_id, 1);
935 * Get the max speed and packet size that we can use
937 sbp2_max_speed_and_size(scsi_id);
939 /* Add this device to the scsi layer now */
940 sdev = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
942 SBP2_ERR("scsi_add_device failed");
943 return PTR_ERR(sdev);
950 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
952 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
954 struct sbp2scsi_host_info *hi;
956 SBP2_DEBUG("sbp2_remove_device");
963 /* This will remove our scsi device aswell */
964 if (scsi_id->scsi_host) {
965 scsi_remove_host(scsi_id->scsi_host);
966 scsi_host_put(scsi_id->scsi_host);
969 sbp2util_remove_command_orb_pool(scsi_id);
971 list_del(&scsi_id->scsi_list);
973 if (scsi_id->login_response) {
974 pci_free_consistent(hi->host->pdev,
975 sizeof(struct sbp2_login_response),
976 scsi_id->login_response,
977 scsi_id->login_response_dma);
978 SBP2_DMA_FREE("single login FIFO");
981 if (scsi_id->login_orb) {
982 pci_free_consistent(hi->host->pdev,
983 sizeof(struct sbp2_login_orb),
985 scsi_id->login_orb_dma);
986 SBP2_DMA_FREE("single login ORB");
989 if (scsi_id->reconnect_orb) {
990 pci_free_consistent(hi->host->pdev,
991 sizeof(struct sbp2_reconnect_orb),
992 scsi_id->reconnect_orb,
993 scsi_id->reconnect_orb_dma);
994 SBP2_DMA_FREE("single reconnect orb");
997 if (scsi_id->logout_orb) {
998 pci_free_consistent(hi->host->pdev,
999 sizeof(struct sbp2_logout_orb),
1000 scsi_id->logout_orb,
1001 scsi_id->logout_orb_dma);
1002 SBP2_DMA_FREE("single logout orb");
1005 if (scsi_id->query_logins_orb) {
1006 pci_free_consistent(hi->host->pdev,
1007 sizeof(struct sbp2_query_logins_orb),
1008 scsi_id->query_logins_orb,
1009 scsi_id->query_logins_orb_dma);
1010 SBP2_DMA_FREE("single query logins orb");
1013 if (scsi_id->query_logins_response) {
1014 pci_free_consistent(hi->host->pdev,
1015 sizeof(struct sbp2_query_logins_response),
1016 scsi_id->query_logins_response,
1017 scsi_id->query_logins_response_dma);
1018 SBP2_DMA_FREE("single query logins data");
1021 scsi_id->ud->device.driver_data = NULL;
1023 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1028 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1030 * This function deals with physical dma write requests (for adapters that do not support
1031 * physical dma in hardware). Mostly just here for debugging...
1033 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data,
1034 u64 addr, size_t length, u16 flags)
1038 * Manually put the data in the right place.
1040 memcpy(bus_to_virt((u32)addr), data, length);
1041 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device", (u32)addr);
1042 return(RCODE_COMPLETE);
1046 * This function deals with physical dma read requests (for adapters that do not support
1047 * physical dma in hardware). Mostly just here for debugging...
1049 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data,
1050 u64 addr, size_t length, u16 flags)
1054 * Grab data from memory and send a read response.
1056 memcpy(data, bus_to_virt((u32)addr), length);
1057 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device", (u32)addr);
1058 return(RCODE_COMPLETE);
1063 /**************************************
1064 * SBP-2 protocol related section
1065 **************************************/
1068 * This function determines if we should convert scsi commands for a particular sbp2 device type
1070 static __inline__ int sbp2_command_conversion_device_type(u8 device_type)
1072 return (((device_type == TYPE_DISK) ||
1073 (device_type == TYPE_RBC) ||
1074 (device_type == TYPE_ROM)) ? 1:0);
1078 * This function queries the device for the maximum concurrent logins it
1081 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1083 struct sbp2scsi_host_info *hi = scsi_id->hi;
1088 SBP2_DEBUG("sbp2_query_logins");
1090 scsi_id->query_logins_orb->reserved1 = 0x0;
1091 scsi_id->query_logins_orb->reserved2 = 0x0;
1093 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1094 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1095 SBP2_DEBUG("sbp2_query_logins: query_response_hi/lo initialized");
1097 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1098 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1099 if (scsi_id->sbp2_device_type_and_lun != SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
1100 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
1101 SBP2_DEBUG("sbp2_query_logins: set lun to %d",
1102 ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun));
1104 SBP2_DEBUG("sbp2_query_logins: lun_misc initialized");
1106 scsi_id->query_logins_orb->reserved_resp_length =
1107 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1108 SBP2_DEBUG("sbp2_query_logins: reserved_resp_length initialized");
1110 scsi_id->query_logins_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1111 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1112 scsi_id->query_logins_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1113 SBP2_STATUS_FIFO_ADDRESS_HI);
1114 SBP2_DEBUG("sbp2_query_logins: status FIFO initialized");
1116 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1118 SBP2_DEBUG("sbp2_query_logins: orb byte-swapped");
1120 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1121 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1123 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1124 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1126 SBP2_DEBUG("sbp2_query_logins: query_logins_response/status FIFO memset");
1128 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1129 data[1] = scsi_id->query_logins_orb_dma;
1130 sbp2util_cpu_to_be32_buffer(data, 8);
1132 atomic_set(&scsi_id->sbp2_login_complete, 0);
1134 SBP2_DEBUG("sbp2_query_logins: prepared to write");
1135 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1136 SBP2_DEBUG("sbp2_query_logins: written");
1138 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1139 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1143 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1144 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1148 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1149 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1150 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1152 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1156 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1158 SBP2_DEBUG("length_max_logins = %x",
1159 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1161 SBP2_DEBUG("Query logins to SBP-2 device successful");
1163 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1164 SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1166 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1167 SBP2_DEBUG("Number of active logins: %d", active_logins);
1169 if (active_logins >= max_logins) {
1177 * This function is called in order to login to a particular SBP-2 device,
1178 * after a bus reset.
1180 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1182 struct sbp2scsi_host_info *hi = scsi_id->hi;
1185 SBP2_DEBUG("sbp2_login_device");
1187 if (!scsi_id->login_orb) {
1188 SBP2_DEBUG("sbp2_login_device: login_orb not alloc'd!");
1192 if (!exclusive_login) {
1193 if (sbp2_query_logins(scsi_id)) {
1194 SBP2_INFO("Device does not support any more concurrent logins");
1199 /* Set-up login ORB, assume no password */
1200 scsi_id->login_orb->password_hi = 0;
1201 scsi_id->login_orb->password_lo = 0;
1202 SBP2_DEBUG("sbp2_login_device: password_hi/lo initialized");
1204 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1205 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1206 SBP2_DEBUG("sbp2_login_device: login_response_hi/lo initialized");
1208 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1209 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1210 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1211 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1212 /* Set the lun if we were able to pull it from the device's unit directory */
1213 if (scsi_id->sbp2_device_type_and_lun != SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
1214 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
1215 SBP2_DEBUG("sbp2_query_logins: set lun to %d",
1216 ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun));
1218 SBP2_DEBUG("sbp2_login_device: lun_misc initialized");
1220 scsi_id->login_orb->passwd_resp_lengths =
1221 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1222 SBP2_DEBUG("sbp2_login_device: passwd_resp_lengths initialized");
1224 scsi_id->login_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1225 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1226 scsi_id->login_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1227 SBP2_STATUS_FIFO_ADDRESS_HI);
1228 SBP2_DEBUG("sbp2_login_device: status FIFO initialized");
1231 * Byte swap ORB if necessary
1233 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1235 SBP2_DEBUG("sbp2_login_device: orb byte-swapped");
1237 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1238 "sbp2 login orb", scsi_id->login_orb_dma);
1241 * Initialize login response and status fifo
1243 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1244 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1246 SBP2_DEBUG("sbp2_login_device: login_response/status FIFO memset");
1249 * Ok, let's write to the target's management agent register
1251 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1252 data[1] = scsi_id->login_orb_dma;
1253 sbp2util_cpu_to_be32_buffer(data, 8);
1255 atomic_set(&scsi_id->sbp2_login_complete, 0);
1257 SBP2_DEBUG("sbp2_login_device: prepared to write to %08x",
1258 (unsigned int)scsi_id->sbp2_management_agent_addr);
1259 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1260 SBP2_DEBUG("sbp2_login_device: written");
1263 * Wait for login status (up to 20 seconds)...
1265 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1266 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1271 * Sanity. Make sure status returned matches login orb.
1273 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1274 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1281 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1282 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1283 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1285 SBP2_ERR("Error logging into SBP-2 device - login failed");
1290 * Byte swap the login response, for use when reconnecting or
1293 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1296 * Grab our command block agent address from the login response.
1298 SBP2_DEBUG("command_block_agent_hi = %x",
1299 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1300 SBP2_DEBUG("command_block_agent_lo = %x",
1301 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1303 scsi_id->sbp2_command_block_agent_addr =
1304 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1305 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1306 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1308 SBP2_INFO("Logged into SBP-2 device");
1315 * This function is called in order to logout from a particular SBP-2
1316 * device, usually called during driver unload.
1318 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1320 struct sbp2scsi_host_info *hi = scsi_id->hi;
1324 SBP2_DEBUG("sbp2_logout_device");
1329 scsi_id->logout_orb->reserved1 = 0x0;
1330 scsi_id->logout_orb->reserved2 = 0x0;
1331 scsi_id->logout_orb->reserved3 = 0x0;
1332 scsi_id->logout_orb->reserved4 = 0x0;
1334 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1335 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1337 /* Notify us when complete */
1338 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1340 scsi_id->logout_orb->reserved5 = 0x0;
1341 scsi_id->logout_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1342 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1343 scsi_id->logout_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1344 SBP2_STATUS_FIFO_ADDRESS_HI);
1347 * Byte swap ORB if necessary
1349 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1351 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1352 "sbp2 logout orb", scsi_id->logout_orb_dma);
1355 * Ok, let's write to the target's management agent register
1357 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1358 data[1] = scsi_id->logout_orb_dma;
1359 sbp2util_cpu_to_be32_buffer(data, 8);
1361 atomic_set(&scsi_id->sbp2_login_complete, 0);
1363 error = hpsb_node_write(scsi_id->ne,
1364 scsi_id->sbp2_management_agent_addr,
1369 /* Wait for device to logout...1 second. */
1370 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1373 SBP2_INFO("Logged out of SBP-2 device");
1380 * This function is called in order to reconnect to a particular SBP-2
1381 * device, after a bus reset.
1383 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1385 struct sbp2scsi_host_info *hi = scsi_id->hi;
1389 SBP2_DEBUG("sbp2_reconnect_device");
1392 * Set-up reconnect ORB
1394 scsi_id->reconnect_orb->reserved1 = 0x0;
1395 scsi_id->reconnect_orb->reserved2 = 0x0;
1396 scsi_id->reconnect_orb->reserved3 = 0x0;
1397 scsi_id->reconnect_orb->reserved4 = 0x0;
1399 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1400 scsi_id->reconnect_orb->login_ID_misc |=
1401 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1403 /* Notify us when complete */
1404 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1406 scsi_id->reconnect_orb->reserved5 = 0x0;
1407 scsi_id->reconnect_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1408 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1409 scsi_id->reconnect_orb->status_FIFO_hi =
1410 (ORB_SET_NODE_ID(hi->host->node_id) | SBP2_STATUS_FIFO_ADDRESS_HI);
1413 * Byte swap ORB if necessary
1415 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1417 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1418 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1421 * Initialize status fifo
1423 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1426 * Ok, let's write to the target's management agent register
1428 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1429 data[1] = scsi_id->reconnect_orb_dma;
1430 sbp2util_cpu_to_be32_buffer(data, 8);
1432 atomic_set(&scsi_id->sbp2_login_complete, 0);
1434 error = hpsb_node_write(scsi_id->ne,
1435 scsi_id->sbp2_management_agent_addr,
1441 * Wait for reconnect status (up to 1 second)...
1443 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1444 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1449 * Sanity. Make sure status returned matches reconnect orb.
1451 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1452 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1459 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1460 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1461 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1463 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1467 HPSB_DEBUG("Reconnected to SBP-2 device");
1474 * This function is called in order to set the busy timeout (number of
1475 * retries to attempt) on the sbp2 device.
1477 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1481 SBP2_DEBUG("sbp2_set_busy_timeout");
1484 * Ok, let's write to the target's busy timeout register
1486 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1488 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4)) {
1489 SBP2_ERR("sbp2_set_busy_timeout error");
1497 * This function is called to parse sbp2 device's config rom unit
1498 * directory. Used to determine things like sbp2 management agent offset,
1499 * and command set used (SCSI or RBC).
1501 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1502 struct unit_directory *ud)
1504 struct csr1212_keyval *kv;
1505 struct csr1212_dentry *dentry;
1506 u64 management_agent_addr;
1507 u32 command_set_spec_id, command_set, unit_characteristics,
1508 firmware_revision, workarounds;
1511 SBP2_DEBUG("sbp2_parse_unit_directory");
1513 management_agent_addr = 0x0;
1514 command_set_spec_id = 0x0;
1516 unit_characteristics = 0x0;
1517 firmware_revision = 0x0;
1519 /* Handle different fields in the unit directory, based on keys */
1520 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1521 switch (kv->key.id) {
1522 case CSR1212_KV_ID_DEPENDENT_INFO:
1523 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1524 /* Save off the management agent address */
1525 management_agent_addr =
1526 CSR1212_REGISTER_SPACE_BASE +
1527 (kv->value.csr_offset << 2);
1529 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1530 (unsigned int) management_agent_addr);
1531 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1532 scsi_id->sbp2_device_type_and_lun = kv->value.immediate;
1536 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1537 /* Command spec organization */
1538 command_set_spec_id = kv->value.immediate;
1539 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1540 (unsigned int) command_set_spec_id);
1543 case SBP2_COMMAND_SET_KEY:
1544 /* Command set used by sbp2 device */
1545 command_set = kv->value.immediate;
1546 SBP2_DEBUG("sbp2_command_set = %x",
1547 (unsigned int) command_set);
1550 case SBP2_UNIT_CHARACTERISTICS_KEY:
1552 * Unit characterisitcs (orb related stuff
1553 * that I'm not yet paying attention to)
1555 unit_characteristics = kv->value.immediate;
1556 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1557 (unsigned int) unit_characteristics);
1560 case SBP2_FIRMWARE_REVISION_KEY:
1561 /* Firmware revision */
1562 firmware_revision = kv->value.immediate;
1563 if (force_inquiry_hack)
1564 SBP2_INFO("sbp2_firmware_revision = %x",
1565 (unsigned int) firmware_revision);
1566 else SBP2_DEBUG("sbp2_firmware_revision = %x",
1567 (unsigned int) firmware_revision);
1575 /* This is the start of our broken device checking. We try to hack
1576 * around oddities and known defects. */
1579 /* If the vendor id is 0xa0b8 (Symbios vendor id), then we have a
1580 * bridge with 128KB max transfer size limitation. For sanity, we
1581 * only voice this when the current max_sectors setting
1582 * exceeds the 128k limit. By default, that is not the case.
1584 * It would be really nice if we could detect this before the scsi
1585 * host gets initialized. That way we can down-force the
1586 * max_sectors to account for it. That is not currently
1588 if ((firmware_revision & 0xffff00) ==
1589 SBP2_128KB_BROKEN_FIRMWARE &&
1590 (max_sectors * 512) > (128*1024)) {
1591 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB max transfer size.",
1592 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1593 SBP2_WARN("WARNING: Current max_sectors setting is larger than 128KB (%d sectors)!",
1595 workarounds |= SBP2_BREAKAGE_128K_MAX_TRANSFER;
1598 /* Check for a blacklisted set of devices that require us to force
1599 * a 36 byte host inquiry. This can be overriden as a module param
1600 * (to force all hosts). */
1601 for (i = 0; i < NUM_BROKEN_INQUIRY_DEVS; i++) {
1602 if ((firmware_revision & 0xffff00) ==
1603 sbp2_broken_inquiry_list[i]) {
1604 SBP2_WARN("Node " NODE_BUS_FMT ": Using 36byte inquiry workaround",
1605 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1606 workarounds |= SBP2_BREAKAGE_INQUIRY_HACK;
1607 break; /* No need to continue. */
1611 /* If this is a logical unit directory entry, process the parent
1612 * to get the values. */
1613 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1614 struct unit_directory *parent_ud =
1615 container_of(ud->device.parent, struct unit_directory, device);
1616 sbp2_parse_unit_directory(scsi_id, parent_ud);
1618 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1619 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1620 scsi_id->sbp2_command_set = command_set;
1621 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1622 scsi_id->sbp2_firmware_revision = firmware_revision;
1623 scsi_id->workarounds = workarounds;
1624 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1625 scsi_id->sbp2_device_type_and_lun = ud->lun;
1630 * This function is called in order to determine the max speed and packet
1631 * size we can use in our ORBs. Note, that we (the driver and host) only
1632 * initiate the transaction. The SBP-2 device actually transfers the data
1633 * (by reading from the DMA area we tell it). This means that the SBP-2
1634 * device decides the actual maximum data it can transfer. We just tell it
1635 * the speed that it needs to use, and the max_rec the host supports, and
1636 * it takes care of the rest.
1638 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1640 struct sbp2scsi_host_info *hi = scsi_id->hi;
1642 SBP2_DEBUG("sbp2_max_speed_and_size");
1644 /* Initial setting comes from the hosts speed map */
1645 scsi_id->speed_code = hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64
1646 + NODEID_TO_NODE(scsi_id->ne->nodeid)];
1648 /* Bump down our speed if the user requested it */
1649 if (scsi_id->speed_code > max_speed) {
1650 scsi_id->speed_code = max_speed;
1651 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1652 hpsb_speedto_str[scsi_id->speed_code]);
1655 /* Payload size is the lesser of what our speed supports and what
1656 * our host supports. */
1657 scsi_id->max_payload_size = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1658 (u8)(hi->host->csr.max_rec - 1));
1660 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1661 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1662 hpsb_speedto_str[scsi_id->speed_code],
1663 1 << ((u32)scsi_id->max_payload_size + 2));
1669 * This function is called in order to perform a SBP-2 agent reset.
1671 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1677 SBP2_DEBUG("sbp2_agent_reset");
1680 * Ok, let's write to the target's management agent register
1682 data = ntohl(SBP2_AGENT_RESET_DATA);
1683 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1686 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1688 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1691 SBP2_ERR("hpsb_node_write failed.\n");
1696 * Need to make sure orb pointer is written on next command
1698 scsi_id->last_orb = NULL;
1704 * This function is called to create the actual command orb and s/g list
1705 * out of the scsi command itself.
1707 static int sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1708 struct sbp2_command_info *command,
1710 unsigned int scsi_use_sg,
1711 unsigned int scsi_request_bufflen,
1712 void *scsi_request_buffer,
1713 enum dma_data_direction dma_dir)
1716 struct sbp2scsi_host_info *hi = scsi_id->hi;
1717 struct scatterlist *sgpnt = (struct scatterlist *) scsi_request_buffer;
1718 struct sbp2_command_orb *command_orb = &command->command_orb;
1719 struct sbp2_unrestricted_page_table *scatter_gather_element =
1720 &command->scatter_gather_element[0];
1721 u32 sg_count, sg_len, orb_direction;
1726 * Set-up our command ORB..
1728 * NOTE: We're doing unrestricted page tables (s/g), as this is
1729 * best performance (at least with the devices I have). This means
1730 * that data_size becomes the number of s/g elements, and
1731 * page_size should be zero (for unrestricted).
1733 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1734 command_orb->next_ORB_lo = 0x0;
1735 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1736 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1737 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1740 * Get the direction of the transfer. If the direction is unknown, then use our
1741 * goofy table as a back-up.
1745 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1748 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1750 case DMA_FROM_DEVICE:
1751 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1753 case DMA_BIDIRECTIONAL:
1755 SBP2_ERR("SCSI data transfer direction not specified. "
1756 "Update the SBP2 direction table in sbp2.h if "
1757 "necessary for your application");
1758 __scsi_print_command(scsi_cmd);
1759 orb_direction = sbp2scsi_direction_table[*scsi_cmd];
1764 * Set-up our pagetable stuff... unfortunately, this has become
1765 * messier than I'd like. Need to clean this up a bit. ;-)
1767 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1769 SBP2_DEBUG("No data transfer");
1772 * Handle no data transfer
1774 command_orb->data_descriptor_hi = 0x0;
1775 command_orb->data_descriptor_lo = 0x0;
1776 command_orb->misc |= ORB_SET_DIRECTION(1);
1778 } else if (scsi_use_sg) {
1780 SBP2_DEBUG("Use scatter/gather");
1783 * Special case if only one element (and less than 64KB in size)
1785 if ((scsi_use_sg == 1) && (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1787 SBP2_DEBUG("Only one s/g element");
1788 command->dma_dir = dma_dir;
1789 command->dma_size = sgpnt[0].length;
1790 command->dma_type = CMD_DMA_PAGE;
1791 command->cmd_dma = pci_map_page(hi->host->pdev,
1796 SBP2_DMA_ALLOC("single page scatter element");
1798 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1799 command_orb->data_descriptor_lo = command->cmd_dma;
1800 command_orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1801 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1804 int count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg, dma_dir);
1805 SBP2_DMA_ALLOC("scatter list");
1807 command->dma_size = scsi_use_sg;
1808 command->dma_dir = dma_dir;
1809 command->sge_buffer = sgpnt;
1811 /* use page tables (s/g) */
1812 command_orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1813 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1814 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1815 command_orb->data_descriptor_lo = command->sge_dma;
1818 * Loop through and fill out our sbp-2 page tables
1819 * (and split up anything too large)
1821 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1822 sg_len = sg_dma_len(sgpnt);
1823 sg_addr = sg_dma_address(sgpnt);
1825 scatter_gather_element[sg_count].segment_base_lo = sg_addr;
1826 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1827 scatter_gather_element[sg_count].length_segment_base_hi =
1828 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1829 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1830 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1832 scatter_gather_element[sg_count].length_segment_base_hi =
1833 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1840 /* Number of page table (s/g) elements */
1841 command_orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1843 sbp2util_packet_dump(scatter_gather_element,
1844 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1845 "sbp2 s/g list", command->sge_dma);
1848 * Byte swap page tables if necessary
1850 sbp2util_cpu_to_be32_buffer(scatter_gather_element,
1851 (sizeof(struct sbp2_unrestricted_page_table)) *
1858 SBP2_DEBUG("No scatter/gather");
1860 command->dma_dir = dma_dir;
1861 command->dma_size = scsi_request_bufflen;
1862 command->dma_type = CMD_DMA_SINGLE;
1863 command->cmd_dma = pci_map_single (hi->host->pdev, scsi_request_buffer,
1866 SBP2_DMA_ALLOC("single bulk");
1869 * Handle case where we get a command w/o s/g enabled (but
1870 * check for transfers larger than 64K)
1872 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1874 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1875 command_orb->data_descriptor_lo = command->cmd_dma;
1876 command_orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1877 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1880 * Sanity, in case our direction table is not
1883 if (!scsi_request_bufflen) {
1884 command_orb->data_descriptor_hi = 0x0;
1885 command_orb->data_descriptor_lo = 0x0;
1886 command_orb->misc |= ORB_SET_DIRECTION(1);
1891 * Need to turn this into page tables, since the
1892 * buffer is too large.
1894 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1895 command_orb->data_descriptor_lo = command->sge_dma;
1897 /* Use page tables (s/g) */
1898 command_orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1899 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1902 * fill out our sbp-2 page tables (and split up
1906 sg_len = scsi_request_bufflen;
1907 sg_addr = command->cmd_dma;
1909 scatter_gather_element[sg_count].segment_base_lo = sg_addr;
1910 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1911 scatter_gather_element[sg_count].length_segment_base_hi =
1912 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1913 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1914 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1916 scatter_gather_element[sg_count].length_segment_base_hi =
1917 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1923 /* Number of page table (s/g) elements */
1924 command_orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1926 sbp2util_packet_dump(scatter_gather_element,
1927 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1928 "sbp2 s/g list", command->sge_dma);
1931 * Byte swap page tables if necessary
1933 sbp2util_cpu_to_be32_buffer(scatter_gather_element,
1934 (sizeof(struct sbp2_unrestricted_page_table)) *
1942 * Byte swap command ORB if necessary
1944 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1947 * Put our scsi command in the command ORB
1949 memset(command_orb->cdb, 0, 12);
1950 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1956 * This function is called in order to begin a regular SBP-2 command.
1958 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1959 struct sbp2_command_info *command)
1961 struct sbp2scsi_host_info *hi = scsi_id->hi;
1962 struct sbp2_command_orb *command_orb = &command->command_orb;
1963 struct node_entry *ne = scsi_id->ne;
1966 outstanding_orb_incr;
1967 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1968 command_orb, global_outstanding_command_orbs);
1970 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1971 sizeof(struct sbp2_command_orb),
1972 PCI_DMA_BIDIRECTIONAL);
1973 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1974 sizeof(command->scatter_gather_element),
1975 PCI_DMA_BIDIRECTIONAL);
1977 * Check to see if there are any previous orbs to use
1979 if (scsi_id->last_orb == NULL) {
1983 * Ok, let's write to the target's management agent register
1985 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
1986 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1987 data[1] = command->command_orb_dma;
1988 sbp2util_cpu_to_be32_buffer(data, 8);
1990 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
1992 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
1993 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1997 SBP2_ORB_DEBUG("write command agent complete");
1999 scsi_id->last_orb = command_orb;
2000 scsi_id->last_orb_dma = command->command_orb_dma;
2006 * We have an orb already sent (maybe or maybe not
2007 * processed) that we can append this orb to. So do so,
2008 * and ring the doorbell. Have to be very careful
2009 * modifying these next orb pointers, as they are accessed
2010 * both by the sbp2 device and us.
2012 scsi_id->last_orb->next_ORB_lo =
2013 cpu_to_be32(command->command_orb_dma);
2014 /* Tells hardware that this pointer is valid */
2015 scsi_id->last_orb->next_ORB_hi = 0x0;
2016 pci_dma_sync_single_for_device(hi->host->pdev, scsi_id->last_orb_dma,
2017 sizeof(struct sbp2_command_orb),
2018 PCI_DMA_BIDIRECTIONAL);
2023 data = cpu_to_be32(command->command_orb_dma);
2024 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
2026 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
2028 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
2029 SBP2_ERR("sbp2util_node_write_no_wait failed");
2033 scsi_id->last_orb = command_orb;
2034 scsi_id->last_orb_dma = command->command_orb_dma;
2041 * This function is called in order to begin a regular SBP-2 command.
2043 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2044 struct scsi_cmnd *SCpnt,
2045 void (*done)(struct scsi_cmnd *))
2047 unchar *cmd = (unchar *) SCpnt->cmnd;
2048 unsigned int request_bufflen = SCpnt->request_bufflen;
2049 struct sbp2_command_info *command;
2051 SBP2_DEBUG("sbp2_send_command");
2052 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2053 printk("[scsi command]\n ");
2054 scsi_print_command(SCpnt);
2056 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2057 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2060 * Allocate a command orb and s/g structure
2062 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2068 * The scsi stack sends down a request_bufflen which does not match the
2069 * length field in the scsi cdb. This causes some sbp2 devices to
2070 * reject this inquiry command. Fix the request_bufflen.
2072 if (*cmd == INQUIRY) {
2073 if (force_inquiry_hack || scsi_id->workarounds & SBP2_BREAKAGE_INQUIRY_HACK)
2074 request_bufflen = cmd[4] = 0x24;
2076 request_bufflen = cmd[4];
2080 * Now actually fill in the comamnd orb and sbp2 s/g list
2082 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2083 request_bufflen, SCpnt->request_buffer,
2084 SCpnt->sc_data_direction);
2086 * Update our cdb if necessary (to handle sbp2 RBC command set
2087 * differences). This is where the command set hacks go! =)
2089 sbp2_check_sbp2_command(scsi_id, command->command_orb.cdb);
2091 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2092 "sbp2 command orb", command->command_orb_dma);
2095 * Initialize status fifo
2097 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2100 * Link up the orb, and ring the doorbell if needed
2102 sbp2_link_orb_command(scsi_id, command);
2109 * This function deals with command set differences between Linux scsi
2110 * command set and sbp2 RBC command set.
2112 static void sbp2_check_sbp2_command(struct scsi_id_instance_data *scsi_id, unchar *cmd)
2117 * Translates SBP-2 status into SCSI sense data for check conditions
2119 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2121 SBP2_DEBUG("sbp2_status_to_sense_data");
2124 * Ok, it's pretty ugly... ;-)
2126 sense_data[0] = 0x70;
2127 sense_data[1] = 0x0;
2128 sense_data[2] = sbp2_status[9];
2129 sense_data[3] = sbp2_status[12];
2130 sense_data[4] = sbp2_status[13];
2131 sense_data[5] = sbp2_status[14];
2132 sense_data[6] = sbp2_status[15];
2134 sense_data[8] = sbp2_status[16];
2135 sense_data[9] = sbp2_status[17];
2136 sense_data[10] = sbp2_status[18];
2137 sense_data[11] = sbp2_status[19];
2138 sense_data[12] = sbp2_status[10];
2139 sense_data[13] = sbp2_status[11];
2140 sense_data[14] = sbp2_status[20];
2141 sense_data[15] = sbp2_status[21];
2143 return(sbp2_status[8] & 0x3f); /* return scsi status */
2147 * This function is called after a command is completed, in order to do any necessary SBP-2
2148 * response data translations for the SCSI stack
2150 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2151 struct scsi_cmnd *SCpnt)
2153 u8 *scsi_buf = SCpnt->request_buffer;
2155 SBP2_DEBUG("sbp2_check_sbp2_response");
2157 switch (SCpnt->cmnd[0]) {
2162 * If scsi_id->sbp2_device_type_and_lun is uninitialized, then fill
2163 * this information in from the inquiry response data. Lun is set to zero.
2165 if (scsi_id->sbp2_device_type_and_lun == SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
2166 SBP2_DEBUG("Creating sbp2_device_type_and_lun from scsi inquiry data");
2167 scsi_id->sbp2_device_type_and_lun = (scsi_buf[0] & 0x1f) << 16;
2171 * Make sure data length is ok. Minimum length is 36 bytes
2173 if (scsi_buf[4] == 0) {
2174 scsi_buf[4] = 36 - 5;
2178 * Fix ansi revision and response data format
2181 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2192 * This function deals with status writes from the SBP-2 device
2194 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2195 quadlet_t *data, u64 addr, size_t length, u16 fl)
2197 struct sbp2scsi_host_info *hi;
2198 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2200 struct scsi_cmnd *SCpnt = NULL;
2201 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2202 struct sbp2_command_info *command;
2204 SBP2_DEBUG("sbp2_handle_status_write");
2206 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2209 SBP2_ERR("host is NULL - this is bad!");
2210 return(RCODE_ADDRESS_ERROR);
2213 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2216 SBP2_ERR("host info is NULL - this is bad!");
2217 return(RCODE_ADDRESS_ERROR);
2221 * Find our scsi_id structure by looking at the status fifo address written to by
2224 id = SBP2_STATUS_FIFO_OFFSET_TO_ENTRY((u32)(addr - SBP2_STATUS_FIFO_ADDRESS));
2225 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2226 if (scsi_id_tmp->ne->nodeid == nodeid && scsi_id_tmp->ud->id == id) {
2227 scsi_id = scsi_id_tmp;
2233 SBP2_ERR("scsi_id is NULL - device is gone?");
2234 return(RCODE_ADDRESS_ERROR);
2238 * Put response into scsi_id status fifo...
2240 memcpy(&scsi_id->status_block, data, length);
2243 * Byte swap first two quadlets (8 bytes) of status for processing
2245 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2248 * Handle command ORB status here if necessary. First, need to match status with command.
2250 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2253 SBP2_DEBUG("Found status for command ORB");
2254 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2255 sizeof(struct sbp2_command_orb),
2256 PCI_DMA_BIDIRECTIONAL);
2257 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2258 sizeof(command->scatter_gather_element),
2259 PCI_DMA_BIDIRECTIONAL);
2261 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2262 outstanding_orb_decr;
2265 * Matched status with command, now grab scsi command pointers and check status
2267 SCpnt = command->Current_SCpnt;
2268 sbp2util_mark_command_completed(scsi_id, command);
2273 * See if the target stored any scsi status information
2275 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2277 * Translate SBP-2 status to SCSI sense data
2279 SBP2_DEBUG("CHECK CONDITION");
2280 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2284 * Check to see if the dead bit is set. If so, we'll have to initiate
2285 * a fetch agent reset.
2287 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2290 * Initiate a fetch agent reset.
2292 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2293 sbp2_agent_reset(scsi_id, 0);
2296 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2300 * Check here to see if there are no commands in-use. If there are none, we can
2301 * null out last orb so that next time around we write directly to the orb pointer...
2302 * Quick start saves one 1394 bus transaction.
2304 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2305 scsi_id->last_orb = NULL;
2311 * It's probably a login/logout/reconnect status.
2313 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2314 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2315 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2316 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2317 atomic_set(&scsi_id->sbp2_login_complete, 1);
2323 /* Complete the SCSI command. */
2324 SBP2_DEBUG("Completing SCSI command");
2325 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2326 command->Current_done);
2327 SBP2_ORB_DEBUG("command orb completed");
2330 return(RCODE_COMPLETE);
2334 /**************************************
2335 * SCSI interface related section
2336 **************************************/
2339 * This routine is the main request entry routine for doing I/O. It is
2340 * called from the scsi stack directly.
2342 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2343 void (*done)(struct scsi_cmnd *))
2345 struct scsi_id_instance_data *scsi_id =
2346 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2347 struct sbp2scsi_host_info *hi;
2349 SBP2_DEBUG("sbp2scsi_queuecommand");
2352 * If scsi_id is null, it means there is no device in this slot,
2353 * so we should return selection timeout.
2356 SCpnt->result = DID_NO_CONNECT << 16;
2364 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2365 SCpnt->result = DID_NO_CONNECT << 16;
2371 * Until we handle multiple luns, just return selection time-out
2372 * to any IO directed at non-zero LUNs
2374 if (SCpnt->device->lun) {
2375 SCpnt->result = DID_NO_CONNECT << 16;
2381 * Check for request sense command, and handle it here
2382 * (autorequest sense)
2384 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2385 SBP2_DEBUG("REQUEST_SENSE");
2386 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2387 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2388 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2393 * Check to see if we are in the middle of a bus reset.
2395 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2396 SBP2_ERR("Bus reset in progress - rejecting command");
2397 SCpnt->result = DID_BUS_BUSY << 16;
2403 * Try and send our SCSI command
2405 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2406 SBP2_ERR("Error sending SCSI command");
2407 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2415 * This function is called in order to complete all outstanding SBP-2
2416 * commands (in case of resets, etc.).
2418 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2421 struct sbp2scsi_host_info *hi = scsi_id->hi;
2422 struct list_head *lh;
2423 struct sbp2_command_info *command;
2425 SBP2_DEBUG("sbp2scsi_complete_all_commands");
2427 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2428 SBP2_DEBUG("Found pending command to complete");
2429 lh = scsi_id->sbp2_command_orb_inuse.next;
2430 command = list_entry(lh, struct sbp2_command_info, list);
2431 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2432 sizeof(struct sbp2_command_orb),
2433 PCI_DMA_BIDIRECTIONAL);
2434 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2435 sizeof(command->scatter_gather_element),
2436 PCI_DMA_BIDIRECTIONAL);
2437 sbp2util_mark_command_completed(scsi_id, command);
2438 if (command->Current_SCpnt) {
2439 command->Current_SCpnt->result = status << 16;
2440 command->Current_done(command->Current_SCpnt);
2448 * This function is called in order to complete a regular SBP-2 command.
2450 * This can be called in interrupt context.
2452 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2453 u32 scsi_status, struct scsi_cmnd *SCpnt,
2454 void (*done)(struct scsi_cmnd *))
2456 unsigned long flags;
2458 SBP2_DEBUG("sbp2scsi_complete_command");
2464 SBP2_ERR("SCpnt is NULL");
2469 * If a bus reset is in progress and there was an error, don't
2470 * complete the command, just let it get retried at the end of the
2473 if (!hpsb_node_entry_valid(scsi_id->ne) && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2474 SBP2_ERR("Bus reset in progress - retry command later");
2479 * Switch on scsi status
2481 switch (scsi_status) {
2482 case SBP2_SCSI_STATUS_GOOD:
2483 SCpnt->result = DID_OK;
2486 case SBP2_SCSI_STATUS_BUSY:
2487 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2488 SCpnt->result = DID_BUS_BUSY << 16;
2491 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2492 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2493 SCpnt->result = CHECK_CONDITION << 1;
2498 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2499 scsi_print_command(SCpnt);
2500 scsi_print_sense("bh", SCpnt);
2505 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2506 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2507 SCpnt->result = DID_NO_CONNECT << 16;
2508 scsi_print_command(SCpnt);
2511 case SBP2_SCSI_STATUS_CONDITION_MET:
2512 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2513 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2514 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2515 SCpnt->result = DID_ERROR << 16;
2516 scsi_print_command(SCpnt);
2520 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2521 SCpnt->result = DID_ERROR << 16;
2525 * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2527 if (SCpnt->result == DID_OK) {
2528 sbp2_check_sbp2_response(scsi_id, SCpnt);
2532 * If a bus reset is in progress and there was an error, complete
2533 * the command as busy so that it will get retried.
2535 if (!hpsb_node_entry_valid(scsi_id->ne) && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2536 SBP2_ERR("Completing command with busy (bus reset)");
2537 SCpnt->result = DID_BUS_BUSY << 16;
2541 * If a unit attention occurs, return busy status so it gets
2542 * retried... it could have happened because of a 1394 bus reset
2546 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2547 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2548 SBP2_DEBUG("UNIT ATTENTION - return busy");
2549 SCpnt->result = DID_BUS_BUSY << 16;
2554 * Tell scsi stack that we're done with this command
2556 spin_lock_irqsave(scsi_id->scsi_host->host_lock,flags);
2558 spin_unlock_irqrestore(scsi_id->scsi_host->host_lock,flags);
2564 static int sbp2scsi_slave_configure (struct scsi_device *sdev)
2566 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2567 sdev->use_10_for_rw = 1;
2568 sdev->use_10_for_ms = 1;
2574 * Called by scsi stack when something has really gone wrong. Usually
2575 * called when a command has timed-out for some reason.
2577 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2579 struct scsi_id_instance_data *scsi_id =
2580 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2581 struct sbp2scsi_host_info *hi = scsi_id->hi;
2582 struct sbp2_command_info *command;
2584 SBP2_ERR("aborting sbp2 command");
2585 scsi_print_command(SCpnt);
2590 * Right now, just return any matching command structures
2593 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2595 SBP2_DEBUG("Found command to abort");
2596 pci_dma_sync_single_for_cpu(hi->host->pdev,
2597 command->command_orb_dma,
2598 sizeof(struct sbp2_command_orb),
2599 PCI_DMA_BIDIRECTIONAL);
2600 pci_dma_sync_single_for_cpu(hi->host->pdev,
2602 sizeof(command->scatter_gather_element),
2603 PCI_DMA_BIDIRECTIONAL);
2604 sbp2util_mark_command_completed(scsi_id, command);
2605 if (command->Current_SCpnt) {
2606 command->Current_SCpnt->result = DID_ABORT << 16;
2607 command->Current_done(command->Current_SCpnt);
2612 * Initiate a fetch agent reset.
2614 sbp2_agent_reset(scsi_id, 0);
2615 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2622 * Called by scsi stack when something has really gone wrong.
2624 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2626 struct scsi_id_instance_data *scsi_id =
2627 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2629 SBP2_ERR("reset requested");
2632 SBP2_ERR("Generating sbp2 fetch agent reset");
2633 sbp2_agent_reset(scsi_id, 0);
2639 static const char *sbp2scsi_info (struct Scsi_Host *host)
2641 return "SCSI emulation for IEEE-1394 SBP-2 Devices";
2644 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev, char *buf)
2646 struct scsi_device *sdev;
2647 struct scsi_id_instance_data *scsi_id;
2650 if (!(sdev = to_scsi_device(dev)))
2653 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2656 if (scsi_id->sbp2_device_type_and_lun == SBP2_DEVICE_TYPE_LUN_UNINITIALIZED)
2659 lun = ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
2661 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2662 scsi_id->ud->id, lun);
2664 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2666 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2667 &dev_attr_ieee1394_id,
2671 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2672 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2673 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2674 MODULE_LICENSE("GPL");
2676 /* SCSI host template */
2677 static struct scsi_host_template scsi_driver_template = {
2678 .module = THIS_MODULE,
2679 .name = "SBP-2 IEEE-1394",
2680 .proc_name = SBP2_DEVICE_NAME,
2681 .info = sbp2scsi_info,
2682 .queuecommand = sbp2scsi_queuecommand,
2683 .eh_abort_handler = sbp2scsi_abort,
2684 .eh_device_reset_handler = sbp2scsi_reset,
2685 .eh_bus_reset_handler = sbp2scsi_reset,
2686 .eh_host_reset_handler = sbp2scsi_reset,
2687 .slave_configure = sbp2scsi_slave_configure,
2689 .sg_tablesize = SG_ALL,
2690 .use_clustering = ENABLE_CLUSTERING,
2691 .cmd_per_lun = SBP2_MAX_CMDS,
2692 .can_queue = SBP2_MAX_CMDS,
2694 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2697 static int sbp2_module_init(void)
2701 SBP2_DEBUG("sbp2_module_init");
2703 printk(KERN_INFO "sbp2: %s\n", version);
2705 /* Module load debug option to force one command at a time (serializing I/O) */
2707 SBP2_ERR("Driver forced to serialize I/O (serialize_io = 1)");
2708 scsi_driver_template.can_queue = 1;
2709 scsi_driver_template.cmd_per_lun = 1;
2712 /* Set max sectors (module load option). Default is 255 sectors. */
2713 scsi_driver_template.max_sectors = max_sectors;
2716 /* Register our high level driver with 1394 stack */
2717 hpsb_register_highlevel(&sbp2_highlevel);
2719 ret = hpsb_register_protocol(&sbp2_driver);
2721 SBP2_ERR("Failed to register protocol");
2722 hpsb_unregister_highlevel(&sbp2_highlevel);
2729 static void __exit sbp2_module_exit(void)
2731 SBP2_DEBUG("sbp2_module_exit");
2733 hpsb_unregister_protocol(&sbp2_driver);
2735 hpsb_unregister_highlevel(&sbp2_highlevel);
2738 module_init(sbp2_module_init);
2739 module_exit(sbp2_module_exit);