ieee1394: sbp2: convert sbp2util_down_timeout to waitqueue
[safe/jmp/linux-2.6] / drivers / ieee1394 / sbp2.c
1 /*
2  * sbp2.c - SBP-2 protocol driver for IEEE-1394
3  *
4  * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5  * jamesg@filanet.com (JSG)
6  *
7  * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
8  *
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.
13  *
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.
18  *
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.
22  */
23
24 /*
25  * Brief Description:
26  *
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.
31  *
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.).
34  *
35  * Current Issues:
36  *
37  *      - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38  *        but the code needs additional debugging.
39  */
40
41 #include <linux/kernel.h>
42 #include <linux/list.h>
43 #include <linux/string.h>
44 #include <linux/stringify.h>
45 #include <linux/slab.h>
46 #include <linux/interrupt.h>
47 #include <linux/fs.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>
58 #include <linux/wait.h>
59
60 #include <asm/current.h>
61 #include <asm/uaccess.h>
62 #include <asm/io.h>
63 #include <asm/byteorder.h>
64 #include <asm/system.h>
65 #include <asm/scatterlist.h>
66
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>
72
73 #include "csr1212.h"
74 #include "ieee1394.h"
75 #include "ieee1394_types.h"
76 #include "ieee1394_core.h"
77 #include "nodemgr.h"
78 #include "hosts.h"
79 #include "highlevel.h"
80 #include "ieee1394_transactions.h"
81 #include "sbp2.h"
82
83 /*
84  * Module load parameter definitions
85  */
86
87 /*
88  * Change max_speed on module load if you have a bad IEEE-1394
89  * controller that has trouble running 2KB packets at 400mb.
90  *
91  * NOTE: On certain OHCI parts I have seen short packets on async transmit
92  * (probably due to PCI latency/throughput issues with the part). You can
93  * bump down the speed if you are running into problems.
94  */
95 static int max_speed = IEEE1394_SPEED_MAX;
96 module_param(max_speed, int, 0644);
97 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
98
99 /*
100  * Set serialize_io to 1 if you'd like only one scsi command sent
101  * down to us at a time (debugging). This might be necessary for very
102  * badly behaved sbp2 devices.
103  *
104  * TODO: Make this configurable per device.
105  */
106 static int serialize_io = 1;
107 module_param(serialize_io, int, 0444);
108 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
109
110 /*
111  * Bump up max_sectors if you'd like to support very large sized
112  * transfers. Please note that some older sbp2 bridge chips are broken for
113  * transfers greater or equal to 128KB.  Default is a value of 255
114  * sectors, or just under 128KB (at 512 byte sector size). I can note that
115  * the Oxsemi sbp2 chipsets have no problems supporting very large
116  * transfer sizes.
117  */
118 static int max_sectors = SBP2_MAX_SECTORS;
119 module_param(max_sectors, int, 0444);
120 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
121                  __stringify(SBP2_MAX_SECTORS) ")");
122
123 /*
124  * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
125  * do an exclusive login, as it's generally unsafe to have two hosts
126  * talking to a single sbp2 device at the same time (filesystem coherency,
127  * etc.). If you're running an sbp2 device that supports multiple logins,
128  * and you're either running read-only filesystems or some sort of special
129  * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
130  * File System, or Lustre, then set exclusive_login to zero.
131  *
132  * So far only bridges from Oxford Semiconductor are known to support
133  * concurrent logins. Depending on firmware, four or two concurrent logins
134  * are possible on OXFW911 and newer Oxsemi bridges.
135  */
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)");
139
140 /*
141  * If any of the following workarounds is required for your device to work,
142  * please submit the kernel messages logged by sbp2 to the linux1394-devel
143  * mailing list.
144  *
145  * - 128kB max transfer
146  *   Limit transfer size. Necessary for some old bridges.
147  *
148  * - 36 byte inquiry
149  *   When scsi_mod probes the device, let the inquiry command look like that
150  *   from MS Windows.
151  *
152  * - skip mode page 8
153  *   Suppress sending of mode_sense for mode page 8 if the device pretends to
154  *   support the SCSI Primary Block commands instead of Reduced Block Commands.
155  *
156  * - fix capacity
157  *   Tell sd_mod to correct the last sector number reported by read_capacity.
158  *   Avoids access beyond actual disk limits on devices with an off-by-one bug.
159  *   Don't use this with devices which don't have this bug.
160  *
161  * - override internal blacklist
162  *   Instead of adding to the built-in blacklist, use only the workarounds
163  *   specified in the module load parameter.
164  *   Useful if a blacklist entry interfered with a non-broken device.
165  */
166 static int sbp2_default_workarounds;
167 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
168 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
169         ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
170         ", 36 byte inquiry = "    __stringify(SBP2_WORKAROUND_INQUIRY_36)
171         ", skip mode page 8 = "   __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
172         ", fix capacity = "       __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
173         ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
174         ", or a combination)");
175
176 /* legacy parameter */
177 static int force_inquiry_hack;
178 module_param(force_inquiry_hack, int, 0644);
179 MODULE_PARM_DESC(force_inquiry_hack, "Deprecated, use 'workarounds'");
180
181 /*
182  * Export information about protocols/devices supported by this driver.
183  */
184 static struct ieee1394_device_id sbp2_id_table[] = {
185         {
186          .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
187          .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
188          .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
189         {}
190 };
191
192 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
193
194 /*
195  * Debug levels, configured via kernel config, or enable here.
196  */
197
198 #define CONFIG_IEEE1394_SBP2_DEBUG 0
199 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
200 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
201 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
202 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
203 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
204
205 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
206 #define SBP2_ORB_DEBUG(fmt, args...)    HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
207 static u32 global_outstanding_command_orbs = 0;
208 #define outstanding_orb_incr global_outstanding_command_orbs++
209 #define outstanding_orb_decr global_outstanding_command_orbs--
210 #else
211 #define SBP2_ORB_DEBUG(fmt, args...)
212 #define outstanding_orb_incr
213 #define outstanding_orb_decr
214 #endif
215
216 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
217 #define SBP2_DMA_ALLOC(fmt, args...) \
218         HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
219                  ++global_outstanding_dmas, ## args)
220 #define SBP2_DMA_FREE(fmt, args...) \
221         HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
222                  --global_outstanding_dmas, ## args)
223 static u32 global_outstanding_dmas = 0;
224 #else
225 #define SBP2_DMA_ALLOC(fmt, args...)
226 #define SBP2_DMA_FREE(fmt, args...)
227 #endif
228
229 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
230 #define SBP2_DEBUG(fmt, args...)        HPSB_ERR("sbp2: "fmt, ## args)
231 #define SBP2_INFO(fmt, args...)         HPSB_ERR("sbp2: "fmt, ## args)
232 #define SBP2_NOTICE(fmt, args...)       HPSB_ERR("sbp2: "fmt, ## args)
233 #define SBP2_WARN(fmt, args...)         HPSB_ERR("sbp2: "fmt, ## args)
234 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
235 #define SBP2_DEBUG(fmt, args...)        HPSB_DEBUG("sbp2: "fmt, ## args)
236 #define SBP2_INFO(fmt, args...)         HPSB_INFO("sbp2: "fmt, ## args)
237 #define SBP2_NOTICE(fmt, args...)       HPSB_NOTICE("sbp2: "fmt, ## args)
238 #define SBP2_WARN(fmt, args...)         HPSB_WARN("sbp2: "fmt, ## args)
239 #else
240 #define SBP2_DEBUG(fmt, args...)
241 #define SBP2_INFO(fmt, args...)         HPSB_INFO("sbp2: "fmt, ## args)
242 #define SBP2_NOTICE(fmt, args...)       HPSB_NOTICE("sbp2: "fmt, ## args)
243 #define SBP2_WARN(fmt, args...)         HPSB_WARN("sbp2: "fmt, ## args)
244 #endif
245
246 #define SBP2_ERR(fmt, args...)          HPSB_ERR("sbp2: "fmt, ## args)
247 #define SBP2_DEBUG_ENTER()              SBP2_DEBUG("%s", __FUNCTION__)
248
249 /*
250  * Globals
251  */
252
253 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
254                                            u32 status);
255
256 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
257                                       u32 scsi_status, struct scsi_cmnd *SCpnt,
258                                       void (*done)(struct scsi_cmnd *));
259
260 static struct scsi_host_template scsi_driver_template;
261
262 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
263
264 static void sbp2_host_reset(struct hpsb_host *host);
265
266 static int sbp2_probe(struct device *dev);
267 static int sbp2_remove(struct device *dev);
268 static int sbp2_update(struct unit_directory *ud);
269
270 static struct hpsb_highlevel sbp2_highlevel = {
271         .name =         SBP2_DEVICE_NAME,
272         .host_reset =   sbp2_host_reset,
273 };
274
275 static struct hpsb_address_ops sbp2_ops = {
276         .write = sbp2_handle_status_write
277 };
278
279 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
280 static struct hpsb_address_ops sbp2_physdma_ops = {
281         .read = sbp2_handle_physdma_read,
282         .write = sbp2_handle_physdma_write,
283 };
284 #endif
285
286 static struct hpsb_protocol_driver sbp2_driver = {
287         .name           = "SBP2 Driver",
288         .id_table       = sbp2_id_table,
289         .update         = sbp2_update,
290         .driver         = {
291                 .name           = SBP2_DEVICE_NAME,
292                 .bus            = &ieee1394_bus_type,
293                 .probe          = sbp2_probe,
294                 .remove         = sbp2_remove,
295         },
296 };
297
298 /*
299  * List of devices with known bugs.
300  *
301  * The firmware_revision field, masked with 0xffff00, is the best indicator
302  * for the type of bridge chip of a device.  It yields a few false positives
303  * but this did not break correctly behaving devices so far.
304  */
305 static const struct {
306         u32 firmware_revision;
307         u32 model_id;
308         unsigned workarounds;
309 } sbp2_workarounds_table[] = {
310         /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
311                 .firmware_revision      = 0x002800,
312                 .model_id               = 0x001010,
313                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36 |
314                                           SBP2_WORKAROUND_MODE_SENSE_8,
315         },
316         /* Initio bridges, actually only needed for some older ones */ {
317                 .firmware_revision      = 0x000200,
318                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36,
319         },
320         /* Symbios bridge */ {
321                 .firmware_revision      = 0xa0b800,
322                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS,
323         },
324         /*
325          * Note about the following Apple iPod blacklist entries:
326          *
327          * There are iPods (2nd gen, 3rd gen) with model_id==0.  Since our
328          * matching logic treats 0 as a wildcard, we cannot match this ID
329          * without rewriting the matching routine.  Fortunately these iPods
330          * do not feature the read_capacity bug according to one report.
331          * Read_capacity behaviour as well as model_id could change due to
332          * Apple-supplied firmware updates though.
333          */
334         /* iPod 4th generation */ {
335                 .firmware_revision      = 0x0a2700,
336                 .model_id               = 0x000021,
337                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
338         },
339         /* iPod mini */ {
340                 .firmware_revision      = 0x0a2700,
341                 .model_id               = 0x000023,
342                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
343         },
344         /* iPod Photo */ {
345                 .firmware_revision      = 0x0a2700,
346                 .model_id               = 0x00007e,
347                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
348         }
349 };
350
351 /**************************************
352  * General utility functions
353  **************************************/
354
355 #ifndef __BIG_ENDIAN
356 /*
357  * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
358  */
359 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
360 {
361         u32 *temp = buffer;
362
363         for (length = (length >> 2); length--; )
364                 temp[length] = be32_to_cpu(temp[length]);
365
366         return;
367 }
368
369 /*
370  * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
371  */
372 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
373 {
374         u32 *temp = buffer;
375
376         for (length = (length >> 2); length--; )
377                 temp[length] = cpu_to_be32(temp[length]);
378
379         return;
380 }
381 #else /* BIG_ENDIAN */
382 /* Why waste the cpu cycles? */
383 #define sbp2util_be32_to_cpu_buffer(x,y)
384 #define sbp2util_cpu_to_be32_buffer(x,y)
385 #endif
386
387 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
388 /*
389  * Debug packet dump routine. Length is in bytes.
390  */
391 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
392                                  u32 dump_phys_addr)
393 {
394         int i;
395         unsigned char *dump = buffer;
396
397         if (!dump || !length || !dump_name)
398                 return;
399
400         if (dump_phys_addr)
401                 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
402         else
403                 printk("[%s]", dump_name);
404         for (i = 0; i < length; i++) {
405                 if (i > 0x3f) {
406                         printk("\n   ...");
407                         break;
408                 }
409                 if ((i & 0x3) == 0)
410                         printk("  ");
411                 if ((i & 0xf) == 0)
412                         printk("\n   ");
413                 printk("%02x ", (int)dump[i]);
414         }
415         printk("\n");
416
417         return;
418 }
419 #else
420 #define sbp2util_packet_dump(w,x,y,z)
421 #endif
422
423 static DECLARE_WAIT_QUEUE_HEAD(access_wq);
424
425 /*
426  * Waits for completion of an SBP-2 access request.
427  * Returns nonzero if timed out or prematurely interrupted.
428  */
429 static int sbp2util_access_timeout(struct scsi_id_instance_data *scsi_id,
430                                    int timeout)
431 {
432         long leftover = wait_event_interruptible_timeout(
433                                 access_wq, scsi_id->access_complete, timeout);
434
435         scsi_id->access_complete = 0;
436         return leftover <= 0;
437 }
438
439 /* Frees an allocated packet */
440 static void sbp2_free_packet(struct hpsb_packet *packet)
441 {
442         hpsb_free_tlabel(packet);
443         hpsb_free_packet(packet);
444 }
445
446 /* This is much like hpsb_node_write(), except it ignores the response
447  * subaction and returns immediately. Can be used from interrupts.
448  */
449 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
450                                        quadlet_t *buffer, size_t length)
451 {
452         struct hpsb_packet *packet;
453
454         packet = hpsb_make_writepacket(ne->host, ne->nodeid,
455                                        addr, buffer, length);
456         if (!packet)
457                 return -ENOMEM;
458
459         hpsb_set_packet_complete_task(packet,
460                                       (void (*)(void *))sbp2_free_packet,
461                                       packet);
462
463         hpsb_node_fill_packet(ne, packet);
464
465         if (hpsb_send_packet(packet) < 0) {
466                 sbp2_free_packet(packet);
467                 return -EIO;
468         }
469
470         return 0;
471 }
472
473 /*
474  * This function is called to create a pool of command orbs used for
475  * command processing. It is called when a new sbp2 device is detected.
476  */
477 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
478 {
479         struct sbp2scsi_host_info *hi = scsi_id->hi;
480         int i;
481         unsigned long flags, orbs;
482         struct sbp2_command_info *command;
483
484         orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
485
486         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
487         for (i = 0; i < orbs; i++) {
488                 command = kzalloc(sizeof(*command), GFP_ATOMIC);
489                 if (!command) {
490                         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
491                                                flags);
492                         return -ENOMEM;
493                 }
494                 command->command_orb_dma =
495                     pci_map_single(hi->host->pdev, &command->command_orb,
496                                    sizeof(struct sbp2_command_orb),
497                                    PCI_DMA_TODEVICE);
498                 SBP2_DMA_ALLOC("single command orb DMA");
499                 command->sge_dma =
500                     pci_map_single(hi->host->pdev,
501                                    &command->scatter_gather_element,
502                                    sizeof(command->scatter_gather_element),
503                                    PCI_DMA_BIDIRECTIONAL);
504                 SBP2_DMA_ALLOC("scatter_gather_element");
505                 INIT_LIST_HEAD(&command->list);
506                 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
507         }
508         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
509         return 0;
510 }
511
512 /*
513  * This function is called to delete a pool of command orbs.
514  */
515 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
516 {
517         struct hpsb_host *host = scsi_id->hi->host;
518         struct list_head *lh, *next;
519         struct sbp2_command_info *command;
520         unsigned long flags;
521
522         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
523         if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
524                 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
525                         command = list_entry(lh, struct sbp2_command_info, list);
526
527                         /* Release our generic DMA's */
528                         pci_unmap_single(host->pdev, command->command_orb_dma,
529                                          sizeof(struct sbp2_command_orb),
530                                          PCI_DMA_TODEVICE);
531                         SBP2_DMA_FREE("single command orb DMA");
532                         pci_unmap_single(host->pdev, command->sge_dma,
533                                          sizeof(command->scatter_gather_element),
534                                          PCI_DMA_BIDIRECTIONAL);
535                         SBP2_DMA_FREE("scatter_gather_element");
536
537                         kfree(command);
538                 }
539         }
540         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
541         return;
542 }
543
544 /*
545  * This function finds the sbp2_command for a given outstanding command
546  * orb.Only looks at the inuse list.
547  */
548 static struct sbp2_command_info *sbp2util_find_command_for_orb(
549                 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
550 {
551         struct sbp2_command_info *command;
552         unsigned long flags;
553
554         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
555         if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
556                 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
557                         if (command->command_orb_dma == orb) {
558                                 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
559                                 return command;
560                         }
561                 }
562         }
563         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
564
565         SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
566
567         return NULL;
568 }
569
570 /*
571  * This function finds the sbp2_command for a given outstanding SCpnt.
572  * Only looks at the inuse list.
573  * Must be called with scsi_id->sbp2_command_orb_lock held.
574  */
575 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
576                 struct scsi_id_instance_data *scsi_id, void *SCpnt)
577 {
578         struct sbp2_command_info *command;
579
580         if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
581                 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
582                         if (command->Current_SCpnt == SCpnt)
583                                 return command;
584         return NULL;
585 }
586
587 /*
588  * This function allocates a command orb used to send a scsi command.
589  */
590 static struct sbp2_command_info *sbp2util_allocate_command_orb(
591                 struct scsi_id_instance_data *scsi_id,
592                 struct scsi_cmnd *Current_SCpnt,
593                 void (*Current_done)(struct scsi_cmnd *))
594 {
595         struct list_head *lh;
596         struct sbp2_command_info *command = NULL;
597         unsigned long flags;
598
599         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
600         if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
601                 lh = scsi_id->sbp2_command_orb_completed.next;
602                 list_del(lh);
603                 command = list_entry(lh, struct sbp2_command_info, list);
604                 command->Current_done = Current_done;
605                 command->Current_SCpnt = Current_SCpnt;
606                 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
607         } else {
608                 SBP2_ERR("%s: no orbs available", __FUNCTION__);
609         }
610         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
611         return command;
612 }
613
614 /* Free our DMA's */
615 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
616 {
617         struct scsi_id_instance_data *scsi_id =
618                 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
619         struct hpsb_host *host;
620
621         if (!scsi_id) {
622                 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
623                 return;
624         }
625
626         host = scsi_id->ud->ne->host;
627
628         if (command->cmd_dma) {
629                 if (command->dma_type == CMD_DMA_SINGLE) {
630                         pci_unmap_single(host->pdev, command->cmd_dma,
631                                          command->dma_size, command->dma_dir);
632                         SBP2_DMA_FREE("single bulk");
633                 } else if (command->dma_type == CMD_DMA_PAGE) {
634                         pci_unmap_page(host->pdev, command->cmd_dma,
635                                        command->dma_size, command->dma_dir);
636                         SBP2_DMA_FREE("single page");
637                 } /* XXX: Check for CMD_DMA_NONE bug */
638                 command->dma_type = CMD_DMA_NONE;
639                 command->cmd_dma = 0;
640         }
641
642         if (command->sge_buffer) {
643                 pci_unmap_sg(host->pdev, command->sge_buffer,
644                              command->dma_size, command->dma_dir);
645                 SBP2_DMA_FREE("scatter list");
646                 command->sge_buffer = NULL;
647         }
648 }
649
650 /*
651  * This function moves a command to the completed orb list.
652  * Must be called with scsi_id->sbp2_command_orb_lock held.
653  */
654 static void sbp2util_mark_command_completed(
655                 struct scsi_id_instance_data *scsi_id,
656                 struct sbp2_command_info *command)
657 {
658         list_del(&command->list);
659         sbp2util_free_command_dma(command);
660         list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
661 }
662
663 /*
664  * Is scsi_id valid? Is the 1394 node still present?
665  */
666 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
667 {
668         return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
669 }
670
671 /*********************************************
672  * IEEE-1394 core driver stack related section
673  *********************************************/
674 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
675
676 static int sbp2_probe(struct device *dev)
677 {
678         struct unit_directory *ud;
679         struct scsi_id_instance_data *scsi_id;
680
681         SBP2_DEBUG_ENTER();
682
683         ud = container_of(dev, struct unit_directory, device);
684
685         /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
686          * instead. */
687         if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
688                 return -ENODEV;
689
690         scsi_id = sbp2_alloc_device(ud);
691
692         if (!scsi_id)
693                 return -ENOMEM;
694
695         sbp2_parse_unit_directory(scsi_id, ud);
696
697         return sbp2_start_device(scsi_id);
698 }
699
700 static int sbp2_remove(struct device *dev)
701 {
702         struct unit_directory *ud;
703         struct scsi_id_instance_data *scsi_id;
704         struct scsi_device *sdev;
705
706         SBP2_DEBUG_ENTER();
707
708         ud = container_of(dev, struct unit_directory, device);
709         scsi_id = ud->device.driver_data;
710         if (!scsi_id)
711                 return 0;
712
713         if (scsi_id->scsi_host) {
714                 /* Get rid of enqueued commands if there is no chance to
715                  * send them. */
716                 if (!sbp2util_node_is_available(scsi_id))
717                         sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
718                 /* scsi_remove_device() will trigger shutdown functions of SCSI
719                  * highlevel drivers which would deadlock if blocked. */
720                 scsi_unblock_requests(scsi_id->scsi_host);
721         }
722         sdev = scsi_id->sdev;
723         if (sdev) {
724                 scsi_id->sdev = NULL;
725                 scsi_remove_device(sdev);
726         }
727
728         sbp2_logout_device(scsi_id);
729         sbp2_remove_device(scsi_id);
730
731         return 0;
732 }
733
734 static int sbp2_update(struct unit_directory *ud)
735 {
736         struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
737
738         SBP2_DEBUG_ENTER();
739
740         if (sbp2_reconnect_device(scsi_id)) {
741
742                 /*
743                  * Ok, reconnect has failed. Perhaps we didn't
744                  * reconnect fast enough. Try doing a regular login, but
745                  * first do a logout just in case of any weirdness.
746                  */
747                 sbp2_logout_device(scsi_id);
748
749                 if (sbp2_login_device(scsi_id)) {
750                         /* Login failed too, just fail, and the backend
751                          * will call our sbp2_remove for us */
752                         SBP2_ERR("Failed to reconnect to sbp2 device!");
753                         return -EBUSY;
754                 }
755         }
756
757         /* Set max retries to something large on the device. */
758         sbp2_set_busy_timeout(scsi_id);
759
760         /* Do a SBP-2 fetch agent reset. */
761         sbp2_agent_reset(scsi_id, 1);
762
763         /* Get the max speed and packet size that we can use. */
764         sbp2_max_speed_and_size(scsi_id);
765
766         /* Complete any pending commands with busy (so they get
767          * retried) and remove them from our queue
768          */
769         sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
770
771         /* Make sure we unblock requests (since this is likely after a bus
772          * reset). */
773         scsi_unblock_requests(scsi_id->scsi_host);
774
775         return 0;
776 }
777
778 /* This functions is called by the sbp2_probe, for each new device. We now
779  * allocate one scsi host for each scsi_id (unit directory). */
780 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
781 {
782         struct sbp2scsi_host_info *hi;
783         struct Scsi_Host *scsi_host = NULL;
784         struct scsi_id_instance_data *scsi_id = NULL;
785
786         SBP2_DEBUG_ENTER();
787
788         scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
789         if (!scsi_id) {
790                 SBP2_ERR("failed to create scsi_id");
791                 goto failed_alloc;
792         }
793
794         scsi_id->ne = ud->ne;
795         scsi_id->ud = ud;
796         scsi_id->speed_code = IEEE1394_SPEED_100;
797         scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
798         scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
799         INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
800         INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
801         INIT_LIST_HEAD(&scsi_id->scsi_list);
802         spin_lock_init(&scsi_id->sbp2_command_orb_lock);
803
804         ud->device.driver_data = scsi_id;
805
806         hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
807         if (!hi) {
808                 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
809                 if (!hi) {
810                         SBP2_ERR("failed to allocate hostinfo");
811                         goto failed_alloc;
812                 }
813                 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
814                 hi->host = ud->ne->host;
815                 INIT_LIST_HEAD(&hi->scsi_ids);
816
817 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
818                 /* Handle data movement if physical dma is not
819                  * enabled or not supported on host controller */
820                 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
821                                              &sbp2_physdma_ops,
822                                              0x0ULL, 0xfffffffcULL)) {
823                         SBP2_ERR("failed to register lower 4GB address range");
824                         goto failed_alloc;
825                 }
826 #endif
827         }
828
829         /* Prevent unloading of the 1394 host */
830         if (!try_module_get(hi->host->driver->owner)) {
831                 SBP2_ERR("failed to get a reference on 1394 host driver");
832                 goto failed_alloc;
833         }
834
835         scsi_id->hi = hi;
836
837         list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
838
839         /* Register the status FIFO address range. We could use the same FIFO
840          * for targets at different nodes. However we need different FIFOs per
841          * target in order to support multi-unit devices.
842          * The FIFO is located out of the local host controller's physical range
843          * but, if possible, within the posted write area. Status writes will
844          * then be performed as unified transactions. This slightly reduces
845          * bandwidth usage, and some Prolific based devices seem to require it.
846          */
847         scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
848                         &sbp2_highlevel, ud->ne->host, &sbp2_ops,
849                         sizeof(struct sbp2_status_block), sizeof(quadlet_t),
850                         ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
851         if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
852                 SBP2_ERR("failed to allocate status FIFO address range");
853                 goto failed_alloc;
854         }
855
856         /* Register our host with the SCSI stack. */
857         scsi_host = scsi_host_alloc(&scsi_driver_template,
858                                     sizeof(unsigned long));
859         if (!scsi_host) {
860                 SBP2_ERR("failed to register scsi host");
861                 goto failed_alloc;
862         }
863
864         scsi_host->hostdata[0] = (unsigned long)scsi_id;
865
866         if (!scsi_add_host(scsi_host, &ud->device)) {
867                 scsi_id->scsi_host = scsi_host;
868                 return scsi_id;
869         }
870
871         SBP2_ERR("failed to add scsi host");
872         scsi_host_put(scsi_host);
873
874 failed_alloc:
875         sbp2_remove_device(scsi_id);
876         return NULL;
877 }
878
879 static void sbp2_host_reset(struct hpsb_host *host)
880 {
881         struct sbp2scsi_host_info *hi;
882         struct scsi_id_instance_data *scsi_id;
883
884         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
885
886         if (hi) {
887                 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
888                         scsi_block_requests(scsi_id->scsi_host);
889         }
890 }
891
892 /*
893  * This function is where we first pull the node unique ids, and then
894  * allocate memory and register a SBP-2 device.
895  */
896 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
897 {
898         struct sbp2scsi_host_info *hi = scsi_id->hi;
899         int error;
900
901         SBP2_DEBUG_ENTER();
902
903         /* Login FIFO DMA */
904         scsi_id->login_response =
905                 pci_alloc_consistent(hi->host->pdev,
906                                      sizeof(struct sbp2_login_response),
907                                      &scsi_id->login_response_dma);
908         if (!scsi_id->login_response)
909                 goto alloc_fail;
910         SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
911
912         /* Query logins ORB DMA */
913         scsi_id->query_logins_orb =
914                 pci_alloc_consistent(hi->host->pdev,
915                                      sizeof(struct sbp2_query_logins_orb),
916                                      &scsi_id->query_logins_orb_dma);
917         if (!scsi_id->query_logins_orb)
918                 goto alloc_fail;
919         SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
920
921         /* Query logins response DMA */
922         scsi_id->query_logins_response =
923                 pci_alloc_consistent(hi->host->pdev,
924                                      sizeof(struct sbp2_query_logins_response),
925                                      &scsi_id->query_logins_response_dma);
926         if (!scsi_id->query_logins_response)
927                 goto alloc_fail;
928         SBP2_DMA_ALLOC("consistent DMA region for query logins response");
929
930         /* Reconnect ORB DMA */
931         scsi_id->reconnect_orb =
932                 pci_alloc_consistent(hi->host->pdev,
933                                      sizeof(struct sbp2_reconnect_orb),
934                                      &scsi_id->reconnect_orb_dma);
935         if (!scsi_id->reconnect_orb)
936                 goto alloc_fail;
937         SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
938
939         /* Logout ORB DMA */
940         scsi_id->logout_orb =
941                 pci_alloc_consistent(hi->host->pdev,
942                                      sizeof(struct sbp2_logout_orb),
943                                      &scsi_id->logout_orb_dma);
944         if (!scsi_id->logout_orb)
945                 goto alloc_fail;
946         SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
947
948         /* Login ORB DMA */
949         scsi_id->login_orb =
950                 pci_alloc_consistent(hi->host->pdev,
951                                      sizeof(struct sbp2_login_orb),
952                                      &scsi_id->login_orb_dma);
953         if (!scsi_id->login_orb)
954                 goto alloc_fail;
955         SBP2_DMA_ALLOC("consistent DMA region for login ORB");
956
957         SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
958
959         /*
960          * Create our command orb pool
961          */
962         if (sbp2util_create_command_orb_pool(scsi_id)) {
963                 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
964                 sbp2_remove_device(scsi_id);
965                 return -ENOMEM;
966         }
967
968         /* Schedule a timeout here. The reason is that we may be so close
969          * to a bus reset, that the device is not available for logins.
970          * This can happen when the bus reset is caused by the host
971          * connected to the sbp2 device being removed. That host would
972          * have a certain amount of time to relogin before the sbp2 device
973          * allows someone else to login instead. One second makes sense. */
974         msleep_interruptible(1000);
975         if (signal_pending(current)) {
976                 sbp2_remove_device(scsi_id);
977                 return -EINTR;
978         }
979
980         /*
981          * Login to the sbp-2 device
982          */
983         if (sbp2_login_device(scsi_id)) {
984                 /* Login failed, just remove the device. */
985                 sbp2_remove_device(scsi_id);
986                 return -EBUSY;
987         }
988
989         /*
990          * Set max retries to something large on the device
991          */
992         sbp2_set_busy_timeout(scsi_id);
993
994         /*
995          * Do a SBP-2 fetch agent reset
996          */
997         sbp2_agent_reset(scsi_id, 1);
998
999         /*
1000          * Get the max speed and packet size that we can use
1001          */
1002         sbp2_max_speed_and_size(scsi_id);
1003
1004         /* Add this device to the scsi layer now */
1005         error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1006         if (error) {
1007                 SBP2_ERR("scsi_add_device failed");
1008                 sbp2_logout_device(scsi_id);
1009                 sbp2_remove_device(scsi_id);
1010                 return error;
1011         }
1012
1013         return 0;
1014
1015 alloc_fail:
1016         SBP2_ERR("Could not allocate memory for scsi_id");
1017         sbp2_remove_device(scsi_id);
1018         return -ENOMEM;
1019 }
1020
1021 /*
1022  * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1023  */
1024 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1025 {
1026         struct sbp2scsi_host_info *hi;
1027
1028         SBP2_DEBUG_ENTER();
1029
1030         if (!scsi_id)
1031                 return;
1032
1033         hi = scsi_id->hi;
1034
1035         /* This will remove our scsi device aswell */
1036         if (scsi_id->scsi_host) {
1037                 scsi_remove_host(scsi_id->scsi_host);
1038                 scsi_host_put(scsi_id->scsi_host);
1039         }
1040
1041         sbp2util_remove_command_orb_pool(scsi_id);
1042
1043         list_del(&scsi_id->scsi_list);
1044
1045         if (scsi_id->login_response) {
1046                 pci_free_consistent(hi->host->pdev,
1047                                     sizeof(struct sbp2_login_response),
1048                                     scsi_id->login_response,
1049                                     scsi_id->login_response_dma);
1050                 SBP2_DMA_FREE("single login FIFO");
1051         }
1052
1053         if (scsi_id->login_orb) {
1054                 pci_free_consistent(hi->host->pdev,
1055                                     sizeof(struct sbp2_login_orb),
1056                                     scsi_id->login_orb,
1057                                     scsi_id->login_orb_dma);
1058                 SBP2_DMA_FREE("single login ORB");
1059         }
1060
1061         if (scsi_id->reconnect_orb) {
1062                 pci_free_consistent(hi->host->pdev,
1063                                     sizeof(struct sbp2_reconnect_orb),
1064                                     scsi_id->reconnect_orb,
1065                                     scsi_id->reconnect_orb_dma);
1066                 SBP2_DMA_FREE("single reconnect orb");
1067         }
1068
1069         if (scsi_id->logout_orb) {
1070                 pci_free_consistent(hi->host->pdev,
1071                                     sizeof(struct sbp2_logout_orb),
1072                                     scsi_id->logout_orb,
1073                                     scsi_id->logout_orb_dma);
1074                 SBP2_DMA_FREE("single logout orb");
1075         }
1076
1077         if (scsi_id->query_logins_orb) {
1078                 pci_free_consistent(hi->host->pdev,
1079                                     sizeof(struct sbp2_query_logins_orb),
1080                                     scsi_id->query_logins_orb,
1081                                     scsi_id->query_logins_orb_dma);
1082                 SBP2_DMA_FREE("single query logins orb");
1083         }
1084
1085         if (scsi_id->query_logins_response) {
1086                 pci_free_consistent(hi->host->pdev,
1087                                     sizeof(struct sbp2_query_logins_response),
1088                                     scsi_id->query_logins_response,
1089                                     scsi_id->query_logins_response_dma);
1090                 SBP2_DMA_FREE("single query logins data");
1091         }
1092
1093         if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
1094                 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1095                                           scsi_id->status_fifo_addr);
1096
1097         scsi_id->ud->device.driver_data = NULL;
1098
1099         if (hi)
1100                 module_put(hi->host->driver->owner);
1101
1102         SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1103
1104         kfree(scsi_id);
1105 }
1106
1107 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1108 /*
1109  * This function deals with physical dma write requests (for adapters that do not support
1110  * physical dma in hardware). Mostly just here for debugging...
1111  */
1112 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1113                                      int destid, quadlet_t *data, u64 addr,
1114                                      size_t length, u16 flags)
1115 {
1116
1117         /*
1118          * Manually put the data in the right place.
1119          */
1120         memcpy(bus_to_virt((u32) addr), data, length);
1121         sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1122                              (u32) addr);
1123         return RCODE_COMPLETE;
1124 }
1125
1126 /*
1127  * This function deals with physical dma read requests (for adapters that do not support
1128  * physical dma in hardware). Mostly just here for debugging...
1129  */
1130 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1131                                     quadlet_t *data, u64 addr, size_t length,
1132                                     u16 flags)
1133 {
1134
1135         /*
1136          * Grab data from memory and send a read response.
1137          */
1138         memcpy(data, bus_to_virt((u32) addr), length);
1139         sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1140                              (u32) addr);
1141         return RCODE_COMPLETE;
1142 }
1143 #endif
1144
1145 /**************************************
1146  * SBP-2 protocol related section
1147  **************************************/
1148
1149 /*
1150  * This function queries the device for the maximum concurrent logins it
1151  * supports.
1152  */
1153 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1154 {
1155         struct sbp2scsi_host_info *hi = scsi_id->hi;
1156         quadlet_t data[2];
1157         int max_logins;
1158         int active_logins;
1159
1160         SBP2_DEBUG_ENTER();
1161
1162         scsi_id->query_logins_orb->reserved1 = 0x0;
1163         scsi_id->query_logins_orb->reserved2 = 0x0;
1164
1165         scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1166         scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1167
1168         scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1169         scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1170         scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1171
1172         scsi_id->query_logins_orb->reserved_resp_length =
1173                 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1174
1175         scsi_id->query_logins_orb->status_fifo_hi =
1176                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1177         scsi_id->query_logins_orb->status_fifo_lo =
1178                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1179
1180         sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1181
1182         sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1183                              "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1184
1185         memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1186
1187         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1188         data[1] = scsi_id->query_logins_orb_dma;
1189         sbp2util_cpu_to_be32_buffer(data, 8);
1190
1191         hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1192
1193         if (sbp2util_access_timeout(scsi_id, 2*HZ)) {
1194                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1195                 return -EIO;
1196         }
1197
1198         if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1199                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1200                 return -EIO;
1201         }
1202
1203         if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1204                 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1205                 return -EIO;
1206         }
1207
1208         sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1209
1210         SBP2_DEBUG("length_max_logins = %x",
1211                    (unsigned int)scsi_id->query_logins_response->length_max_logins);
1212
1213         max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1214         SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1215
1216         active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1217         SBP2_INFO("Number of active logins: %d", active_logins);
1218
1219         if (active_logins >= max_logins) {
1220                 return -EIO;
1221         }
1222
1223         return 0;
1224 }
1225
1226 /*
1227  * This function is called in order to login to a particular SBP-2 device,
1228  * after a bus reset.
1229  */
1230 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1231 {
1232         struct sbp2scsi_host_info *hi = scsi_id->hi;
1233         quadlet_t data[2];
1234
1235         SBP2_DEBUG_ENTER();
1236
1237         if (!scsi_id->login_orb) {
1238                 SBP2_DEBUG("%s: login_orb not alloc'd!", __FUNCTION__);
1239                 return -EIO;
1240         }
1241
1242         if (!exclusive_login) {
1243                 if (sbp2_query_logins(scsi_id)) {
1244                         SBP2_INFO("Device does not support any more concurrent logins");
1245                         return -EIO;
1246                 }
1247         }
1248
1249         /* Set-up login ORB, assume no password */
1250         scsi_id->login_orb->password_hi = 0;
1251         scsi_id->login_orb->password_lo = 0;
1252
1253         scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1254         scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1255
1256         scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1257         scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0);   /* One second reconnect time */
1258         scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login);     /* Exclusive access to device */
1259         scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1);      /* Notify us of login complete */
1260         scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1261
1262         scsi_id->login_orb->passwd_resp_lengths =
1263                 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1264
1265         scsi_id->login_orb->status_fifo_hi =
1266                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1267         scsi_id->login_orb->status_fifo_lo =
1268                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1269
1270         sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1271
1272         sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1273                              "sbp2 login orb", scsi_id->login_orb_dma);
1274
1275         memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1276
1277         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1278         data[1] = scsi_id->login_orb_dma;
1279         sbp2util_cpu_to_be32_buffer(data, 8);
1280
1281         hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1282
1283         /*
1284          * Wait for login status (up to 20 seconds)...
1285          */
1286         if (sbp2util_access_timeout(scsi_id, 20*HZ)) {
1287                 SBP2_ERR("Error logging into SBP-2 device - timed out");
1288                 return -EIO;
1289         }
1290
1291         /*
1292          * Sanity. Make sure status returned matches login orb.
1293          */
1294         if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1295                 SBP2_ERR("Error logging into SBP-2 device - timed out");
1296                 return -EIO;
1297         }
1298
1299         if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1300                 SBP2_ERR("Error logging into SBP-2 device - failed");
1301                 return -EIO;
1302         }
1303
1304         /*
1305          * Byte swap the login response, for use when reconnecting or
1306          * logging out.
1307          */
1308         sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1309
1310         /*
1311          * Grab our command block agent address from the login response.
1312          */
1313         SBP2_DEBUG("command_block_agent_hi = %x",
1314                    (unsigned int)scsi_id->login_response->command_block_agent_hi);
1315         SBP2_DEBUG("command_block_agent_lo = %x",
1316                    (unsigned int)scsi_id->login_response->command_block_agent_lo);
1317
1318         scsi_id->sbp2_command_block_agent_addr =
1319                 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1320         scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1321         scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1322
1323         SBP2_INFO("Logged into SBP-2 device");
1324         return 0;
1325 }
1326
1327 /*
1328  * This function is called in order to logout from a particular SBP-2
1329  * device, usually called during driver unload.
1330  */
1331 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1332 {
1333         struct sbp2scsi_host_info *hi = scsi_id->hi;
1334         quadlet_t data[2];
1335         int error;
1336
1337         SBP2_DEBUG_ENTER();
1338
1339         /*
1340          * Set-up logout ORB
1341          */
1342         scsi_id->logout_orb->reserved1 = 0x0;
1343         scsi_id->logout_orb->reserved2 = 0x0;
1344         scsi_id->logout_orb->reserved3 = 0x0;
1345         scsi_id->logout_orb->reserved4 = 0x0;
1346
1347         scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1348         scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1349
1350         /* Notify us when complete */
1351         scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1352
1353         scsi_id->logout_orb->reserved5 = 0x0;
1354         scsi_id->logout_orb->status_fifo_hi =
1355                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1356         scsi_id->logout_orb->status_fifo_lo =
1357                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1358
1359         /*
1360          * Byte swap ORB if necessary
1361          */
1362         sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1363
1364         sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1365                              "sbp2 logout orb", scsi_id->logout_orb_dma);
1366
1367         /*
1368          * Ok, let's write to the target's management agent register
1369          */
1370         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1371         data[1] = scsi_id->logout_orb_dma;
1372         sbp2util_cpu_to_be32_buffer(data, 8);
1373
1374         error = hpsb_node_write(scsi_id->ne,
1375                                 scsi_id->sbp2_management_agent_addr, data, 8);
1376         if (error)
1377                 return error;
1378
1379         /* Wait for device to logout...1 second. */
1380         if (sbp2util_access_timeout(scsi_id, HZ))
1381                 return -EIO;
1382
1383         SBP2_INFO("Logged out of SBP-2 device");
1384         return 0;
1385 }
1386
1387 /*
1388  * This function is called in order to reconnect to a particular SBP-2
1389  * device, after a bus reset.
1390  */
1391 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1392 {
1393         struct sbp2scsi_host_info *hi = scsi_id->hi;
1394         quadlet_t data[2];
1395         int error;
1396
1397         SBP2_DEBUG_ENTER();
1398
1399         /*
1400          * Set-up reconnect ORB
1401          */
1402         scsi_id->reconnect_orb->reserved1 = 0x0;
1403         scsi_id->reconnect_orb->reserved2 = 0x0;
1404         scsi_id->reconnect_orb->reserved3 = 0x0;
1405         scsi_id->reconnect_orb->reserved4 = 0x0;
1406
1407         scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1408         scsi_id->reconnect_orb->login_ID_misc |=
1409                 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1410
1411         /* Notify us when complete */
1412         scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1413
1414         scsi_id->reconnect_orb->reserved5 = 0x0;
1415         scsi_id->reconnect_orb->status_fifo_hi =
1416                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1417         scsi_id->reconnect_orb->status_fifo_lo =
1418                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1419
1420         /*
1421          * Byte swap ORB if necessary
1422          */
1423         sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1424
1425         sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1426                              "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1427
1428         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1429         data[1] = scsi_id->reconnect_orb_dma;
1430         sbp2util_cpu_to_be32_buffer(data, 8);
1431
1432         error = hpsb_node_write(scsi_id->ne,
1433                                 scsi_id->sbp2_management_agent_addr, data, 8);
1434         if (error)
1435                 return error;
1436
1437         /*
1438          * Wait for reconnect status (up to 1 second)...
1439          */
1440         if (sbp2util_access_timeout(scsi_id, HZ)) {
1441                 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1442                 return -EIO;
1443         }
1444
1445         /*
1446          * Sanity. Make sure status returned matches reconnect orb.
1447          */
1448         if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1449                 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1450                 return -EIO;
1451         }
1452
1453         if (STATUS_TEST_RDS(scsi_id->status_block.ORB_offset_hi_misc)) {
1454                 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1455                 return -EIO;
1456         }
1457
1458         HPSB_DEBUG("Reconnected to SBP-2 device");
1459         return 0;
1460 }
1461
1462 /*
1463  * This function is called in order to set the busy timeout (number of
1464  * retries to attempt) on the sbp2 device.
1465  */
1466 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1467 {
1468         quadlet_t data;
1469
1470         SBP2_DEBUG_ENTER();
1471
1472         data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1473         if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1474                 SBP2_ERR("%s error", __FUNCTION__);
1475         return 0;
1476 }
1477
1478 /*
1479  * This function is called to parse sbp2 device's config rom unit
1480  * directory. Used to determine things like sbp2 management agent offset,
1481  * and command set used (SCSI or RBC).
1482  */
1483 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1484                                       struct unit_directory *ud)
1485 {
1486         struct csr1212_keyval *kv;
1487         struct csr1212_dentry *dentry;
1488         u64 management_agent_addr;
1489         u32 command_set_spec_id, command_set, unit_characteristics,
1490             firmware_revision;
1491         unsigned workarounds;
1492         int i;
1493
1494         SBP2_DEBUG_ENTER();
1495
1496         management_agent_addr = 0x0;
1497         command_set_spec_id = 0x0;
1498         command_set = 0x0;
1499         unit_characteristics = 0x0;
1500         firmware_revision = 0x0;
1501
1502         /* Handle different fields in the unit directory, based on keys */
1503         csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1504                 switch (kv->key.id) {
1505                 case CSR1212_KV_ID_DEPENDENT_INFO:
1506                         if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1507                                 /* Save off the management agent address */
1508                                 management_agent_addr =
1509                                     CSR1212_REGISTER_SPACE_BASE +
1510                                     (kv->value.csr_offset << 2);
1511
1512                                 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1513                                            (unsigned int)management_agent_addr);
1514                         } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1515                                 scsi_id->sbp2_lun =
1516                                     ORB_SET_LUN(kv->value.immediate);
1517                         }
1518                         break;
1519
1520                 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1521                         /* Command spec organization */
1522                         command_set_spec_id = kv->value.immediate;
1523                         SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1524                                    (unsigned int)command_set_spec_id);
1525                         break;
1526
1527                 case SBP2_COMMAND_SET_KEY:
1528                         /* Command set used by sbp2 device */
1529                         command_set = kv->value.immediate;
1530                         SBP2_DEBUG("sbp2_command_set = %x",
1531                                    (unsigned int)command_set);
1532                         break;
1533
1534                 case SBP2_UNIT_CHARACTERISTICS_KEY:
1535                         /*
1536                          * Unit characterisitcs (orb related stuff
1537                          * that I'm not yet paying attention to)
1538                          */
1539                         unit_characteristics = kv->value.immediate;
1540                         SBP2_DEBUG("sbp2_unit_characteristics = %x",
1541                                    (unsigned int)unit_characteristics);
1542                         break;
1543
1544                 case SBP2_FIRMWARE_REVISION_KEY:
1545                         /* Firmware revision */
1546                         firmware_revision = kv->value.immediate;
1547                         SBP2_DEBUG("sbp2_firmware_revision = %x",
1548                                    (unsigned int)firmware_revision);
1549                         break;
1550
1551                 default:
1552                         break;
1553                 }
1554         }
1555
1556         workarounds = sbp2_default_workarounds;
1557         if (force_inquiry_hack) {
1558                 SBP2_WARN("force_inquiry_hack is deprecated. "
1559                           "Use parameter 'workarounds' instead.");
1560                 workarounds |= SBP2_WORKAROUND_INQUIRY_36;
1561         }
1562
1563         if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1564                 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1565                         if (sbp2_workarounds_table[i].firmware_revision &&
1566                             sbp2_workarounds_table[i].firmware_revision !=
1567                             (firmware_revision & 0xffff00))
1568                                 continue;
1569                         if (sbp2_workarounds_table[i].model_id &&
1570                             sbp2_workarounds_table[i].model_id != ud->model_id)
1571                                 continue;
1572                         workarounds |= sbp2_workarounds_table[i].workarounds;
1573                         break;
1574                 }
1575
1576         if (workarounds)
1577                 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1578                           "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1579                           " model_id 0x%06x)",
1580                           NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1581                           workarounds, firmware_revision,
1582                           ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1583                           ud->model_id);
1584
1585         /* We would need one SCSI host template for each target to adjust
1586          * max_sectors on the fly, therefore warn only. */
1587         if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1588             (max_sectors * 512) > (128 * 1024))
1589                 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1590                           "max transfer size. WARNING: Current max_sectors "
1591                           "setting is larger than 128KB (%d sectors)",
1592                           NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1593                           max_sectors);
1594
1595         /* If this is a logical unit directory entry, process the parent
1596          * to get the values. */
1597         if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1598                 struct unit_directory *parent_ud =
1599                         container_of(ud->device.parent, struct unit_directory, device);
1600                 sbp2_parse_unit_directory(scsi_id, parent_ud);
1601         } else {
1602                 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1603                 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1604                 scsi_id->sbp2_command_set = command_set;
1605                 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1606                 scsi_id->sbp2_firmware_revision = firmware_revision;
1607                 scsi_id->workarounds = workarounds;
1608                 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1609                         scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1610         }
1611 }
1612
1613 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1614
1615 /*
1616  * This function is called in order to determine the max speed and packet
1617  * size we can use in our ORBs. Note, that we (the driver and host) only
1618  * initiate the transaction. The SBP-2 device actually transfers the data
1619  * (by reading from the DMA area we tell it). This means that the SBP-2
1620  * device decides the actual maximum data it can transfer. We just tell it
1621  * the speed that it needs to use, and the max_rec the host supports, and
1622  * it takes care of the rest.
1623  */
1624 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1625 {
1626         struct sbp2scsi_host_info *hi = scsi_id->hi;
1627         u8 payload;
1628
1629         SBP2_DEBUG_ENTER();
1630
1631         scsi_id->speed_code =
1632             hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1633
1634         /* Bump down our speed if the user requested it */
1635         if (scsi_id->speed_code > max_speed) {
1636                 scsi_id->speed_code = max_speed;
1637                 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1638                          hpsb_speedto_str[scsi_id->speed_code]);
1639         }
1640
1641         /* Payload size is the lesser of what our speed supports and what
1642          * our host supports.  */
1643         payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1644                       (u8) (hi->host->csr.max_rec - 1));
1645
1646         /* If physical DMA is off, work around limitation in ohci1394:
1647          * packet size must not exceed PAGE_SIZE */
1648         if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1649                 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1650                        payload)
1651                         payload--;
1652
1653         HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1654                    NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1655                    hpsb_speedto_str[scsi_id->speed_code],
1656                    SBP2_PAYLOAD_TO_BYTES(payload));
1657
1658         scsi_id->max_payload_size = payload;
1659         return 0;
1660 }
1661
1662 /*
1663  * This function is called in order to perform a SBP-2 agent reset.
1664  */
1665 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1666 {
1667         quadlet_t data;
1668         u64 addr;
1669         int retval;
1670         unsigned long flags;
1671
1672         SBP2_DEBUG_ENTER();
1673
1674         data = ntohl(SBP2_AGENT_RESET_DATA);
1675         addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1676
1677         if (wait)
1678                 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1679         else
1680                 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1681
1682         if (retval < 0) {
1683                 SBP2_ERR("hpsb_node_write failed.\n");
1684                 return -EIO;
1685         }
1686
1687         /*
1688          * Need to make sure orb pointer is written on next command
1689          */
1690         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1691         scsi_id->last_orb = NULL;
1692         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1693
1694         return 0;
1695 }
1696
1697 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1698                                      struct sbp2scsi_host_info *hi,
1699                                      struct sbp2_command_info *command,
1700                                      unsigned int scsi_use_sg,
1701                                      struct scatterlist *sgpnt,
1702                                      u32 orb_direction,
1703                                      enum dma_data_direction dma_dir)
1704 {
1705         command->dma_dir = dma_dir;
1706         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1707         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1708
1709         /* Special case if only one element (and less than 64KB in size) */
1710         if ((scsi_use_sg == 1) &&
1711             (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1712
1713                 SBP2_DEBUG("Only one s/g element");
1714                 command->dma_size = sgpnt[0].length;
1715                 command->dma_type = CMD_DMA_PAGE;
1716                 command->cmd_dma = pci_map_page(hi->host->pdev,
1717                                                 sgpnt[0].page,
1718                                                 sgpnt[0].offset,
1719                                                 command->dma_size,
1720                                                 command->dma_dir);
1721                 SBP2_DMA_ALLOC("single page scatter element");
1722
1723                 orb->data_descriptor_lo = command->cmd_dma;
1724                 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1725
1726         } else {
1727                 struct sbp2_unrestricted_page_table *sg_element =
1728                                         &command->scatter_gather_element[0];
1729                 u32 sg_count, sg_len;
1730                 dma_addr_t sg_addr;
1731                 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1732                                           dma_dir);
1733
1734                 SBP2_DMA_ALLOC("scatter list");
1735
1736                 command->dma_size = scsi_use_sg;
1737                 command->sge_buffer = sgpnt;
1738
1739                 /* use page tables (s/g) */
1740                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1741                 orb->data_descriptor_lo = command->sge_dma;
1742
1743                 /*
1744                  * Loop through and fill out our sbp-2 page tables
1745                  * (and split up anything too large)
1746                  */
1747                 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1748                         sg_len = sg_dma_len(sgpnt);
1749                         sg_addr = sg_dma_address(sgpnt);
1750                         while (sg_len) {
1751                                 sg_element[sg_count].segment_base_lo = sg_addr;
1752                                 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1753                                         sg_element[sg_count].length_segment_base_hi =
1754                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1755                                         sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1756                                         sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1757                                 } else {
1758                                         sg_element[sg_count].length_segment_base_hi =
1759                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1760                                         sg_len = 0;
1761                                 }
1762                                 sg_count++;
1763                         }
1764                 }
1765
1766                 /* Number of page table (s/g) elements */
1767                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1768
1769                 sbp2util_packet_dump(sg_element,
1770                                      (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1771                                      "sbp2 s/g list", command->sge_dma);
1772
1773                 /* Byte swap page tables if necessary */
1774                 sbp2util_cpu_to_be32_buffer(sg_element,
1775                                             (sizeof(struct sbp2_unrestricted_page_table)) *
1776                                             sg_count);
1777         }
1778 }
1779
1780 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1781                                         struct sbp2scsi_host_info *hi,
1782                                         struct sbp2_command_info *command,
1783                                         struct scatterlist *sgpnt,
1784                                         u32 orb_direction,
1785                                         unsigned int scsi_request_bufflen,
1786                                         void *scsi_request_buffer,
1787                                         enum dma_data_direction dma_dir)
1788 {
1789         command->dma_dir = dma_dir;
1790         command->dma_size = scsi_request_bufflen;
1791         command->dma_type = CMD_DMA_SINGLE;
1792         command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1793                                           command->dma_size, command->dma_dir);
1794         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1795         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1796
1797         SBP2_DMA_ALLOC("single bulk");
1798
1799         /*
1800          * Handle case where we get a command w/o s/g enabled (but
1801          * check for transfers larger than 64K)
1802          */
1803         if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1804
1805                 orb->data_descriptor_lo = command->cmd_dma;
1806                 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1807
1808         } else {
1809                 struct sbp2_unrestricted_page_table *sg_element =
1810                         &command->scatter_gather_element[0];
1811                 u32 sg_count, sg_len;
1812                 dma_addr_t sg_addr;
1813
1814                 /*
1815                  * Need to turn this into page tables, since the
1816                  * buffer is too large.
1817                  */
1818                 orb->data_descriptor_lo = command->sge_dma;
1819
1820                 /* Use page tables (s/g) */
1821                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1822
1823                 /*
1824                  * fill out our sbp-2 page tables (and split up
1825                  * the large buffer)
1826                  */
1827                 sg_count = 0;
1828                 sg_len = scsi_request_bufflen;
1829                 sg_addr = command->cmd_dma;
1830                 while (sg_len) {
1831                         sg_element[sg_count].segment_base_lo = sg_addr;
1832                         if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1833                                 sg_element[sg_count].length_segment_base_hi =
1834                                         PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1835                                 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1836                                 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1837                         } else {
1838                                 sg_element[sg_count].length_segment_base_hi =
1839                                         PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1840                                 sg_len = 0;
1841                         }
1842                         sg_count++;
1843                 }
1844
1845                 /* Number of page table (s/g) elements */
1846                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1847
1848                 sbp2util_packet_dump(sg_element,
1849                                      (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1850                                      "sbp2 s/g list", command->sge_dma);
1851
1852                 /* Byte swap page tables if necessary */
1853                 sbp2util_cpu_to_be32_buffer(sg_element,
1854                                             (sizeof(struct sbp2_unrestricted_page_table)) *
1855                                              sg_count);
1856         }
1857 }
1858
1859 /*
1860  * This function is called to create the actual command orb and s/g list
1861  * out of the scsi command itself.
1862  */
1863 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1864                                     struct sbp2_command_info *command,
1865                                     unchar *scsi_cmd,
1866                                     unsigned int scsi_use_sg,
1867                                     unsigned int scsi_request_bufflen,
1868                                     void *scsi_request_buffer,
1869                                     enum dma_data_direction dma_dir)
1870 {
1871         struct sbp2scsi_host_info *hi = scsi_id->hi;
1872         struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1873         struct sbp2_command_orb *command_orb = &command->command_orb;
1874         u32 orb_direction;
1875
1876         /*
1877          * Set-up our command ORB..
1878          *
1879          * NOTE: We're doing unrestricted page tables (s/g), as this is
1880          * best performance (at least with the devices I have). This means
1881          * that data_size becomes the number of s/g elements, and
1882          * page_size should be zero (for unrestricted).
1883          */
1884         command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1885         command_orb->next_ORB_lo = 0x0;
1886         command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1887         command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1888         command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1889
1890         if (dma_dir == DMA_NONE)
1891                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1892         else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1893                 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1894         else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1895                 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1896         else {
1897                 SBP2_WARN("Falling back to DMA_NONE");
1898                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1899         }
1900
1901         /* Set-up our pagetable stuff */
1902         if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1903                 SBP2_DEBUG("No data transfer");
1904                 command_orb->data_descriptor_hi = 0x0;
1905                 command_orb->data_descriptor_lo = 0x0;
1906                 command_orb->misc |= ORB_SET_DIRECTION(1);
1907         } else if (scsi_use_sg) {
1908                 SBP2_DEBUG("Use scatter/gather");
1909                 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1910                                          sgpnt, orb_direction, dma_dir);
1911         } else {
1912                 SBP2_DEBUG("No scatter/gather");
1913                 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1914                                             orb_direction, scsi_request_bufflen,
1915                                             scsi_request_buffer, dma_dir);
1916         }
1917
1918         /* Byte swap command ORB if necessary */
1919         sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1920
1921         /* Put our scsi command in the command ORB */
1922         memset(command_orb->cdb, 0, 12);
1923         memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1924 }
1925
1926 /*
1927  * This function is called in order to begin a regular SBP-2 command.
1928  */
1929 static void sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1930                                  struct sbp2_command_info *command)
1931 {
1932         struct sbp2scsi_host_info *hi = scsi_id->hi;
1933         struct sbp2_command_orb *command_orb = &command->command_orb;
1934         struct sbp2_command_orb *last_orb;
1935         dma_addr_t last_orb_dma;
1936         u64 addr = scsi_id->sbp2_command_block_agent_addr;
1937         quadlet_t data[2];
1938         size_t length;
1939         unsigned long flags;
1940
1941         outstanding_orb_incr;
1942         SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1943                        command_orb, global_outstanding_command_orbs);
1944
1945         pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1946                                        sizeof(struct sbp2_command_orb),
1947                                        PCI_DMA_TODEVICE);
1948         pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1949                                        sizeof(command->scatter_gather_element),
1950                                        PCI_DMA_BIDIRECTIONAL);
1951         /*
1952          * Check to see if there are any previous orbs to use
1953          */
1954         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1955         last_orb = scsi_id->last_orb;
1956         last_orb_dma = scsi_id->last_orb_dma;
1957         if (!last_orb) {
1958                 /*
1959                  * last_orb == NULL means: We know that the target's fetch agent
1960                  * is not active right now.
1961                  */
1962                 addr += SBP2_ORB_POINTER_OFFSET;
1963                 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1964                 data[1] = command->command_orb_dma;
1965                 sbp2util_cpu_to_be32_buffer(data, 8);
1966                 length = 8;
1967         } else {
1968                 /*
1969                  * last_orb != NULL means: We know that the target's fetch agent
1970                  * is (very probably) not dead or in reset state right now.
1971                  * We have an ORB already sent that we can append a new one to.
1972                  * The target's fetch agent may or may not have read this
1973                  * previous ORB yet.
1974                  */
1975                 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
1976                                             sizeof(struct sbp2_command_orb),
1977                                             PCI_DMA_TODEVICE);
1978                 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
1979                 wmb();
1980                 /* Tells hardware that this pointer is valid */
1981                 last_orb->next_ORB_hi = 0;
1982                 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
1983                                                sizeof(struct sbp2_command_orb),
1984                                                PCI_DMA_TODEVICE);
1985                 addr += SBP2_DOORBELL_OFFSET;
1986                 data[0] = 0;
1987                 length = 4;
1988         }
1989         scsi_id->last_orb = command_orb;
1990         scsi_id->last_orb_dma = command->command_orb_dma;
1991         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1992
1993         SBP2_ORB_DEBUG("write to %s register, command orb %p",
1994                         last_orb ? "DOORBELL" : "ORB_POINTER", command_orb);
1995         if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length))
1996                 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1997         /* We rely on SCSI EH to deal with _node_write_ failures. */
1998 }
1999
2000 /*
2001  * This function is called in order to begin a regular SBP-2 command.
2002  */
2003 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2004                              struct scsi_cmnd *SCpnt,
2005                              void (*done)(struct scsi_cmnd *))
2006 {
2007         unchar *cmd = (unchar *) SCpnt->cmnd;
2008         unsigned int request_bufflen = SCpnt->request_bufflen;
2009         struct sbp2_command_info *command;
2010
2011         SBP2_DEBUG_ENTER();
2012         SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2013         SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2014
2015         /*
2016          * Allocate a command orb and s/g structure
2017          */
2018         command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2019         if (!command) {
2020                 return -EIO;
2021         }
2022
2023         /*
2024          * Now actually fill in the comamnd orb and sbp2 s/g list
2025          */
2026         sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2027                                 request_bufflen, SCpnt->request_buffer,
2028                                 SCpnt->sc_data_direction);
2029
2030         sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2031                              "sbp2 command orb", command->command_orb_dma);
2032
2033         /*
2034          * Link up the orb, and ring the doorbell if needed
2035          */
2036         sbp2_link_orb_command(scsi_id, command);
2037
2038         return 0;
2039 }
2040
2041 /*
2042  * Translates SBP-2 status into SCSI sense data for check conditions
2043  */
2044 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2045 {
2046         SBP2_DEBUG_ENTER();
2047
2048         /*
2049          * Ok, it's pretty ugly...   ;-)
2050          */
2051         sense_data[0] = 0x70;
2052         sense_data[1] = 0x0;
2053         sense_data[2] = sbp2_status[9];
2054         sense_data[3] = sbp2_status[12];
2055         sense_data[4] = sbp2_status[13];
2056         sense_data[5] = sbp2_status[14];
2057         sense_data[6] = sbp2_status[15];
2058         sense_data[7] = 10;
2059         sense_data[8] = sbp2_status[16];
2060         sense_data[9] = sbp2_status[17];
2061         sense_data[10] = sbp2_status[18];
2062         sense_data[11] = sbp2_status[19];
2063         sense_data[12] = sbp2_status[10];
2064         sense_data[13] = sbp2_status[11];
2065         sense_data[14] = sbp2_status[20];
2066         sense_data[15] = sbp2_status[21];
2067
2068         return sbp2_status[8] & 0x3f;   /* return scsi status */
2069 }
2070
2071 /*
2072  * This function deals with status writes from the SBP-2 device
2073  */
2074 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
2075                                     int destid, quadlet_t *data, u64 addr,
2076                                     size_t length, u16 fl)
2077 {
2078         struct sbp2scsi_host_info *hi;
2079         struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2080         struct scsi_cmnd *SCpnt = NULL;
2081         struct sbp2_status_block *sb;
2082         u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2083         struct sbp2_command_info *command;
2084         unsigned long flags;
2085
2086         SBP2_DEBUG_ENTER();
2087
2088         sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2089
2090         if (unlikely(length < 8 || length > sizeof(struct sbp2_status_block))) {
2091                 SBP2_ERR("Wrong size of status block");
2092                 return RCODE_ADDRESS_ERROR;
2093         }
2094         if (unlikely(!host)) {
2095                 SBP2_ERR("host is NULL - this is bad!");
2096                 return RCODE_ADDRESS_ERROR;
2097         }
2098         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2099         if (unlikely(!hi)) {
2100                 SBP2_ERR("host info is NULL - this is bad!");
2101                 return RCODE_ADDRESS_ERROR;
2102         }
2103         /*
2104          * Find our scsi_id structure by looking at the status fifo address
2105          * written to by the sbp2 device.
2106          */
2107         list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2108                 if (scsi_id_tmp->ne->nodeid == nodeid &&
2109                     scsi_id_tmp->status_fifo_addr == addr) {
2110                         scsi_id = scsi_id_tmp;
2111                         break;
2112                 }
2113         }
2114         if (unlikely(!scsi_id)) {
2115                 SBP2_ERR("scsi_id is NULL - device is gone?");
2116                 return RCODE_ADDRESS_ERROR;
2117         }
2118
2119         /*
2120          * Put response into scsi_id status fifo buffer. The first two bytes
2121          * come in big endian bit order. Often the target writes only a
2122          * truncated status block, minimally the first two quadlets. The rest
2123          * is implied to be zeros.
2124          */
2125         sb = &scsi_id->status_block;
2126         memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
2127         memcpy(sb, data, length);
2128         sbp2util_be32_to_cpu_buffer(sb, 8);
2129
2130         /*
2131          * Ignore unsolicited status. Handle command ORB status.
2132          */
2133         if (unlikely(STATUS_GET_SRC(sb->ORB_offset_hi_misc) == 2))
2134                 command = NULL;
2135         else
2136                 command = sbp2util_find_command_for_orb(scsi_id,
2137                                                         sb->ORB_offset_lo);
2138         if (command) {
2139                 SBP2_DEBUG("Found status for command ORB");
2140                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2141                                             sizeof(struct sbp2_command_orb),
2142                                             PCI_DMA_TODEVICE);
2143                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2144                                             sizeof(command->scatter_gather_element),
2145                                             PCI_DMA_BIDIRECTIONAL);
2146
2147                 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2148                 outstanding_orb_decr;
2149
2150                 /*
2151                  * Matched status with command, now grab scsi command pointers
2152                  * and check status.
2153                  */
2154                 /*
2155                  * FIXME: If the src field in the status is 1, the ORB DMA must
2156                  * not be reused until status for a subsequent ORB is received.
2157                  */
2158                 SCpnt = command->Current_SCpnt;
2159                 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2160                 sbp2util_mark_command_completed(scsi_id, command);
2161                 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2162
2163                 if (SCpnt) {
2164                         if (STATUS_TEST_RS(sb->ORB_offset_hi_misc))
2165                                 scsi_status =
2166                                         SBP2_SCSI_STATUS_COMMAND_TERMINATED;
2167                         /*
2168                          * See if the target stored any scsi status information.
2169                          */
2170                         if (STATUS_GET_LEN(sb->ORB_offset_hi_misc) > 1) {
2171                                 SBP2_DEBUG("CHECK CONDITION");
2172                                 scsi_status = sbp2_status_to_sense_data(
2173                                         (unchar *)sb, SCpnt->sense_buffer);
2174                         }
2175
2176                         /*
2177                          * Check to see if the dead bit is set. If so, we'll
2178                          * have to initiate a fetch agent reset.
2179                          */
2180                         if (STATUS_TEST_D(sb->ORB_offset_hi_misc)) {
2181                                 SBP2_DEBUG("Dead bit set - "
2182                                            "initiating fetch agent reset");
2183                                 sbp2_agent_reset(scsi_id, 0);
2184                         }
2185
2186                         SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2187                 }
2188
2189                 /*
2190                  * Check here to see if there are no commands in-use. If there
2191                  * are none, we know that the fetch agent left the active state
2192                  * _and_ that we did not reactivate it yet. Therefore clear
2193                  * last_orb so that next time we write directly to the
2194                  * ORB_POINTER register. That way the fetch agent does not need
2195                  * to refetch the next_ORB.
2196                  */
2197                 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2198                 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
2199                         scsi_id->last_orb = NULL;
2200                 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2201
2202         } else {
2203                 /*
2204                  * It's probably a login/logout/reconnect status.
2205                  */
2206                 if ((sb->ORB_offset_lo == scsi_id->reconnect_orb_dma) ||
2207                     (sb->ORB_offset_lo == scsi_id->login_orb_dma) ||
2208                     (sb->ORB_offset_lo == scsi_id->query_logins_orb_dma) ||
2209                     (sb->ORB_offset_lo == scsi_id->logout_orb_dma)) {
2210                         scsi_id->access_complete = 1;
2211                         wake_up_interruptible(&access_wq);
2212                 }
2213         }
2214
2215         if (SCpnt) {
2216                 SBP2_DEBUG("Completing SCSI command");
2217                 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2218                                           command->Current_done);
2219                 SBP2_ORB_DEBUG("command orb completed");
2220         }
2221
2222         return RCODE_COMPLETE;
2223 }
2224
2225 /**************************************
2226  * SCSI interface related section
2227  **************************************/
2228
2229 /*
2230  * This routine is the main request entry routine for doing I/O. It is
2231  * called from the scsi stack directly.
2232  */
2233 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2234                                  void (*done)(struct scsi_cmnd *))
2235 {
2236         struct scsi_id_instance_data *scsi_id =
2237                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2238         struct sbp2scsi_host_info *hi;
2239         int result = DID_NO_CONNECT << 16;
2240
2241         SBP2_DEBUG_ENTER();
2242 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2243         scsi_print_command(SCpnt);
2244 #endif
2245
2246         if (!sbp2util_node_is_available(scsi_id))
2247                 goto done;
2248
2249         hi = scsi_id->hi;
2250
2251         if (!hi) {
2252                 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2253                 goto done;
2254         }
2255
2256         /*
2257          * Until we handle multiple luns, just return selection time-out
2258          * to any IO directed at non-zero LUNs
2259          */
2260         if (SCpnt->device->lun)
2261                 goto done;
2262
2263         /*
2264          * Check for request sense command, and handle it here
2265          * (autorequest sense)
2266          */
2267         if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2268                 SBP2_DEBUG("REQUEST_SENSE");
2269                 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2270                 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2271                 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2272                 return 0;
2273         }
2274
2275         /*
2276          * Check to see if we are in the middle of a bus reset.
2277          */
2278         if (!hpsb_node_entry_valid(scsi_id->ne)) {
2279                 SBP2_ERR("Bus reset in progress - rejecting command");
2280                 result = DID_BUS_BUSY << 16;
2281                 goto done;
2282         }
2283
2284         /*
2285          * Bidirectional commands are not yet implemented,
2286          * and unknown transfer direction not handled.
2287          */
2288         if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2289                 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2290                 result = DID_ERROR << 16;
2291                 goto done;
2292         }
2293
2294         /*
2295          * Try and send our SCSI command
2296          */
2297         if (sbp2_send_command(scsi_id, SCpnt, done)) {
2298                 SBP2_ERR("Error sending SCSI command");
2299                 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2300                                           SCpnt, done);
2301         }
2302         return 0;
2303
2304 done:
2305         SCpnt->result = result;
2306         done(SCpnt);
2307         return 0;
2308 }
2309
2310 /*
2311  * This function is called in order to complete all outstanding SBP-2
2312  * commands (in case of resets, etc.).
2313  */
2314 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2315                                            u32 status)
2316 {
2317         struct sbp2scsi_host_info *hi = scsi_id->hi;
2318         struct list_head *lh;
2319         struct sbp2_command_info *command;
2320         unsigned long flags;
2321
2322         SBP2_DEBUG_ENTER();
2323
2324         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2325         while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2326                 SBP2_DEBUG("Found pending command to complete");
2327                 lh = scsi_id->sbp2_command_orb_inuse.next;
2328                 command = list_entry(lh, struct sbp2_command_info, list);
2329                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2330                                             sizeof(struct sbp2_command_orb),
2331                                             PCI_DMA_TODEVICE);
2332                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2333                                             sizeof(command->scatter_gather_element),
2334                                             PCI_DMA_BIDIRECTIONAL);
2335                 sbp2util_mark_command_completed(scsi_id, command);
2336                 if (command->Current_SCpnt) {
2337                         command->Current_SCpnt->result = status << 16;
2338                         command->Current_done(command->Current_SCpnt);
2339                 }
2340         }
2341         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2342
2343         return;
2344 }
2345
2346 /*
2347  * This function is called in order to complete a regular SBP-2 command.
2348  *
2349  * This can be called in interrupt context.
2350  */
2351 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2352                                       u32 scsi_status, struct scsi_cmnd *SCpnt,
2353                                       void (*done)(struct scsi_cmnd *))
2354 {
2355         SBP2_DEBUG_ENTER();
2356
2357         /*
2358          * Sanity
2359          */
2360         if (!SCpnt) {
2361                 SBP2_ERR("SCpnt is NULL");
2362                 return;
2363         }
2364
2365         /*
2366          * If a bus reset is in progress and there was an error, don't
2367          * complete the command, just let it get retried at the end of the
2368          * bus reset.
2369          */
2370         if (!hpsb_node_entry_valid(scsi_id->ne)
2371             && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2372                 SBP2_ERR("Bus reset in progress - retry command later");
2373                 return;
2374         }
2375
2376         /*
2377          * Switch on scsi status
2378          */
2379         switch (scsi_status) {
2380         case SBP2_SCSI_STATUS_GOOD:
2381                 SCpnt->result = DID_OK << 16;
2382                 break;
2383
2384         case SBP2_SCSI_STATUS_BUSY:
2385                 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2386                 SCpnt->result = DID_BUS_BUSY << 16;
2387                 break;
2388
2389         case SBP2_SCSI_STATUS_CHECK_CONDITION:
2390                 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2391                 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2392 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2393                 scsi_print_command(SCpnt);
2394                 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
2395 #endif
2396                 break;
2397
2398         case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2399                 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2400                 SCpnt->result = DID_NO_CONNECT << 16;
2401                 scsi_print_command(SCpnt);
2402                 break;
2403
2404         case SBP2_SCSI_STATUS_CONDITION_MET:
2405         case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2406         case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2407                 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2408                 SCpnt->result = DID_ERROR << 16;
2409                 scsi_print_command(SCpnt);
2410                 break;
2411
2412         default:
2413                 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2414                 SCpnt->result = DID_ERROR << 16;
2415         }
2416
2417         /*
2418          * If a bus reset is in progress and there was an error, complete
2419          * the command as busy so that it will get retried.
2420          */
2421         if (!hpsb_node_entry_valid(scsi_id->ne)
2422             && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2423                 SBP2_ERR("Completing command with busy (bus reset)");
2424                 SCpnt->result = DID_BUS_BUSY << 16;
2425         }
2426
2427         /*
2428          * If a unit attention occurs, return busy status so it gets
2429          * retried... it could have happened because of a 1394 bus reset
2430          * or hot-plug...
2431          * XXX  DID_BUS_BUSY is actually a bad idea because it will defy
2432          * the scsi layer's retry logic.
2433          */
2434 #if 0
2435         if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2436             (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2437                 SBP2_DEBUG("UNIT ATTENTION - return busy");
2438                 SCpnt->result = DID_BUS_BUSY << 16;
2439         }
2440 #endif
2441
2442         /*
2443          * Tell scsi stack that we're done with this command
2444          */
2445         done(SCpnt);
2446 }
2447
2448 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2449 {
2450         struct scsi_id_instance_data *scsi_id =
2451                 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2452
2453         scsi_id->sdev = sdev;
2454
2455         if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2456                 sdev->inquiry_len = 36;
2457         return 0;
2458 }
2459
2460 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2461 {
2462         struct scsi_id_instance_data *scsi_id =
2463                 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2464
2465         blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2466         sdev->use_10_for_rw = 1;
2467         sdev->use_10_for_ms = 1;
2468
2469         if (sdev->type == TYPE_DISK &&
2470             scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2471                 sdev->skip_ms_page_8 = 1;
2472         if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2473                 sdev->fix_capacity = 1;
2474         if (scsi_id->ne->guid_vendor_id == 0x0010b9 && /* Maxtor's OUI */
2475             (sdev->type == TYPE_DISK || sdev->type == TYPE_RBC))
2476                 sdev->allow_restart = 1;
2477         return 0;
2478 }
2479
2480 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2481 {
2482         ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2483         return;
2484 }
2485
2486 /*
2487  * Called by scsi stack when something has really gone wrong.  Usually
2488  * called when a command has timed-out for some reason.
2489  */
2490 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2491 {
2492         struct scsi_id_instance_data *scsi_id =
2493                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2494         struct sbp2scsi_host_info *hi = scsi_id->hi;
2495         struct sbp2_command_info *command;
2496         unsigned long flags;
2497
2498         SBP2_ERR("aborting sbp2 command");
2499         scsi_print_command(SCpnt);
2500
2501         if (sbp2util_node_is_available(scsi_id)) {
2502
2503                 /*
2504                  * Right now, just return any matching command structures
2505                  * to the free pool.
2506                  */
2507                 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2508                 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2509                 if (command) {
2510                         SBP2_DEBUG("Found command to abort");
2511                         pci_dma_sync_single_for_cpu(hi->host->pdev,
2512                                                     command->command_orb_dma,
2513                                                     sizeof(struct sbp2_command_orb),
2514                                                     PCI_DMA_TODEVICE);
2515                         pci_dma_sync_single_for_cpu(hi->host->pdev,
2516                                                     command->sge_dma,
2517                                                     sizeof(command->scatter_gather_element),
2518                                                     PCI_DMA_BIDIRECTIONAL);
2519                         sbp2util_mark_command_completed(scsi_id, command);
2520                         if (command->Current_SCpnt) {
2521                                 command->Current_SCpnt->result = DID_ABORT << 16;
2522                                 command->Current_done(command->Current_SCpnt);
2523                         }
2524                 }
2525                 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2526
2527                 /*
2528                  * Initiate a fetch agent reset.
2529                  */
2530                 sbp2_agent_reset(scsi_id, 0);
2531                 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2532         }
2533
2534         return SUCCESS;
2535 }
2536
2537 /*
2538  * Called by scsi stack when something has really gone wrong.
2539  */
2540 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2541 {
2542         struct scsi_id_instance_data *scsi_id =
2543                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2544
2545         SBP2_ERR("reset requested");
2546
2547         if (sbp2util_node_is_available(scsi_id)) {
2548                 SBP2_ERR("Generating sbp2 fetch agent reset");
2549                 sbp2_agent_reset(scsi_id, 0);
2550         }
2551
2552         return SUCCESS;
2553 }
2554
2555 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2556                                            struct device_attribute *attr,
2557                                            char *buf)
2558 {
2559         struct scsi_device *sdev;
2560         struct scsi_id_instance_data *scsi_id;
2561         int lun;
2562
2563         if (!(sdev = to_scsi_device(dev)))
2564                 return 0;
2565
2566         if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2567                 return 0;
2568
2569         lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2570
2571         return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2572                        scsi_id->ud->id, lun);
2573 }
2574 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2575
2576 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2577         &dev_attr_ieee1394_id,
2578         NULL
2579 };
2580
2581 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2582 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2583 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2584 MODULE_LICENSE("GPL");
2585
2586 /* SCSI host template */
2587 static struct scsi_host_template scsi_driver_template = {
2588         .module =                       THIS_MODULE,
2589         .name =                         "SBP-2 IEEE-1394",
2590         .proc_name =                    SBP2_DEVICE_NAME,
2591         .queuecommand =                 sbp2scsi_queuecommand,
2592         .eh_abort_handler =             sbp2scsi_abort,
2593         .eh_device_reset_handler =      sbp2scsi_reset,
2594         .slave_alloc =                  sbp2scsi_slave_alloc,
2595         .slave_configure =              sbp2scsi_slave_configure,
2596         .slave_destroy =                sbp2scsi_slave_destroy,
2597         .this_id =                      -1,
2598         .sg_tablesize =                 SG_ALL,
2599         .use_clustering =               ENABLE_CLUSTERING,
2600         .cmd_per_lun =                  SBP2_MAX_CMDS,
2601         .can_queue =                    SBP2_MAX_CMDS,
2602         .emulated =                     1,
2603         .sdev_attrs =                   sbp2_sysfs_sdev_attrs,
2604 };
2605
2606 static int sbp2_module_init(void)
2607 {
2608         int ret;
2609
2610         SBP2_DEBUG_ENTER();
2611
2612         /* Module load debug option to force one command at a time (serializing I/O) */
2613         if (serialize_io) {
2614                 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2615                 SBP2_INFO("Try serialize_io=0 for better performance");
2616                 scsi_driver_template.can_queue = 1;
2617                 scsi_driver_template.cmd_per_lun = 1;
2618         }
2619
2620         if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2621             (max_sectors * 512) > (128 * 1024))
2622                 max_sectors = 128 * 1024 / 512;
2623         scsi_driver_template.max_sectors = max_sectors;
2624
2625         /* Register our high level driver with 1394 stack */
2626         hpsb_register_highlevel(&sbp2_highlevel);
2627
2628         ret = hpsb_register_protocol(&sbp2_driver);
2629         if (ret) {
2630                 SBP2_ERR("Failed to register protocol");
2631                 hpsb_unregister_highlevel(&sbp2_highlevel);
2632                 return ret;
2633         }
2634
2635         return 0;
2636 }
2637
2638 static void __exit sbp2_module_exit(void)
2639 {
2640         SBP2_DEBUG_ENTER();
2641
2642         hpsb_unregister_protocol(&sbp2_driver);
2643
2644         hpsb_unregister_highlevel(&sbp2_highlevel);
2645 }
2646
2647 module_init(sbp2_module_init);
2648 module_exit(sbp2_module_exit);