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