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