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