2 * sbp2.c - SBP-2 protocol driver for IEEE-1394
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5 * jamesg@filanet.com (JSG)
7 * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 * This driver implements the Serial Bus Protocol 2 (SBP-2) over IEEE-1394
28 * under Linux. The SBP-2 driver is implemented as an IEEE-1394 high-level
29 * driver. It also registers as a SCSI lower-level driver in order to accept
30 * SCSI commands for transport using SBP-2.
32 * You may access any attached SBP-2 storage devices as if they were SCSI
33 * devices (e.g. mount /dev/sda1, fdisk, mkfs, etc.).
37 * - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38 * but the code needs additional debugging.
41 #include <linux/blkdev.h>
42 #include <linux/compiler.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/gfp.h>
47 #include <linux/init.h>
48 #include <linux/kernel.h>
49 #include <linux/list.h>
50 #include <linux/module.h>
51 #include <linux/moduleparam.h>
52 #include <linux/pci.h>
53 #include <linux/slab.h>
54 #include <linux/spinlock.h>
55 #include <linux/stat.h>
56 #include <linux/string.h>
57 #include <linux/stringify.h>
58 #include <linux/types.h>
59 #include <linux/wait.h>
61 #include <asm/byteorder.h>
62 #include <asm/errno.h>
63 #include <asm/param.h>
64 #include <asm/scatterlist.h>
65 #include <asm/system.h>
66 #include <asm/types.h>
68 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
69 #include <asm/io.h> /* for bus_to_virt */
72 #include <scsi/scsi.h>
73 #include <scsi/scsi_cmnd.h>
74 #include <scsi/scsi_dbg.h>
75 #include <scsi/scsi_device.h>
76 #include <scsi/scsi_host.h>
79 #include "highlevel.h"
82 #include "ieee1394_core.h"
83 #include "ieee1394_hotplug.h"
84 #include "ieee1394_transactions.h"
85 #include "ieee1394_types.h"
90 * Module load parameter definitions
94 * Change max_speed on module load if you have a bad IEEE-1394
95 * controller that has trouble running 2KB packets at 400mb.
97 * NOTE: On certain OHCI parts I have seen short packets on async transmit
98 * (probably due to PCI latency/throughput issues with the part). You can
99 * bump down the speed if you are running into problems.
101 static int max_speed
= IEEE1394_SPEED_MAX
;
102 module_param(max_speed
, int, 0644);
103 MODULE_PARM_DESC(max_speed
, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
106 * Set serialize_io to 1 if you'd like only one scsi command sent
107 * down to us at a time (debugging). This might be necessary for very
108 * badly behaved sbp2 devices.
110 * TODO: Make this configurable per device.
112 static int serialize_io
= 1;
113 module_param(serialize_io
, int, 0444);
114 MODULE_PARM_DESC(serialize_io
, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
117 * Bump up max_sectors if you'd like to support very large sized
118 * transfers. Please note that some older sbp2 bridge chips are broken for
119 * transfers greater or equal to 128KB. Default is a value of 255
120 * sectors, or just under 128KB (at 512 byte sector size). I can note that
121 * the Oxsemi sbp2 chipsets have no problems supporting very large
124 static int max_sectors
= SBP2_MAX_SECTORS
;
125 module_param(max_sectors
, int, 0444);
126 MODULE_PARM_DESC(max_sectors
, "Change max sectors per I/O supported (default = "
127 __stringify(SBP2_MAX_SECTORS
) ")");
130 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
131 * do an exclusive login, as it's generally unsafe to have two hosts
132 * talking to a single sbp2 device at the same time (filesystem coherency,
133 * etc.). If you're running an sbp2 device that supports multiple logins,
134 * and you're either running read-only filesystems or some sort of special
135 * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
136 * File System, or Lustre, then set exclusive_login to zero.
138 * So far only bridges from Oxford Semiconductor are known to support
139 * concurrent logins. Depending on firmware, four or two concurrent logins
140 * are possible on OXFW911 and newer Oxsemi bridges.
142 static int exclusive_login
= 1;
143 module_param(exclusive_login
, int, 0644);
144 MODULE_PARM_DESC(exclusive_login
, "Exclusive login to sbp2 device (default = 1)");
147 * If any of the following workarounds is required for your device to work,
148 * please submit the kernel messages logged by sbp2 to the linux1394-devel
151 * - 128kB max transfer
152 * Limit transfer size. Necessary for some old bridges.
155 * When scsi_mod probes the device, let the inquiry command look like that
159 * Suppress sending of mode_sense for mode page 8 if the device pretends to
160 * support the SCSI Primary Block commands instead of Reduced Block Commands.
163 * Tell sd_mod to correct the last sector number reported by read_capacity.
164 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
165 * Don't use this with devices which don't have this bug.
167 * - override internal blacklist
168 * Instead of adding to the built-in blacklist, use only the workarounds
169 * specified in the module load parameter.
170 * Useful if a blacklist entry interfered with a non-broken device.
172 static int sbp2_default_workarounds
;
173 module_param_named(workarounds
, sbp2_default_workarounds
, int, 0644);
174 MODULE_PARM_DESC(workarounds
, "Work around device bugs (default = 0"
175 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS
)
176 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36
)
177 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8
)
178 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY
)
179 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE
)
180 ", or a combination)");
183 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
184 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
189 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data
*, u32
);
190 static void sbp2scsi_complete_command(struct scsi_id_instance_data
*, u32
,
192 void (*)(struct scsi_cmnd
*));
193 static struct scsi_id_instance_data
*sbp2_alloc_device(struct unit_directory
*);
194 static int sbp2_start_device(struct scsi_id_instance_data
*);
195 static void sbp2_remove_device(struct scsi_id_instance_data
*);
196 static int sbp2_login_device(struct scsi_id_instance_data
*);
197 static int sbp2_reconnect_device(struct scsi_id_instance_data
*);
198 static int sbp2_logout_device(struct scsi_id_instance_data
*);
199 static void sbp2_host_reset(struct hpsb_host
*);
200 static int sbp2_handle_status_write(struct hpsb_host
*, int, int, quadlet_t
*,
202 static int sbp2_agent_reset(struct scsi_id_instance_data
*, int);
203 static void sbp2_parse_unit_directory(struct scsi_id_instance_data
*,
204 struct unit_directory
*);
205 static int sbp2_set_busy_timeout(struct scsi_id_instance_data
*);
206 static int sbp2_max_speed_and_size(struct scsi_id_instance_data
*);
209 static const u8 sbp2_speedto_max_payload
[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
211 static struct hpsb_highlevel sbp2_highlevel
= {
212 .name
= SBP2_DEVICE_NAME
,
213 .host_reset
= sbp2_host_reset
,
216 static struct hpsb_address_ops sbp2_ops
= {
217 .write
= sbp2_handle_status_write
220 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
221 static int sbp2_handle_physdma_write(struct hpsb_host
*, int, int, quadlet_t
*,
223 static int sbp2_handle_physdma_read(struct hpsb_host
*, int, quadlet_t
*, u64
,
226 static struct hpsb_address_ops sbp2_physdma_ops
= {
227 .read
= sbp2_handle_physdma_read
,
228 .write
= sbp2_handle_physdma_write
,
234 * Interface to driver core and IEEE 1394 core
236 static struct ieee1394_device_id sbp2_id_table
[] = {
238 .match_flags
= IEEE1394_MATCH_SPECIFIER_ID
| IEEE1394_MATCH_VERSION
,
239 .specifier_id
= SBP2_UNIT_SPEC_ID_ENTRY
& 0xffffff,
240 .version
= SBP2_SW_VERSION_ENTRY
& 0xffffff},
243 MODULE_DEVICE_TABLE(ieee1394
, sbp2_id_table
);
245 static int sbp2_probe(struct device
*);
246 static int sbp2_remove(struct device
*);
247 static int sbp2_update(struct unit_directory
*);
249 static struct hpsb_protocol_driver sbp2_driver
= {
250 .name
= "SBP2 Driver",
251 .id_table
= sbp2_id_table
,
252 .update
= sbp2_update
,
254 .name
= SBP2_DEVICE_NAME
,
255 .bus
= &ieee1394_bus_type
,
257 .remove
= sbp2_remove
,
263 * Interface to SCSI core
265 static int sbp2scsi_queuecommand(struct scsi_cmnd
*,
266 void (*)(struct scsi_cmnd
*));
267 static int sbp2scsi_abort(struct scsi_cmnd
*);
268 static int sbp2scsi_reset(struct scsi_cmnd
*);
269 static int sbp2scsi_slave_alloc(struct scsi_device
*);
270 static int sbp2scsi_slave_configure(struct scsi_device
*);
271 static void sbp2scsi_slave_destroy(struct scsi_device
*);
272 static ssize_t
sbp2_sysfs_ieee1394_id_show(struct device
*,
273 struct device_attribute
*, char *);
275 static DEVICE_ATTR(ieee1394_id
, S_IRUGO
, sbp2_sysfs_ieee1394_id_show
, NULL
);
277 static struct device_attribute
*sbp2_sysfs_sdev_attrs
[] = {
278 &dev_attr_ieee1394_id
,
282 static struct scsi_host_template scsi_driver_template
= {
283 .module
= THIS_MODULE
,
284 .name
= "SBP-2 IEEE-1394",
285 .proc_name
= SBP2_DEVICE_NAME
,
286 .queuecommand
= sbp2scsi_queuecommand
,
287 .eh_abort_handler
= sbp2scsi_abort
,
288 .eh_device_reset_handler
= sbp2scsi_reset
,
289 .slave_alloc
= sbp2scsi_slave_alloc
,
290 .slave_configure
= sbp2scsi_slave_configure
,
291 .slave_destroy
= sbp2scsi_slave_destroy
,
293 .sg_tablesize
= SG_ALL
,
294 .use_clustering
= ENABLE_CLUSTERING
,
295 .cmd_per_lun
= SBP2_MAX_CMDS
,
296 .can_queue
= SBP2_MAX_CMDS
,
298 .sdev_attrs
= sbp2_sysfs_sdev_attrs
,
303 * List of devices with known bugs.
305 * The firmware_revision field, masked with 0xffff00, is the best indicator
306 * for the type of bridge chip of a device. It yields a few false positives
307 * but this did not break correctly behaving devices so far.
309 static const struct {
310 u32 firmware_revision
;
312 unsigned workarounds
;
313 } sbp2_workarounds_table
[] = {
314 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
315 .firmware_revision
= 0x002800,
316 .model_id
= 0x001010,
317 .workarounds
= SBP2_WORKAROUND_INQUIRY_36
|
318 SBP2_WORKAROUND_MODE_SENSE_8
,
320 /* Initio bridges, actually only needed for some older ones */ {
321 .firmware_revision
= 0x000200,
322 .workarounds
= SBP2_WORKAROUND_INQUIRY_36
,
324 /* Symbios bridge */ {
325 .firmware_revision
= 0xa0b800,
326 .workarounds
= SBP2_WORKAROUND_128K_MAX_TRANS
,
329 * Note about the following Apple iPod blacklist entries:
331 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
332 * matching logic treats 0 as a wildcard, we cannot match this ID
333 * without rewriting the matching routine. Fortunately these iPods
334 * do not feature the read_capacity bug according to one report.
335 * Read_capacity behaviour as well as model_id could change due to
336 * Apple-supplied firmware updates though.
338 /* iPod 4th generation */ {
339 .firmware_revision
= 0x0a2700,
340 .model_id
= 0x000021,
341 .workarounds
= SBP2_WORKAROUND_FIX_CAPACITY
,
344 .firmware_revision
= 0x0a2700,
345 .model_id
= 0x000023,
346 .workarounds
= SBP2_WORKAROUND_FIX_CAPACITY
,
349 .firmware_revision
= 0x0a2700,
350 .model_id
= 0x00007e,
351 .workarounds
= SBP2_WORKAROUND_FIX_CAPACITY
,
355 /**************************************
356 * General utility functions
357 **************************************/
361 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
363 static inline void sbp2util_be32_to_cpu_buffer(void *buffer
, int length
)
367 for (length
= (length
>> 2); length
--; )
368 temp
[length
] = be32_to_cpu(temp
[length
]);
374 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
376 static inline void sbp2util_cpu_to_be32_buffer(void *buffer
, int length
)
380 for (length
= (length
>> 2); length
--; )
381 temp
[length
] = cpu_to_be32(temp
[length
]);
385 #else /* BIG_ENDIAN */
386 /* Why waste the cpu cycles? */
387 #define sbp2util_be32_to_cpu_buffer(x,y) do {} while (0)
388 #define sbp2util_cpu_to_be32_buffer(x,y) do {} while (0)
391 static DECLARE_WAIT_QUEUE_HEAD(access_wq
);
394 * Waits for completion of an SBP-2 access request.
395 * Returns nonzero if timed out or prematurely interrupted.
397 static int sbp2util_access_timeout(struct scsi_id_instance_data
*scsi_id
,
400 long leftover
= wait_event_interruptible_timeout(
401 access_wq
, scsi_id
->access_complete
, timeout
);
403 scsi_id
->access_complete
= 0;
404 return leftover
<= 0;
407 /* Frees an allocated packet */
408 static void sbp2_free_packet(struct hpsb_packet
*packet
)
410 hpsb_free_tlabel(packet
);
411 hpsb_free_packet(packet
);
414 /* This is much like hpsb_node_write(), except it ignores the response
415 * subaction and returns immediately. Can be used from interrupts.
417 static int sbp2util_node_write_no_wait(struct node_entry
*ne
, u64 addr
,
418 quadlet_t
*buffer
, size_t length
)
420 struct hpsb_packet
*packet
;
422 packet
= hpsb_make_writepacket(ne
->host
, ne
->nodeid
,
423 addr
, buffer
, length
);
427 hpsb_set_packet_complete_task(packet
,
428 (void (*)(void *))sbp2_free_packet
,
431 hpsb_node_fill_packet(ne
, packet
);
433 if (hpsb_send_packet(packet
) < 0) {
434 sbp2_free_packet(packet
);
441 static void sbp2util_notify_fetch_agent(struct scsi_id_instance_data
*scsi_id
,
442 u64 offset
, quadlet_t
*data
, size_t len
)
445 * There is a small window after a bus reset within which the node
446 * entry's generation is current but the reconnect wasn't completed.
448 if (unlikely(atomic_read(&scsi_id
->state
) == SBP2LU_STATE_IN_RESET
))
451 if (hpsb_node_write(scsi_id
->ne
,
452 scsi_id
->sbp2_command_block_agent_addr
+ offset
,
454 SBP2_ERR("sbp2util_notify_fetch_agent failed.");
456 * Now accept new SCSI commands, unless a bus reset happended during
459 if (likely(atomic_read(&scsi_id
->state
) != SBP2LU_STATE_IN_RESET
))
460 scsi_unblock_requests(scsi_id
->scsi_host
);
463 static void sbp2util_write_orb_pointer(struct work_struct
*work
)
467 data
[0] = ORB_SET_NODE_ID(
468 (container_of(work
, struct scsi_id_instance_data
, protocol_work
))->hi
->host
->node_id
);
469 data
[1] = (container_of(work
, struct scsi_id_instance_data
, protocol_work
))->last_orb_dma
;
470 sbp2util_cpu_to_be32_buffer(data
, 8);
471 sbp2util_notify_fetch_agent(container_of(work
, struct scsi_id_instance_data
, protocol_work
), SBP2_ORB_POINTER_OFFSET
, data
, 8);
474 static void sbp2util_write_doorbell(struct work_struct
*work
)
476 sbp2util_notify_fetch_agent(container_of(work
, struct scsi_id_instance_data
, protocol_work
), SBP2_DOORBELL_OFFSET
, NULL
, 4);
480 * This function is called to create a pool of command orbs used for
481 * command processing. It is called when a new sbp2 device is detected.
483 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data
*scsi_id
)
485 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
487 unsigned long flags
, orbs
;
488 struct sbp2_command_info
*command
;
490 orbs
= serialize_io
? 2 : SBP2_MAX_CMDS
;
492 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
493 for (i
= 0; i
< orbs
; i
++) {
494 command
= kzalloc(sizeof(*command
), GFP_ATOMIC
);
496 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
,
500 command
->command_orb_dma
=
501 pci_map_single(hi
->host
->pdev
, &command
->command_orb
,
502 sizeof(struct sbp2_command_orb
),
505 pci_map_single(hi
->host
->pdev
,
506 &command
->scatter_gather_element
,
507 sizeof(command
->scatter_gather_element
),
508 PCI_DMA_BIDIRECTIONAL
);
509 INIT_LIST_HEAD(&command
->list
);
510 list_add_tail(&command
->list
, &scsi_id
->sbp2_command_orb_completed
);
512 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
517 * This function is called to delete a pool of command orbs.
519 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data
*scsi_id
)
521 struct hpsb_host
*host
= scsi_id
->hi
->host
;
522 struct list_head
*lh
, *next
;
523 struct sbp2_command_info
*command
;
526 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
527 if (!list_empty(&scsi_id
->sbp2_command_orb_completed
)) {
528 list_for_each_safe(lh
, next
, &scsi_id
->sbp2_command_orb_completed
) {
529 command
= list_entry(lh
, struct sbp2_command_info
, list
);
531 /* Release our generic DMA's */
532 pci_unmap_single(host
->pdev
, command
->command_orb_dma
,
533 sizeof(struct sbp2_command_orb
),
535 pci_unmap_single(host
->pdev
, command
->sge_dma
,
536 sizeof(command
->scatter_gather_element
),
537 PCI_DMA_BIDIRECTIONAL
);
541 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
546 * This function finds the sbp2_command for a given outstanding command
547 * orb.Only looks at the inuse list.
549 static struct sbp2_command_info
*sbp2util_find_command_for_orb(
550 struct scsi_id_instance_data
*scsi_id
, dma_addr_t orb
)
552 struct sbp2_command_info
*command
;
555 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
556 if (!list_empty(&scsi_id
->sbp2_command_orb_inuse
)) {
557 list_for_each_entry(command
, &scsi_id
->sbp2_command_orb_inuse
, list
) {
558 if (command
->command_orb_dma
== orb
) {
559 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
564 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
569 * This function finds the sbp2_command for a given outstanding SCpnt.
570 * Only looks at the inuse list.
571 * Must be called with scsi_id->sbp2_command_orb_lock held.
573 static struct sbp2_command_info
*sbp2util_find_command_for_SCpnt(
574 struct scsi_id_instance_data
*scsi_id
, void *SCpnt
)
576 struct sbp2_command_info
*command
;
578 if (!list_empty(&scsi_id
->sbp2_command_orb_inuse
))
579 list_for_each_entry(command
, &scsi_id
->sbp2_command_orb_inuse
, list
)
580 if (command
->Current_SCpnt
== SCpnt
)
586 * This function allocates a command orb used to send a scsi command.
588 static struct sbp2_command_info
*sbp2util_allocate_command_orb(
589 struct scsi_id_instance_data
*scsi_id
,
590 struct scsi_cmnd
*Current_SCpnt
,
591 void (*Current_done
)(struct scsi_cmnd
*))
593 struct list_head
*lh
;
594 struct sbp2_command_info
*command
= NULL
;
597 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
598 if (!list_empty(&scsi_id
->sbp2_command_orb_completed
)) {
599 lh
= scsi_id
->sbp2_command_orb_completed
.next
;
601 command
= list_entry(lh
, struct sbp2_command_info
, list
);
602 command
->Current_done
= Current_done
;
603 command
->Current_SCpnt
= Current_SCpnt
;
604 list_add_tail(&command
->list
, &scsi_id
->sbp2_command_orb_inuse
);
606 SBP2_ERR("%s: no orbs available", __FUNCTION__
);
608 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
613 static void sbp2util_free_command_dma(struct sbp2_command_info
*command
)
615 struct scsi_id_instance_data
*scsi_id
=
616 (struct scsi_id_instance_data
*)command
->Current_SCpnt
->device
->host
->hostdata
[0];
617 struct hpsb_host
*host
;
620 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__
);
624 host
= scsi_id
->ud
->ne
->host
;
626 if (command
->cmd_dma
) {
627 if (command
->dma_type
== CMD_DMA_SINGLE
)
628 pci_unmap_single(host
->pdev
, command
->cmd_dma
,
629 command
->dma_size
, command
->dma_dir
);
630 else if (command
->dma_type
== CMD_DMA_PAGE
)
631 pci_unmap_page(host
->pdev
, command
->cmd_dma
,
632 command
->dma_size
, command
->dma_dir
);
633 /* XXX: Check for CMD_DMA_NONE bug */
634 command
->dma_type
= CMD_DMA_NONE
;
635 command
->cmd_dma
= 0;
638 if (command
->sge_buffer
) {
639 pci_unmap_sg(host
->pdev
, command
->sge_buffer
,
640 command
->dma_size
, command
->dma_dir
);
641 command
->sge_buffer
= NULL
;
646 * This function moves a command to the completed orb list.
647 * Must be called with scsi_id->sbp2_command_orb_lock held.
649 static void sbp2util_mark_command_completed(
650 struct scsi_id_instance_data
*scsi_id
,
651 struct sbp2_command_info
*command
)
653 list_del(&command
->list
);
654 sbp2util_free_command_dma(command
);
655 list_add_tail(&command
->list
, &scsi_id
->sbp2_command_orb_completed
);
659 * Is scsi_id valid? Is the 1394 node still present?
661 static inline int sbp2util_node_is_available(struct scsi_id_instance_data
*scsi_id
)
663 return scsi_id
&& scsi_id
->ne
&& !scsi_id
->ne
->in_limbo
;
666 /*********************************************
667 * IEEE-1394 core driver stack related section
668 *********************************************/
670 static int sbp2_probe(struct device
*dev
)
672 struct unit_directory
*ud
;
673 struct scsi_id_instance_data
*scsi_id
;
675 ud
= container_of(dev
, struct unit_directory
, device
);
677 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
679 if (ud
->flags
& UNIT_DIRECTORY_HAS_LUN_DIRECTORY
)
682 scsi_id
= sbp2_alloc_device(ud
);
687 sbp2_parse_unit_directory(scsi_id
, ud
);
689 return sbp2_start_device(scsi_id
);
692 static int sbp2_remove(struct device
*dev
)
694 struct unit_directory
*ud
;
695 struct scsi_id_instance_data
*scsi_id
;
696 struct scsi_device
*sdev
;
698 ud
= container_of(dev
, struct unit_directory
, device
);
699 scsi_id
= ud
->device
.driver_data
;
703 if (scsi_id
->scsi_host
) {
704 /* Get rid of enqueued commands if there is no chance to
706 if (!sbp2util_node_is_available(scsi_id
))
707 sbp2scsi_complete_all_commands(scsi_id
, DID_NO_CONNECT
);
708 /* scsi_remove_device() will trigger shutdown functions of SCSI
709 * highlevel drivers which would deadlock if blocked. */
710 atomic_set(&scsi_id
->state
, SBP2LU_STATE_IN_SHUTDOWN
);
711 scsi_unblock_requests(scsi_id
->scsi_host
);
713 sdev
= scsi_id
->sdev
;
715 scsi_id
->sdev
= NULL
;
716 scsi_remove_device(sdev
);
719 sbp2_logout_device(scsi_id
);
720 sbp2_remove_device(scsi_id
);
725 static int sbp2_update(struct unit_directory
*ud
)
727 struct scsi_id_instance_data
*scsi_id
= ud
->device
.driver_data
;
729 if (sbp2_reconnect_device(scsi_id
)) {
732 * Ok, reconnect has failed. Perhaps we didn't
733 * reconnect fast enough. Try doing a regular login, but
734 * first do a logout just in case of any weirdness.
736 sbp2_logout_device(scsi_id
);
738 if (sbp2_login_device(scsi_id
)) {
739 /* Login failed too, just fail, and the backend
740 * will call our sbp2_remove for us */
741 SBP2_ERR("Failed to reconnect to sbp2 device!");
746 /* Set max retries to something large on the device. */
747 sbp2_set_busy_timeout(scsi_id
);
749 /* Do a SBP-2 fetch agent reset. */
750 sbp2_agent_reset(scsi_id
, 1);
752 /* Get the max speed and packet size that we can use. */
753 sbp2_max_speed_and_size(scsi_id
);
755 /* Complete any pending commands with busy (so they get
756 * retried) and remove them from our queue
758 sbp2scsi_complete_all_commands(scsi_id
, DID_BUS_BUSY
);
760 /* Accept new commands unless there was another bus reset in the
762 if (hpsb_node_entry_valid(scsi_id
->ne
)) {
763 atomic_set(&scsi_id
->state
, SBP2LU_STATE_RUNNING
);
764 scsi_unblock_requests(scsi_id
->scsi_host
);
769 /* This functions is called by the sbp2_probe, for each new device. We now
770 * allocate one scsi host for each scsi_id (unit directory). */
771 static struct scsi_id_instance_data
*sbp2_alloc_device(struct unit_directory
*ud
)
773 struct sbp2scsi_host_info
*hi
;
774 struct Scsi_Host
*scsi_host
= NULL
;
775 struct scsi_id_instance_data
*scsi_id
= NULL
;
777 scsi_id
= kzalloc(sizeof(*scsi_id
), GFP_KERNEL
);
779 SBP2_ERR("failed to create scsi_id");
783 scsi_id
->ne
= ud
->ne
;
785 scsi_id
->speed_code
= IEEE1394_SPEED_100
;
786 scsi_id
->max_payload_size
= sbp2_speedto_max_payload
[IEEE1394_SPEED_100
];
787 scsi_id
->status_fifo_addr
= CSR1212_INVALID_ADDR_SPACE
;
788 INIT_LIST_HEAD(&scsi_id
->sbp2_command_orb_inuse
);
789 INIT_LIST_HEAD(&scsi_id
->sbp2_command_orb_completed
);
790 INIT_LIST_HEAD(&scsi_id
->scsi_list
);
791 spin_lock_init(&scsi_id
->sbp2_command_orb_lock
);
792 atomic_set(&scsi_id
->state
, SBP2LU_STATE_RUNNING
);
793 INIT_WORK(&scsi_id
->protocol_work
, NULL
);
795 ud
->device
.driver_data
= scsi_id
;
797 hi
= hpsb_get_hostinfo(&sbp2_highlevel
, ud
->ne
->host
);
799 hi
= hpsb_create_hostinfo(&sbp2_highlevel
, ud
->ne
->host
, sizeof(*hi
));
801 SBP2_ERR("failed to allocate hostinfo");
804 hi
->host
= ud
->ne
->host
;
805 INIT_LIST_HEAD(&hi
->scsi_ids
);
807 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
808 /* Handle data movement if physical dma is not
809 * enabled or not supported on host controller */
810 if (!hpsb_register_addrspace(&sbp2_highlevel
, ud
->ne
->host
,
812 0x0ULL
, 0xfffffffcULL
)) {
813 SBP2_ERR("failed to register lower 4GB address range");
819 /* Prevent unloading of the 1394 host */
820 if (!try_module_get(hi
->host
->driver
->owner
)) {
821 SBP2_ERR("failed to get a reference on 1394 host driver");
827 list_add_tail(&scsi_id
->scsi_list
, &hi
->scsi_ids
);
829 /* Register the status FIFO address range. We could use the same FIFO
830 * for targets at different nodes. However we need different FIFOs per
831 * target in order to support multi-unit devices.
832 * The FIFO is located out of the local host controller's physical range
833 * but, if possible, within the posted write area. Status writes will
834 * then be performed as unified transactions. This slightly reduces
835 * bandwidth usage, and some Prolific based devices seem to require it.
837 scsi_id
->status_fifo_addr
= hpsb_allocate_and_register_addrspace(
838 &sbp2_highlevel
, ud
->ne
->host
, &sbp2_ops
,
839 sizeof(struct sbp2_status_block
), sizeof(quadlet_t
),
840 ud
->ne
->host
->low_addr_space
, CSR1212_ALL_SPACE_END
);
841 if (scsi_id
->status_fifo_addr
== CSR1212_INVALID_ADDR_SPACE
) {
842 SBP2_ERR("failed to allocate status FIFO address range");
846 /* Register our host with the SCSI stack. */
847 scsi_host
= scsi_host_alloc(&scsi_driver_template
,
848 sizeof(unsigned long));
850 SBP2_ERR("failed to register scsi host");
854 scsi_host
->hostdata
[0] = (unsigned long)scsi_id
;
856 if (!scsi_add_host(scsi_host
, &ud
->device
)) {
857 scsi_id
->scsi_host
= scsi_host
;
861 SBP2_ERR("failed to add scsi host");
862 scsi_host_put(scsi_host
);
865 sbp2_remove_device(scsi_id
);
869 static void sbp2_host_reset(struct hpsb_host
*host
)
871 struct sbp2scsi_host_info
*hi
;
872 struct scsi_id_instance_data
*scsi_id
;
874 hi
= hpsb_get_hostinfo(&sbp2_highlevel
, host
);
877 list_for_each_entry(scsi_id
, &hi
->scsi_ids
, scsi_list
)
878 if (likely(atomic_read(&scsi_id
->state
) !=
879 SBP2LU_STATE_IN_SHUTDOWN
)) {
880 atomic_set(&scsi_id
->state
, SBP2LU_STATE_IN_RESET
);
881 scsi_block_requests(scsi_id
->scsi_host
);
886 * This function is where we first pull the node unique ids, and then
887 * allocate memory and register a SBP-2 device.
889 static int sbp2_start_device(struct scsi_id_instance_data
*scsi_id
)
891 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
895 scsi_id
->login_response
=
896 pci_alloc_consistent(hi
->host
->pdev
,
897 sizeof(struct sbp2_login_response
),
898 &scsi_id
->login_response_dma
);
899 if (!scsi_id
->login_response
)
902 /* Query logins ORB DMA */
903 scsi_id
->query_logins_orb
=
904 pci_alloc_consistent(hi
->host
->pdev
,
905 sizeof(struct sbp2_query_logins_orb
),
906 &scsi_id
->query_logins_orb_dma
);
907 if (!scsi_id
->query_logins_orb
)
910 /* Query logins response DMA */
911 scsi_id
->query_logins_response
=
912 pci_alloc_consistent(hi
->host
->pdev
,
913 sizeof(struct sbp2_query_logins_response
),
914 &scsi_id
->query_logins_response_dma
);
915 if (!scsi_id
->query_logins_response
)
918 /* Reconnect ORB DMA */
919 scsi_id
->reconnect_orb
=
920 pci_alloc_consistent(hi
->host
->pdev
,
921 sizeof(struct sbp2_reconnect_orb
),
922 &scsi_id
->reconnect_orb_dma
);
923 if (!scsi_id
->reconnect_orb
)
927 scsi_id
->logout_orb
=
928 pci_alloc_consistent(hi
->host
->pdev
,
929 sizeof(struct sbp2_logout_orb
),
930 &scsi_id
->logout_orb_dma
);
931 if (!scsi_id
->logout_orb
)
936 pci_alloc_consistent(hi
->host
->pdev
,
937 sizeof(struct sbp2_login_orb
),
938 &scsi_id
->login_orb_dma
);
939 if (!scsi_id
->login_orb
)
943 * Create our command orb pool
945 if (sbp2util_create_command_orb_pool(scsi_id
)) {
946 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
947 sbp2_remove_device(scsi_id
);
951 /* Schedule a timeout here. The reason is that we may be so close
952 * to a bus reset, that the device is not available for logins.
953 * This can happen when the bus reset is caused by the host
954 * connected to the sbp2 device being removed. That host would
955 * have a certain amount of time to relogin before the sbp2 device
956 * allows someone else to login instead. One second makes sense. */
957 if (msleep_interruptible(1000)) {
958 sbp2_remove_device(scsi_id
);
963 * Login to the sbp-2 device
965 if (sbp2_login_device(scsi_id
)) {
966 /* Login failed, just remove the device. */
967 sbp2_remove_device(scsi_id
);
972 * Set max retries to something large on the device
974 sbp2_set_busy_timeout(scsi_id
);
977 * Do a SBP-2 fetch agent reset
979 sbp2_agent_reset(scsi_id
, 1);
982 * Get the max speed and packet size that we can use
984 sbp2_max_speed_and_size(scsi_id
);
986 /* Add this device to the scsi layer now */
987 error
= scsi_add_device(scsi_id
->scsi_host
, 0, scsi_id
->ud
->id
, 0);
989 SBP2_ERR("scsi_add_device failed");
990 sbp2_logout_device(scsi_id
);
991 sbp2_remove_device(scsi_id
);
998 SBP2_ERR("Could not allocate memory for scsi_id");
999 sbp2_remove_device(scsi_id
);
1004 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1006 static void sbp2_remove_device(struct scsi_id_instance_data
*scsi_id
)
1008 struct sbp2scsi_host_info
*hi
;
1015 /* This will remove our scsi device aswell */
1016 if (scsi_id
->scsi_host
) {
1017 scsi_remove_host(scsi_id
->scsi_host
);
1018 scsi_host_put(scsi_id
->scsi_host
);
1020 flush_scheduled_work();
1021 sbp2util_remove_command_orb_pool(scsi_id
);
1023 list_del(&scsi_id
->scsi_list
);
1025 if (scsi_id
->login_response
)
1026 pci_free_consistent(hi
->host
->pdev
,
1027 sizeof(struct sbp2_login_response
),
1028 scsi_id
->login_response
,
1029 scsi_id
->login_response_dma
);
1030 if (scsi_id
->login_orb
)
1031 pci_free_consistent(hi
->host
->pdev
,
1032 sizeof(struct sbp2_login_orb
),
1034 scsi_id
->login_orb_dma
);
1035 if (scsi_id
->reconnect_orb
)
1036 pci_free_consistent(hi
->host
->pdev
,
1037 sizeof(struct sbp2_reconnect_orb
),
1038 scsi_id
->reconnect_orb
,
1039 scsi_id
->reconnect_orb_dma
);
1040 if (scsi_id
->logout_orb
)
1041 pci_free_consistent(hi
->host
->pdev
,
1042 sizeof(struct sbp2_logout_orb
),
1043 scsi_id
->logout_orb
,
1044 scsi_id
->logout_orb_dma
);
1045 if (scsi_id
->query_logins_orb
)
1046 pci_free_consistent(hi
->host
->pdev
,
1047 sizeof(struct sbp2_query_logins_orb
),
1048 scsi_id
->query_logins_orb
,
1049 scsi_id
->query_logins_orb_dma
);
1050 if (scsi_id
->query_logins_response
)
1051 pci_free_consistent(hi
->host
->pdev
,
1052 sizeof(struct sbp2_query_logins_response
),
1053 scsi_id
->query_logins_response
,
1054 scsi_id
->query_logins_response_dma
);
1056 if (scsi_id
->status_fifo_addr
!= CSR1212_INVALID_ADDR_SPACE
)
1057 hpsb_unregister_addrspace(&sbp2_highlevel
, hi
->host
,
1058 scsi_id
->status_fifo_addr
);
1060 scsi_id
->ud
->device
.driver_data
= NULL
;
1063 module_put(hi
->host
->driver
->owner
);
1068 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1070 * This function deals with physical dma write requests (for adapters that do not support
1071 * physical dma in hardware). Mostly just here for debugging...
1073 static int sbp2_handle_physdma_write(struct hpsb_host
*host
, int nodeid
,
1074 int destid
, quadlet_t
*data
, u64 addr
,
1075 size_t length
, u16 flags
)
1079 * Manually put the data in the right place.
1081 memcpy(bus_to_virt((u32
) addr
), data
, length
);
1082 return RCODE_COMPLETE
;
1086 * This function deals with physical dma read requests (for adapters that do not support
1087 * physical dma in hardware). Mostly just here for debugging...
1089 static int sbp2_handle_physdma_read(struct hpsb_host
*host
, int nodeid
,
1090 quadlet_t
*data
, u64 addr
, size_t length
,
1095 * Grab data from memory and send a read response.
1097 memcpy(data
, bus_to_virt((u32
) addr
), length
);
1098 return RCODE_COMPLETE
;
1102 /**************************************
1103 * SBP-2 protocol related section
1104 **************************************/
1107 * This function queries the device for the maximum concurrent logins it
1110 static int sbp2_query_logins(struct scsi_id_instance_data
*scsi_id
)
1112 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1117 scsi_id
->query_logins_orb
->reserved1
= 0x0;
1118 scsi_id
->query_logins_orb
->reserved2
= 0x0;
1120 scsi_id
->query_logins_orb
->query_response_lo
= scsi_id
->query_logins_response_dma
;
1121 scsi_id
->query_logins_orb
->query_response_hi
= ORB_SET_NODE_ID(hi
->host
->node_id
);
1123 scsi_id
->query_logins_orb
->lun_misc
= ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST
);
1124 scsi_id
->query_logins_orb
->lun_misc
|= ORB_SET_NOTIFY(1);
1125 scsi_id
->query_logins_orb
->lun_misc
|= ORB_SET_LUN(scsi_id
->sbp2_lun
);
1127 scsi_id
->query_logins_orb
->reserved_resp_length
=
1128 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response
));
1130 scsi_id
->query_logins_orb
->status_fifo_hi
=
1131 ORB_SET_STATUS_FIFO_HI(scsi_id
->status_fifo_addr
, hi
->host
->node_id
);
1132 scsi_id
->query_logins_orb
->status_fifo_lo
=
1133 ORB_SET_STATUS_FIFO_LO(scsi_id
->status_fifo_addr
);
1135 sbp2util_cpu_to_be32_buffer(scsi_id
->query_logins_orb
, sizeof(struct sbp2_query_logins_orb
));
1137 memset(scsi_id
->query_logins_response
, 0, sizeof(struct sbp2_query_logins_response
));
1139 data
[0] = ORB_SET_NODE_ID(hi
->host
->node_id
);
1140 data
[1] = scsi_id
->query_logins_orb_dma
;
1141 sbp2util_cpu_to_be32_buffer(data
, 8);
1143 hpsb_node_write(scsi_id
->ne
, scsi_id
->sbp2_management_agent_addr
, data
, 8);
1145 if (sbp2util_access_timeout(scsi_id
, 2*HZ
)) {
1146 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1150 if (scsi_id
->status_block
.ORB_offset_lo
!= scsi_id
->query_logins_orb_dma
) {
1151 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1155 if (STATUS_TEST_RDS(scsi_id
->status_block
.ORB_offset_hi_misc
)) {
1156 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1160 sbp2util_cpu_to_be32_buffer(scsi_id
->query_logins_response
, sizeof(struct sbp2_query_logins_response
));
1162 max_logins
= RESPONSE_GET_MAX_LOGINS(scsi_id
->query_logins_response
->length_max_logins
);
1163 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins
);
1165 active_logins
= RESPONSE_GET_ACTIVE_LOGINS(scsi_id
->query_logins_response
->length_max_logins
);
1166 SBP2_INFO("Number of active logins: %d", active_logins
);
1168 if (active_logins
>= max_logins
) {
1176 * This function is called in order to login to a particular SBP-2 device,
1177 * after a bus reset.
1179 static int sbp2_login_device(struct scsi_id_instance_data
*scsi_id
)
1181 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1184 if (!scsi_id
->login_orb
)
1187 if (!exclusive_login
) {
1188 if (sbp2_query_logins(scsi_id
)) {
1189 SBP2_INFO("Device does not support any more concurrent logins");
1194 /* Set-up login ORB, assume no password */
1195 scsi_id
->login_orb
->password_hi
= 0;
1196 scsi_id
->login_orb
->password_lo
= 0;
1198 scsi_id
->login_orb
->login_response_lo
= scsi_id
->login_response_dma
;
1199 scsi_id
->login_orb
->login_response_hi
= ORB_SET_NODE_ID(hi
->host
->node_id
);
1201 scsi_id
->login_orb
->lun_misc
= ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST
);
1202 scsi_id
->login_orb
->lun_misc
|= ORB_SET_RECONNECT(0); /* One second reconnect time */
1203 scsi_id
->login_orb
->lun_misc
|= ORB_SET_EXCLUSIVE(exclusive_login
); /* Exclusive access to device */
1204 scsi_id
->login_orb
->lun_misc
|= ORB_SET_NOTIFY(1); /* Notify us of login complete */
1205 scsi_id
->login_orb
->lun_misc
|= ORB_SET_LUN(scsi_id
->sbp2_lun
);
1207 scsi_id
->login_orb
->passwd_resp_lengths
=
1208 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response
));
1210 scsi_id
->login_orb
->status_fifo_hi
=
1211 ORB_SET_STATUS_FIFO_HI(scsi_id
->status_fifo_addr
, hi
->host
->node_id
);
1212 scsi_id
->login_orb
->status_fifo_lo
=
1213 ORB_SET_STATUS_FIFO_LO(scsi_id
->status_fifo_addr
);
1215 sbp2util_cpu_to_be32_buffer(scsi_id
->login_orb
, sizeof(struct sbp2_login_orb
));
1217 memset(scsi_id
->login_response
, 0, sizeof(struct sbp2_login_response
));
1219 data
[0] = ORB_SET_NODE_ID(hi
->host
->node_id
);
1220 data
[1] = scsi_id
->login_orb_dma
;
1221 sbp2util_cpu_to_be32_buffer(data
, 8);
1223 hpsb_node_write(scsi_id
->ne
, scsi_id
->sbp2_management_agent_addr
, data
, 8);
1226 * Wait for login status (up to 20 seconds)...
1228 if (sbp2util_access_timeout(scsi_id
, 20*HZ
)) {
1229 SBP2_ERR("Error logging into SBP-2 device - timed out");
1234 * Sanity. Make sure status returned matches login orb.
1236 if (scsi_id
->status_block
.ORB_offset_lo
!= scsi_id
->login_orb_dma
) {
1237 SBP2_ERR("Error logging into SBP-2 device - timed out");
1241 if (STATUS_TEST_RDS(scsi_id
->status_block
.ORB_offset_hi_misc
)) {
1242 SBP2_ERR("Error logging into SBP-2 device - failed");
1247 * Byte swap the login response, for use when reconnecting or
1250 sbp2util_cpu_to_be32_buffer(scsi_id
->login_response
, sizeof(struct sbp2_login_response
));
1253 * Grab our command block agent address from the login response.
1255 scsi_id
->sbp2_command_block_agent_addr
=
1256 ((u64
)scsi_id
->login_response
->command_block_agent_hi
) << 32;
1257 scsi_id
->sbp2_command_block_agent_addr
|= ((u64
)scsi_id
->login_response
->command_block_agent_lo
);
1258 scsi_id
->sbp2_command_block_agent_addr
&= 0x0000ffffffffffffULL
;
1260 SBP2_INFO("Logged into SBP-2 device");
1265 * This function is called in order to logout from a particular SBP-2
1266 * device, usually called during driver unload.
1268 static int sbp2_logout_device(struct scsi_id_instance_data
*scsi_id
)
1270 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1277 scsi_id
->logout_orb
->reserved1
= 0x0;
1278 scsi_id
->logout_orb
->reserved2
= 0x0;
1279 scsi_id
->logout_orb
->reserved3
= 0x0;
1280 scsi_id
->logout_orb
->reserved4
= 0x0;
1282 scsi_id
->logout_orb
->login_ID_misc
= ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST
);
1283 scsi_id
->logout_orb
->login_ID_misc
|= ORB_SET_LOGIN_ID(scsi_id
->login_response
->length_login_ID
);
1285 /* Notify us when complete */
1286 scsi_id
->logout_orb
->login_ID_misc
|= ORB_SET_NOTIFY(1);
1288 scsi_id
->logout_orb
->reserved5
= 0x0;
1289 scsi_id
->logout_orb
->status_fifo_hi
=
1290 ORB_SET_STATUS_FIFO_HI(scsi_id
->status_fifo_addr
, hi
->host
->node_id
);
1291 scsi_id
->logout_orb
->status_fifo_lo
=
1292 ORB_SET_STATUS_FIFO_LO(scsi_id
->status_fifo_addr
);
1295 * Byte swap ORB if necessary
1297 sbp2util_cpu_to_be32_buffer(scsi_id
->logout_orb
, sizeof(struct sbp2_logout_orb
));
1300 * Ok, let's write to the target's management agent register
1302 data
[0] = ORB_SET_NODE_ID(hi
->host
->node_id
);
1303 data
[1] = scsi_id
->logout_orb_dma
;
1304 sbp2util_cpu_to_be32_buffer(data
, 8);
1306 error
= hpsb_node_write(scsi_id
->ne
,
1307 scsi_id
->sbp2_management_agent_addr
, data
, 8);
1311 /* Wait for device to logout...1 second. */
1312 if (sbp2util_access_timeout(scsi_id
, HZ
))
1315 SBP2_INFO("Logged out of SBP-2 device");
1320 * This function is called in order to reconnect to a particular SBP-2
1321 * device, after a bus reset.
1323 static int sbp2_reconnect_device(struct scsi_id_instance_data
*scsi_id
)
1325 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1330 * Set-up reconnect ORB
1332 scsi_id
->reconnect_orb
->reserved1
= 0x0;
1333 scsi_id
->reconnect_orb
->reserved2
= 0x0;
1334 scsi_id
->reconnect_orb
->reserved3
= 0x0;
1335 scsi_id
->reconnect_orb
->reserved4
= 0x0;
1337 scsi_id
->reconnect_orb
->login_ID_misc
= ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST
);
1338 scsi_id
->reconnect_orb
->login_ID_misc
|=
1339 ORB_SET_LOGIN_ID(scsi_id
->login_response
->length_login_ID
);
1341 /* Notify us when complete */
1342 scsi_id
->reconnect_orb
->login_ID_misc
|= ORB_SET_NOTIFY(1);
1344 scsi_id
->reconnect_orb
->reserved5
= 0x0;
1345 scsi_id
->reconnect_orb
->status_fifo_hi
=
1346 ORB_SET_STATUS_FIFO_HI(scsi_id
->status_fifo_addr
, hi
->host
->node_id
);
1347 scsi_id
->reconnect_orb
->status_fifo_lo
=
1348 ORB_SET_STATUS_FIFO_LO(scsi_id
->status_fifo_addr
);
1351 * Byte swap ORB if necessary
1353 sbp2util_cpu_to_be32_buffer(scsi_id
->reconnect_orb
, sizeof(struct sbp2_reconnect_orb
));
1355 data
[0] = ORB_SET_NODE_ID(hi
->host
->node_id
);
1356 data
[1] = scsi_id
->reconnect_orb_dma
;
1357 sbp2util_cpu_to_be32_buffer(data
, 8);
1359 error
= hpsb_node_write(scsi_id
->ne
,
1360 scsi_id
->sbp2_management_agent_addr
, data
, 8);
1365 * Wait for reconnect status (up to 1 second)...
1367 if (sbp2util_access_timeout(scsi_id
, HZ
)) {
1368 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1373 * Sanity. Make sure status returned matches reconnect orb.
1375 if (scsi_id
->status_block
.ORB_offset_lo
!= scsi_id
->reconnect_orb_dma
) {
1376 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1380 if (STATUS_TEST_RDS(scsi_id
->status_block
.ORB_offset_hi_misc
)) {
1381 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1385 SBP2_INFO("Reconnected to SBP-2 device");
1390 * This function is called in order to set the busy timeout (number of
1391 * retries to attempt) on the sbp2 device.
1393 static int sbp2_set_busy_timeout(struct scsi_id_instance_data
*scsi_id
)
1397 data
= cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE
);
1398 if (hpsb_node_write(scsi_id
->ne
, SBP2_BUSY_TIMEOUT_ADDRESS
, &data
, 4))
1399 SBP2_ERR("%s error", __FUNCTION__
);
1404 * This function is called to parse sbp2 device's config rom unit
1405 * directory. Used to determine things like sbp2 management agent offset,
1406 * and command set used (SCSI or RBC).
1408 static void sbp2_parse_unit_directory(struct scsi_id_instance_data
*scsi_id
,
1409 struct unit_directory
*ud
)
1411 struct csr1212_keyval
*kv
;
1412 struct csr1212_dentry
*dentry
;
1413 u64 management_agent_addr
;
1414 u32 command_set_spec_id
, command_set
, unit_characteristics
,
1416 unsigned workarounds
;
1419 management_agent_addr
= 0x0;
1420 command_set_spec_id
= 0x0;
1422 unit_characteristics
= 0x0;
1423 firmware_revision
= 0x0;
1425 /* Handle different fields in the unit directory, based on keys */
1426 csr1212_for_each_dir_entry(ud
->ne
->csr
, kv
, ud
->ud_kv
, dentry
) {
1427 switch (kv
->key
.id
) {
1428 case CSR1212_KV_ID_DEPENDENT_INFO
:
1429 if (kv
->key
.type
== CSR1212_KV_TYPE_CSR_OFFSET
)
1430 /* Save off the management agent address */
1431 management_agent_addr
=
1432 CSR1212_REGISTER_SPACE_BASE
+
1433 (kv
->value
.csr_offset
<< 2);
1435 else if (kv
->key
.type
== CSR1212_KV_TYPE_IMMEDIATE
)
1437 ORB_SET_LUN(kv
->value
.immediate
);
1440 case SBP2_COMMAND_SET_SPEC_ID_KEY
:
1441 /* Command spec organization */
1442 command_set_spec_id
= kv
->value
.immediate
;
1445 case SBP2_COMMAND_SET_KEY
:
1446 /* Command set used by sbp2 device */
1447 command_set
= kv
->value
.immediate
;
1450 case SBP2_UNIT_CHARACTERISTICS_KEY
:
1452 * Unit characterisitcs (orb related stuff
1453 * that I'm not yet paying attention to)
1455 unit_characteristics
= kv
->value
.immediate
;
1458 case SBP2_FIRMWARE_REVISION_KEY
:
1459 /* Firmware revision */
1460 firmware_revision
= kv
->value
.immediate
;
1468 workarounds
= sbp2_default_workarounds
;
1470 if (!(workarounds
& SBP2_WORKAROUND_OVERRIDE
))
1471 for (i
= 0; i
< ARRAY_SIZE(sbp2_workarounds_table
); i
++) {
1472 if (sbp2_workarounds_table
[i
].firmware_revision
&&
1473 sbp2_workarounds_table
[i
].firmware_revision
!=
1474 (firmware_revision
& 0xffff00))
1476 if (sbp2_workarounds_table
[i
].model_id
&&
1477 sbp2_workarounds_table
[i
].model_id
!= ud
->model_id
)
1479 workarounds
|= sbp2_workarounds_table
[i
].workarounds
;
1484 SBP2_INFO("Workarounds for node " NODE_BUS_FMT
": 0x%x "
1485 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1486 " model_id 0x%06x)",
1487 NODE_BUS_ARGS(ud
->ne
->host
, ud
->ne
->nodeid
),
1488 workarounds
, firmware_revision
,
1489 ud
->vendor_id
? ud
->vendor_id
: ud
->ne
->vendor_id
,
1492 /* We would need one SCSI host template for each target to adjust
1493 * max_sectors on the fly, therefore warn only. */
1494 if (workarounds
& SBP2_WORKAROUND_128K_MAX_TRANS
&&
1495 (max_sectors
* 512) > (128 * 1024))
1496 SBP2_INFO("Node " NODE_BUS_FMT
": Bridge only supports 128KB "
1497 "max transfer size. WARNING: Current max_sectors "
1498 "setting is larger than 128KB (%d sectors)",
1499 NODE_BUS_ARGS(ud
->ne
->host
, ud
->ne
->nodeid
),
1502 /* If this is a logical unit directory entry, process the parent
1503 * to get the values. */
1504 if (ud
->flags
& UNIT_DIRECTORY_LUN_DIRECTORY
) {
1505 struct unit_directory
*parent_ud
=
1506 container_of(ud
->device
.parent
, struct unit_directory
, device
);
1507 sbp2_parse_unit_directory(scsi_id
, parent_ud
);
1509 scsi_id
->sbp2_management_agent_addr
= management_agent_addr
;
1510 scsi_id
->sbp2_command_set_spec_id
= command_set_spec_id
;
1511 scsi_id
->sbp2_command_set
= command_set
;
1512 scsi_id
->sbp2_unit_characteristics
= unit_characteristics
;
1513 scsi_id
->sbp2_firmware_revision
= firmware_revision
;
1514 scsi_id
->workarounds
= workarounds
;
1515 if (ud
->flags
& UNIT_DIRECTORY_HAS_LUN
)
1516 scsi_id
->sbp2_lun
= ORB_SET_LUN(ud
->lun
);
1520 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1523 * This function is called in order to determine the max speed and packet
1524 * size we can use in our ORBs. Note, that we (the driver and host) only
1525 * initiate the transaction. The SBP-2 device actually transfers the data
1526 * (by reading from the DMA area we tell it). This means that the SBP-2
1527 * device decides the actual maximum data it can transfer. We just tell it
1528 * the speed that it needs to use, and the max_rec the host supports, and
1529 * it takes care of the rest.
1531 static int sbp2_max_speed_and_size(struct scsi_id_instance_data
*scsi_id
)
1533 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1536 scsi_id
->speed_code
=
1537 hi
->host
->speed
[NODEID_TO_NODE(scsi_id
->ne
->nodeid
)];
1539 /* Bump down our speed if the user requested it */
1540 if (scsi_id
->speed_code
> max_speed
) {
1541 scsi_id
->speed_code
= max_speed
;
1542 SBP2_INFO("Reducing speed to %s", hpsb_speedto_str
[max_speed
]);
1545 /* Payload size is the lesser of what our speed supports and what
1546 * our host supports. */
1547 payload
= min(sbp2_speedto_max_payload
[scsi_id
->speed_code
],
1548 (u8
) (hi
->host
->csr
.max_rec
- 1));
1550 /* If physical DMA is off, work around limitation in ohci1394:
1551 * packet size must not exceed PAGE_SIZE */
1552 if (scsi_id
->ne
->host
->low_addr_space
< (1ULL << 32))
1553 while (SBP2_PAYLOAD_TO_BYTES(payload
) + 24 > PAGE_SIZE
&&
1557 SBP2_INFO("Node " NODE_BUS_FMT
": Max speed [%s] - Max payload [%u]",
1558 NODE_BUS_ARGS(hi
->host
, scsi_id
->ne
->nodeid
),
1559 hpsb_speedto_str
[scsi_id
->speed_code
],
1560 SBP2_PAYLOAD_TO_BYTES(payload
));
1562 scsi_id
->max_payload_size
= payload
;
1567 * This function is called in order to perform a SBP-2 agent reset.
1569 static int sbp2_agent_reset(struct scsi_id_instance_data
*scsi_id
, int wait
)
1574 unsigned long flags
;
1576 /* cancel_delayed_work(&scsi_id->protocol_work); */
1578 flush_scheduled_work();
1580 data
= ntohl(SBP2_AGENT_RESET_DATA
);
1581 addr
= scsi_id
->sbp2_command_block_agent_addr
+ SBP2_AGENT_RESET_OFFSET
;
1584 retval
= hpsb_node_write(scsi_id
->ne
, addr
, &data
, 4);
1586 retval
= sbp2util_node_write_no_wait(scsi_id
->ne
, addr
, &data
, 4);
1589 SBP2_ERR("hpsb_node_write failed.\n");
1594 * Need to make sure orb pointer is written on next command
1596 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
1597 scsi_id
->last_orb
= NULL
;
1598 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
1603 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb
*orb
,
1604 struct sbp2scsi_host_info
*hi
,
1605 struct sbp2_command_info
*command
,
1606 unsigned int scsi_use_sg
,
1607 struct scatterlist
*sgpnt
,
1609 enum dma_data_direction dma_dir
)
1611 command
->dma_dir
= dma_dir
;
1612 orb
->data_descriptor_hi
= ORB_SET_NODE_ID(hi
->host
->node_id
);
1613 orb
->misc
|= ORB_SET_DIRECTION(orb_direction
);
1615 /* Special case if only one element (and less than 64KB in size) */
1616 if ((scsi_use_sg
== 1) &&
1617 (sgpnt
[0].length
<= SBP2_MAX_SG_ELEMENT_LENGTH
)) {
1619 command
->dma_size
= sgpnt
[0].length
;
1620 command
->dma_type
= CMD_DMA_PAGE
;
1621 command
->cmd_dma
= pci_map_page(hi
->host
->pdev
,
1627 orb
->data_descriptor_lo
= command
->cmd_dma
;
1628 orb
->misc
|= ORB_SET_DATA_SIZE(command
->dma_size
);
1631 struct sbp2_unrestricted_page_table
*sg_element
=
1632 &command
->scatter_gather_element
[0];
1633 u32 sg_count
, sg_len
;
1635 int i
, count
= pci_map_sg(hi
->host
->pdev
, sgpnt
, scsi_use_sg
,
1638 command
->dma_size
= scsi_use_sg
;
1639 command
->sge_buffer
= sgpnt
;
1641 /* use page tables (s/g) */
1642 orb
->misc
|= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1643 orb
->data_descriptor_lo
= command
->sge_dma
;
1646 * Loop through and fill out our sbp-2 page tables
1647 * (and split up anything too large)
1649 for (i
= 0, sg_count
= 0 ; i
< count
; i
++, sgpnt
++) {
1650 sg_len
= sg_dma_len(sgpnt
);
1651 sg_addr
= sg_dma_address(sgpnt
);
1653 sg_element
[sg_count
].segment_base_lo
= sg_addr
;
1654 if (sg_len
> SBP2_MAX_SG_ELEMENT_LENGTH
) {
1655 sg_element
[sg_count
].length_segment_base_hi
=
1656 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH
);
1657 sg_addr
+= SBP2_MAX_SG_ELEMENT_LENGTH
;
1658 sg_len
-= SBP2_MAX_SG_ELEMENT_LENGTH
;
1660 sg_element
[sg_count
].length_segment_base_hi
=
1661 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len
);
1668 /* Number of page table (s/g) elements */
1669 orb
->misc
|= ORB_SET_DATA_SIZE(sg_count
);
1671 /* Byte swap page tables if necessary */
1672 sbp2util_cpu_to_be32_buffer(sg_element
,
1673 (sizeof(struct sbp2_unrestricted_page_table
)) *
1678 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb
*orb
,
1679 struct sbp2scsi_host_info
*hi
,
1680 struct sbp2_command_info
*command
,
1681 struct scatterlist
*sgpnt
,
1683 unsigned int scsi_request_bufflen
,
1684 void *scsi_request_buffer
,
1685 enum dma_data_direction dma_dir
)
1687 command
->dma_dir
= dma_dir
;
1688 command
->dma_size
= scsi_request_bufflen
;
1689 command
->dma_type
= CMD_DMA_SINGLE
;
1690 command
->cmd_dma
= pci_map_single(hi
->host
->pdev
, scsi_request_buffer
,
1691 command
->dma_size
, command
->dma_dir
);
1692 orb
->data_descriptor_hi
= ORB_SET_NODE_ID(hi
->host
->node_id
);
1693 orb
->misc
|= ORB_SET_DIRECTION(orb_direction
);
1696 * Handle case where we get a command w/o s/g enabled (but
1697 * check for transfers larger than 64K)
1699 if (scsi_request_bufflen
<= SBP2_MAX_SG_ELEMENT_LENGTH
) {
1701 orb
->data_descriptor_lo
= command
->cmd_dma
;
1702 orb
->misc
|= ORB_SET_DATA_SIZE(scsi_request_bufflen
);
1705 struct sbp2_unrestricted_page_table
*sg_element
=
1706 &command
->scatter_gather_element
[0];
1707 u32 sg_count
, sg_len
;
1711 * Need to turn this into page tables, since the
1712 * buffer is too large.
1714 orb
->data_descriptor_lo
= command
->sge_dma
;
1716 /* Use page tables (s/g) */
1717 orb
->misc
|= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1720 * fill out our sbp-2 page tables (and split up
1724 sg_len
= scsi_request_bufflen
;
1725 sg_addr
= command
->cmd_dma
;
1727 sg_element
[sg_count
].segment_base_lo
= sg_addr
;
1728 if (sg_len
> SBP2_MAX_SG_ELEMENT_LENGTH
) {
1729 sg_element
[sg_count
].length_segment_base_hi
=
1730 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH
);
1731 sg_addr
+= SBP2_MAX_SG_ELEMENT_LENGTH
;
1732 sg_len
-= SBP2_MAX_SG_ELEMENT_LENGTH
;
1734 sg_element
[sg_count
].length_segment_base_hi
=
1735 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len
);
1741 /* Number of page table (s/g) elements */
1742 orb
->misc
|= ORB_SET_DATA_SIZE(sg_count
);
1744 /* Byte swap page tables if necessary */
1745 sbp2util_cpu_to_be32_buffer(sg_element
,
1746 (sizeof(struct sbp2_unrestricted_page_table
)) *
1752 * This function is called to create the actual command orb and s/g list
1753 * out of the scsi command itself.
1755 static void sbp2_create_command_orb(struct scsi_id_instance_data
*scsi_id
,
1756 struct sbp2_command_info
*command
,
1758 unsigned int scsi_use_sg
,
1759 unsigned int scsi_request_bufflen
,
1760 void *scsi_request_buffer
,
1761 enum dma_data_direction dma_dir
)
1763 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1764 struct scatterlist
*sgpnt
= (struct scatterlist
*)scsi_request_buffer
;
1765 struct sbp2_command_orb
*command_orb
= &command
->command_orb
;
1769 * Set-up our command ORB..
1771 * NOTE: We're doing unrestricted page tables (s/g), as this is
1772 * best performance (at least with the devices I have). This means
1773 * that data_size becomes the number of s/g elements, and
1774 * page_size should be zero (for unrestricted).
1776 command_orb
->next_ORB_hi
= ORB_SET_NULL_PTR(1);
1777 command_orb
->next_ORB_lo
= 0x0;
1778 command_orb
->misc
= ORB_SET_MAX_PAYLOAD(scsi_id
->max_payload_size
);
1779 command_orb
->misc
|= ORB_SET_SPEED(scsi_id
->speed_code
);
1780 command_orb
->misc
|= ORB_SET_NOTIFY(1); /* Notify us when complete */
1782 if (dma_dir
== DMA_NONE
)
1783 orb_direction
= ORB_DIRECTION_NO_DATA_TRANSFER
;
1784 else if (dma_dir
== DMA_TO_DEVICE
&& scsi_request_bufflen
)
1785 orb_direction
= ORB_DIRECTION_WRITE_TO_MEDIA
;
1786 else if (dma_dir
== DMA_FROM_DEVICE
&& scsi_request_bufflen
)
1787 orb_direction
= ORB_DIRECTION_READ_FROM_MEDIA
;
1789 SBP2_INFO("Falling back to DMA_NONE");
1790 orb_direction
= ORB_DIRECTION_NO_DATA_TRANSFER
;
1793 /* Set-up our pagetable stuff */
1794 if (orb_direction
== ORB_DIRECTION_NO_DATA_TRANSFER
) {
1795 command_orb
->data_descriptor_hi
= 0x0;
1796 command_orb
->data_descriptor_lo
= 0x0;
1797 command_orb
->misc
|= ORB_SET_DIRECTION(1);
1798 } else if (scsi_use_sg
)
1799 sbp2_prep_command_orb_sg(command_orb
, hi
, command
, scsi_use_sg
,
1800 sgpnt
, orb_direction
, dma_dir
);
1802 sbp2_prep_command_orb_no_sg(command_orb
, hi
, command
, sgpnt
,
1803 orb_direction
, scsi_request_bufflen
,
1804 scsi_request_buffer
, dma_dir
);
1806 /* Byte swap command ORB if necessary */
1807 sbp2util_cpu_to_be32_buffer(command_orb
, sizeof(struct sbp2_command_orb
));
1809 /* Put our scsi command in the command ORB */
1810 memset(command_orb
->cdb
, 0, 12);
1811 memcpy(command_orb
->cdb
, scsi_cmd
, COMMAND_SIZE(*scsi_cmd
));
1815 * This function is called in order to begin a regular SBP-2 command.
1817 static void sbp2_link_orb_command(struct scsi_id_instance_data
*scsi_id
,
1818 struct sbp2_command_info
*command
)
1820 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
1821 struct sbp2_command_orb
*command_orb
= &command
->command_orb
;
1822 struct sbp2_command_orb
*last_orb
;
1823 dma_addr_t last_orb_dma
;
1824 u64 addr
= scsi_id
->sbp2_command_block_agent_addr
;
1827 unsigned long flags
;
1829 pci_dma_sync_single_for_device(hi
->host
->pdev
, command
->command_orb_dma
,
1830 sizeof(struct sbp2_command_orb
),
1832 pci_dma_sync_single_for_device(hi
->host
->pdev
, command
->sge_dma
,
1833 sizeof(command
->scatter_gather_element
),
1834 PCI_DMA_BIDIRECTIONAL
);
1836 * Check to see if there are any previous orbs to use
1838 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
1839 last_orb
= scsi_id
->last_orb
;
1840 last_orb_dma
= scsi_id
->last_orb_dma
;
1843 * last_orb == NULL means: We know that the target's fetch agent
1844 * is not active right now.
1846 addr
+= SBP2_ORB_POINTER_OFFSET
;
1847 data
[0] = ORB_SET_NODE_ID(hi
->host
->node_id
);
1848 data
[1] = command
->command_orb_dma
;
1849 sbp2util_cpu_to_be32_buffer(data
, 8);
1853 * last_orb != NULL means: We know that the target's fetch agent
1854 * is (very probably) not dead or in reset state right now.
1855 * We have an ORB already sent that we can append a new one to.
1856 * The target's fetch agent may or may not have read this
1859 pci_dma_sync_single_for_cpu(hi
->host
->pdev
, last_orb_dma
,
1860 sizeof(struct sbp2_command_orb
),
1862 last_orb
->next_ORB_lo
= cpu_to_be32(command
->command_orb_dma
);
1864 /* Tells hardware that this pointer is valid */
1865 last_orb
->next_ORB_hi
= 0;
1866 pci_dma_sync_single_for_device(hi
->host
->pdev
, last_orb_dma
,
1867 sizeof(struct sbp2_command_orb
),
1869 addr
+= SBP2_DOORBELL_OFFSET
;
1873 scsi_id
->last_orb
= command_orb
;
1874 scsi_id
->last_orb_dma
= command
->command_orb_dma
;
1875 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
1877 if (sbp2util_node_write_no_wait(scsi_id
->ne
, addr
, data
, length
)) {
1879 * sbp2util_node_write_no_wait failed. We certainly ran out
1880 * of transaction labels, perhaps just because there were no
1881 * context switches which gave khpsbpkt a chance to collect
1882 * free tlabels. Try again in non-atomic context. If necessary,
1883 * the workqueue job will sleep to guaranteedly get a tlabel.
1884 * We do not accept new commands until the job is over.
1886 scsi_block_requests(scsi_id
->scsi_host
);
1887 PREPARE_WORK(&scsi_id
->protocol_work
,
1888 last_orb
? sbp2util_write_doorbell
:
1889 sbp2util_write_orb_pointer
1891 schedule_work(&scsi_id
->protocol_work
);
1896 * This function is called in order to begin a regular SBP-2 command.
1898 static int sbp2_send_command(struct scsi_id_instance_data
*scsi_id
,
1899 struct scsi_cmnd
*SCpnt
,
1900 void (*done
)(struct scsi_cmnd
*))
1902 unchar
*cmd
= (unchar
*) SCpnt
->cmnd
;
1903 unsigned int request_bufflen
= SCpnt
->request_bufflen
;
1904 struct sbp2_command_info
*command
;
1907 * Allocate a command orb and s/g structure
1909 command
= sbp2util_allocate_command_orb(scsi_id
, SCpnt
, done
);
1914 * Now actually fill in the comamnd orb and sbp2 s/g list
1916 sbp2_create_command_orb(scsi_id
, command
, cmd
, SCpnt
->use_sg
,
1917 request_bufflen
, SCpnt
->request_buffer
,
1918 SCpnt
->sc_data_direction
);
1921 * Link up the orb, and ring the doorbell if needed
1923 sbp2_link_orb_command(scsi_id
, command
);
1929 * Translates SBP-2 status into SCSI sense data for check conditions
1931 static unsigned int sbp2_status_to_sense_data(unchar
*sbp2_status
, unchar
*sense_data
)
1934 * Ok, it's pretty ugly... ;-)
1936 sense_data
[0] = 0x70;
1937 sense_data
[1] = 0x0;
1938 sense_data
[2] = sbp2_status
[9];
1939 sense_data
[3] = sbp2_status
[12];
1940 sense_data
[4] = sbp2_status
[13];
1941 sense_data
[5] = sbp2_status
[14];
1942 sense_data
[6] = sbp2_status
[15];
1944 sense_data
[8] = sbp2_status
[16];
1945 sense_data
[9] = sbp2_status
[17];
1946 sense_data
[10] = sbp2_status
[18];
1947 sense_data
[11] = sbp2_status
[19];
1948 sense_data
[12] = sbp2_status
[10];
1949 sense_data
[13] = sbp2_status
[11];
1950 sense_data
[14] = sbp2_status
[20];
1951 sense_data
[15] = sbp2_status
[21];
1953 return sbp2_status
[8] & 0x3f; /* return scsi status */
1957 * This function deals with status writes from the SBP-2 device
1959 static int sbp2_handle_status_write(struct hpsb_host
*host
, int nodeid
,
1960 int destid
, quadlet_t
*data
, u64 addr
,
1961 size_t length
, u16 fl
)
1963 struct sbp2scsi_host_info
*hi
;
1964 struct scsi_id_instance_data
*scsi_id
= NULL
, *scsi_id_tmp
;
1965 struct scsi_cmnd
*SCpnt
= NULL
;
1966 struct sbp2_status_block
*sb
;
1967 u32 scsi_status
= SBP2_SCSI_STATUS_GOOD
;
1968 struct sbp2_command_info
*command
;
1969 unsigned long flags
;
1971 if (unlikely(length
< 8 || length
> sizeof(struct sbp2_status_block
))) {
1972 SBP2_ERR("Wrong size of status block");
1973 return RCODE_ADDRESS_ERROR
;
1975 if (unlikely(!host
)) {
1976 SBP2_ERR("host is NULL - this is bad!");
1977 return RCODE_ADDRESS_ERROR
;
1979 hi
= hpsb_get_hostinfo(&sbp2_highlevel
, host
);
1980 if (unlikely(!hi
)) {
1981 SBP2_ERR("host info is NULL - this is bad!");
1982 return RCODE_ADDRESS_ERROR
;
1985 * Find our scsi_id structure by looking at the status fifo address
1986 * written to by the sbp2 device.
1988 list_for_each_entry(scsi_id_tmp
, &hi
->scsi_ids
, scsi_list
) {
1989 if (scsi_id_tmp
->ne
->nodeid
== nodeid
&&
1990 scsi_id_tmp
->status_fifo_addr
== addr
) {
1991 scsi_id
= scsi_id_tmp
;
1995 if (unlikely(!scsi_id
)) {
1996 SBP2_ERR("scsi_id is NULL - device is gone?");
1997 return RCODE_ADDRESS_ERROR
;
2001 * Put response into scsi_id status fifo buffer. The first two bytes
2002 * come in big endian bit order. Often the target writes only a
2003 * truncated status block, minimally the first two quadlets. The rest
2004 * is implied to be zeros.
2006 sb
= &scsi_id
->status_block
;
2007 memset(sb
->command_set_dependent
, 0, sizeof(sb
->command_set_dependent
));
2008 memcpy(sb
, data
, length
);
2009 sbp2util_be32_to_cpu_buffer(sb
, 8);
2012 * Ignore unsolicited status. Handle command ORB status.
2014 if (unlikely(STATUS_GET_SRC(sb
->ORB_offset_hi_misc
) == 2))
2017 command
= sbp2util_find_command_for_orb(scsi_id
,
2020 pci_dma_sync_single_for_cpu(hi
->host
->pdev
, command
->command_orb_dma
,
2021 sizeof(struct sbp2_command_orb
),
2023 pci_dma_sync_single_for_cpu(hi
->host
->pdev
, command
->sge_dma
,
2024 sizeof(command
->scatter_gather_element
),
2025 PCI_DMA_BIDIRECTIONAL
);
2027 * Matched status with command, now grab scsi command pointers
2031 * FIXME: If the src field in the status is 1, the ORB DMA must
2032 * not be reused until status for a subsequent ORB is received.
2034 SCpnt
= command
->Current_SCpnt
;
2035 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
2036 sbp2util_mark_command_completed(scsi_id
, command
);
2037 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
2040 u32 h
= sb
->ORB_offset_hi_misc
;
2041 u32 r
= STATUS_GET_RESP(h
);
2043 if (r
!= RESP_STATUS_REQUEST_COMPLETE
) {
2044 SBP2_INFO("resp 0x%x, sbp_status 0x%x",
2045 r
, STATUS_GET_SBP_STATUS(h
));
2047 r
== RESP_STATUS_TRANSPORT_FAILURE
?
2048 SBP2_SCSI_STATUS_BUSY
:
2049 SBP2_SCSI_STATUS_COMMAND_TERMINATED
;
2052 * See if the target stored any scsi status information.
2054 if (STATUS_GET_LEN(h
) > 1)
2055 scsi_status
= sbp2_status_to_sense_data(
2056 (unchar
*)sb
, SCpnt
->sense_buffer
);
2058 * Check to see if the dead bit is set. If so, we'll
2059 * have to initiate a fetch agent reset.
2061 if (STATUS_TEST_DEAD(h
))
2062 sbp2_agent_reset(scsi_id
, 0);
2066 * Check here to see if there are no commands in-use. If there
2067 * are none, we know that the fetch agent left the active state
2068 * _and_ that we did not reactivate it yet. Therefore clear
2069 * last_orb so that next time we write directly to the
2070 * ORB_POINTER register. That way the fetch agent does not need
2071 * to refetch the next_ORB.
2073 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
2074 if (list_empty(&scsi_id
->sbp2_command_orb_inuse
))
2075 scsi_id
->last_orb
= NULL
;
2076 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
2080 * It's probably a login/logout/reconnect status.
2082 if ((sb
->ORB_offset_lo
== scsi_id
->reconnect_orb_dma
) ||
2083 (sb
->ORB_offset_lo
== scsi_id
->login_orb_dma
) ||
2084 (sb
->ORB_offset_lo
== scsi_id
->query_logins_orb_dma
) ||
2085 (sb
->ORB_offset_lo
== scsi_id
->logout_orb_dma
)) {
2086 scsi_id
->access_complete
= 1;
2087 wake_up_interruptible(&access_wq
);
2092 sbp2scsi_complete_command(scsi_id
, scsi_status
, SCpnt
,
2093 command
->Current_done
);
2094 return RCODE_COMPLETE
;
2097 /**************************************
2098 * SCSI interface related section
2099 **************************************/
2102 * This routine is the main request entry routine for doing I/O. It is
2103 * called from the scsi stack directly.
2105 static int sbp2scsi_queuecommand(struct scsi_cmnd
*SCpnt
,
2106 void (*done
)(struct scsi_cmnd
*))
2108 struct scsi_id_instance_data
*scsi_id
=
2109 (struct scsi_id_instance_data
*)SCpnt
->device
->host
->hostdata
[0];
2110 struct sbp2scsi_host_info
*hi
;
2111 int result
= DID_NO_CONNECT
<< 16;
2113 if (!sbp2util_node_is_available(scsi_id
))
2119 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2124 * Until we handle multiple luns, just return selection time-out
2125 * to any IO directed at non-zero LUNs
2127 if (SCpnt
->device
->lun
)
2131 * Check for request sense command, and handle it here
2132 * (autorequest sense)
2134 if (SCpnt
->cmnd
[0] == REQUEST_SENSE
) {
2135 memcpy(SCpnt
->request_buffer
, SCpnt
->sense_buffer
, SCpnt
->request_bufflen
);
2136 memset(SCpnt
->sense_buffer
, 0, sizeof(SCpnt
->sense_buffer
));
2137 sbp2scsi_complete_command(scsi_id
, SBP2_SCSI_STATUS_GOOD
, SCpnt
, done
);
2142 * Check to see if we are in the middle of a bus reset.
2144 if (!hpsb_node_entry_valid(scsi_id
->ne
)) {
2145 SBP2_ERR("Bus reset in progress - rejecting command");
2146 result
= DID_BUS_BUSY
<< 16;
2151 * Bidirectional commands are not yet implemented,
2152 * and unknown transfer direction not handled.
2154 if (SCpnt
->sc_data_direction
== DMA_BIDIRECTIONAL
) {
2155 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2156 result
= DID_ERROR
<< 16;
2161 * Try and send our SCSI command
2163 if (sbp2_send_command(scsi_id
, SCpnt
, done
)) {
2164 SBP2_ERR("Error sending SCSI command");
2165 sbp2scsi_complete_command(scsi_id
, SBP2_SCSI_STATUS_SELECTION_TIMEOUT
,
2171 SCpnt
->result
= result
;
2177 * This function is called in order to complete all outstanding SBP-2
2178 * commands (in case of resets, etc.).
2180 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data
*scsi_id
,
2183 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
2184 struct list_head
*lh
;
2185 struct sbp2_command_info
*command
;
2186 unsigned long flags
;
2188 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
2189 while (!list_empty(&scsi_id
->sbp2_command_orb_inuse
)) {
2190 lh
= scsi_id
->sbp2_command_orb_inuse
.next
;
2191 command
= list_entry(lh
, struct sbp2_command_info
, list
);
2192 pci_dma_sync_single_for_cpu(hi
->host
->pdev
, command
->command_orb_dma
,
2193 sizeof(struct sbp2_command_orb
),
2195 pci_dma_sync_single_for_cpu(hi
->host
->pdev
, command
->sge_dma
,
2196 sizeof(command
->scatter_gather_element
),
2197 PCI_DMA_BIDIRECTIONAL
);
2198 sbp2util_mark_command_completed(scsi_id
, command
);
2199 if (command
->Current_SCpnt
) {
2200 command
->Current_SCpnt
->result
= status
<< 16;
2201 command
->Current_done(command
->Current_SCpnt
);
2204 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
2210 * This function is called in order to complete a regular SBP-2 command.
2212 * This can be called in interrupt context.
2214 static void sbp2scsi_complete_command(struct scsi_id_instance_data
*scsi_id
,
2215 u32 scsi_status
, struct scsi_cmnd
*SCpnt
,
2216 void (*done
)(struct scsi_cmnd
*))
2222 SBP2_ERR("SCpnt is NULL");
2227 * Switch on scsi status
2229 switch (scsi_status
) {
2230 case SBP2_SCSI_STATUS_GOOD
:
2231 SCpnt
->result
= DID_OK
<< 16;
2234 case SBP2_SCSI_STATUS_BUSY
:
2235 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2236 SCpnt
->result
= DID_BUS_BUSY
<< 16;
2239 case SBP2_SCSI_STATUS_CHECK_CONDITION
:
2240 SCpnt
->result
= CHECK_CONDITION
<< 1 | DID_OK
<< 16;
2243 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT
:
2244 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2245 SCpnt
->result
= DID_NO_CONNECT
<< 16;
2246 scsi_print_command(SCpnt
);
2249 case SBP2_SCSI_STATUS_CONDITION_MET
:
2250 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT
:
2251 case SBP2_SCSI_STATUS_COMMAND_TERMINATED
:
2252 SBP2_ERR("Bad SCSI status = %x", scsi_status
);
2253 SCpnt
->result
= DID_ERROR
<< 16;
2254 scsi_print_command(SCpnt
);
2258 SBP2_ERR("Unsupported SCSI status = %x", scsi_status
);
2259 SCpnt
->result
= DID_ERROR
<< 16;
2263 * If a bus reset is in progress and there was an error, complete
2264 * the command as busy so that it will get retried.
2266 if (!hpsb_node_entry_valid(scsi_id
->ne
)
2267 && (scsi_status
!= SBP2_SCSI_STATUS_GOOD
)) {
2268 SBP2_ERR("Completing command with busy (bus reset)");
2269 SCpnt
->result
= DID_BUS_BUSY
<< 16;
2273 * Tell scsi stack that we're done with this command
2278 static int sbp2scsi_slave_alloc(struct scsi_device
*sdev
)
2280 struct scsi_id_instance_data
*scsi_id
=
2281 (struct scsi_id_instance_data
*)sdev
->host
->hostdata
[0];
2283 scsi_id
->sdev
= sdev
;
2284 sdev
->allow_restart
= 1;
2286 if (scsi_id
->workarounds
& SBP2_WORKAROUND_INQUIRY_36
)
2287 sdev
->inquiry_len
= 36;
2291 static int sbp2scsi_slave_configure(struct scsi_device
*sdev
)
2293 struct scsi_id_instance_data
*scsi_id
=
2294 (struct scsi_id_instance_data
*)sdev
->host
->hostdata
[0];
2296 blk_queue_dma_alignment(sdev
->request_queue
, (512 - 1));
2297 sdev
->use_10_for_rw
= 1;
2299 if (sdev
->type
== TYPE_DISK
&&
2300 scsi_id
->workarounds
& SBP2_WORKAROUND_MODE_SENSE_8
)
2301 sdev
->skip_ms_page_8
= 1;
2302 if (scsi_id
->workarounds
& SBP2_WORKAROUND_FIX_CAPACITY
)
2303 sdev
->fix_capacity
= 1;
2307 static void sbp2scsi_slave_destroy(struct scsi_device
*sdev
)
2309 ((struct scsi_id_instance_data
*)sdev
->host
->hostdata
[0])->sdev
= NULL
;
2314 * Called by scsi stack when something has really gone wrong. Usually
2315 * called when a command has timed-out for some reason.
2317 static int sbp2scsi_abort(struct scsi_cmnd
*SCpnt
)
2319 struct scsi_id_instance_data
*scsi_id
=
2320 (struct scsi_id_instance_data
*)SCpnt
->device
->host
->hostdata
[0];
2321 struct sbp2scsi_host_info
*hi
= scsi_id
->hi
;
2322 struct sbp2_command_info
*command
;
2323 unsigned long flags
;
2325 SBP2_INFO("aborting sbp2 command");
2326 scsi_print_command(SCpnt
);
2328 if (sbp2util_node_is_available(scsi_id
)) {
2329 sbp2_agent_reset(scsi_id
, 1);
2331 /* Return a matching command structure to the free pool. */
2332 spin_lock_irqsave(&scsi_id
->sbp2_command_orb_lock
, flags
);
2333 command
= sbp2util_find_command_for_SCpnt(scsi_id
, SCpnt
);
2335 pci_dma_sync_single_for_cpu(hi
->host
->pdev
,
2336 command
->command_orb_dma
,
2337 sizeof(struct sbp2_command_orb
),
2339 pci_dma_sync_single_for_cpu(hi
->host
->pdev
,
2341 sizeof(command
->scatter_gather_element
),
2342 PCI_DMA_BIDIRECTIONAL
);
2343 sbp2util_mark_command_completed(scsi_id
, command
);
2344 if (command
->Current_SCpnt
) {
2345 command
->Current_SCpnt
->result
= DID_ABORT
<< 16;
2346 command
->Current_done(command
->Current_SCpnt
);
2349 spin_unlock_irqrestore(&scsi_id
->sbp2_command_orb_lock
, flags
);
2351 sbp2scsi_complete_all_commands(scsi_id
, DID_BUS_BUSY
);
2358 * Called by scsi stack when something has really gone wrong.
2360 static int sbp2scsi_reset(struct scsi_cmnd
*SCpnt
)
2362 struct scsi_id_instance_data
*scsi_id
=
2363 (struct scsi_id_instance_data
*)SCpnt
->device
->host
->hostdata
[0];
2365 SBP2_INFO("reset requested");
2367 if (sbp2util_node_is_available(scsi_id
)) {
2368 SBP2_INFO("generating sbp2 fetch agent reset");
2369 sbp2_agent_reset(scsi_id
, 1);
2375 static ssize_t
sbp2_sysfs_ieee1394_id_show(struct device
*dev
,
2376 struct device_attribute
*attr
,
2379 struct scsi_device
*sdev
;
2380 struct scsi_id_instance_data
*scsi_id
;
2383 if (!(sdev
= to_scsi_device(dev
)))
2386 if (!(scsi_id
= (struct scsi_id_instance_data
*)sdev
->host
->hostdata
[0]))
2389 lun
= ORB_SET_LUN(scsi_id
->sbp2_lun
);
2391 return sprintf(buf
, "%016Lx:%d:%d\n", (unsigned long long)scsi_id
->ne
->guid
,
2392 scsi_id
->ud
->id
, lun
);
2395 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2396 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2397 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME
);
2398 MODULE_LICENSE("GPL");
2400 static int sbp2_module_init(void)
2404 /* Module load debug option to force one command at a time (serializing I/O) */
2406 scsi_driver_template
.can_queue
= 1;
2407 scsi_driver_template
.cmd_per_lun
= 1;
2410 if (sbp2_default_workarounds
& SBP2_WORKAROUND_128K_MAX_TRANS
&&
2411 (max_sectors
* 512) > (128 * 1024))
2412 max_sectors
= 128 * 1024 / 512;
2413 scsi_driver_template
.max_sectors
= max_sectors
;
2415 /* Register our high level driver with 1394 stack */
2416 hpsb_register_highlevel(&sbp2_highlevel
);
2418 ret
= hpsb_register_protocol(&sbp2_driver
);
2420 SBP2_ERR("Failed to register protocol");
2421 hpsb_unregister_highlevel(&sbp2_highlevel
);
2428 static void __exit
sbp2_module_exit(void)
2430 hpsb_unregister_protocol(&sbp2_driver
);
2431 hpsb_unregister_highlevel(&sbp2_highlevel
);
2434 module_init(sbp2_module_init
);
2435 module_exit(sbp2_module_exit
);