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