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