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