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: 1306 $ 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, 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 * TODO: Make this configurable per device.
109 static int serialize_io = 1;
110 module_param(serialize_io, int, 0444);
111 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
114 * Bump up max_sectors if you'd like to support very large sized
115 * transfers. Please note that some older sbp2 bridge chips are broken for
116 * transfers greater or equal to 128KB. Default is a value of 255
117 * sectors, or just under 128KB (at 512 byte sector size). I can note that
118 * the Oxsemi sbp2 chipsets have no problems supporting very large
121 static int max_sectors = SBP2_MAX_SECTORS;
122 module_param(max_sectors, int, 0444);
123 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = 255)");
126 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
127 * do an exclusive login, as it's generally unsafe to have two hosts
128 * talking to a single sbp2 device at the same time (filesystem coherency,
129 * etc.). If you're running an sbp2 device that supports multiple logins,
130 * and you're either running read-only filesystems or some sort of special
131 * filesystem supporting multiple hosts (one such filesystem is OpenGFS,
132 * see opengfs.sourceforge.net for more info), then set exclusive_login
133 * to zero. Note: The Oxsemi OXFW911 sbp2 chipset supports up to four
136 static int exclusive_login = 1;
137 module_param(exclusive_login, int, 0644);
138 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
141 * SCSI inquiry hack for really badly behaved sbp2 devices. Turn this on
142 * if your sbp2 device is not properly handling the SCSI inquiry command.
143 * This hack makes the inquiry look more like a typical MS Windows
146 * If force_inquiry_hack=1 is required for your device to work,
147 * please submit the logged sbp2_firmware_revision value of this device to
148 * the linux1394-devel mailing list.
150 static int force_inquiry_hack;
151 module_param(force_inquiry_hack, int, 0444);
152 MODULE_PARM_DESC(force_inquiry_hack, "Force SCSI inquiry hack (default = 0)");
156 * Export information about protocols/devices supported by this driver.
158 static struct ieee1394_device_id sbp2_id_table[] = {
160 .match_flags =IEEE1394_MATCH_SPECIFIER_ID |
161 IEEE1394_MATCH_VERSION,
162 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
163 .version = SBP2_SW_VERSION_ENTRY & 0xffffff
168 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
171 * Debug levels, configured via kernel config, or enable here.
174 #define CONFIG_IEEE1394_SBP2_DEBUG 0
175 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
176 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
177 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
178 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
179 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
181 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
182 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
183 static u32 global_outstanding_command_orbs = 0;
184 #define outstanding_orb_incr global_outstanding_command_orbs++
185 #define outstanding_orb_decr global_outstanding_command_orbs--
187 #define SBP2_ORB_DEBUG(fmt, args...)
188 #define outstanding_orb_incr
189 #define outstanding_orb_decr
192 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
193 #define SBP2_DMA_ALLOC(fmt, args...) \
194 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
195 ++global_outstanding_dmas, ## args)
196 #define SBP2_DMA_FREE(fmt, args...) \
197 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
198 --global_outstanding_dmas, ## args)
199 static u32 global_outstanding_dmas = 0;
201 #define SBP2_DMA_ALLOC(fmt, args...)
202 #define SBP2_DMA_FREE(fmt, args...)
205 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
206 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
207 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
208 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
209 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
210 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
211 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
212 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
213 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
214 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
216 #define SBP2_DEBUG(fmt, args...)
217 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
218 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
219 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
222 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
229 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
232 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
233 u32 scsi_status, struct scsi_cmnd *SCpnt,
234 void (*done)(struct scsi_cmnd *));
236 static struct scsi_host_template scsi_driver_template;
238 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
240 static void sbp2_host_reset(struct hpsb_host *host);
242 static int sbp2_probe(struct device *dev);
243 static int sbp2_remove(struct device *dev);
244 static int sbp2_update(struct unit_directory *ud);
246 static struct hpsb_highlevel sbp2_highlevel = {
247 .name = SBP2_DEVICE_NAME,
248 .host_reset = sbp2_host_reset,
251 static struct hpsb_address_ops sbp2_ops = {
252 .write = sbp2_handle_status_write
255 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
256 static struct hpsb_address_ops sbp2_physdma_ops = {
257 .read = sbp2_handle_physdma_read,
258 .write = sbp2_handle_physdma_write,
262 static struct hpsb_protocol_driver sbp2_driver = {
263 .name = "SBP2 Driver",
264 .id_table = sbp2_id_table,
265 .update = sbp2_update,
267 .name = SBP2_DEVICE_NAME,
268 .bus = &ieee1394_bus_type,
270 .remove = sbp2_remove,
275 /* List of device firmware's that require a forced 36 byte inquiry. */
276 static u32 sbp2_broken_inquiry_list[] = {
277 0x00002800, /* Stefan Richter <richtest@bauwesen.tu-cottbus.de> */
278 /* DViCO Momobay CX-1 */
279 0x00000200 /* Andreas Plesch <plesch@fas.harvard.edu> */
280 /* QPS Fire DVDBurner */
283 #define NUM_BROKEN_INQUIRY_DEVS \
284 (sizeof(sbp2_broken_inquiry_list)/sizeof(*sbp2_broken_inquiry_list))
286 /**************************************
287 * General utility functions
288 **************************************/
293 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
295 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
299 for (length = (length >> 2); length--; )
300 temp[length] = be32_to_cpu(temp[length]);
306 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
308 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
312 for (length = (length >> 2); length--; )
313 temp[length] = cpu_to_be32(temp[length]);
317 #else /* BIG_ENDIAN */
318 /* Why waste the cpu cycles? */
319 #define sbp2util_be32_to_cpu_buffer(x,y)
320 #define sbp2util_cpu_to_be32_buffer(x,y)
323 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
325 * Debug packet dump routine. Length is in bytes.
327 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name, u32 dump_phys_addr)
330 unsigned char *dump = buffer;
332 if (!dump || !length || !dump_name)
336 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
338 printk("[%s]", dump_name);
339 for (i = 0; i < length; i++) {
348 printk("%02x ", (int) dump[i]);
355 #define sbp2util_packet_dump(w,x,y,z)
359 * Goofy routine that basically does a down_timeout function.
361 static int sbp2util_down_timeout(atomic_t *done, int timeout)
365 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
366 if (msleep_interruptible(100)) /* 100ms */
369 return ((i > 0) ? 0:1);
372 /* Free's an allocated packet */
373 static void sbp2_free_packet(struct hpsb_packet *packet)
375 hpsb_free_tlabel(packet);
376 hpsb_free_packet(packet);
379 /* This is much like hpsb_node_write(), except it ignores the response
380 * subaction and returns immediately. Can be used from interrupts.
382 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
383 quadlet_t *buffer, size_t length)
385 struct hpsb_packet *packet;
387 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
388 addr, buffer, length);
392 hpsb_set_packet_complete_task(packet, (void (*)(void*))sbp2_free_packet,
395 hpsb_node_fill_packet(ne, packet);
397 if (hpsb_send_packet(packet) < 0) {
398 sbp2_free_packet(packet);
406 * This function is called to create a pool of command orbs used for
407 * command processing. It is called when a new sbp2 device is detected.
409 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
411 struct sbp2scsi_host_info *hi = scsi_id->hi;
413 unsigned long flags, orbs;
414 struct sbp2_command_info *command;
416 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
418 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
419 for (i = 0; i < orbs; i++) {
420 command = (struct sbp2_command_info *)
421 kmalloc(sizeof(struct sbp2_command_info), GFP_ATOMIC);
423 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
426 memset(command, '\0', sizeof(struct sbp2_command_info));
427 command->command_orb_dma =
428 pci_map_single (hi->host->pdev, &command->command_orb,
429 sizeof(struct sbp2_command_orb),
430 PCI_DMA_BIDIRECTIONAL);
431 SBP2_DMA_ALLOC("single command orb DMA");
433 pci_map_single (hi->host->pdev, &command->scatter_gather_element,
434 sizeof(command->scatter_gather_element),
435 PCI_DMA_BIDIRECTIONAL);
436 SBP2_DMA_ALLOC("scatter_gather_element");
437 INIT_LIST_HEAD(&command->list);
438 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
440 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
445 * This function is called to delete a pool of command orbs.
447 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
449 struct hpsb_host *host = scsi_id->hi->host;
450 struct list_head *lh, *next;
451 struct sbp2_command_info *command;
454 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
455 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
456 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
457 command = list_entry(lh, struct sbp2_command_info, list);
459 /* Release our generic DMA's */
460 pci_unmap_single(host->pdev, command->command_orb_dma,
461 sizeof(struct sbp2_command_orb),
462 PCI_DMA_BIDIRECTIONAL);
463 SBP2_DMA_FREE("single command orb DMA");
464 pci_unmap_single(host->pdev, command->sge_dma,
465 sizeof(command->scatter_gather_element),
466 PCI_DMA_BIDIRECTIONAL);
467 SBP2_DMA_FREE("scatter_gather_element");
472 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
477 * This function finds the sbp2_command for a given outstanding command
478 * orb.Only looks at the inuse list.
480 static struct sbp2_command_info *sbp2util_find_command_for_orb(
481 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
483 struct sbp2_command_info *command;
486 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
487 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
488 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
489 if (command->command_orb_dma == orb) {
490 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
495 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
497 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
503 * This function finds the sbp2_command for a given outstanding SCpnt.
504 * Only looks at the inuse list.
506 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(struct scsi_id_instance_data *scsi_id, void *SCpnt)
508 struct sbp2_command_info *command;
511 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
512 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
513 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
514 if (command->Current_SCpnt == SCpnt) {
515 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
520 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
525 * This function allocates a command orb used to send a scsi command.
527 static struct sbp2_command_info *sbp2util_allocate_command_orb(
528 struct scsi_id_instance_data *scsi_id,
529 struct scsi_cmnd *Current_SCpnt,
530 void (*Current_done)(struct scsi_cmnd *))
532 struct list_head *lh;
533 struct sbp2_command_info *command = NULL;
536 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
537 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
538 lh = scsi_id->sbp2_command_orb_completed.next;
540 command = list_entry(lh, struct sbp2_command_info, list);
541 command->Current_done = Current_done;
542 command->Current_SCpnt = Current_SCpnt;
543 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
545 SBP2_ERR("sbp2util_allocate_command_orb - No orbs available!");
547 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
552 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
554 struct scsi_id_instance_data *scsi_id =
555 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
556 struct hpsb_host *host;
559 printk(KERN_ERR "%s: scsi_id == NULL\n", __FUNCTION__);
563 host = scsi_id->ud->ne->host;
565 if (command->cmd_dma) {
566 if (command->dma_type == CMD_DMA_SINGLE) {
567 pci_unmap_single(host->pdev, command->cmd_dma,
568 command->dma_size, command->dma_dir);
569 SBP2_DMA_FREE("single bulk");
570 } else if (command->dma_type == CMD_DMA_PAGE) {
571 pci_unmap_page(host->pdev, command->cmd_dma,
572 command->dma_size, command->dma_dir);
573 SBP2_DMA_FREE("single page");
574 } /* XXX: Check for CMD_DMA_NONE bug */
575 command->dma_type = CMD_DMA_NONE;
576 command->cmd_dma = 0;
579 if (command->sge_buffer) {
580 pci_unmap_sg(host->pdev, command->sge_buffer,
581 command->dma_size, command->dma_dir);
582 SBP2_DMA_FREE("scatter list");
583 command->sge_buffer = NULL;
588 * This function moves a command to the completed orb list.
590 static void sbp2util_mark_command_completed(struct scsi_id_instance_data *scsi_id, struct sbp2_command_info *command)
594 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
595 list_del(&command->list);
596 sbp2util_free_command_dma(command);
597 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
598 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
602 * Is scsi_id valid? Is the 1394 node still present?
604 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
606 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
611 /*********************************************
612 * IEEE-1394 core driver stack related section
613 *********************************************/
614 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
616 static int sbp2_probe(struct device *dev)
618 struct unit_directory *ud;
619 struct scsi_id_instance_data *scsi_id;
621 SBP2_DEBUG("sbp2_probe");
623 ud = container_of(dev, struct unit_directory, device);
625 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
627 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
630 scsi_id = sbp2_alloc_device(ud);
635 sbp2_parse_unit_directory(scsi_id, ud);
637 return sbp2_start_device(scsi_id);
640 static int sbp2_remove(struct device *dev)
642 struct unit_directory *ud;
643 struct scsi_id_instance_data *scsi_id;
644 struct scsi_device *sdev;
646 SBP2_DEBUG("sbp2_remove");
648 ud = container_of(dev, struct unit_directory, device);
649 scsi_id = ud->device.driver_data;
653 /* Trigger shutdown functions in scsi's highlevel. */
654 if (scsi_id->scsi_host)
655 scsi_unblock_requests(scsi_id->scsi_host);
656 sdev = scsi_id->sdev;
658 scsi_id->sdev = NULL;
659 scsi_remove_device(sdev);
662 sbp2_logout_device(scsi_id);
663 sbp2_remove_device(scsi_id);
668 static int sbp2_update(struct unit_directory *ud)
670 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
672 SBP2_DEBUG("sbp2_update");
674 if (sbp2_reconnect_device(scsi_id)) {
677 * Ok, reconnect has failed. Perhaps we didn't
678 * reconnect fast enough. Try doing a regular login, but
679 * first do a logout just in case of any weirdness.
681 sbp2_logout_device(scsi_id);
683 if (sbp2_login_device(scsi_id)) {
684 /* Login failed too, just fail, and the backend
685 * will call our sbp2_remove for us */
686 SBP2_ERR("Failed to reconnect to sbp2 device!");
691 /* Set max retries to something large on the device. */
692 sbp2_set_busy_timeout(scsi_id);
694 /* Do a SBP-2 fetch agent reset. */
695 sbp2_agent_reset(scsi_id, 1);
697 /* Get the max speed and packet size that we can use. */
698 sbp2_max_speed_and_size(scsi_id);
700 /* Complete any pending commands with busy (so they get
701 * retried) and remove them from our queue
703 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
705 /* Make sure we unblock requests (since this is likely after a bus
707 scsi_unblock_requests(scsi_id->scsi_host);
712 /* This functions is called by the sbp2_probe, for each new device. We now
713 * allocate one scsi host for each scsi_id (unit directory). */
714 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
716 struct sbp2scsi_host_info *hi;
717 struct Scsi_Host *scsi_host = NULL;
718 struct scsi_id_instance_data *scsi_id = NULL;
720 SBP2_DEBUG("sbp2_alloc_device");
722 scsi_id = kmalloc(sizeof(*scsi_id), GFP_KERNEL);
724 SBP2_ERR("failed to create scsi_id");
727 memset(scsi_id, 0, sizeof(*scsi_id));
729 scsi_id->ne = ud->ne;
731 scsi_id->speed_code = IEEE1394_SPEED_100;
732 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
733 atomic_set(&scsi_id->sbp2_login_complete, 0);
734 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
735 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
736 INIT_LIST_HEAD(&scsi_id->scsi_list);
737 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
738 scsi_id->sbp2_device_type_and_lun = SBP2_DEVICE_TYPE_LUN_UNINITIALIZED;
740 ud->device.driver_data = scsi_id;
742 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
744 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
746 SBP2_ERR("failed to allocate hostinfo");
749 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
750 hi->host = ud->ne->host;
751 INIT_LIST_HEAD(&hi->scsi_ids);
753 /* Register our sbp2 status address space... */
754 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_ops,
755 SBP2_STATUS_FIFO_ADDRESS,
756 SBP2_STATUS_FIFO_ADDRESS +
757 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(SBP2_MAX_UDS_PER_NODE+1));
758 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
759 /* Handle data movement if physical dma is not
760 * enabled/supportedon host controller */
761 hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host, &sbp2_physdma_ops,
762 0x0ULL, 0xfffffffcULL);
768 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
770 /* Register our host with the SCSI stack. */
771 scsi_host = scsi_host_alloc(&scsi_driver_template,
772 sizeof (unsigned long));
774 SBP2_ERR("failed to register scsi host");
778 scsi_host->hostdata[0] = (unsigned long)scsi_id;
780 if (!scsi_add_host(scsi_host, &ud->device)) {
781 scsi_id->scsi_host = scsi_host;
785 SBP2_ERR("failed to add scsi host");
786 scsi_host_put(scsi_host);
789 sbp2_remove_device(scsi_id);
794 static void sbp2_host_reset(struct hpsb_host *host)
796 struct sbp2scsi_host_info *hi;
797 struct scsi_id_instance_data *scsi_id;
799 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
802 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
803 scsi_block_requests(scsi_id->scsi_host);
809 * This function is where we first pull the node unique ids, and then
810 * allocate memory and register a SBP-2 device.
812 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
814 struct sbp2scsi_host_info *hi = scsi_id->hi;
817 SBP2_DEBUG("sbp2_start_device");
820 scsi_id->login_response =
821 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_login_response),
822 &scsi_id->login_response_dma);
823 if (!scsi_id->login_response)
825 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
827 /* Query logins ORB DMA */
828 scsi_id->query_logins_orb =
829 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_query_logins_orb),
830 &scsi_id->query_logins_orb_dma);
831 if (!scsi_id->query_logins_orb)
833 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
835 /* Query logins response DMA */
836 scsi_id->query_logins_response =
837 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_query_logins_response),
838 &scsi_id->query_logins_response_dma);
839 if (!scsi_id->query_logins_response)
841 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
843 /* Reconnect ORB DMA */
844 scsi_id->reconnect_orb =
845 pci_alloc_consistent(hi->host->pdev, 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, sizeof(struct sbp2_logout_orb),
854 &scsi_id->logout_orb_dma);
855 if (!scsi_id->logout_orb)
857 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
861 pci_alloc_consistent(hi->host->pdev, sizeof(struct sbp2_login_orb),
862 &scsi_id->login_orb_dma);
863 if (!scsi_id->login_orb) {
865 if (scsi_id->query_logins_response) {
866 pci_free_consistent(hi->host->pdev,
867 sizeof(struct sbp2_query_logins_response),
868 scsi_id->query_logins_response,
869 scsi_id->query_logins_response_dma);
870 SBP2_DMA_FREE("query logins response DMA");
873 if (scsi_id->query_logins_orb) {
874 pci_free_consistent(hi->host->pdev,
875 sizeof(struct sbp2_query_logins_orb),
876 scsi_id->query_logins_orb,
877 scsi_id->query_logins_orb_dma);
878 SBP2_DMA_FREE("query logins ORB DMA");
881 if (scsi_id->logout_orb) {
882 pci_free_consistent(hi->host->pdev,
883 sizeof(struct sbp2_logout_orb),
885 scsi_id->logout_orb_dma);
886 SBP2_DMA_FREE("logout ORB DMA");
889 if (scsi_id->reconnect_orb) {
890 pci_free_consistent(hi->host->pdev,
891 sizeof(struct sbp2_reconnect_orb),
892 scsi_id->reconnect_orb,
893 scsi_id->reconnect_orb_dma);
894 SBP2_DMA_FREE("reconnect ORB DMA");
897 if (scsi_id->login_response) {
898 pci_free_consistent(hi->host->pdev,
899 sizeof(struct sbp2_login_response),
900 scsi_id->login_response,
901 scsi_id->login_response_dma);
902 SBP2_DMA_FREE("login FIFO DMA");
905 list_del(&scsi_id->scsi_list);
909 SBP2_ERR ("Could not allocate memory for scsi_id");
913 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
915 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
918 * Create our command orb pool
920 if (sbp2util_create_command_orb_pool(scsi_id)) {
921 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
922 sbp2_remove_device(scsi_id);
926 /* Schedule a timeout here. The reason is that we may be so close
927 * to a bus reset, that the device is not available for logins.
928 * This can happen when the bus reset is caused by the host
929 * connected to the sbp2 device being removed. That host would
930 * have a certain amount of time to relogin before the sbp2 device
931 * allows someone else to login instead. One second makes sense. */
932 msleep_interruptible(1000);
933 if (signal_pending(current)) {
934 SBP2_WARN("aborting sbp2_start_device due to event");
935 sbp2_remove_device(scsi_id);
940 * Login to the sbp-2 device
942 if (sbp2_login_device(scsi_id)) {
943 /* Login failed, just remove the device. */
944 sbp2_remove_device(scsi_id);
949 * Set max retries to something large on the device
951 sbp2_set_busy_timeout(scsi_id);
954 * Do a SBP-2 fetch agent reset
956 sbp2_agent_reset(scsi_id, 1);
959 * Get the max speed and packet size that we can use
961 sbp2_max_speed_and_size(scsi_id);
963 /* Add this device to the scsi layer now */
964 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
966 SBP2_ERR("scsi_add_device failed");
974 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
976 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
978 struct sbp2scsi_host_info *hi;
980 SBP2_DEBUG("sbp2_remove_device");
987 /* This will remove our scsi device aswell */
988 if (scsi_id->scsi_host) {
989 scsi_remove_host(scsi_id->scsi_host);
990 scsi_host_put(scsi_id->scsi_host);
993 sbp2util_remove_command_orb_pool(scsi_id);
995 list_del(&scsi_id->scsi_list);
997 if (scsi_id->login_response) {
998 pci_free_consistent(hi->host->pdev,
999 sizeof(struct sbp2_login_response),
1000 scsi_id->login_response,
1001 scsi_id->login_response_dma);
1002 SBP2_DMA_FREE("single login FIFO");
1005 if (scsi_id->login_orb) {
1006 pci_free_consistent(hi->host->pdev,
1007 sizeof(struct sbp2_login_orb),
1009 scsi_id->login_orb_dma);
1010 SBP2_DMA_FREE("single login ORB");
1013 if (scsi_id->reconnect_orb) {
1014 pci_free_consistent(hi->host->pdev,
1015 sizeof(struct sbp2_reconnect_orb),
1016 scsi_id->reconnect_orb,
1017 scsi_id->reconnect_orb_dma);
1018 SBP2_DMA_FREE("single reconnect orb");
1021 if (scsi_id->logout_orb) {
1022 pci_free_consistent(hi->host->pdev,
1023 sizeof(struct sbp2_logout_orb),
1024 scsi_id->logout_orb,
1025 scsi_id->logout_orb_dma);
1026 SBP2_DMA_FREE("single logout orb");
1029 if (scsi_id->query_logins_orb) {
1030 pci_free_consistent(hi->host->pdev,
1031 sizeof(struct sbp2_query_logins_orb),
1032 scsi_id->query_logins_orb,
1033 scsi_id->query_logins_orb_dma);
1034 SBP2_DMA_FREE("single query logins orb");
1037 if (scsi_id->query_logins_response) {
1038 pci_free_consistent(hi->host->pdev,
1039 sizeof(struct sbp2_query_logins_response),
1040 scsi_id->query_logins_response,
1041 scsi_id->query_logins_response_dma);
1042 SBP2_DMA_FREE("single query logins data");
1045 scsi_id->ud->device.driver_data = NULL;
1047 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1052 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1054 * This function deals with physical dma write requests (for adapters that do not support
1055 * physical dma in hardware). Mostly just here for debugging...
1057 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid, int destid, quadlet_t *data,
1058 u64 addr, size_t length, u16 flags)
1062 * Manually put the data in the right place.
1064 memcpy(bus_to_virt((u32)addr), data, length);
1065 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device", (u32)addr);
1066 return(RCODE_COMPLETE);
1070 * This function deals with physical dma read requests (for adapters that do not support
1071 * physical dma in hardware). Mostly just here for debugging...
1073 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid, quadlet_t *data,
1074 u64 addr, size_t length, u16 flags)
1078 * Grab data from memory and send a read response.
1080 memcpy(data, bus_to_virt((u32)addr), length);
1081 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device", (u32)addr);
1082 return(RCODE_COMPLETE);
1087 /**************************************
1088 * SBP-2 protocol related section
1089 **************************************/
1092 * This function queries the device for the maximum concurrent logins it
1095 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1097 struct sbp2scsi_host_info *hi = scsi_id->hi;
1102 SBP2_DEBUG("sbp2_query_logins");
1104 scsi_id->query_logins_orb->reserved1 = 0x0;
1105 scsi_id->query_logins_orb->reserved2 = 0x0;
1107 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1108 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1109 SBP2_DEBUG("sbp2_query_logins: query_response_hi/lo initialized");
1111 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1112 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1113 if (scsi_id->sbp2_device_type_and_lun != SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
1114 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
1115 SBP2_DEBUG("sbp2_query_logins: set lun to %d",
1116 ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun));
1118 SBP2_DEBUG("sbp2_query_logins: lun_misc initialized");
1120 scsi_id->query_logins_orb->reserved_resp_length =
1121 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1122 SBP2_DEBUG("sbp2_query_logins: reserved_resp_length initialized");
1124 scsi_id->query_logins_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1125 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1126 scsi_id->query_logins_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1127 SBP2_STATUS_FIFO_ADDRESS_HI);
1128 SBP2_DEBUG("sbp2_query_logins: status FIFO initialized");
1130 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1132 SBP2_DEBUG("sbp2_query_logins: orb byte-swapped");
1134 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1135 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1137 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1138 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1140 SBP2_DEBUG("sbp2_query_logins: query_logins_response/status FIFO memset");
1142 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1143 data[1] = scsi_id->query_logins_orb_dma;
1144 sbp2util_cpu_to_be32_buffer(data, 8);
1146 atomic_set(&scsi_id->sbp2_login_complete, 0);
1148 SBP2_DEBUG("sbp2_query_logins: prepared to write");
1149 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1150 SBP2_DEBUG("sbp2_query_logins: written");
1152 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1153 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1157 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1158 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1162 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1163 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1164 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1166 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1170 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1172 SBP2_DEBUG("length_max_logins = %x",
1173 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1175 SBP2_DEBUG("Query logins to SBP-2 device successful");
1177 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1178 SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1180 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1181 SBP2_DEBUG("Number of active logins: %d", active_logins);
1183 if (active_logins >= max_logins) {
1191 * This function is called in order to login to a particular SBP-2 device,
1192 * after a bus reset.
1194 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1196 struct sbp2scsi_host_info *hi = scsi_id->hi;
1199 SBP2_DEBUG("sbp2_login_device");
1201 if (!scsi_id->login_orb) {
1202 SBP2_DEBUG("sbp2_login_device: login_orb not alloc'd!");
1206 if (!exclusive_login) {
1207 if (sbp2_query_logins(scsi_id)) {
1208 SBP2_INFO("Device does not support any more concurrent logins");
1213 /* Set-up login ORB, assume no password */
1214 scsi_id->login_orb->password_hi = 0;
1215 scsi_id->login_orb->password_lo = 0;
1216 SBP2_DEBUG("sbp2_login_device: password_hi/lo initialized");
1218 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1219 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1220 SBP2_DEBUG("sbp2_login_device: login_response_hi/lo initialized");
1222 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1223 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1224 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1225 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1226 /* Set the lun if we were able to pull it from the device's unit directory */
1227 if (scsi_id->sbp2_device_type_and_lun != SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
1228 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
1229 SBP2_DEBUG("sbp2_query_logins: set lun to %d",
1230 ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun));
1232 SBP2_DEBUG("sbp2_login_device: lun_misc initialized");
1234 scsi_id->login_orb->passwd_resp_lengths =
1235 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1236 SBP2_DEBUG("sbp2_login_device: passwd_resp_lengths initialized");
1238 scsi_id->login_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1239 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1240 scsi_id->login_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1241 SBP2_STATUS_FIFO_ADDRESS_HI);
1242 SBP2_DEBUG("sbp2_login_device: status FIFO initialized");
1245 * Byte swap ORB if necessary
1247 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1249 SBP2_DEBUG("sbp2_login_device: orb byte-swapped");
1251 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1252 "sbp2 login orb", scsi_id->login_orb_dma);
1255 * Initialize login response and status fifo
1257 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1258 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1260 SBP2_DEBUG("sbp2_login_device: login_response/status FIFO memset");
1263 * Ok, let's write to the target's management agent register
1265 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1266 data[1] = scsi_id->login_orb_dma;
1267 sbp2util_cpu_to_be32_buffer(data, 8);
1269 atomic_set(&scsi_id->sbp2_login_complete, 0);
1271 SBP2_DEBUG("sbp2_login_device: prepared to write to %08x",
1272 (unsigned int)scsi_id->sbp2_management_agent_addr);
1273 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1274 SBP2_DEBUG("sbp2_login_device: written");
1277 * Wait for login status (up to 20 seconds)...
1279 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1280 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1285 * Sanity. Make sure status returned matches login orb.
1287 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1288 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1295 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1296 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1297 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1299 SBP2_ERR("Error logging into SBP-2 device - login failed");
1304 * Byte swap the login response, for use when reconnecting or
1307 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1310 * Grab our command block agent address from the login response.
1312 SBP2_DEBUG("command_block_agent_hi = %x",
1313 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1314 SBP2_DEBUG("command_block_agent_lo = %x",
1315 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1317 scsi_id->sbp2_command_block_agent_addr =
1318 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1319 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1320 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1322 SBP2_INFO("Logged into SBP-2 device");
1329 * This function is called in order to logout from a particular SBP-2
1330 * device, usually called during driver unload.
1332 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1334 struct sbp2scsi_host_info *hi = scsi_id->hi;
1338 SBP2_DEBUG("sbp2_logout_device");
1343 scsi_id->logout_orb->reserved1 = 0x0;
1344 scsi_id->logout_orb->reserved2 = 0x0;
1345 scsi_id->logout_orb->reserved3 = 0x0;
1346 scsi_id->logout_orb->reserved4 = 0x0;
1348 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1349 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1351 /* Notify us when complete */
1352 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1354 scsi_id->logout_orb->reserved5 = 0x0;
1355 scsi_id->logout_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1356 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1357 scsi_id->logout_orb->status_FIFO_hi = (ORB_SET_NODE_ID(hi->host->node_id) |
1358 SBP2_STATUS_FIFO_ADDRESS_HI);
1361 * Byte swap ORB if necessary
1363 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1365 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1366 "sbp2 logout orb", scsi_id->logout_orb_dma);
1369 * Ok, let's write to the target's management agent register
1371 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1372 data[1] = scsi_id->logout_orb_dma;
1373 sbp2util_cpu_to_be32_buffer(data, 8);
1375 atomic_set(&scsi_id->sbp2_login_complete, 0);
1377 error = hpsb_node_write(scsi_id->ne,
1378 scsi_id->sbp2_management_agent_addr,
1383 /* Wait for device to logout...1 second. */
1384 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1387 SBP2_INFO("Logged out of SBP-2 device");
1394 * This function is called in order to reconnect to a particular SBP-2
1395 * device, after a bus reset.
1397 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1399 struct sbp2scsi_host_info *hi = scsi_id->hi;
1403 SBP2_DEBUG("sbp2_reconnect_device");
1406 * Set-up reconnect ORB
1408 scsi_id->reconnect_orb->reserved1 = 0x0;
1409 scsi_id->reconnect_orb->reserved2 = 0x0;
1410 scsi_id->reconnect_orb->reserved3 = 0x0;
1411 scsi_id->reconnect_orb->reserved4 = 0x0;
1413 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1414 scsi_id->reconnect_orb->login_ID_misc |=
1415 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1417 /* Notify us when complete */
1418 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1420 scsi_id->reconnect_orb->reserved5 = 0x0;
1421 scsi_id->reconnect_orb->status_FIFO_lo = SBP2_STATUS_FIFO_ADDRESS_LO +
1422 SBP2_STATUS_FIFO_ENTRY_TO_OFFSET(scsi_id->ud->id);
1423 scsi_id->reconnect_orb->status_FIFO_hi =
1424 (ORB_SET_NODE_ID(hi->host->node_id) | SBP2_STATUS_FIFO_ADDRESS_HI);
1427 * Byte swap ORB if necessary
1429 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1431 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1432 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1435 * Initialize status fifo
1437 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1440 * Ok, let's write to the target's management agent register
1442 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1443 data[1] = scsi_id->reconnect_orb_dma;
1444 sbp2util_cpu_to_be32_buffer(data, 8);
1446 atomic_set(&scsi_id->sbp2_login_complete, 0);
1448 error = hpsb_node_write(scsi_id->ne,
1449 scsi_id->sbp2_management_agent_addr,
1455 * Wait for reconnect status (up to 1 second)...
1457 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1458 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1463 * Sanity. Make sure status returned matches reconnect orb.
1465 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1466 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1473 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1474 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1475 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1477 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1481 HPSB_DEBUG("Reconnected to SBP-2 device");
1488 * This function is called in order to set the busy timeout (number of
1489 * retries to attempt) on the sbp2 device.
1491 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1495 SBP2_DEBUG("sbp2_set_busy_timeout");
1498 * Ok, let's write to the target's busy timeout register
1500 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1502 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4)) {
1503 SBP2_ERR("sbp2_set_busy_timeout error");
1511 * This function is called to parse sbp2 device's config rom unit
1512 * directory. Used to determine things like sbp2 management agent offset,
1513 * and command set used (SCSI or RBC).
1515 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1516 struct unit_directory *ud)
1518 struct csr1212_keyval *kv;
1519 struct csr1212_dentry *dentry;
1520 u64 management_agent_addr;
1521 u32 command_set_spec_id, command_set, unit_characteristics,
1522 firmware_revision, workarounds;
1525 SBP2_DEBUG("sbp2_parse_unit_directory");
1527 management_agent_addr = 0x0;
1528 command_set_spec_id = 0x0;
1530 unit_characteristics = 0x0;
1531 firmware_revision = 0x0;
1533 /* Handle different fields in the unit directory, based on keys */
1534 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1535 switch (kv->key.id) {
1536 case CSR1212_KV_ID_DEPENDENT_INFO:
1537 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1538 /* Save off the management agent address */
1539 management_agent_addr =
1540 CSR1212_REGISTER_SPACE_BASE +
1541 (kv->value.csr_offset << 2);
1543 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1544 (unsigned int) management_agent_addr);
1545 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1546 scsi_id->sbp2_device_type_and_lun = kv->value.immediate;
1550 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1551 /* Command spec organization */
1552 command_set_spec_id = kv->value.immediate;
1553 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1554 (unsigned int) command_set_spec_id);
1557 case SBP2_COMMAND_SET_KEY:
1558 /* Command set used by sbp2 device */
1559 command_set = kv->value.immediate;
1560 SBP2_DEBUG("sbp2_command_set = %x",
1561 (unsigned int) command_set);
1564 case SBP2_UNIT_CHARACTERISTICS_KEY:
1566 * Unit characterisitcs (orb related stuff
1567 * that I'm not yet paying attention to)
1569 unit_characteristics = kv->value.immediate;
1570 SBP2_DEBUG("sbp2_unit_characteristics = %x",
1571 (unsigned int) unit_characteristics);
1574 case SBP2_FIRMWARE_REVISION_KEY:
1575 /* Firmware revision */
1576 firmware_revision = kv->value.immediate;
1577 if (force_inquiry_hack)
1578 SBP2_INFO("sbp2_firmware_revision = %x",
1579 (unsigned int) firmware_revision);
1580 else SBP2_DEBUG("sbp2_firmware_revision = %x",
1581 (unsigned int) firmware_revision);
1589 /* This is the start of our broken device checking. We try to hack
1590 * around oddities and known defects. */
1593 /* If the vendor id is 0xa0b8 (Symbios vendor id), then we have a
1594 * bridge with 128KB max transfer size limitation. For sanity, we
1595 * only voice this when the current max_sectors setting
1596 * exceeds the 128k limit. By default, that is not the case.
1598 * It would be really nice if we could detect this before the scsi
1599 * host gets initialized. That way we can down-force the
1600 * max_sectors to account for it. That is not currently
1602 if ((firmware_revision & 0xffff00) ==
1603 SBP2_128KB_BROKEN_FIRMWARE &&
1604 (max_sectors * 512) > (128*1024)) {
1605 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB max transfer size.",
1606 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1607 SBP2_WARN("WARNING: Current max_sectors setting is larger than 128KB (%d sectors)!",
1609 workarounds |= SBP2_BREAKAGE_128K_MAX_TRANSFER;
1612 /* Check for a blacklisted set of devices that require us to force
1613 * a 36 byte host inquiry. This can be overriden as a module param
1614 * (to force all hosts). */
1615 for (i = 0; i < NUM_BROKEN_INQUIRY_DEVS; i++) {
1616 if ((firmware_revision & 0xffff00) ==
1617 sbp2_broken_inquiry_list[i]) {
1618 SBP2_WARN("Node " NODE_BUS_FMT ": Using 36byte inquiry workaround",
1619 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1620 workarounds |= SBP2_BREAKAGE_INQUIRY_HACK;
1621 break; /* No need to continue. */
1625 /* If this is a logical unit directory entry, process the parent
1626 * to get the values. */
1627 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1628 struct unit_directory *parent_ud =
1629 container_of(ud->device.parent, struct unit_directory, device);
1630 sbp2_parse_unit_directory(scsi_id, parent_ud);
1632 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1633 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1634 scsi_id->sbp2_command_set = command_set;
1635 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1636 scsi_id->sbp2_firmware_revision = firmware_revision;
1637 scsi_id->workarounds = workarounds;
1638 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1639 scsi_id->sbp2_device_type_and_lun = ud->lun;
1644 * This function is called in order to determine the max speed and packet
1645 * size we can use in our ORBs. Note, that we (the driver and host) only
1646 * initiate the transaction. The SBP-2 device actually transfers the data
1647 * (by reading from the DMA area we tell it). This means that the SBP-2
1648 * device decides the actual maximum data it can transfer. We just tell it
1649 * the speed that it needs to use, and the max_rec the host supports, and
1650 * it takes care of the rest.
1652 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1654 struct sbp2scsi_host_info *hi = scsi_id->hi;
1656 SBP2_DEBUG("sbp2_max_speed_and_size");
1658 /* Initial setting comes from the hosts speed map */
1659 scsi_id->speed_code = hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64
1660 + NODEID_TO_NODE(scsi_id->ne->nodeid)];
1662 /* Bump down our speed if the user requested it */
1663 if (scsi_id->speed_code > max_speed) {
1664 scsi_id->speed_code = max_speed;
1665 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1666 hpsb_speedto_str[scsi_id->speed_code]);
1669 /* Payload size is the lesser of what our speed supports and what
1670 * our host supports. */
1671 scsi_id->max_payload_size = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1672 (u8)(hi->host->csr.max_rec - 1));
1674 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1675 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1676 hpsb_speedto_str[scsi_id->speed_code],
1677 1 << ((u32)scsi_id->max_payload_size + 2));
1683 * This function is called in order to perform a SBP-2 agent reset.
1685 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1691 SBP2_DEBUG("sbp2_agent_reset");
1694 * Ok, let's write to the target's management agent register
1696 data = ntohl(SBP2_AGENT_RESET_DATA);
1697 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1700 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1702 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1705 SBP2_ERR("hpsb_node_write failed.\n");
1710 * Need to make sure orb pointer is written on next command
1712 scsi_id->last_orb = NULL;
1718 * This function is called to create the actual command orb and s/g list
1719 * out of the scsi command itself.
1721 static int sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1722 struct sbp2_command_info *command,
1724 unsigned int scsi_use_sg,
1725 unsigned int scsi_request_bufflen,
1726 void *scsi_request_buffer,
1727 enum dma_data_direction dma_dir)
1730 struct sbp2scsi_host_info *hi = scsi_id->hi;
1731 struct scatterlist *sgpnt = (struct scatterlist *) scsi_request_buffer;
1732 struct sbp2_command_orb *command_orb = &command->command_orb;
1733 struct sbp2_unrestricted_page_table *scatter_gather_element =
1734 &command->scatter_gather_element[0];
1735 u32 sg_count, sg_len, orb_direction;
1740 * Set-up our command ORB..
1742 * NOTE: We're doing unrestricted page tables (s/g), as this is
1743 * best performance (at least with the devices I have). This means
1744 * that data_size becomes the number of s/g elements, and
1745 * page_size should be zero (for unrestricted).
1747 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1748 command_orb->next_ORB_lo = 0x0;
1749 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1750 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1751 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1754 * Get the direction of the transfer. If the direction is unknown, then use our
1755 * goofy table as a back-up.
1759 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1762 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1764 case DMA_FROM_DEVICE:
1765 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1767 case DMA_BIDIRECTIONAL:
1769 SBP2_ERR("SCSI data transfer direction not specified. "
1770 "Update the SBP2 direction table in sbp2.h if "
1771 "necessary for your application");
1772 __scsi_print_command(scsi_cmd);
1773 orb_direction = sbp2scsi_direction_table[*scsi_cmd];
1778 * Set-up our pagetable stuff... unfortunately, this has become
1779 * messier than I'd like. Need to clean this up a bit. ;-)
1781 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1783 SBP2_DEBUG("No data transfer");
1786 * Handle no data transfer
1788 command_orb->data_descriptor_hi = 0x0;
1789 command_orb->data_descriptor_lo = 0x0;
1790 command_orb->misc |= ORB_SET_DIRECTION(1);
1792 } else if (scsi_use_sg) {
1794 SBP2_DEBUG("Use scatter/gather");
1797 * Special case if only one element (and less than 64KB in size)
1799 if ((scsi_use_sg == 1) && (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1801 SBP2_DEBUG("Only one s/g element");
1802 command->dma_dir = dma_dir;
1803 command->dma_size = sgpnt[0].length;
1804 command->dma_type = CMD_DMA_PAGE;
1805 command->cmd_dma = pci_map_page(hi->host->pdev,
1810 SBP2_DMA_ALLOC("single page scatter element");
1812 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1813 command_orb->data_descriptor_lo = command->cmd_dma;
1814 command_orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1815 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1818 int count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg, dma_dir);
1819 SBP2_DMA_ALLOC("scatter list");
1821 command->dma_size = scsi_use_sg;
1822 command->dma_dir = dma_dir;
1823 command->sge_buffer = sgpnt;
1825 /* use page tables (s/g) */
1826 command_orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1827 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1828 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1829 command_orb->data_descriptor_lo = command->sge_dma;
1832 * Loop through and fill out our sbp-2 page tables
1833 * (and split up anything too large)
1835 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1836 sg_len = sg_dma_len(sgpnt);
1837 sg_addr = sg_dma_address(sgpnt);
1839 scatter_gather_element[sg_count].segment_base_lo = sg_addr;
1840 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1841 scatter_gather_element[sg_count].length_segment_base_hi =
1842 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1843 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1844 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1846 scatter_gather_element[sg_count].length_segment_base_hi =
1847 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1854 /* Number of page table (s/g) elements */
1855 command_orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1857 sbp2util_packet_dump(scatter_gather_element,
1858 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1859 "sbp2 s/g list", command->sge_dma);
1862 * Byte swap page tables if necessary
1864 sbp2util_cpu_to_be32_buffer(scatter_gather_element,
1865 (sizeof(struct sbp2_unrestricted_page_table)) *
1872 SBP2_DEBUG("No scatter/gather");
1874 command->dma_dir = dma_dir;
1875 command->dma_size = scsi_request_bufflen;
1876 command->dma_type = CMD_DMA_SINGLE;
1877 command->cmd_dma = pci_map_single (hi->host->pdev, scsi_request_buffer,
1880 SBP2_DMA_ALLOC("single bulk");
1883 * Handle case where we get a command w/o s/g enabled (but
1884 * check for transfers larger than 64K)
1886 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1888 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1889 command_orb->data_descriptor_lo = command->cmd_dma;
1890 command_orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1891 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1894 * Sanity, in case our direction table is not
1897 if (!scsi_request_bufflen) {
1898 command_orb->data_descriptor_hi = 0x0;
1899 command_orb->data_descriptor_lo = 0x0;
1900 command_orb->misc |= ORB_SET_DIRECTION(1);
1905 * Need to turn this into page tables, since the
1906 * buffer is too large.
1908 command_orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1909 command_orb->data_descriptor_lo = command->sge_dma;
1911 /* Use page tables (s/g) */
1912 command_orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1913 command_orb->misc |= ORB_SET_DIRECTION(orb_direction);
1916 * fill out our sbp-2 page tables (and split up
1920 sg_len = scsi_request_bufflen;
1921 sg_addr = command->cmd_dma;
1923 scatter_gather_element[sg_count].segment_base_lo = sg_addr;
1924 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1925 scatter_gather_element[sg_count].length_segment_base_hi =
1926 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1927 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1928 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1930 scatter_gather_element[sg_count].length_segment_base_hi =
1931 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1937 /* Number of page table (s/g) elements */
1938 command_orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1940 sbp2util_packet_dump(scatter_gather_element,
1941 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1942 "sbp2 s/g list", command->sge_dma);
1945 * Byte swap page tables if necessary
1947 sbp2util_cpu_to_be32_buffer(scatter_gather_element,
1948 (sizeof(struct sbp2_unrestricted_page_table)) *
1956 * Byte swap command ORB if necessary
1958 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1961 * Put our scsi command in the command ORB
1963 memset(command_orb->cdb, 0, 12);
1964 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1970 * This function is called in order to begin a regular SBP-2 command.
1972 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1973 struct sbp2_command_info *command)
1975 struct sbp2scsi_host_info *hi = scsi_id->hi;
1976 struct sbp2_command_orb *command_orb = &command->command_orb;
1977 struct node_entry *ne = scsi_id->ne;
1980 outstanding_orb_incr;
1981 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1982 command_orb, global_outstanding_command_orbs);
1984 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1985 sizeof(struct sbp2_command_orb),
1986 PCI_DMA_BIDIRECTIONAL);
1987 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1988 sizeof(command->scatter_gather_element),
1989 PCI_DMA_BIDIRECTIONAL);
1991 * Check to see if there are any previous orbs to use
1993 if (scsi_id->last_orb == NULL) {
1997 * Ok, let's write to the target's management agent register
1999 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
2000 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
2001 data[1] = command->command_orb_dma;
2002 sbp2util_cpu_to_be32_buffer(data, 8);
2004 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
2006 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
2007 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
2011 SBP2_ORB_DEBUG("write command agent complete");
2013 scsi_id->last_orb = command_orb;
2014 scsi_id->last_orb_dma = command->command_orb_dma;
2020 * We have an orb already sent (maybe or maybe not
2021 * processed) that we can append this orb to. So do so,
2022 * and ring the doorbell. Have to be very careful
2023 * modifying these next orb pointers, as they are accessed
2024 * both by the sbp2 device and us.
2026 scsi_id->last_orb->next_ORB_lo =
2027 cpu_to_be32(command->command_orb_dma);
2028 /* Tells hardware that this pointer is valid */
2029 scsi_id->last_orb->next_ORB_hi = 0x0;
2030 pci_dma_sync_single_for_device(hi->host->pdev, scsi_id->last_orb_dma,
2031 sizeof(struct sbp2_command_orb),
2032 PCI_DMA_BIDIRECTIONAL);
2037 data = cpu_to_be32(command->command_orb_dma);
2038 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
2040 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
2042 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
2043 SBP2_ERR("sbp2util_node_write_no_wait failed");
2047 scsi_id->last_orb = command_orb;
2048 scsi_id->last_orb_dma = command->command_orb_dma;
2055 * This function is called in order to begin a regular SBP-2 command.
2057 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2058 struct scsi_cmnd *SCpnt,
2059 void (*done)(struct scsi_cmnd *))
2061 unchar *cmd = (unchar *) SCpnt->cmnd;
2062 unsigned int request_bufflen = SCpnt->request_bufflen;
2063 struct sbp2_command_info *command;
2065 SBP2_DEBUG("sbp2_send_command");
2066 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2067 printk("[scsi command]\n ");
2068 scsi_print_command(SCpnt);
2070 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2071 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2074 * Allocate a command orb and s/g structure
2076 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2082 * The scsi stack sends down a request_bufflen which does not match the
2083 * length field in the scsi cdb. This causes some sbp2 devices to
2084 * reject this inquiry command. Fix the request_bufflen.
2086 if (*cmd == INQUIRY) {
2087 if (force_inquiry_hack || scsi_id->workarounds & SBP2_BREAKAGE_INQUIRY_HACK)
2088 request_bufflen = cmd[4] = 0x24;
2090 request_bufflen = cmd[4];
2094 * Now actually fill in the comamnd orb and sbp2 s/g list
2096 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2097 request_bufflen, SCpnt->request_buffer,
2098 SCpnt->sc_data_direction);
2100 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2101 "sbp2 command orb", command->command_orb_dma);
2104 * Initialize status fifo
2106 memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2109 * Link up the orb, and ring the doorbell if needed
2111 sbp2_link_orb_command(scsi_id, command);
2118 * Translates SBP-2 status into SCSI sense data for check conditions
2120 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2122 SBP2_DEBUG("sbp2_status_to_sense_data");
2125 * Ok, it's pretty ugly... ;-)
2127 sense_data[0] = 0x70;
2128 sense_data[1] = 0x0;
2129 sense_data[2] = sbp2_status[9];
2130 sense_data[3] = sbp2_status[12];
2131 sense_data[4] = sbp2_status[13];
2132 sense_data[5] = sbp2_status[14];
2133 sense_data[6] = sbp2_status[15];
2135 sense_data[8] = sbp2_status[16];
2136 sense_data[9] = sbp2_status[17];
2137 sense_data[10] = sbp2_status[18];
2138 sense_data[11] = sbp2_status[19];
2139 sense_data[12] = sbp2_status[10];
2140 sense_data[13] = sbp2_status[11];
2141 sense_data[14] = sbp2_status[20];
2142 sense_data[15] = sbp2_status[21];
2144 return(sbp2_status[8] & 0x3f); /* return scsi status */
2148 * This function is called after a command is completed, in order to do any necessary SBP-2
2149 * response data translations for the SCSI stack
2151 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2152 struct scsi_cmnd *SCpnt)
2154 u8 *scsi_buf = SCpnt->request_buffer;
2156 SBP2_DEBUG("sbp2_check_sbp2_response");
2158 switch (SCpnt->cmnd[0]) {
2163 * If scsi_id->sbp2_device_type_and_lun is uninitialized, then fill
2164 * this information in from the inquiry response data. Lun is set to zero.
2166 if (scsi_id->sbp2_device_type_and_lun == SBP2_DEVICE_TYPE_LUN_UNINITIALIZED) {
2167 SBP2_DEBUG("Creating sbp2_device_type_and_lun from scsi inquiry data");
2168 scsi_id->sbp2_device_type_and_lun = (scsi_buf[0] & 0x1f) << 16;
2172 * Make sure data length is ok. Minimum length is 36 bytes
2174 if (scsi_buf[4] == 0) {
2175 scsi_buf[4] = 36 - 5;
2179 * Fix ansi revision and response data format
2182 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2193 * This function deals with status writes from the SBP-2 device
2195 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2196 quadlet_t *data, u64 addr, size_t length, u16 fl)
2198 struct sbp2scsi_host_info *hi;
2199 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2201 struct scsi_cmnd *SCpnt = NULL;
2202 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2203 struct sbp2_command_info *command;
2204 unsigned long flags;
2206 SBP2_DEBUG("sbp2_handle_status_write");
2208 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2211 SBP2_ERR("host is NULL - this is bad!");
2212 return(RCODE_ADDRESS_ERROR);
2215 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2218 SBP2_ERR("host info is NULL - this is bad!");
2219 return(RCODE_ADDRESS_ERROR);
2223 * Find our scsi_id structure by looking at the status fifo address written to by
2226 id = SBP2_STATUS_FIFO_OFFSET_TO_ENTRY((u32)(addr - SBP2_STATUS_FIFO_ADDRESS));
2227 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2228 if (scsi_id_tmp->ne->nodeid == nodeid && scsi_id_tmp->ud->id == id) {
2229 scsi_id = scsi_id_tmp;
2235 SBP2_ERR("scsi_id is NULL - device is gone?");
2236 return(RCODE_ADDRESS_ERROR);
2240 * Put response into scsi_id status fifo...
2242 memcpy(&scsi_id->status_block, data, length);
2245 * Byte swap first two quadlets (8 bytes) of status for processing
2247 sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2250 * Handle command ORB status here if necessary. First, need to match status with command.
2252 command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2255 SBP2_DEBUG("Found status for command ORB");
2256 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2257 sizeof(struct sbp2_command_orb),
2258 PCI_DMA_BIDIRECTIONAL);
2259 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2260 sizeof(command->scatter_gather_element),
2261 PCI_DMA_BIDIRECTIONAL);
2263 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2264 outstanding_orb_decr;
2267 * Matched status with command, now grab scsi command pointers and check status
2269 SCpnt = command->Current_SCpnt;
2270 sbp2util_mark_command_completed(scsi_id, command);
2275 * See if the target stored any scsi status information
2277 if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2279 * Translate SBP-2 status to SCSI sense data
2281 SBP2_DEBUG("CHECK CONDITION");
2282 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2286 * Check to see if the dead bit is set. If so, we'll have to initiate
2287 * a fetch agent reset.
2289 if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2292 * Initiate a fetch agent reset.
2294 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2295 sbp2_agent_reset(scsi_id, 0);
2298 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2302 * Check here to see if there are no commands in-use. If there are none, we can
2303 * null out last orb so that next time around we write directly to the orb pointer...
2304 * Quick start saves one 1394 bus transaction.
2306 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2307 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2308 scsi_id->last_orb = NULL;
2310 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2315 * It's probably a login/logout/reconnect status.
2317 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2318 (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2319 (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2320 (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2321 atomic_set(&scsi_id->sbp2_login_complete, 1);
2327 /* Complete the SCSI command. */
2328 SBP2_DEBUG("Completing SCSI command");
2329 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2330 command->Current_done);
2331 SBP2_ORB_DEBUG("command orb completed");
2334 return(RCODE_COMPLETE);
2338 /**************************************
2339 * SCSI interface related section
2340 **************************************/
2343 * This routine is the main request entry routine for doing I/O. It is
2344 * called from the scsi stack directly.
2346 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2347 void (*done)(struct scsi_cmnd *))
2349 struct scsi_id_instance_data *scsi_id =
2350 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2351 struct sbp2scsi_host_info *hi;
2352 int result = DID_NO_CONNECT << 16;
2354 SBP2_DEBUG("sbp2scsi_queuecommand");
2356 if (!sbp2util_node_is_available(scsi_id))
2362 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2367 * Until we handle multiple luns, just return selection time-out
2368 * to any IO directed at non-zero LUNs
2370 if (SCpnt->device->lun)
2374 * Check for request sense command, and handle it here
2375 * (autorequest sense)
2377 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2378 SBP2_DEBUG("REQUEST_SENSE");
2379 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2380 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2381 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2386 * Check to see if we are in the middle of a bus reset.
2388 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2389 SBP2_ERR("Bus reset in progress - rejecting command");
2390 result = DID_BUS_BUSY << 16;
2395 * Try and send our SCSI command
2397 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2398 SBP2_ERR("Error sending SCSI command");
2399 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2405 SCpnt->result = result;
2411 * This function is called in order to complete all outstanding SBP-2
2412 * commands (in case of resets, etc.).
2414 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2417 struct sbp2scsi_host_info *hi = scsi_id->hi;
2418 struct list_head *lh;
2419 struct sbp2_command_info *command;
2420 unsigned long flags;
2422 SBP2_DEBUG("sbp2scsi_complete_all_commands");
2424 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2425 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2426 SBP2_DEBUG("Found pending command to complete");
2427 lh = scsi_id->sbp2_command_orb_inuse.next;
2428 command = list_entry(lh, struct sbp2_command_info, list);
2429 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2430 sizeof(struct sbp2_command_orb),
2431 PCI_DMA_BIDIRECTIONAL);
2432 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2433 sizeof(command->scatter_gather_element),
2434 PCI_DMA_BIDIRECTIONAL);
2435 sbp2util_mark_command_completed(scsi_id, command);
2436 if (command->Current_SCpnt) {
2437 command->Current_SCpnt->result = status << 16;
2438 command->Current_done(command->Current_SCpnt);
2441 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2447 * This function is called in order to complete a regular SBP-2 command.
2449 * This can be called in interrupt context.
2451 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2452 u32 scsi_status, struct scsi_cmnd *SCpnt,
2453 void (*done)(struct scsi_cmnd *))
2455 SBP2_DEBUG("sbp2scsi_complete_command");
2461 SBP2_ERR("SCpnt is NULL");
2466 * If a bus reset is in progress and there was an error, don't
2467 * complete the command, just let it get retried at the end of the
2470 if (!hpsb_node_entry_valid(scsi_id->ne) && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2471 SBP2_ERR("Bus reset in progress - retry command later");
2476 * Switch on scsi status
2478 switch (scsi_status) {
2479 case SBP2_SCSI_STATUS_GOOD:
2480 SCpnt->result = DID_OK;
2483 case SBP2_SCSI_STATUS_BUSY:
2484 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2485 SCpnt->result = DID_BUS_BUSY << 16;
2488 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2489 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2490 SCpnt->result = CHECK_CONDITION << 1;
2495 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2496 scsi_print_command(SCpnt);
2497 scsi_print_sense("bh", SCpnt);
2502 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2503 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2504 SCpnt->result = DID_NO_CONNECT << 16;
2505 scsi_print_command(SCpnt);
2508 case SBP2_SCSI_STATUS_CONDITION_MET:
2509 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2510 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2511 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2512 SCpnt->result = DID_ERROR << 16;
2513 scsi_print_command(SCpnt);
2517 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2518 SCpnt->result = DID_ERROR << 16;
2522 * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2524 if (SCpnt->result == DID_OK) {
2525 sbp2_check_sbp2_response(scsi_id, SCpnt);
2529 * If a bus reset is in progress and there was an error, complete
2530 * the command as busy so that it will get retried.
2532 if (!hpsb_node_entry_valid(scsi_id->ne) && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2533 SBP2_ERR("Completing command with busy (bus reset)");
2534 SCpnt->result = DID_BUS_BUSY << 16;
2538 * If a unit attention occurs, return busy status so it gets
2539 * retried... it could have happened because of a 1394 bus reset
2543 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2544 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2545 SBP2_DEBUG("UNIT ATTENTION - return busy");
2546 SCpnt->result = DID_BUS_BUSY << 16;
2551 * Tell scsi stack that we're done with this command
2557 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2559 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = sdev;
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;
2573 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2575 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2581 * Called by scsi stack when something has really gone wrong. Usually
2582 * called when a command has timed-out for some reason.
2584 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2586 struct scsi_id_instance_data *scsi_id =
2587 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2588 struct sbp2scsi_host_info *hi = scsi_id->hi;
2589 struct sbp2_command_info *command;
2591 SBP2_ERR("aborting sbp2 command");
2592 scsi_print_command(SCpnt);
2594 if (sbp2util_node_is_available(scsi_id)) {
2597 * Right now, just return any matching command structures
2600 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2602 SBP2_DEBUG("Found command to abort");
2603 pci_dma_sync_single_for_cpu(hi->host->pdev,
2604 command->command_orb_dma,
2605 sizeof(struct sbp2_command_orb),
2606 PCI_DMA_BIDIRECTIONAL);
2607 pci_dma_sync_single_for_cpu(hi->host->pdev,
2609 sizeof(command->scatter_gather_element),
2610 PCI_DMA_BIDIRECTIONAL);
2611 sbp2util_mark_command_completed(scsi_id, command);
2612 if (command->Current_SCpnt) {
2613 command->Current_SCpnt->result = DID_ABORT << 16;
2614 command->Current_done(command->Current_SCpnt);
2619 * Initiate a fetch agent reset.
2621 sbp2_agent_reset(scsi_id, 0);
2622 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2629 * Called by scsi stack when something has really gone wrong.
2631 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2633 struct scsi_id_instance_data *scsi_id =
2634 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2635 unsigned long flags;
2637 SBP2_ERR("reset requested");
2639 spin_lock_irqsave(SCpnt->device->host->host_lock, flags);
2641 if (sbp2util_node_is_available(scsi_id)) {
2642 SBP2_ERR("Generating sbp2 fetch agent reset");
2643 sbp2_agent_reset(scsi_id, 0);
2646 spin_unlock_irqrestore(SCpnt->device->host->host_lock, flags);
2651 static const char *sbp2scsi_info (struct Scsi_Host *host)
2653 return "SCSI emulation for IEEE-1394 SBP-2 Devices";
2656 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr, char *buf)
2658 struct scsi_device *sdev;
2659 struct scsi_id_instance_data *scsi_id;
2662 if (!(sdev = to_scsi_device(dev)))
2665 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2668 if (scsi_id->sbp2_device_type_and_lun == SBP2_DEVICE_TYPE_LUN_UNINITIALIZED)
2671 lun = ORB_SET_LUN(scsi_id->sbp2_device_type_and_lun);
2673 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2674 scsi_id->ud->id, lun);
2676 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2678 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2679 &dev_attr_ieee1394_id,
2683 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2684 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2685 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2686 MODULE_LICENSE("GPL");
2688 /* SCSI host template */
2689 static struct scsi_host_template scsi_driver_template = {
2690 .module = THIS_MODULE,
2691 .name = "SBP-2 IEEE-1394",
2692 .proc_name = SBP2_DEVICE_NAME,
2693 .info = sbp2scsi_info,
2694 .queuecommand = sbp2scsi_queuecommand,
2695 .eh_abort_handler = sbp2scsi_abort,
2696 .eh_device_reset_handler = sbp2scsi_reset,
2697 .eh_bus_reset_handler = sbp2scsi_reset,
2698 .eh_host_reset_handler = sbp2scsi_reset,
2699 .slave_alloc = sbp2scsi_slave_alloc,
2700 .slave_configure = sbp2scsi_slave_configure,
2701 .slave_destroy = sbp2scsi_slave_destroy,
2703 .sg_tablesize = SG_ALL,
2704 .use_clustering = ENABLE_CLUSTERING,
2705 .cmd_per_lun = SBP2_MAX_CMDS,
2706 .can_queue = SBP2_MAX_CMDS,
2708 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2711 static int sbp2_module_init(void)
2715 SBP2_DEBUG("sbp2_module_init");
2717 printk(KERN_INFO "sbp2: %s\n", version);
2719 /* Module load debug option to force one command at a time (serializing I/O) */
2721 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2722 SBP2_INFO("Try serialize_io=0 for better performance");
2723 scsi_driver_template.can_queue = 1;
2724 scsi_driver_template.cmd_per_lun = 1;
2727 /* Set max sectors (module load option). Default is 255 sectors. */
2728 scsi_driver_template.max_sectors = max_sectors;
2731 /* Register our high level driver with 1394 stack */
2732 hpsb_register_highlevel(&sbp2_highlevel);
2734 ret = hpsb_register_protocol(&sbp2_driver);
2736 SBP2_ERR("Failed to register protocol");
2737 hpsb_unregister_highlevel(&sbp2_highlevel);
2744 static void __exit sbp2_module_exit(void)
2746 SBP2_DEBUG("sbp2_module_exit");
2748 hpsb_unregister_protocol(&sbp2_driver);
2750 hpsb_unregister_highlevel(&sbp2_highlevel);
2753 module_init(sbp2_module_init);
2754 module_exit(sbp2_module_exit);