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