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