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