sbp2: proper treatment of DID_OK
[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 or not supported on host controller */
753                 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
754                                              &sbp2_physdma_ops,
755                                              0x0ULL, 0xfffffffcULL)) {
756                         SBP2_ERR("failed to register lower 4GB address range");
757                         goto failed_alloc;
758                 }
759 #endif
760         }
761
762         /* Prevent unloading of the 1394 host */
763         if (!try_module_get(hi->host->driver->owner)) {
764                 SBP2_ERR("failed to get a reference on 1394 host driver");
765                 goto failed_alloc;
766         }
767
768         scsi_id->hi = hi;
769
770         list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
771
772         /* Register the status FIFO address range. We could use the same FIFO
773          * for targets at different nodes. However we need different FIFOs per
774          * target in order to support multi-unit devices. */
775         scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
776                         &sbp2_highlevel, ud->ne->host, &sbp2_ops,
777                         sizeof(struct sbp2_status_block), sizeof(quadlet_t),
778                         ~0ULL, ~0ULL);
779         if (!scsi_id->status_fifo_addr) {
780                 SBP2_ERR("failed to allocate status FIFO address range");
781                 goto failed_alloc;
782         }
783
784         /* Register our host with the SCSI stack. */
785         scsi_host = scsi_host_alloc(&scsi_driver_template,
786                                     sizeof(unsigned long));
787         if (!scsi_host) {
788                 SBP2_ERR("failed to register scsi host");
789                 goto failed_alloc;
790         }
791
792         scsi_host->hostdata[0] = (unsigned long)scsi_id;
793
794         if (!scsi_add_host(scsi_host, &ud->device)) {
795                 scsi_id->scsi_host = scsi_host;
796                 return scsi_id;
797         }
798
799         SBP2_ERR("failed to add scsi host");
800         scsi_host_put(scsi_host);
801
802 failed_alloc:
803         sbp2_remove_device(scsi_id);
804         return NULL;
805 }
806
807 static void sbp2_host_reset(struct hpsb_host *host)
808 {
809         struct sbp2scsi_host_info *hi;
810         struct scsi_id_instance_data *scsi_id;
811
812         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
813
814         if (hi) {
815                 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
816                         scsi_block_requests(scsi_id->scsi_host);
817         }
818 }
819
820 /*
821  * This function is where we first pull the node unique ids, and then
822  * allocate memory and register a SBP-2 device.
823  */
824 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
825 {
826         struct sbp2scsi_host_info *hi = scsi_id->hi;
827         int error;
828
829         SBP2_DEBUG("sbp2_start_device");
830
831         /* Login FIFO DMA */
832         scsi_id->login_response =
833                 pci_alloc_consistent(hi->host->pdev,
834                                      sizeof(struct sbp2_login_response),
835                                      &scsi_id->login_response_dma);
836         if (!scsi_id->login_response)
837                 goto alloc_fail;
838         SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
839
840         /* Query logins ORB DMA */
841         scsi_id->query_logins_orb =
842                 pci_alloc_consistent(hi->host->pdev,
843                                      sizeof(struct sbp2_query_logins_orb),
844                                      &scsi_id->query_logins_orb_dma);
845         if (!scsi_id->query_logins_orb)
846                 goto alloc_fail;
847         SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
848
849         /* Query logins response DMA */
850         scsi_id->query_logins_response =
851                 pci_alloc_consistent(hi->host->pdev,
852                                      sizeof(struct sbp2_query_logins_response),
853                                      &scsi_id->query_logins_response_dma);
854         if (!scsi_id->query_logins_response)
855                 goto alloc_fail;
856         SBP2_DMA_ALLOC("consistent DMA region for query logins response");
857
858         /* Reconnect ORB DMA */
859         scsi_id->reconnect_orb =
860                 pci_alloc_consistent(hi->host->pdev,
861                                      sizeof(struct sbp2_reconnect_orb),
862                                      &scsi_id->reconnect_orb_dma);
863         if (!scsi_id->reconnect_orb)
864                 goto alloc_fail;
865         SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
866
867         /* Logout ORB DMA */
868         scsi_id->logout_orb =
869                 pci_alloc_consistent(hi->host->pdev,
870                                      sizeof(struct sbp2_logout_orb),
871                                      &scsi_id->logout_orb_dma);
872         if (!scsi_id->logout_orb)
873                 goto alloc_fail;
874         SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
875
876         /* Login ORB DMA */
877         scsi_id->login_orb =
878                 pci_alloc_consistent(hi->host->pdev,
879                                      sizeof(struct sbp2_login_orb),
880                                      &scsi_id->login_orb_dma);
881         if (!scsi_id->login_orb)
882                 goto alloc_fail;
883         SBP2_DMA_ALLOC("consistent DMA region for login ORB");
884
885         SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
886
887         /*
888          * Create our command orb pool
889          */
890         if (sbp2util_create_command_orb_pool(scsi_id)) {
891                 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
892                 sbp2_remove_device(scsi_id);
893                 return -ENOMEM;
894         }
895
896         /* Schedule a timeout here. The reason is that we may be so close
897          * to a bus reset, that the device is not available for logins.
898          * This can happen when the bus reset is caused by the host
899          * connected to the sbp2 device being removed. That host would
900          * have a certain amount of time to relogin before the sbp2 device
901          * allows someone else to login instead. One second makes sense. */
902         msleep_interruptible(1000);
903         if (signal_pending(current)) {
904                 SBP2_WARN("aborting sbp2_start_device due to event");
905                 sbp2_remove_device(scsi_id);
906                 return -EINTR;
907         }
908
909         /*
910          * Login to the sbp-2 device
911          */
912         if (sbp2_login_device(scsi_id)) {
913                 /* Login failed, just remove the device. */
914                 sbp2_remove_device(scsi_id);
915                 return -EBUSY;
916         }
917
918         /*
919          * Set max retries to something large on the device
920          */
921         sbp2_set_busy_timeout(scsi_id);
922
923         /*
924          * Do a SBP-2 fetch agent reset
925          */
926         sbp2_agent_reset(scsi_id, 1);
927
928         /*
929          * Get the max speed and packet size that we can use
930          */
931         sbp2_max_speed_and_size(scsi_id);
932
933         /* Add this device to the scsi layer now */
934         error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
935         if (error) {
936                 SBP2_ERR("scsi_add_device failed");
937                 sbp2_logout_device(scsi_id);
938                 sbp2_remove_device(scsi_id);
939                 return error;
940         }
941
942         return 0;
943
944 alloc_fail:
945         SBP2_ERR("Could not allocate memory for scsi_id");
946         sbp2_remove_device(scsi_id);
947         return -ENOMEM;
948 }
949
950 /*
951  * This function removes an sbp2 device from the sbp2scsi_host_info struct.
952  */
953 static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
954 {
955         struct sbp2scsi_host_info *hi;
956
957         SBP2_DEBUG("sbp2_remove_device");
958
959         if (!scsi_id)
960                 return;
961
962         hi = scsi_id->hi;
963
964         /* This will remove our scsi device aswell */
965         if (scsi_id->scsi_host) {
966                 scsi_remove_host(scsi_id->scsi_host);
967                 scsi_host_put(scsi_id->scsi_host);
968         }
969
970         sbp2util_remove_command_orb_pool(scsi_id);
971
972         list_del(&scsi_id->scsi_list);
973
974         if (scsi_id->login_response) {
975                 pci_free_consistent(hi->host->pdev,
976                                     sizeof(struct sbp2_login_response),
977                                     scsi_id->login_response,
978                                     scsi_id->login_response_dma);
979                 SBP2_DMA_FREE("single login FIFO");
980         }
981
982         if (scsi_id->login_orb) {
983                 pci_free_consistent(hi->host->pdev,
984                                     sizeof(struct sbp2_login_orb),
985                                     scsi_id->login_orb,
986                                     scsi_id->login_orb_dma);
987                 SBP2_DMA_FREE("single login ORB");
988         }
989
990         if (scsi_id->reconnect_orb) {
991                 pci_free_consistent(hi->host->pdev,
992                                     sizeof(struct sbp2_reconnect_orb),
993                                     scsi_id->reconnect_orb,
994                                     scsi_id->reconnect_orb_dma);
995                 SBP2_DMA_FREE("single reconnect orb");
996         }
997
998         if (scsi_id->logout_orb) {
999                 pci_free_consistent(hi->host->pdev,
1000                                     sizeof(struct sbp2_logout_orb),
1001                                     scsi_id->logout_orb,
1002                                     scsi_id->logout_orb_dma);
1003                 SBP2_DMA_FREE("single logout orb");
1004         }
1005
1006         if (scsi_id->query_logins_orb) {
1007                 pci_free_consistent(hi->host->pdev,
1008                                     sizeof(struct sbp2_query_logins_orb),
1009                                     scsi_id->query_logins_orb,
1010                                     scsi_id->query_logins_orb_dma);
1011                 SBP2_DMA_FREE("single query logins orb");
1012         }
1013
1014         if (scsi_id->query_logins_response) {
1015                 pci_free_consistent(hi->host->pdev,
1016                                     sizeof(struct sbp2_query_logins_response),
1017                                     scsi_id->query_logins_response,
1018                                     scsi_id->query_logins_response_dma);
1019                 SBP2_DMA_FREE("single query logins data");
1020         }
1021
1022         if (scsi_id->status_fifo_addr)
1023                 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
1024                         scsi_id->status_fifo_addr);
1025
1026         scsi_id->ud->device.driver_data = NULL;
1027
1028         if (hi)
1029                 module_put(hi->host->driver->owner);
1030
1031         SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1032
1033         kfree(scsi_id);
1034 }
1035
1036 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1037 /*
1038  * This function deals with physical dma write requests (for adapters that do not support
1039  * physical dma in hardware). Mostly just here for debugging...
1040  */
1041 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1042                                      int destid, quadlet_t *data, u64 addr,
1043                                      size_t length, u16 flags)
1044 {
1045
1046         /*
1047          * Manually put the data in the right place.
1048          */
1049         memcpy(bus_to_virt((u32) addr), data, length);
1050         sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1051                              (u32) addr);
1052         return RCODE_COMPLETE;
1053 }
1054
1055 /*
1056  * This function deals with physical dma read requests (for adapters that do not support
1057  * physical dma in hardware). Mostly just here for debugging...
1058  */
1059 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1060                                     quadlet_t *data, u64 addr, size_t length,
1061                                     u16 flags)
1062 {
1063
1064         /*
1065          * Grab data from memory and send a read response.
1066          */
1067         memcpy(data, bus_to_virt((u32) addr), length);
1068         sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1069                              (u32) addr);
1070         return RCODE_COMPLETE;
1071 }
1072 #endif
1073
1074 /**************************************
1075  * SBP-2 protocol related section
1076  **************************************/
1077
1078 /*
1079  * This function queries the device for the maximum concurrent logins it
1080  * supports.
1081  */
1082 static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1083 {
1084         struct sbp2scsi_host_info *hi = scsi_id->hi;
1085         quadlet_t data[2];
1086         int max_logins;
1087         int active_logins;
1088
1089         SBP2_DEBUG("sbp2_query_logins");
1090
1091         scsi_id->query_logins_orb->reserved1 = 0x0;
1092         scsi_id->query_logins_orb->reserved2 = 0x0;
1093
1094         scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1095         scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1096         SBP2_DEBUG("sbp2_query_logins: query_response_hi/lo initialized");
1097
1098         scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1099         scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1100         scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1101         SBP2_DEBUG("sbp2_query_logins: lun_misc initialized");
1102
1103         scsi_id->query_logins_orb->reserved_resp_length =
1104                 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1105         SBP2_DEBUG("sbp2_query_logins: reserved_resp_length initialized");
1106
1107         scsi_id->query_logins_orb->status_fifo_hi =
1108                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1109         scsi_id->query_logins_orb->status_fifo_lo =
1110                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1111
1112         sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1113
1114         SBP2_DEBUG("sbp2_query_logins: orb byte-swapped");
1115
1116         sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1117                              "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1118
1119         memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1120         memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1121
1122         SBP2_DEBUG("sbp2_query_logins: query_logins_response/status FIFO memset");
1123
1124         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1125         data[1] = scsi_id->query_logins_orb_dma;
1126         sbp2util_cpu_to_be32_buffer(data, 8);
1127
1128         atomic_set(&scsi_id->sbp2_login_complete, 0);
1129
1130         SBP2_DEBUG("sbp2_query_logins: prepared to write");
1131         hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1132         SBP2_DEBUG("sbp2_query_logins: written");
1133
1134         if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1135                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1136                 return -EIO;
1137         }
1138
1139         if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1140                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1141                 return -EIO;
1142         }
1143
1144         if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1145             STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1146             STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1147
1148                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1149                 return -EIO;
1150         }
1151
1152         sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1153
1154         SBP2_DEBUG("length_max_logins = %x",
1155                    (unsigned int)scsi_id->query_logins_response->length_max_logins);
1156
1157         SBP2_DEBUG("Query logins to SBP-2 device successful");
1158
1159         max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
1160         SBP2_DEBUG("Maximum concurrent logins supported: %d", max_logins);
1161
1162         active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
1163         SBP2_DEBUG("Number of active logins: %d", active_logins);
1164
1165         if (active_logins >= max_logins) {
1166                 return -EIO;
1167         }
1168
1169         return 0;
1170 }
1171
1172 /*
1173  * This function is called in order to login to a particular SBP-2 device,
1174  * after a bus reset.
1175  */
1176 static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1177 {
1178         struct sbp2scsi_host_info *hi = scsi_id->hi;
1179         quadlet_t data[2];
1180
1181         SBP2_DEBUG("sbp2_login_device");
1182
1183         if (!scsi_id->login_orb) {
1184                 SBP2_DEBUG("sbp2_login_device: login_orb not alloc'd!");
1185                 return -EIO;
1186         }
1187
1188         if (!exclusive_login) {
1189                 if (sbp2_query_logins(scsi_id)) {
1190                         SBP2_INFO("Device does not support any more concurrent logins");
1191                         return -EIO;
1192                 }
1193         }
1194
1195         /* Set-up login ORB, assume no password */
1196         scsi_id->login_orb->password_hi = 0;
1197         scsi_id->login_orb->password_lo = 0;
1198         SBP2_DEBUG("sbp2_login_device: password_hi/lo initialized");
1199
1200         scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1201         scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1202         SBP2_DEBUG("sbp2_login_device: login_response_hi/lo initialized");
1203
1204         scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1205         scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0);   /* One second reconnect time */
1206         scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login);     /* Exclusive access to device */
1207         scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1);      /* Notify us of login complete */
1208         scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1209         SBP2_DEBUG("sbp2_login_device: lun_misc initialized");
1210
1211         scsi_id->login_orb->passwd_resp_lengths =
1212                 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1213         SBP2_DEBUG("sbp2_login_device: passwd_resp_lengths initialized");
1214
1215         scsi_id->login_orb->status_fifo_hi =
1216                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1217         scsi_id->login_orb->status_fifo_lo =
1218                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1219
1220         /*
1221          * Byte swap ORB if necessary
1222          */
1223         sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1224
1225         SBP2_DEBUG("sbp2_login_device: orb byte-swapped");
1226
1227         sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1228                              "sbp2 login orb", scsi_id->login_orb_dma);
1229
1230         /*
1231          * Initialize login response and status fifo
1232          */
1233         memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1234         memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1235
1236         SBP2_DEBUG("sbp2_login_device: login_response/status FIFO memset");
1237
1238         /*
1239          * Ok, let's write to the target's management agent register
1240          */
1241         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1242         data[1] = scsi_id->login_orb_dma;
1243         sbp2util_cpu_to_be32_buffer(data, 8);
1244
1245         atomic_set(&scsi_id->sbp2_login_complete, 0);
1246
1247         SBP2_DEBUG("sbp2_login_device: prepared to write to %08x",
1248                    (unsigned int)scsi_id->sbp2_management_agent_addr);
1249         hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1250         SBP2_DEBUG("sbp2_login_device: written");
1251
1252         /*
1253          * Wait for login status (up to 20 seconds)...
1254          */
1255         if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1256                 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1257                 return -EIO;
1258         }
1259
1260         /*
1261          * Sanity. Make sure status returned matches login orb.
1262          */
1263         if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1264                 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
1265                 return -EIO;
1266         }
1267
1268         /*
1269          * Check status
1270          */
1271         if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1272             STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1273             STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1274
1275                 SBP2_ERR("Error logging into SBP-2 device - login failed");
1276                 return -EIO;
1277         }
1278
1279         /*
1280          * Byte swap the login response, for use when reconnecting or
1281          * logging out.
1282          */
1283         sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1284
1285         /*
1286          * Grab our command block agent address from the login response.
1287          */
1288         SBP2_DEBUG("command_block_agent_hi = %x",
1289                    (unsigned int)scsi_id->login_response->command_block_agent_hi);
1290         SBP2_DEBUG("command_block_agent_lo = %x",
1291                    (unsigned int)scsi_id->login_response->command_block_agent_lo);
1292
1293         scsi_id->sbp2_command_block_agent_addr =
1294                 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1295         scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1296         scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1297
1298         SBP2_INFO("Logged into SBP-2 device");
1299
1300         return 0;
1301
1302 }
1303
1304 /*
1305  * This function is called in order to logout from a particular SBP-2
1306  * device, usually called during driver unload.
1307  */
1308 static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1309 {
1310         struct sbp2scsi_host_info *hi = scsi_id->hi;
1311         quadlet_t data[2];
1312         int error;
1313
1314         SBP2_DEBUG("sbp2_logout_device");
1315
1316         /*
1317          * Set-up logout ORB
1318          */
1319         scsi_id->logout_orb->reserved1 = 0x0;
1320         scsi_id->logout_orb->reserved2 = 0x0;
1321         scsi_id->logout_orb->reserved3 = 0x0;
1322         scsi_id->logout_orb->reserved4 = 0x0;
1323
1324         scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1325         scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1326
1327         /* Notify us when complete */
1328         scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1329
1330         scsi_id->logout_orb->reserved5 = 0x0;
1331         scsi_id->logout_orb->status_fifo_hi =
1332                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1333         scsi_id->logout_orb->status_fifo_lo =
1334                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1335
1336         /*
1337          * Byte swap ORB if necessary
1338          */
1339         sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1340
1341         sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1342                              "sbp2 logout orb", scsi_id->logout_orb_dma);
1343
1344         /*
1345          * Ok, let's write to the target's management agent register
1346          */
1347         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1348         data[1] = scsi_id->logout_orb_dma;
1349         sbp2util_cpu_to_be32_buffer(data, 8);
1350
1351         atomic_set(&scsi_id->sbp2_login_complete, 0);
1352
1353         error = hpsb_node_write(scsi_id->ne,
1354                                 scsi_id->sbp2_management_agent_addr, data, 8);
1355         if (error)
1356                 return error;
1357
1358         /* Wait for device to logout...1 second. */
1359         if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1360                 return -EIO;
1361
1362         SBP2_INFO("Logged out of SBP-2 device");
1363
1364         return 0;
1365
1366 }
1367
1368 /*
1369  * This function is called in order to reconnect to a particular SBP-2
1370  * device, after a bus reset.
1371  */
1372 static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1373 {
1374         struct sbp2scsi_host_info *hi = scsi_id->hi;
1375         quadlet_t data[2];
1376         int error;
1377
1378         SBP2_DEBUG("sbp2_reconnect_device");
1379
1380         /*
1381          * Set-up reconnect ORB
1382          */
1383         scsi_id->reconnect_orb->reserved1 = 0x0;
1384         scsi_id->reconnect_orb->reserved2 = 0x0;
1385         scsi_id->reconnect_orb->reserved3 = 0x0;
1386         scsi_id->reconnect_orb->reserved4 = 0x0;
1387
1388         scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1389         scsi_id->reconnect_orb->login_ID_misc |=
1390                 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1391
1392         /* Notify us when complete */
1393         scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1394
1395         scsi_id->reconnect_orb->reserved5 = 0x0;
1396         scsi_id->reconnect_orb->status_fifo_hi =
1397                 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1398         scsi_id->reconnect_orb->status_fifo_lo =
1399                 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1400
1401         /*
1402          * Byte swap ORB if necessary
1403          */
1404         sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1405
1406         sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1407                              "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1408
1409         /*
1410          * Initialize status fifo
1411          */
1412         memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
1413
1414         /*
1415          * Ok, let's write to the target's management agent register
1416          */
1417         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1418         data[1] = scsi_id->reconnect_orb_dma;
1419         sbp2util_cpu_to_be32_buffer(data, 8);
1420
1421         atomic_set(&scsi_id->sbp2_login_complete, 0);
1422
1423         error = hpsb_node_write(scsi_id->ne,
1424                                 scsi_id->sbp2_management_agent_addr, data, 8);
1425         if (error)
1426                 return error;
1427
1428         /*
1429          * Wait for reconnect status (up to 1 second)...
1430          */
1431         if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1432                 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1433                 return -EIO;
1434         }
1435
1436         /*
1437          * Sanity. Make sure status returned matches reconnect orb.
1438          */
1439         if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1440                 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
1441                 return -EIO;
1442         }
1443
1444         /*
1445          * Check status
1446          */
1447         if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1448             STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1449             STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1450
1451                 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
1452                 return -EIO;
1453         }
1454
1455         HPSB_DEBUG("Reconnected to SBP-2 device");
1456
1457         return 0;
1458
1459 }
1460
1461 /*
1462  * This function is called in order to set the busy timeout (number of
1463  * retries to attempt) on the sbp2 device.
1464  */
1465 static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1466 {
1467         quadlet_t data;
1468
1469         SBP2_DEBUG("sbp2_set_busy_timeout");
1470
1471         /*
1472          * Ok, let's write to the target's busy timeout register
1473          */
1474         data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1475
1476         if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4)) {
1477                 SBP2_ERR("sbp2_set_busy_timeout error");
1478         }
1479
1480         return 0;
1481 }
1482
1483 /*
1484  * This function is called to parse sbp2 device's config rom unit
1485  * directory. Used to determine things like sbp2 management agent offset,
1486  * and command set used (SCSI or RBC).
1487  */
1488 static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1489                                       struct unit_directory *ud)
1490 {
1491         struct csr1212_keyval *kv;
1492         struct csr1212_dentry *dentry;
1493         u64 management_agent_addr;
1494         u32 command_set_spec_id, command_set, unit_characteristics,
1495             firmware_revision, workarounds;
1496         int i;
1497
1498         SBP2_DEBUG("sbp2_parse_unit_directory");
1499
1500         management_agent_addr = 0x0;
1501         command_set_spec_id = 0x0;
1502         command_set = 0x0;
1503         unit_characteristics = 0x0;
1504         firmware_revision = 0x0;
1505
1506         /* Handle different fields in the unit directory, based on keys */
1507         csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1508                 switch (kv->key.id) {
1509                 case CSR1212_KV_ID_DEPENDENT_INFO:
1510                         if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1511                                 /* Save off the management agent address */
1512                                 management_agent_addr =
1513                                     CSR1212_REGISTER_SPACE_BASE +
1514                                     (kv->value.csr_offset << 2);
1515
1516                                 SBP2_DEBUG("sbp2_management_agent_addr = %x",
1517                                            (unsigned int)management_agent_addr);
1518                         } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1519                                 scsi_id->sbp2_lun =
1520                                     ORB_SET_LUN(kv->value.immediate);
1521                         }
1522                         break;
1523
1524                 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1525                         /* Command spec organization */
1526                         command_set_spec_id = kv->value.immediate;
1527                         SBP2_DEBUG("sbp2_command_set_spec_id = %x",
1528                                    (unsigned int)command_set_spec_id);
1529                         break;
1530
1531                 case SBP2_COMMAND_SET_KEY:
1532                         /* Command set used by sbp2 device */
1533                         command_set = kv->value.immediate;
1534                         SBP2_DEBUG("sbp2_command_set = %x",
1535                                    (unsigned int)command_set);
1536                         break;
1537
1538                 case SBP2_UNIT_CHARACTERISTICS_KEY:
1539                         /*
1540                          * Unit characterisitcs (orb related stuff
1541                          * that I'm not yet paying attention to)
1542                          */
1543                         unit_characteristics = kv->value.immediate;
1544                         SBP2_DEBUG("sbp2_unit_characteristics = %x",
1545                                    (unsigned int)unit_characteristics);
1546                         break;
1547
1548                 case SBP2_FIRMWARE_REVISION_KEY:
1549                         /* Firmware revision */
1550                         firmware_revision = kv->value.immediate;
1551                         if (force_inquiry_hack)
1552                                 SBP2_INFO("sbp2_firmware_revision = %x",
1553                                           (unsigned int)firmware_revision);
1554                         else
1555                                 SBP2_DEBUG("sbp2_firmware_revision = %x",
1556                                            (unsigned int)firmware_revision);
1557                         break;
1558
1559                 default:
1560                         break;
1561                 }
1562         }
1563
1564         /* This is the start of our broken device checking. We try to hack
1565          * around oddities and known defects.  */
1566         workarounds = 0x0;
1567
1568         /* If the vendor id is 0xa0b8 (Symbios vendor id), then we have a
1569          * bridge with 128KB max transfer size limitation. For sanity, we
1570          * only voice this when the current max_sectors setting
1571          * exceeds the 128k limit. By default, that is not the case.
1572          *
1573          * It would be really nice if we could detect this before the scsi
1574          * host gets initialized. That way we can down-force the
1575          * max_sectors to account for it. That is not currently
1576          * possible.  */
1577         if ((firmware_revision & 0xffff00) ==
1578                         SBP2_128KB_BROKEN_FIRMWARE &&
1579                         (max_sectors * 512) > (128*1024)) {
1580                 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB max transfer size.",
1581                                 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1582                 SBP2_WARN("WARNING: Current max_sectors setting is larger than 128KB (%d sectors)!",
1583                                 max_sectors);
1584                 workarounds |= SBP2_BREAKAGE_128K_MAX_TRANSFER;
1585         }
1586
1587         /* Check for a blacklisted set of devices that require us to force
1588          * a 36 byte host inquiry. This can be overriden as a module param
1589          * (to force all hosts).  */
1590         for (i = 0; i < ARRAY_SIZE(sbp2_broken_inquiry_list); i++) {
1591                 if ((firmware_revision & 0xffff00) ==
1592                                 sbp2_broken_inquiry_list[i]) {
1593                         SBP2_WARN("Node " NODE_BUS_FMT ": Using 36byte inquiry workaround",
1594                                         NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid));
1595                         workarounds |= SBP2_BREAKAGE_INQUIRY_HACK;
1596                         break; /* No need to continue. */
1597                 }
1598         }
1599
1600         /* If this is a logical unit directory entry, process the parent
1601          * to get the values. */
1602         if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1603                 struct unit_directory *parent_ud =
1604                         container_of(ud->device.parent, struct unit_directory, device);
1605                 sbp2_parse_unit_directory(scsi_id, parent_ud);
1606         } else {
1607                 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1608                 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1609                 scsi_id->sbp2_command_set = command_set;
1610                 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1611                 scsi_id->sbp2_firmware_revision = firmware_revision;
1612                 scsi_id->workarounds = workarounds;
1613                 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1614                         scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1615         }
1616 }
1617
1618 /*
1619  * This function is called in order to determine the max speed and packet
1620  * size we can use in our ORBs. Note, that we (the driver and host) only
1621  * initiate the transaction. The SBP-2 device actually transfers the data
1622  * (by reading from the DMA area we tell it). This means that the SBP-2
1623  * device decides the actual maximum data it can transfer. We just tell it
1624  * the speed that it needs to use, and the max_rec the host supports, and
1625  * it takes care of the rest.
1626  */
1627 static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1628 {
1629         struct sbp2scsi_host_info *hi = scsi_id->hi;
1630
1631         SBP2_DEBUG("sbp2_max_speed_and_size");
1632
1633         /* Initial setting comes from the hosts speed map */
1634         scsi_id->speed_code =
1635             hi->host->speed_map[NODEID_TO_NODE(hi->host->node_id) * 64 +
1636                                 NODEID_TO_NODE(scsi_id->ne->nodeid)];
1637
1638         /* Bump down our speed if the user requested it */
1639         if (scsi_id->speed_code > max_speed) {
1640                 scsi_id->speed_code = max_speed;
1641                 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1642                          hpsb_speedto_str[scsi_id->speed_code]);
1643         }
1644
1645         /* Payload size is the lesser of what our speed supports and what
1646          * our host supports.  */
1647         scsi_id->max_payload_size =
1648             min(sbp2_speedto_max_payload[scsi_id->speed_code],
1649                 (u8) (hi->host->csr.max_rec - 1));
1650
1651         HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1652                    NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1653                    hpsb_speedto_str[scsi_id->speed_code],
1654                    1 << ((u32) scsi_id->max_payload_size + 2));
1655
1656         return 0;
1657 }
1658
1659 /*
1660  * This function is called in order to perform a SBP-2 agent reset.
1661  */
1662 static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1663 {
1664         quadlet_t data;
1665         u64 addr;
1666         int retval;
1667
1668         SBP2_DEBUG("sbp2_agent_reset");
1669
1670         /*
1671          * Ok, let's write to the target's management agent register
1672          */
1673         data = ntohl(SBP2_AGENT_RESET_DATA);
1674         addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1675
1676         if (wait)
1677                 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1678         else
1679                 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1680
1681         if (retval < 0) {
1682                 SBP2_ERR("hpsb_node_write failed.\n");
1683                 return -EIO;
1684         }
1685
1686         /*
1687          * Need to make sure orb pointer is written on next command
1688          */
1689         scsi_id->last_orb = NULL;
1690
1691         return 0;
1692 }
1693
1694 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1695                                      struct sbp2scsi_host_info *hi,
1696                                      struct sbp2_command_info *command,
1697                                      unsigned int scsi_use_sg,
1698                                      struct scatterlist *sgpnt,
1699                                      u32 orb_direction,
1700                                      enum dma_data_direction dma_dir)
1701 {
1702         command->dma_dir = dma_dir;
1703         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1704         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1705
1706         /* Special case if only one element (and less than 64KB in size) */
1707         if ((scsi_use_sg == 1) &&
1708             (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1709
1710                 SBP2_DEBUG("Only one s/g element");
1711                 command->dma_size = sgpnt[0].length;
1712                 command->dma_type = CMD_DMA_PAGE;
1713                 command->cmd_dma = pci_map_page(hi->host->pdev,
1714                                                 sgpnt[0].page,
1715                                                 sgpnt[0].offset,
1716                                                 command->dma_size,
1717                                                 command->dma_dir);
1718                 SBP2_DMA_ALLOC("single page scatter element");
1719
1720                 orb->data_descriptor_lo = command->cmd_dma;
1721                 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1722
1723         } else {
1724                 struct sbp2_unrestricted_page_table *sg_element =
1725                                         &command->scatter_gather_element[0];
1726                 u32 sg_count, sg_len;
1727                 dma_addr_t sg_addr;
1728                 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1729                                           dma_dir);
1730
1731                 SBP2_DMA_ALLOC("scatter list");
1732
1733                 command->dma_size = scsi_use_sg;
1734                 command->sge_buffer = sgpnt;
1735
1736                 /* use page tables (s/g) */
1737                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1738                 orb->data_descriptor_lo = command->sge_dma;
1739
1740                 /*
1741                  * Loop through and fill out our sbp-2 page tables
1742                  * (and split up anything too large)
1743                  */
1744                 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1745                         sg_len = sg_dma_len(sgpnt);
1746                         sg_addr = sg_dma_address(sgpnt);
1747                         while (sg_len) {
1748                                 sg_element[sg_count].segment_base_lo = sg_addr;
1749                                 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1750                                         sg_element[sg_count].length_segment_base_hi =
1751                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1752                                         sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1753                                         sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1754                                 } else {
1755                                         sg_element[sg_count].length_segment_base_hi =
1756                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1757                                         sg_len = 0;
1758                                 }
1759                                 sg_count++;
1760                         }
1761                 }
1762
1763                 /* Number of page table (s/g) elements */
1764                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1765
1766                 sbp2util_packet_dump(sg_element,
1767                                      (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1768                                      "sbp2 s/g list", command->sge_dma);
1769
1770                 /* Byte swap page tables if necessary */
1771                 sbp2util_cpu_to_be32_buffer(sg_element,
1772                                             (sizeof(struct sbp2_unrestricted_page_table)) *
1773                                             sg_count);
1774         }
1775 }
1776
1777 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1778                                         struct sbp2scsi_host_info *hi,
1779                                         struct sbp2_command_info *command,
1780                                         struct scatterlist *sgpnt,
1781                                         u32 orb_direction,
1782                                         unsigned int scsi_request_bufflen,
1783                                         void *scsi_request_buffer,
1784                                         enum dma_data_direction dma_dir)
1785 {
1786         command->dma_dir = dma_dir;
1787         command->dma_size = scsi_request_bufflen;
1788         command->dma_type = CMD_DMA_SINGLE;
1789         command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1790                                           command->dma_size, command->dma_dir);
1791         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1792         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1793
1794         SBP2_DMA_ALLOC("single bulk");
1795
1796         /*
1797          * Handle case where we get a command w/o s/g enabled (but
1798          * check for transfers larger than 64K)
1799          */
1800         if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1801
1802                 orb->data_descriptor_lo = command->cmd_dma;
1803                 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1804
1805         } else {
1806                 struct sbp2_unrestricted_page_table *sg_element =
1807                         &command->scatter_gather_element[0];
1808                 u32 sg_count, sg_len;
1809                 dma_addr_t sg_addr;
1810
1811                 /*
1812                  * Need to turn this into page tables, since the
1813                  * buffer is too large.
1814                  */
1815                 orb->data_descriptor_lo = command->sge_dma;
1816
1817                 /* Use page tables (s/g) */
1818                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1819
1820                 /*
1821                  * fill out our sbp-2 page tables (and split up
1822                  * the large buffer)
1823                  */
1824                 sg_count = 0;
1825                 sg_len = scsi_request_bufflen;
1826                 sg_addr = command->cmd_dma;
1827                 while (sg_len) {
1828                         sg_element[sg_count].segment_base_lo = sg_addr;
1829                         if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1830                                 sg_element[sg_count].length_segment_base_hi =
1831                                         PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1832                                 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1833                                 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1834                         } else {
1835                                 sg_element[sg_count].length_segment_base_hi =
1836                                         PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1837                                 sg_len = 0;
1838                         }
1839                         sg_count++;
1840                 }
1841
1842                 /* Number of page table (s/g) elements */
1843                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1844
1845                 sbp2util_packet_dump(sg_element,
1846                                      (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1847                                      "sbp2 s/g list", command->sge_dma);
1848
1849                 /* Byte swap page tables if necessary */
1850                 sbp2util_cpu_to_be32_buffer(sg_element,
1851                                             (sizeof(struct sbp2_unrestricted_page_table)) *
1852                                              sg_count);
1853         }
1854 }
1855
1856 /*
1857  * This function is called to create the actual command orb and s/g list
1858  * out of the scsi command itself.
1859  */
1860 static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1861                                     struct sbp2_command_info *command,
1862                                     unchar *scsi_cmd,
1863                                     unsigned int scsi_use_sg,
1864                                     unsigned int scsi_request_bufflen,
1865                                     void *scsi_request_buffer,
1866                                     enum dma_data_direction dma_dir)
1867 {
1868         struct sbp2scsi_host_info *hi = scsi_id->hi;
1869         struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1870         struct sbp2_command_orb *command_orb = &command->command_orb;
1871         u32 orb_direction;
1872
1873         /*
1874          * Set-up our command ORB..
1875          *
1876          * NOTE: We're doing unrestricted page tables (s/g), as this is
1877          * best performance (at least with the devices I have). This means
1878          * that data_size becomes the number of s/g elements, and
1879          * page_size should be zero (for unrestricted).
1880          */
1881         command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1882         command_orb->next_ORB_lo = 0x0;
1883         command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1884         command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
1885         command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1886
1887         if (dma_dir == DMA_NONE)
1888                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1889         else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1890                 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1891         else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1892                 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1893         else {
1894                 SBP2_WARN("Falling back to DMA_NONE");
1895                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1896         }
1897
1898         /* Set-up our pagetable stuff */
1899         if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1900                 SBP2_DEBUG("No data transfer");
1901                 command_orb->data_descriptor_hi = 0x0;
1902                 command_orb->data_descriptor_lo = 0x0;
1903                 command_orb->misc |= ORB_SET_DIRECTION(1);
1904         } else if (scsi_use_sg) {
1905                 SBP2_DEBUG("Use scatter/gather");
1906                 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1907                                          sgpnt, orb_direction, dma_dir);
1908         } else {
1909                 SBP2_DEBUG("No scatter/gather");
1910                 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1911                                             orb_direction, scsi_request_bufflen,
1912                                             scsi_request_buffer, dma_dir);
1913         }
1914
1915         /* Byte swap command ORB if necessary */
1916         sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1917
1918         /* Put our scsi command in the command ORB */
1919         memset(command_orb->cdb, 0, 12);
1920         memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1921 }
1922
1923 /*
1924  * This function is called in order to begin a regular SBP-2 command.
1925  */
1926 static int sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1927                                  struct sbp2_command_info *command)
1928 {
1929         struct sbp2scsi_host_info *hi = scsi_id->hi;
1930         struct sbp2_command_orb *command_orb = &command->command_orb;
1931         struct node_entry *ne = scsi_id->ne;
1932         u64 addr;
1933
1934         outstanding_orb_incr;
1935         SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
1936                        command_orb, global_outstanding_command_orbs);
1937
1938         pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1939                                        sizeof(struct sbp2_command_orb),
1940                                        PCI_DMA_BIDIRECTIONAL);
1941         pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1942                                        sizeof(command->scatter_gather_element),
1943                                        PCI_DMA_BIDIRECTIONAL);
1944         /*
1945          * Check to see if there are any previous orbs to use
1946          */
1947         if (scsi_id->last_orb == NULL) {
1948                 quadlet_t data[2];
1949
1950                 /*
1951                  * Ok, let's write to the target's management agent register
1952                  */
1953                 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_ORB_POINTER_OFFSET;
1954                 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1955                 data[1] = command->command_orb_dma;
1956                 sbp2util_cpu_to_be32_buffer(data, 8);
1957
1958                 SBP2_ORB_DEBUG("write command agent, command orb %p", command_orb);
1959
1960                 if (sbp2util_node_write_no_wait(ne, addr, data, 8) < 0) {
1961                         SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
1962                         return -EIO;
1963                 }
1964
1965                 SBP2_ORB_DEBUG("write command agent complete");
1966
1967                 scsi_id->last_orb = command_orb;
1968                 scsi_id->last_orb_dma = command->command_orb_dma;
1969
1970         } else {
1971                 quadlet_t data;
1972
1973                 /*
1974                  * We have an orb already sent (maybe or maybe not
1975                  * processed) that we can append this orb to. So do so,
1976                  * and ring the doorbell. Have to be very careful
1977                  * modifying these next orb pointers, as they are accessed
1978                  * both by the sbp2 device and us.
1979                  */
1980                 scsi_id->last_orb->next_ORB_lo =
1981                     cpu_to_be32(command->command_orb_dma);
1982                 /* Tells hardware that this pointer is valid */
1983                 scsi_id->last_orb->next_ORB_hi = 0x0;
1984                 pci_dma_sync_single_for_device(hi->host->pdev,
1985                                                scsi_id->last_orb_dma,
1986                                                sizeof(struct sbp2_command_orb),
1987                                                PCI_DMA_BIDIRECTIONAL);
1988
1989                 /*
1990                  * Ring the doorbell
1991                  */
1992                 data = cpu_to_be32(command->command_orb_dma);
1993                 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_DOORBELL_OFFSET;
1994
1995                 SBP2_ORB_DEBUG("ring doorbell, command orb %p", command_orb);
1996
1997                 if (sbp2util_node_write_no_wait(ne, addr, &data, 4) < 0) {
1998                         SBP2_ERR("sbp2util_node_write_no_wait failed");
1999                         return -EIO;
2000                 }
2001
2002                 scsi_id->last_orb = command_orb;
2003                 scsi_id->last_orb_dma = command->command_orb_dma;
2004
2005         }
2006         return 0;
2007 }
2008
2009 /*
2010  * This function is called in order to begin a regular SBP-2 command.
2011  */
2012 static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2013                              struct scsi_cmnd *SCpnt,
2014                              void (*done)(struct scsi_cmnd *))
2015 {
2016         unchar *cmd = (unchar *) SCpnt->cmnd;
2017         unsigned int request_bufflen = SCpnt->request_bufflen;
2018         struct sbp2_command_info *command;
2019
2020         SBP2_DEBUG("sbp2_send_command");
2021 #if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2022         printk("[scsi command]\n   ");
2023         scsi_print_command(SCpnt);
2024 #endif
2025         SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2026         SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2027
2028         /*
2029          * Allocate a command orb and s/g structure
2030          */
2031         command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2032         if (!command) {
2033                 return -EIO;
2034         }
2035
2036         /*
2037          * Now actually fill in the comamnd orb and sbp2 s/g list
2038          */
2039         sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2040                                 request_bufflen, SCpnt->request_buffer,
2041                                 SCpnt->sc_data_direction);
2042
2043         sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2044                              "sbp2 command orb", command->command_orb_dma);
2045
2046         /*
2047          * Initialize status fifo
2048          */
2049         memset(&scsi_id->status_block, 0, sizeof(struct sbp2_status_block));
2050
2051         /*
2052          * Link up the orb, and ring the doorbell if needed
2053          */
2054         sbp2_link_orb_command(scsi_id, command);
2055
2056         return 0;
2057 }
2058
2059 /*
2060  * Translates SBP-2 status into SCSI sense data for check conditions
2061  */
2062 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2063 {
2064         SBP2_DEBUG("sbp2_status_to_sense_data");
2065
2066         /*
2067          * Ok, it's pretty ugly...   ;-)
2068          */
2069         sense_data[0] = 0x70;
2070         sense_data[1] = 0x0;
2071         sense_data[2] = sbp2_status[9];
2072         sense_data[3] = sbp2_status[12];
2073         sense_data[4] = sbp2_status[13];
2074         sense_data[5] = sbp2_status[14];
2075         sense_data[6] = sbp2_status[15];
2076         sense_data[7] = 10;
2077         sense_data[8] = sbp2_status[16];
2078         sense_data[9] = sbp2_status[17];
2079         sense_data[10] = sbp2_status[18];
2080         sense_data[11] = sbp2_status[19];
2081         sense_data[12] = sbp2_status[10];
2082         sense_data[13] = sbp2_status[11];
2083         sense_data[14] = sbp2_status[20];
2084         sense_data[15] = sbp2_status[21];
2085
2086         return sbp2_status[8] & 0x3f;   /* return scsi status */
2087 }
2088
2089 /*
2090  * This function is called after a command is completed, in order to do any necessary SBP-2
2091  * response data translations for the SCSI stack
2092  */
2093 static void sbp2_check_sbp2_response(struct scsi_id_instance_data *scsi_id,
2094                                      struct scsi_cmnd *SCpnt)
2095 {
2096         u8 *scsi_buf = SCpnt->request_buffer;
2097
2098         SBP2_DEBUG("sbp2_check_sbp2_response");
2099
2100         if (SCpnt->cmnd[0] == INQUIRY && (SCpnt->cmnd[1] & 3) == 0) {
2101                 /*
2102                  * Make sure data length is ok. Minimum length is 36 bytes
2103                  */
2104                 if (scsi_buf[4] == 0) {
2105                         scsi_buf[4] = 36 - 5;
2106                 }
2107
2108                 /*
2109                  * Fix ansi revision and response data format
2110                  */
2111                 scsi_buf[2] |= 2;
2112                 scsi_buf[3] = (scsi_buf[3] & 0xf0) | 2;
2113         }
2114 }
2115
2116 /*
2117  * This function deals with status writes from the SBP-2 device
2118  */
2119 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid, int destid,
2120                                     quadlet_t *data, u64 addr, size_t length, u16 fl)
2121 {
2122         struct sbp2scsi_host_info *hi;
2123         struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
2124         struct scsi_cmnd *SCpnt = NULL;
2125         u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2126         struct sbp2_command_info *command;
2127         unsigned long flags;
2128
2129         SBP2_DEBUG("sbp2_handle_status_write");
2130
2131         sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2132
2133         if (!host) {
2134                 SBP2_ERR("host is NULL - this is bad!");
2135                 return RCODE_ADDRESS_ERROR;
2136         }
2137
2138         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2139
2140         if (!hi) {
2141                 SBP2_ERR("host info is NULL - this is bad!");
2142                 return RCODE_ADDRESS_ERROR;
2143         }
2144
2145         /*
2146          * Find our scsi_id structure by looking at the status fifo address
2147          * written to by the sbp2 device.
2148          */
2149         list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
2150                 if (scsi_id_tmp->ne->nodeid == nodeid &&
2151                     scsi_id_tmp->status_fifo_addr == addr) {
2152                         scsi_id = scsi_id_tmp;
2153                         break;
2154                 }
2155         }
2156
2157         if (!scsi_id) {
2158                 SBP2_ERR("scsi_id is NULL - device is gone?");
2159                 return RCODE_ADDRESS_ERROR;
2160         }
2161
2162         /*
2163          * Put response into scsi_id status fifo...
2164          */
2165         memcpy(&scsi_id->status_block, data, length);
2166
2167         /*
2168          * Byte swap first two quadlets (8 bytes) of status for processing
2169          */
2170         sbp2util_be32_to_cpu_buffer(&scsi_id->status_block, 8);
2171
2172         /*
2173          * Handle command ORB status here if necessary. First, need to match status with command.
2174          */
2175         command = sbp2util_find_command_for_orb(scsi_id, scsi_id->status_block.ORB_offset_lo);
2176         if (command) {
2177
2178                 SBP2_DEBUG("Found status for command ORB");
2179                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2180                                             sizeof(struct sbp2_command_orb),
2181                                             PCI_DMA_BIDIRECTIONAL);
2182                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2183                                             sizeof(command->scatter_gather_element),
2184                                             PCI_DMA_BIDIRECTIONAL);
2185
2186                 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2187                 outstanding_orb_decr;
2188
2189                 /*
2190                  * Matched status with command, now grab scsi command pointers and check status
2191                  */
2192                 SCpnt = command->Current_SCpnt;
2193                 sbp2util_mark_command_completed(scsi_id, command);
2194
2195                 if (SCpnt) {
2196
2197                         /*
2198                          * See if the target stored any scsi status information
2199                          */
2200                         if (STATUS_GET_LENGTH(scsi_id->status_block.ORB_offset_hi_misc) > 1) {
2201                                 /*
2202                                  * Translate SBP-2 status to SCSI sense data
2203                                  */
2204                                 SBP2_DEBUG("CHECK CONDITION");
2205                                 scsi_status = sbp2_status_to_sense_data((unchar *)&scsi_id->status_block, SCpnt->sense_buffer);
2206                         }
2207
2208                         /*
2209                          * Check to see if the dead bit is set. If so, we'll have to initiate
2210                          * a fetch agent reset.
2211                          */
2212                         if (STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc)) {
2213
2214                                 /*
2215                                  * Initiate a fetch agent reset.
2216                                  */
2217                                 SBP2_DEBUG("Dead bit set - initiating fetch agent reset");
2218                                 sbp2_agent_reset(scsi_id, 0);
2219                         }
2220
2221                         SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2222                 }
2223
2224                 /*
2225                  * Check here to see if there are no commands in-use. If there are none, we can
2226                  * null out last orb so that next time around we write directly to the orb pointer...
2227                  * Quick start saves one 1394 bus transaction.
2228                  */
2229                 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2230                 if (list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2231                         scsi_id->last_orb = NULL;
2232                 }
2233                 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2234
2235         } else {
2236
2237                 /*
2238                  * It's probably a login/logout/reconnect status.
2239                  */
2240                 if ((scsi_id->login_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2241                     (scsi_id->query_logins_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2242                     (scsi_id->reconnect_orb_dma == scsi_id->status_block.ORB_offset_lo) ||
2243                     (scsi_id->logout_orb_dma == scsi_id->status_block.ORB_offset_lo)) {
2244                         atomic_set(&scsi_id->sbp2_login_complete, 1);
2245                 }
2246         }
2247
2248         if (SCpnt) {
2249
2250                 /* Complete the SCSI command. */
2251                 SBP2_DEBUG("Completing SCSI command");
2252                 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2253                                           command->Current_done);
2254                 SBP2_ORB_DEBUG("command orb completed");
2255         }
2256
2257         return RCODE_COMPLETE;
2258 }
2259
2260 /**************************************
2261  * SCSI interface related section
2262  **************************************/
2263
2264 /*
2265  * This routine is the main request entry routine for doing I/O. It is
2266  * called from the scsi stack directly.
2267  */
2268 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2269                                  void (*done)(struct scsi_cmnd *))
2270 {
2271         struct scsi_id_instance_data *scsi_id =
2272                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2273         struct sbp2scsi_host_info *hi;
2274         int result = DID_NO_CONNECT << 16;
2275
2276         SBP2_DEBUG("sbp2scsi_queuecommand");
2277
2278         if (!sbp2util_node_is_available(scsi_id))
2279                 goto done;
2280
2281         hi = scsi_id->hi;
2282
2283         if (!hi) {
2284                 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
2285                 goto done;
2286         }
2287
2288         /*
2289          * Until we handle multiple luns, just return selection time-out
2290          * to any IO directed at non-zero LUNs
2291          */
2292         if (SCpnt->device->lun)
2293                 goto done;
2294
2295         /*
2296          * Check for request sense command, and handle it here
2297          * (autorequest sense)
2298          */
2299         if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2300                 SBP2_DEBUG("REQUEST_SENSE");
2301                 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2302                 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2303                 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
2304                 return 0;
2305         }
2306
2307         /*
2308          * Check to see if we are in the middle of a bus reset.
2309          */
2310         if (!hpsb_node_entry_valid(scsi_id->ne)) {
2311                 SBP2_ERR("Bus reset in progress - rejecting command");
2312                 result = DID_BUS_BUSY << 16;
2313                 goto done;
2314         }
2315
2316         /*
2317          * Bidirectional commands are not yet implemented,
2318          * and unknown transfer direction not handled.
2319          */
2320         if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2321                 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2322                 result = DID_ERROR << 16;
2323                 goto done;
2324         }
2325
2326         /*
2327          * Try and send our SCSI command
2328          */
2329         if (sbp2_send_command(scsi_id, SCpnt, done)) {
2330                 SBP2_ERR("Error sending SCSI command");
2331                 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2332                                           SCpnt, done);
2333         }
2334         return 0;
2335
2336 done:
2337         SCpnt->result = result;
2338         done(SCpnt);
2339         return 0;
2340 }
2341
2342 /*
2343  * This function is called in order to complete all outstanding SBP-2
2344  * commands (in case of resets, etc.).
2345  */
2346 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2347                                            u32 status)
2348 {
2349         struct sbp2scsi_host_info *hi = scsi_id->hi;
2350         struct list_head *lh;
2351         struct sbp2_command_info *command;
2352         unsigned long flags;
2353
2354         SBP2_DEBUG("sbp2scsi_complete_all_commands");
2355
2356         spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
2357         while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2358                 SBP2_DEBUG("Found pending command to complete");
2359                 lh = scsi_id->sbp2_command_orb_inuse.next;
2360                 command = list_entry(lh, struct sbp2_command_info, list);
2361                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2362                                             sizeof(struct sbp2_command_orb),
2363                                             PCI_DMA_BIDIRECTIONAL);
2364                 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2365                                             sizeof(command->scatter_gather_element),
2366                                             PCI_DMA_BIDIRECTIONAL);
2367                 sbp2util_mark_command_completed(scsi_id, command);
2368                 if (command->Current_SCpnt) {
2369                         command->Current_SCpnt->result = status << 16;
2370                         command->Current_done(command->Current_SCpnt);
2371                 }
2372         }
2373         spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
2374
2375         return;
2376 }
2377
2378 /*
2379  * This function is called in order to complete a regular SBP-2 command.
2380  *
2381  * This can be called in interrupt context.
2382  */
2383 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2384                                       u32 scsi_status, struct scsi_cmnd *SCpnt,
2385                                       void (*done)(struct scsi_cmnd *))
2386 {
2387         SBP2_DEBUG("sbp2scsi_complete_command");
2388
2389         /*
2390          * Sanity
2391          */
2392         if (!SCpnt) {
2393                 SBP2_ERR("SCpnt is NULL");
2394                 return;
2395         }
2396
2397         /*
2398          * If a bus reset is in progress and there was an error, don't
2399          * complete the command, just let it get retried at the end of the
2400          * bus reset.
2401          */
2402         if (!hpsb_node_entry_valid(scsi_id->ne)
2403             && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2404                 SBP2_ERR("Bus reset in progress - retry command later");
2405                 return;
2406         }
2407
2408         /*
2409          * Switch on scsi status
2410          */
2411         switch (scsi_status) {
2412         case SBP2_SCSI_STATUS_GOOD:
2413                 SCpnt->result = DID_OK << 16;
2414                 break;
2415
2416         case SBP2_SCSI_STATUS_BUSY:
2417                 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2418                 SCpnt->result = DID_BUS_BUSY << 16;
2419                 break;
2420
2421         case SBP2_SCSI_STATUS_CHECK_CONDITION:
2422                 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
2423                 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
2424
2425                 /*
2426                  * Debug stuff
2427                  */
2428 #if CONFIG_IEEE1394_SBP2_DEBUG >= 1
2429                 scsi_print_command(SCpnt);
2430                 scsi_print_sense("bh", SCpnt);
2431 #endif
2432
2433                 break;
2434
2435         case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2436                 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2437                 SCpnt->result = DID_NO_CONNECT << 16;
2438                 scsi_print_command(SCpnt);
2439                 break;
2440
2441         case SBP2_SCSI_STATUS_CONDITION_MET:
2442         case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2443         case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2444                 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2445                 SCpnt->result = DID_ERROR << 16;
2446                 scsi_print_command(SCpnt);
2447                 break;
2448
2449         default:
2450                 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2451                 SCpnt->result = DID_ERROR << 16;
2452         }
2453
2454         /*
2455          * Take care of any sbp2 response data mucking here (RBC stuff, etc.)
2456          */
2457         if (SCpnt->result == DID_OK << 16) {
2458                 sbp2_check_sbp2_response(scsi_id, SCpnt);
2459         }
2460
2461         /*
2462          * If a bus reset is in progress and there was an error, complete
2463          * the command as busy so that it will get retried.
2464          */
2465         if (!hpsb_node_entry_valid(scsi_id->ne)
2466             && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2467                 SBP2_ERR("Completing command with busy (bus reset)");
2468                 SCpnt->result = DID_BUS_BUSY << 16;
2469         }
2470
2471         /*
2472          * If a unit attention occurs, return busy status so it gets
2473          * retried... it could have happened because of a 1394 bus reset
2474          * or hot-plug...
2475          * XXX  DID_BUS_BUSY is actually a bad idea because it will defy
2476          * the scsi layer's retry logic.
2477          */
2478 #if 0
2479         if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2480             (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2481                 SBP2_DEBUG("UNIT ATTENTION - return busy");
2482                 SCpnt->result = DID_BUS_BUSY << 16;
2483         }
2484 #endif
2485
2486         /*
2487          * Tell scsi stack that we're done with this command
2488          */
2489         done(SCpnt);
2490 }
2491
2492 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2493 {
2494         struct scsi_id_instance_data *scsi_id =
2495                 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2496
2497         scsi_id->sdev = sdev;
2498
2499         if (force_inquiry_hack ||
2500             scsi_id->workarounds & SBP2_BREAKAGE_INQUIRY_HACK) {
2501                 sdev->inquiry_len = 36;
2502                 sdev->skip_ms_page_8 = 1;
2503         }
2504         return 0;
2505 }
2506
2507 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2508 {
2509         blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2510         sdev->use_10_for_rw = 1;
2511         sdev->use_10_for_ms = 1;
2512         return 0;
2513 }
2514
2515 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2516 {
2517         ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2518         return;
2519 }
2520
2521 /*
2522  * Called by scsi stack when something has really gone wrong.  Usually
2523  * called when a command has timed-out for some reason.
2524  */
2525 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2526 {
2527         struct scsi_id_instance_data *scsi_id =
2528                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2529         struct sbp2scsi_host_info *hi = scsi_id->hi;
2530         struct sbp2_command_info *command;
2531
2532         SBP2_ERR("aborting sbp2 command");
2533         scsi_print_command(SCpnt);
2534
2535         if (sbp2util_node_is_available(scsi_id)) {
2536
2537                 /*
2538                  * Right now, just return any matching command structures
2539                  * to the free pool.
2540                  */
2541                 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2542                 if (command) {
2543                         SBP2_DEBUG("Found command to abort");
2544                         pci_dma_sync_single_for_cpu(hi->host->pdev,
2545                                                     command->command_orb_dma,
2546                                                     sizeof(struct sbp2_command_orb),
2547                                                     PCI_DMA_BIDIRECTIONAL);
2548                         pci_dma_sync_single_for_cpu(hi->host->pdev,
2549                                                     command->sge_dma,
2550                                                     sizeof(command->scatter_gather_element),
2551                                                     PCI_DMA_BIDIRECTIONAL);
2552                         sbp2util_mark_command_completed(scsi_id, command);
2553                         if (command->Current_SCpnt) {
2554                                 command->Current_SCpnt->result = DID_ABORT << 16;
2555                                 command->Current_done(command->Current_SCpnt);
2556                         }
2557                 }
2558
2559                 /*
2560                  * Initiate a fetch agent reset.
2561                  */
2562                 sbp2_agent_reset(scsi_id, 0);
2563                 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2564         }
2565
2566         return SUCCESS;
2567 }
2568
2569 /*
2570  * Called by scsi stack when something has really gone wrong.
2571  */
2572 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2573 {
2574         struct scsi_id_instance_data *scsi_id =
2575                 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2576
2577         SBP2_ERR("reset requested");
2578
2579         if (sbp2util_node_is_available(scsi_id)) {
2580                 SBP2_ERR("Generating sbp2 fetch agent reset");
2581                 sbp2_agent_reset(scsi_id, 0);
2582         }
2583
2584         return SUCCESS;
2585 }
2586
2587 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2588                                            struct device_attribute *attr,
2589                                            char *buf)
2590 {
2591         struct scsi_device *sdev;
2592         struct scsi_id_instance_data *scsi_id;
2593         int lun;
2594
2595         if (!(sdev = to_scsi_device(dev)))
2596                 return 0;
2597
2598         if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2599                 return 0;
2600
2601         lun = ORB_SET_LUN(scsi_id->sbp2_lun);
2602
2603         return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2604                        scsi_id->ud->id, lun);
2605 }
2606 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2607
2608 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2609         &dev_attr_ieee1394_id,
2610         NULL
2611 };
2612
2613 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2614 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2615 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2616 MODULE_LICENSE("GPL");
2617
2618 /* SCSI host template */
2619 static struct scsi_host_template scsi_driver_template = {
2620         .module =                       THIS_MODULE,
2621         .name =                         "SBP-2 IEEE-1394",
2622         .proc_name =                    SBP2_DEVICE_NAME,
2623         .queuecommand =                 sbp2scsi_queuecommand,
2624         .eh_abort_handler =             sbp2scsi_abort,
2625         .eh_device_reset_handler =      sbp2scsi_reset,
2626         .slave_alloc =                  sbp2scsi_slave_alloc,
2627         .slave_configure =              sbp2scsi_slave_configure,
2628         .slave_destroy =                sbp2scsi_slave_destroy,
2629         .this_id =                      -1,
2630         .sg_tablesize =                 SG_ALL,
2631         .use_clustering =               ENABLE_CLUSTERING,
2632         .cmd_per_lun =                  SBP2_MAX_CMDS,
2633         .can_queue =                    SBP2_MAX_CMDS,
2634         .emulated =                     1,
2635         .sdev_attrs =                   sbp2_sysfs_sdev_attrs,
2636 };
2637
2638 static int sbp2_module_init(void)
2639 {
2640         int ret;
2641
2642         SBP2_DEBUG("sbp2_module_init");
2643
2644         /* Module load debug option to force one command at a time (serializing I/O) */
2645         if (serialize_io) {
2646                 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2647                 SBP2_INFO("Try serialize_io=0 for better performance");
2648                 scsi_driver_template.can_queue = 1;
2649                 scsi_driver_template.cmd_per_lun = 1;
2650         }
2651
2652         /* Set max sectors (module load option). Default is 255 sectors. */
2653         scsi_driver_template.max_sectors = max_sectors;
2654
2655         /* Register our high level driver with 1394 stack */
2656         hpsb_register_highlevel(&sbp2_highlevel);
2657
2658         ret = hpsb_register_protocol(&sbp2_driver);
2659         if (ret) {
2660                 SBP2_ERR("Failed to register protocol");
2661                 hpsb_unregister_highlevel(&sbp2_highlevel);
2662                 return ret;
2663         }
2664
2665         return 0;
2666 }
2667
2668 static void __exit sbp2_module_exit(void)
2669 {
2670         SBP2_DEBUG("sbp2_module_exit");
2671
2672         hpsb_unregister_protocol(&sbp2_driver);
2673
2674         hpsb_unregister_highlevel(&sbp2_highlevel);
2675 }
2676
2677 module_init(sbp2_module_init);
2678 module_exit(sbp2_module_exit);