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