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