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