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