ieee1394: sbp2: convert from PCI DMA to generic DMA
[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 (usually storage devices) as regular
33  * SCSI devices. E.g. mount /dev/sda1, fdisk, mkfs, etc..
34  *
35  * See http://www.t10.org/drafts.htm#sbp2 for the final draft of the SBP-2
36  * specification and for where to purchase the official standard.
37  *
38  * TODO:
39  *   - look into possible improvements of the SCSI error handlers
40  *   - handle Unit_Characteristics.mgt_ORB_timeout and .ORB_size
41  *   - handle Logical_Unit_Number.ordered
42  *   - handle src == 1 in status blocks
43  *   - reimplement the DMA mapping in absence of physical DMA so that
44  *     bus_to_virt is no longer required
45  *   - debug the handling of absent physical DMA
46  *   - replace CONFIG_IEEE1394_SBP2_PHYS_DMA by automatic detection
47  *     (this is easy but depends on the previous two TODO items)
48  *   - make the parameter serialize_io configurable per device
49  *   - move all requests to fetch agent registers into non-atomic context,
50  *     replace all usages of sbp2util_node_write_no_wait by true transactions
51  * Grep for inline FIXME comments below.
52  */
53
54 #include <linux/blkdev.h>
55 #include <linux/compiler.h>
56 #include <linux/delay.h>
57 #include <linux/device.h>
58 #include <linux/dma-mapping.h>
59 #include <linux/gfp.h>
60 #include <linux/init.h>
61 #include <linux/kernel.h>
62 #include <linux/list.h>
63 #include <linux/module.h>
64 #include <linux/moduleparam.h>
65 #include <linux/slab.h>
66 #include <linux/spinlock.h>
67 #include <linux/stat.h>
68 #include <linux/string.h>
69 #include <linux/stringify.h>
70 #include <linux/types.h>
71 #include <linux/wait.h>
72
73 #include <asm/byteorder.h>
74 #include <asm/errno.h>
75 #include <asm/param.h>
76 #include <asm/scatterlist.h>
77 #include <asm/system.h>
78 #include <asm/types.h>
79
80 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
81 #include <asm/io.h> /* for bus_to_virt */
82 #endif
83
84 #include <scsi/scsi.h>
85 #include <scsi/scsi_cmnd.h>
86 #include <scsi/scsi_dbg.h>
87 #include <scsi/scsi_device.h>
88 #include <scsi/scsi_host.h>
89
90 #include "csr1212.h"
91 #include "highlevel.h"
92 #include "hosts.h"
93 #include "ieee1394.h"
94 #include "ieee1394_core.h"
95 #include "ieee1394_hotplug.h"
96 #include "ieee1394_transactions.h"
97 #include "ieee1394_types.h"
98 #include "nodemgr.h"
99 #include "sbp2.h"
100
101 /*
102  * Module load parameter definitions
103  */
104
105 /*
106  * Change max_speed on module load if you have a bad IEEE-1394
107  * controller that has trouble running 2KB packets at 400mb.
108  *
109  * NOTE: On certain OHCI parts I have seen short packets on async transmit
110  * (probably due to PCI latency/throughput issues with the part). You can
111  * bump down the speed if you are running into problems.
112  */
113 static int sbp2_max_speed = IEEE1394_SPEED_MAX;
114 module_param_named(max_speed, sbp2_max_speed, int, 0644);
115 MODULE_PARM_DESC(max_speed, "Force max speed "
116                  "(3 = 800Mb/s, 2 = 400Mb/s, 1 = 200Mb/s, 0 = 100Mb/s)");
117
118 /*
119  * Set serialize_io to 1 if you'd like only one scsi command sent
120  * down to us at a time (debugging). This might be necessary for very
121  * badly behaved sbp2 devices.
122  */
123 static int sbp2_serialize_io = 1;
124 module_param_named(serialize_io, sbp2_serialize_io, int, 0444);
125 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers "
126                  "(default = 1, faster = 0)");
127
128 /*
129  * Bump up max_sectors if you'd like to support very large sized
130  * transfers. Please note that some older sbp2 bridge chips are broken for
131  * transfers greater or equal to 128KB.  Default is a value of 255
132  * sectors, or just under 128KB (at 512 byte sector size). I can note that
133  * the Oxsemi sbp2 chipsets have no problems supporting very large
134  * transfer sizes.
135  */
136 static int sbp2_max_sectors = SBP2_MAX_SECTORS;
137 module_param_named(max_sectors, sbp2_max_sectors, int, 0444);
138 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported "
139                  "(default = " __stringify(SBP2_MAX_SECTORS) ")");
140
141 /*
142  * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
143  * do an exclusive login, as it's generally unsafe to have two hosts
144  * talking to a single sbp2 device at the same time (filesystem coherency,
145  * etc.). If you're running an sbp2 device that supports multiple logins,
146  * and you're either running read-only filesystems or some sort of special
147  * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
148  * File System, or Lustre, then set exclusive_login to zero.
149  *
150  * So far only bridges from Oxford Semiconductor are known to support
151  * concurrent logins. Depending on firmware, four or two concurrent logins
152  * are possible on OXFW911 and newer Oxsemi bridges.
153  */
154 static int sbp2_exclusive_login = 1;
155 module_param_named(exclusive_login, sbp2_exclusive_login, int, 0644);
156 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
157                  "(default = 1)");
158
159 /*
160  * If any of the following workarounds is required for your device to work,
161  * please submit the kernel messages logged by sbp2 to the linux1394-devel
162  * mailing list.
163  *
164  * - 128kB max transfer
165  *   Limit transfer size. Necessary for some old bridges.
166  *
167  * - 36 byte inquiry
168  *   When scsi_mod probes the device, let the inquiry command look like that
169  *   from MS Windows.
170  *
171  * - skip mode page 8
172  *   Suppress sending of mode_sense for mode page 8 if the device pretends to
173  *   support the SCSI Primary Block commands instead of Reduced Block Commands.
174  *
175  * - fix capacity
176  *   Tell sd_mod to correct the last sector number reported by read_capacity.
177  *   Avoids access beyond actual disk limits on devices with an off-by-one bug.
178  *   Don't use this with devices which don't have this bug.
179  *
180  * - override internal blacklist
181  *   Instead of adding to the built-in blacklist, use only the workarounds
182  *   specified in the module load parameter.
183  *   Useful if a blacklist entry interfered with a non-broken device.
184  */
185 static int sbp2_default_workarounds;
186 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
187 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
188         ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
189         ", 36 byte inquiry = "    __stringify(SBP2_WORKAROUND_INQUIRY_36)
190         ", skip mode page 8 = "   __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
191         ", fix capacity = "       __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
192         ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
193         ", or a combination)");
194
195
196 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
197 #define SBP2_ERR(fmt, args...)  HPSB_ERR("sbp2: "fmt, ## args)
198
199 /*
200  * Globals
201  */
202 static void sbp2scsi_complete_all_commands(struct sbp2_lu *, u32);
203 static void sbp2scsi_complete_command(struct sbp2_lu *, u32, struct scsi_cmnd *,
204                                       void (*)(struct scsi_cmnd *));
205 static struct sbp2_lu *sbp2_alloc_device(struct unit_directory *);
206 static int sbp2_start_device(struct sbp2_lu *);
207 static void sbp2_remove_device(struct sbp2_lu *);
208 static int sbp2_login_device(struct sbp2_lu *);
209 static int sbp2_reconnect_device(struct sbp2_lu *);
210 static int sbp2_logout_device(struct sbp2_lu *);
211 static void sbp2_host_reset(struct hpsb_host *);
212 static int sbp2_handle_status_write(struct hpsb_host *, int, int, quadlet_t *,
213                                     u64, size_t, u16);
214 static int sbp2_agent_reset(struct sbp2_lu *, int);
215 static void sbp2_parse_unit_directory(struct sbp2_lu *,
216                                       struct unit_directory *);
217 static int sbp2_set_busy_timeout(struct sbp2_lu *);
218 static int sbp2_max_speed_and_size(struct sbp2_lu *);
219
220
221 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
222
223 static struct hpsb_highlevel sbp2_highlevel = {
224         .name           = SBP2_DEVICE_NAME,
225         .host_reset     = sbp2_host_reset,
226 };
227
228 static struct hpsb_address_ops sbp2_ops = {
229         .write          = sbp2_handle_status_write
230 };
231
232 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
233 static int sbp2_handle_physdma_write(struct hpsb_host *, int, int, quadlet_t *,
234                                      u64, size_t, u16);
235 static int sbp2_handle_physdma_read(struct hpsb_host *, int, quadlet_t *, u64,
236                                     size_t, u16);
237
238 static struct hpsb_address_ops sbp2_physdma_ops = {
239         .read           = sbp2_handle_physdma_read,
240         .write          = sbp2_handle_physdma_write,
241 };
242 #endif
243
244
245 /*
246  * Interface to driver core and IEEE 1394 core
247  */
248 static struct ieee1394_device_id sbp2_id_table[] = {
249         {
250          .match_flags   = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
251          .specifier_id  = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
252          .version       = SBP2_SW_VERSION_ENTRY & 0xffffff},
253         {}
254 };
255 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
256
257 static int sbp2_probe(struct device *);
258 static int sbp2_remove(struct device *);
259 static int sbp2_update(struct unit_directory *);
260
261 static struct hpsb_protocol_driver sbp2_driver = {
262         .name           = "SBP2 Driver",
263         .id_table       = sbp2_id_table,
264         .update         = sbp2_update,
265         .driver         = {
266                 .name           = SBP2_DEVICE_NAME,
267                 .bus            = &ieee1394_bus_type,
268                 .probe          = sbp2_probe,
269                 .remove         = sbp2_remove,
270         },
271 };
272
273
274 /*
275  * Interface to SCSI core
276  */
277 static int sbp2scsi_queuecommand(struct scsi_cmnd *,
278                                  void (*)(struct scsi_cmnd *));
279 static int sbp2scsi_abort(struct scsi_cmnd *);
280 static int sbp2scsi_reset(struct scsi_cmnd *);
281 static int sbp2scsi_slave_alloc(struct scsi_device *);
282 static int sbp2scsi_slave_configure(struct scsi_device *);
283 static void sbp2scsi_slave_destroy(struct scsi_device *);
284 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *,
285                                            struct device_attribute *, char *);
286
287 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
288
289 static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
290         &dev_attr_ieee1394_id,
291         NULL
292 };
293
294 static struct scsi_host_template sbp2_shost_template = {
295         .module                  = THIS_MODULE,
296         .name                    = "SBP-2 IEEE-1394",
297         .proc_name               = SBP2_DEVICE_NAME,
298         .queuecommand            = sbp2scsi_queuecommand,
299         .eh_abort_handler        = sbp2scsi_abort,
300         .eh_device_reset_handler = sbp2scsi_reset,
301         .slave_alloc             = sbp2scsi_slave_alloc,
302         .slave_configure         = sbp2scsi_slave_configure,
303         .slave_destroy           = sbp2scsi_slave_destroy,
304         .this_id                 = -1,
305         .sg_tablesize            = SG_ALL,
306         .use_clustering          = ENABLE_CLUSTERING,
307         .cmd_per_lun             = SBP2_MAX_CMDS,
308         .can_queue               = SBP2_MAX_CMDS,
309         .emulated                = 1,
310         .sdev_attrs              = sbp2_sysfs_sdev_attrs,
311 };
312
313
314 /*
315  * List of devices with known bugs.
316  *
317  * The firmware_revision field, masked with 0xffff00, is the best indicator
318  * for the type of bridge chip of a device.  It yields a few false positives
319  * but this did not break correctly behaving devices so far.
320  */
321 static const struct {
322         u32 firmware_revision;
323         u32 model_id;
324         unsigned workarounds;
325 } sbp2_workarounds_table[] = {
326         /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
327                 .firmware_revision      = 0x002800,
328                 .model_id               = 0x001010,
329                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36 |
330                                           SBP2_WORKAROUND_MODE_SENSE_8,
331         },
332         /* Initio bridges, actually only needed for some older ones */ {
333                 .firmware_revision      = 0x000200,
334                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36,
335         },
336         /* Symbios bridge */ {
337                 .firmware_revision      = 0xa0b800,
338                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS,
339         },
340         /*
341          * Note about the following Apple iPod blacklist entries:
342          *
343          * There are iPods (2nd gen, 3rd gen) with model_id==0.  Since our
344          * matching logic treats 0 as a wildcard, we cannot match this ID
345          * without rewriting the matching routine.  Fortunately these iPods
346          * do not feature the read_capacity bug according to one report.
347          * Read_capacity behaviour as well as model_id could change due to
348          * Apple-supplied firmware updates though.
349          */
350         /* iPod 4th generation */ {
351                 .firmware_revision      = 0x0a2700,
352                 .model_id               = 0x000021,
353                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
354         },
355         /* iPod mini */ {
356                 .firmware_revision      = 0x0a2700,
357                 .model_id               = 0x000023,
358                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
359         },
360         /* iPod Photo */ {
361                 .firmware_revision      = 0x0a2700,
362                 .model_id               = 0x00007e,
363                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
364         }
365 };
366
367 /**************************************
368  * General utility functions
369  **************************************/
370
371 #ifndef __BIG_ENDIAN
372 /*
373  * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
374  */
375 static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
376 {
377         u32 *temp = buffer;
378
379         for (length = (length >> 2); length--; )
380                 temp[length] = be32_to_cpu(temp[length]);
381 }
382
383 /*
384  * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
385  */
386 static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
387 {
388         u32 *temp = buffer;
389
390         for (length = (length >> 2); length--; )
391                 temp[length] = cpu_to_be32(temp[length]);
392 }
393 #else /* BIG_ENDIAN */
394 /* Why waste the cpu cycles? */
395 #define sbp2util_be32_to_cpu_buffer(x,y) do {} while (0)
396 #define sbp2util_cpu_to_be32_buffer(x,y) do {} while (0)
397 #endif
398
399 static DECLARE_WAIT_QUEUE_HEAD(sbp2_access_wq);
400
401 /*
402  * Waits for completion of an SBP-2 access request.
403  * Returns nonzero if timed out or prematurely interrupted.
404  */
405 static int sbp2util_access_timeout(struct sbp2_lu *lu, int timeout)
406 {
407         long leftover;
408
409         leftover = wait_event_interruptible_timeout(
410                         sbp2_access_wq, lu->access_complete, timeout);
411         lu->access_complete = 0;
412         return leftover <= 0;
413 }
414
415 static void sbp2_free_packet(void *packet)
416 {
417         hpsb_free_tlabel(packet);
418         hpsb_free_packet(packet);
419 }
420
421 /*
422  * This is much like hpsb_node_write(), except it ignores the response
423  * subaction and returns immediately. Can be used from atomic context.
424  */
425 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
426                                        quadlet_t *buf, size_t len)
427 {
428         struct hpsb_packet *packet;
429
430         packet = hpsb_make_writepacket(ne->host, ne->nodeid, addr, buf, len);
431         if (!packet)
432                 return -ENOMEM;
433
434         hpsb_set_packet_complete_task(packet, sbp2_free_packet, packet);
435         hpsb_node_fill_packet(ne, packet);
436         if (hpsb_send_packet(packet) < 0) {
437                 sbp2_free_packet(packet);
438                 return -EIO;
439         }
440         return 0;
441 }
442
443 static void sbp2util_notify_fetch_agent(struct sbp2_lu *lu, u64 offset,
444                                         quadlet_t *data, size_t len)
445 {
446         /* There is a small window after a bus reset within which the node
447          * entry's generation is current but the reconnect wasn't completed. */
448         if (unlikely(atomic_read(&lu->state) == SBP2LU_STATE_IN_RESET))
449                 return;
450
451         if (hpsb_node_write(lu->ne, lu->command_block_agent_addr + offset,
452                             data, len))
453                 SBP2_ERR("sbp2util_notify_fetch_agent failed.");
454
455         /* Now accept new SCSI commands, unless a bus reset happended during
456          * hpsb_node_write. */
457         if (likely(atomic_read(&lu->state) != SBP2LU_STATE_IN_RESET))
458                 scsi_unblock_requests(lu->shost);
459 }
460
461 static void sbp2util_write_orb_pointer(struct work_struct *work)
462 {
463         quadlet_t data[2];
464
465         data[0] = ORB_SET_NODE_ID((container_of(work, struct sbp2_lu, protocol_work))->hi->host->node_id);
466         data[1] = (container_of(work, struct sbp2_lu, protocol_work))->last_orb_dma;
467         sbp2util_cpu_to_be32_buffer(data, 8);
468         sbp2util_notify_fetch_agent(container_of(work, struct sbp2_lu, protocol_work), SBP2_ORB_POINTER_OFFSET, data, 8);
469 }
470
471 static void sbp2util_write_doorbell(struct work_struct *work)
472 {
473         sbp2util_notify_fetch_agent(container_of(work, struct sbp2_lu, protocol_work), SBP2_DOORBELL_OFFSET, NULL, 4);
474 }
475
476 static int sbp2util_create_command_orb_pool(struct sbp2_lu *lu)
477 {
478         struct sbp2_fwhost_info *hi = lu->hi;
479         int i;
480         unsigned long flags, orbs;
481         struct sbp2_command_info *cmd;
482
483         orbs = sbp2_serialize_io ? 2 : SBP2_MAX_CMDS;
484
485         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
486         for (i = 0; i < orbs; i++) {
487                 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
488                 if (!cmd) {
489                         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
490                         return -ENOMEM;
491                 }
492                 cmd->command_orb_dma = dma_map_single(&hi->host->device,
493                                                 &cmd->command_orb,
494                                                 sizeof(struct sbp2_command_orb),
495                                                 DMA_TO_DEVICE);
496                 cmd->sge_dma = dma_map_single(&hi->host->device,
497                                         &cmd->scatter_gather_element,
498                                         sizeof(cmd->scatter_gather_element),
499                                         DMA_BIDIRECTIONAL);
500                 INIT_LIST_HEAD(&cmd->list);
501                 list_add_tail(&cmd->list, &lu->cmd_orb_completed);
502         }
503         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
504         return 0;
505 }
506
507 static void sbp2util_remove_command_orb_pool(struct sbp2_lu *lu)
508 {
509         struct hpsb_host *host = lu->hi->host;
510         struct list_head *lh, *next;
511         struct sbp2_command_info *cmd;
512         unsigned long flags;
513
514         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
515         if (!list_empty(&lu->cmd_orb_completed))
516                 list_for_each_safe(lh, next, &lu->cmd_orb_completed) {
517                         cmd = list_entry(lh, struct sbp2_command_info, list);
518                         dma_unmap_single(&host->device, cmd->command_orb_dma,
519                                          sizeof(struct sbp2_command_orb),
520                                          DMA_TO_DEVICE);
521                         dma_unmap_single(&host->device, cmd->sge_dma,
522                                          sizeof(cmd->scatter_gather_element),
523                                          DMA_BIDIRECTIONAL);
524                         kfree(cmd);
525                 }
526         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
527         return;
528 }
529
530 /*
531  * Finds the sbp2_command for a given outstanding command ORB.
532  * Only looks at the in-use list.
533  */
534 static struct sbp2_command_info *sbp2util_find_command_for_orb(
535                                 struct sbp2_lu *lu, dma_addr_t orb)
536 {
537         struct sbp2_command_info *cmd;
538         unsigned long flags;
539
540         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
541         if (!list_empty(&lu->cmd_orb_inuse))
542                 list_for_each_entry(cmd, &lu->cmd_orb_inuse, list)
543                         if (cmd->command_orb_dma == orb) {
544                                 spin_unlock_irqrestore(
545                                                 &lu->cmd_orb_lock, flags);
546                                 return cmd;
547                         }
548         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
549         return NULL;
550 }
551
552 /*
553  * Finds the sbp2_command for a given outstanding SCpnt.
554  * Only looks at the in-use list.
555  * Must be called with lu->cmd_orb_lock held.
556  */
557 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
558                                 struct sbp2_lu *lu, void *SCpnt)
559 {
560         struct sbp2_command_info *cmd;
561
562         if (!list_empty(&lu->cmd_orb_inuse))
563                 list_for_each_entry(cmd, &lu->cmd_orb_inuse, list)
564                         if (cmd->Current_SCpnt == SCpnt)
565                                 return cmd;
566         return NULL;
567 }
568
569 static struct sbp2_command_info *sbp2util_allocate_command_orb(
570                                 struct sbp2_lu *lu,
571                                 struct scsi_cmnd *Current_SCpnt,
572                                 void (*Current_done)(struct scsi_cmnd *))
573 {
574         struct list_head *lh;
575         struct sbp2_command_info *cmd = NULL;
576         unsigned long flags;
577
578         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
579         if (!list_empty(&lu->cmd_orb_completed)) {
580                 lh = lu->cmd_orb_completed.next;
581                 list_del(lh);
582                 cmd = list_entry(lh, struct sbp2_command_info, list);
583                 cmd->Current_done = Current_done;
584                 cmd->Current_SCpnt = Current_SCpnt;
585                 list_add_tail(&cmd->list, &lu->cmd_orb_inuse);
586         } else
587                 SBP2_ERR("%s: no orbs available", __FUNCTION__);
588         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
589         return cmd;
590 }
591
592 /*
593  * Unmaps the DMAs of a command and moves the command to the completed ORB list.
594  * Must be called with lu->cmd_orb_lock held.
595  */
596 static void sbp2util_mark_command_completed(struct sbp2_lu *lu,
597                                             struct sbp2_command_info *cmd)
598 {
599         struct hpsb_host *host = lu->ud->ne->host;
600
601         if (cmd->cmd_dma) {
602                 if (cmd->dma_type == CMD_DMA_SINGLE)
603                         dma_unmap_single(&host->device, cmd->cmd_dma,
604                                          cmd->dma_size, cmd->dma_dir);
605                 else if (cmd->dma_type == CMD_DMA_PAGE)
606                         dma_unmap_page(&host->device, cmd->cmd_dma,
607                                        cmd->dma_size, cmd->dma_dir);
608                 /* XXX: Check for CMD_DMA_NONE bug */
609                 cmd->dma_type = CMD_DMA_NONE;
610                 cmd->cmd_dma = 0;
611         }
612         if (cmd->sge_buffer) {
613                 dma_unmap_sg(&host->device, cmd->sge_buffer,
614                              cmd->dma_size, cmd->dma_dir);
615                 cmd->sge_buffer = NULL;
616         }
617         list_move_tail(&cmd->list, &lu->cmd_orb_completed);
618 }
619
620 /*
621  * Is lu valid? Is the 1394 node still present?
622  */
623 static inline int sbp2util_node_is_available(struct sbp2_lu *lu)
624 {
625         return lu && lu->ne && !lu->ne->in_limbo;
626 }
627
628 /*********************************************
629  * IEEE-1394 core driver stack related section
630  *********************************************/
631
632 static int sbp2_probe(struct device *dev)
633 {
634         struct unit_directory *ud;
635         struct sbp2_lu *lu;
636
637         ud = container_of(dev, struct unit_directory, device);
638
639         /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
640          * instead. */
641         if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
642                 return -ENODEV;
643
644         lu = sbp2_alloc_device(ud);
645         if (!lu)
646                 return -ENOMEM;
647
648         sbp2_parse_unit_directory(lu, ud);
649         return sbp2_start_device(lu);
650 }
651
652 static int sbp2_remove(struct device *dev)
653 {
654         struct unit_directory *ud;
655         struct sbp2_lu *lu;
656         struct scsi_device *sdev;
657
658         ud = container_of(dev, struct unit_directory, device);
659         lu = ud->device.driver_data;
660         if (!lu)
661                 return 0;
662
663         if (lu->shost) {
664                 /* Get rid of enqueued commands if there is no chance to
665                  * send them. */
666                 if (!sbp2util_node_is_available(lu))
667                         sbp2scsi_complete_all_commands(lu, DID_NO_CONNECT);
668                 /* scsi_remove_device() may trigger shutdown functions of SCSI
669                  * highlevel drivers which would deadlock if blocked. */
670                 atomic_set(&lu->state, SBP2LU_STATE_IN_SHUTDOWN);
671                 scsi_unblock_requests(lu->shost);
672         }
673         sdev = lu->sdev;
674         if (sdev) {
675                 lu->sdev = NULL;
676                 scsi_remove_device(sdev);
677         }
678
679         sbp2_logout_device(lu);
680         sbp2_remove_device(lu);
681
682         return 0;
683 }
684
685 static int sbp2_update(struct unit_directory *ud)
686 {
687         struct sbp2_lu *lu = ud->device.driver_data;
688
689         if (sbp2_reconnect_device(lu)) {
690                 /* Reconnect has failed. Perhaps we didn't reconnect fast
691                  * enough. Try a regular login, but first log out just in
692                  * case of any weirdness. */
693                 sbp2_logout_device(lu);
694
695                 if (sbp2_login_device(lu)) {
696                         /* Login failed too, just fail, and the backend
697                          * will call our sbp2_remove for us */
698                         SBP2_ERR("Failed to reconnect to sbp2 device!");
699                         return -EBUSY;
700                 }
701         }
702
703         sbp2_set_busy_timeout(lu);
704         sbp2_agent_reset(lu, 1);
705         sbp2_max_speed_and_size(lu);
706
707         /* Complete any pending commands with busy (so they get retried)
708          * and remove them from our queue. */
709         sbp2scsi_complete_all_commands(lu, DID_BUS_BUSY);
710
711         /* Accept new commands unless there was another bus reset in the
712          * meantime. */
713         if (hpsb_node_entry_valid(lu->ne)) {
714                 atomic_set(&lu->state, SBP2LU_STATE_RUNNING);
715                 scsi_unblock_requests(lu->shost);
716         }
717         return 0;
718 }
719
720 static struct sbp2_lu *sbp2_alloc_device(struct unit_directory *ud)
721 {
722         struct sbp2_fwhost_info *hi;
723         struct Scsi_Host *shost = NULL;
724         struct sbp2_lu *lu = NULL;
725
726         lu = kzalloc(sizeof(*lu), GFP_KERNEL);
727         if (!lu) {
728                 SBP2_ERR("failed to create lu");
729                 goto failed_alloc;
730         }
731
732         lu->ne = ud->ne;
733         lu->ud = ud;
734         lu->speed_code = IEEE1394_SPEED_100;
735         lu->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
736         lu->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
737         INIT_LIST_HEAD(&lu->cmd_orb_inuse);
738         INIT_LIST_HEAD(&lu->cmd_orb_completed);
739         INIT_LIST_HEAD(&lu->lu_list);
740         spin_lock_init(&lu->cmd_orb_lock);
741         atomic_set(&lu->state, SBP2LU_STATE_RUNNING);
742         INIT_WORK(&lu->protocol_work, NULL);
743
744         ud->device.driver_data = lu;
745
746         hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
747         if (!hi) {
748                 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host,
749                                           sizeof(*hi));
750                 if (!hi) {
751                         SBP2_ERR("failed to allocate hostinfo");
752                         goto failed_alloc;
753                 }
754                 hi->host = ud->ne->host;
755                 INIT_LIST_HEAD(&hi->logical_units);
756
757 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
758                 /* Handle data movement if physical dma is not
759                  * enabled or not supported on host controller */
760                 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
761                                              &sbp2_physdma_ops,
762                                              0x0ULL, 0xfffffffcULL)) {
763                         SBP2_ERR("failed to register lower 4GB address range");
764                         goto failed_alloc;
765                 }
766 #endif
767         }
768
769         /* Prevent unloading of the 1394 host */
770         if (!try_module_get(hi->host->driver->owner)) {
771                 SBP2_ERR("failed to get a reference on 1394 host driver");
772                 goto failed_alloc;
773         }
774
775         lu->hi = hi;
776
777         list_add_tail(&lu->lu_list, &hi->logical_units);
778
779         /* Register the status FIFO address range. We could use the same FIFO
780          * for targets at different nodes. However we need different FIFOs per
781          * target in order to support multi-unit devices.
782          * The FIFO is located out of the local host controller's physical range
783          * but, if possible, within the posted write area. Status writes will
784          * then be performed as unified transactions. This slightly reduces
785          * bandwidth usage, and some Prolific based devices seem to require it.
786          */
787         lu->status_fifo_addr = hpsb_allocate_and_register_addrspace(
788                         &sbp2_highlevel, ud->ne->host, &sbp2_ops,
789                         sizeof(struct sbp2_status_block), sizeof(quadlet_t),
790                         ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
791         if (lu->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
792                 SBP2_ERR("failed to allocate status FIFO address range");
793                 goto failed_alloc;
794         }
795
796         shost = scsi_host_alloc(&sbp2_shost_template, sizeof(unsigned long));
797         if (!shost) {
798                 SBP2_ERR("failed to register scsi host");
799                 goto failed_alloc;
800         }
801
802         shost->hostdata[0] = (unsigned long)lu;
803
804         if (!scsi_add_host(shost, &ud->device)) {
805                 lu->shost = shost;
806                 return lu;
807         }
808
809         SBP2_ERR("failed to add scsi host");
810         scsi_host_put(shost);
811
812 failed_alloc:
813         sbp2_remove_device(lu);
814         return NULL;
815 }
816
817 static void sbp2_host_reset(struct hpsb_host *host)
818 {
819         struct sbp2_fwhost_info *hi;
820         struct sbp2_lu *lu;
821
822         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
823         if (!hi)
824                 return;
825         list_for_each_entry(lu, &hi->logical_units, lu_list)
826                 if (likely(atomic_read(&lu->state) !=
827                            SBP2LU_STATE_IN_SHUTDOWN)) {
828                         atomic_set(&lu->state, SBP2LU_STATE_IN_RESET);
829                         scsi_block_requests(lu->shost);
830                 }
831 }
832
833 static int sbp2_start_device(struct sbp2_lu *lu)
834 {
835         struct sbp2_fwhost_info *hi = lu->hi;
836         int error;
837
838         lu->login_response = dma_alloc_coherent(&hi->host->device,
839                                      sizeof(struct sbp2_login_response),
840                                      &lu->login_response_dma, GFP_KERNEL);
841         if (!lu->login_response)
842                 goto alloc_fail;
843
844         lu->query_logins_orb = dma_alloc_coherent(&hi->host->device,
845                                      sizeof(struct sbp2_query_logins_orb),
846                                      &lu->query_logins_orb_dma, GFP_KERNEL);
847         if (!lu->query_logins_orb)
848                 goto alloc_fail;
849
850         lu->query_logins_response = dma_alloc_coherent(&hi->host->device,
851                                      sizeof(struct sbp2_query_logins_response),
852                                      &lu->query_logins_response_dma, GFP_KERNEL);
853         if (!lu->query_logins_response)
854                 goto alloc_fail;
855
856         lu->reconnect_orb = dma_alloc_coherent(&hi->host->device,
857                                      sizeof(struct sbp2_reconnect_orb),
858                                      &lu->reconnect_orb_dma, GFP_KERNEL);
859         if (!lu->reconnect_orb)
860                 goto alloc_fail;
861
862         lu->logout_orb = dma_alloc_coherent(&hi->host->device,
863                                      sizeof(struct sbp2_logout_orb),
864                                      &lu->logout_orb_dma, GFP_KERNEL);
865         if (!lu->logout_orb)
866                 goto alloc_fail;
867
868         lu->login_orb = dma_alloc_coherent(&hi->host->device,
869                                      sizeof(struct sbp2_login_orb),
870                                      &lu->login_orb_dma, GFP_KERNEL);
871         if (!lu->login_orb)
872                 goto alloc_fail;
873
874         if (sbp2util_create_command_orb_pool(lu)) {
875                 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
876                 sbp2_remove_device(lu);
877                 return -ENOMEM;
878         }
879
880         /* Wait a second before trying to log in. Previously logged in
881          * initiators need a chance to reconnect. */
882         if (msleep_interruptible(1000)) {
883                 sbp2_remove_device(lu);
884                 return -EINTR;
885         }
886
887         if (sbp2_login_device(lu)) {
888                 sbp2_remove_device(lu);
889                 return -EBUSY;
890         }
891
892         sbp2_set_busy_timeout(lu);
893         sbp2_agent_reset(lu, 1);
894         sbp2_max_speed_and_size(lu);
895
896         error = scsi_add_device(lu->shost, 0, lu->ud->id, 0);
897         if (error) {
898                 SBP2_ERR("scsi_add_device failed");
899                 sbp2_logout_device(lu);
900                 sbp2_remove_device(lu);
901                 return error;
902         }
903
904         return 0;
905
906 alloc_fail:
907         SBP2_ERR("Could not allocate memory for lu");
908         sbp2_remove_device(lu);
909         return -ENOMEM;
910 }
911
912 static void sbp2_remove_device(struct sbp2_lu *lu)
913 {
914         struct sbp2_fwhost_info *hi;
915
916         if (!lu)
917                 return;
918
919         hi = lu->hi;
920
921         if (lu->shost) {
922                 scsi_remove_host(lu->shost);
923                 scsi_host_put(lu->shost);
924         }
925         flush_scheduled_work();
926         sbp2util_remove_command_orb_pool(lu);
927
928         list_del(&lu->lu_list);
929
930         if (lu->login_response)
931                 dma_free_coherent(&hi->host->device,
932                                     sizeof(struct sbp2_login_response),
933                                     lu->login_response,
934                                     lu->login_response_dma);
935         if (lu->login_orb)
936                 dma_free_coherent(&hi->host->device,
937                                     sizeof(struct sbp2_login_orb),
938                                     lu->login_orb,
939                                     lu->login_orb_dma);
940         if (lu->reconnect_orb)
941                 dma_free_coherent(&hi->host->device,
942                                     sizeof(struct sbp2_reconnect_orb),
943                                     lu->reconnect_orb,
944                                     lu->reconnect_orb_dma);
945         if (lu->logout_orb)
946                 dma_free_coherent(&hi->host->device,
947                                     sizeof(struct sbp2_logout_orb),
948                                     lu->logout_orb,
949                                     lu->logout_orb_dma);
950         if (lu->query_logins_orb)
951                 dma_free_coherent(&hi->host->device,
952                                     sizeof(struct sbp2_query_logins_orb),
953                                     lu->query_logins_orb,
954                                     lu->query_logins_orb_dma);
955         if (lu->query_logins_response)
956                 dma_free_coherent(&hi->host->device,
957                                     sizeof(struct sbp2_query_logins_response),
958                                     lu->query_logins_response,
959                                     lu->query_logins_response_dma);
960
961         if (lu->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
962                 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
963                                           lu->status_fifo_addr);
964
965         lu->ud->device.driver_data = NULL;
966
967         if (hi)
968                 module_put(hi->host->driver->owner);
969
970         kfree(lu);
971 }
972
973 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
974 /*
975  * Deal with write requests on adapters which do not support physical DMA or
976  * have it switched off.
977  */
978 static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
979                                      int destid, quadlet_t *data, u64 addr,
980                                      size_t length, u16 flags)
981 {
982         memcpy(bus_to_virt((u32) addr), data, length);
983         return RCODE_COMPLETE;
984 }
985
986 /*
987  * Deal with read requests on adapters which do not support physical DMA or
988  * have it switched off.
989  */
990 static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
991                                     quadlet_t *data, u64 addr, size_t length,
992                                     u16 flags)
993 {
994         memcpy(data, bus_to_virt((u32) addr), length);
995         return RCODE_COMPLETE;
996 }
997 #endif
998
999 /**************************************
1000  * SBP-2 protocol related section
1001  **************************************/
1002
1003 static int sbp2_query_logins(struct sbp2_lu *lu)
1004 {
1005         struct sbp2_fwhost_info *hi = lu->hi;
1006         quadlet_t data[2];
1007         int max_logins;
1008         int active_logins;
1009
1010         lu->query_logins_orb->reserved1 = 0x0;
1011         lu->query_logins_orb->reserved2 = 0x0;
1012
1013         lu->query_logins_orb->query_response_lo = lu->query_logins_response_dma;
1014         lu->query_logins_orb->query_response_hi =
1015                         ORB_SET_NODE_ID(hi->host->node_id);
1016         lu->query_logins_orb->lun_misc =
1017                         ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1018         lu->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
1019         lu->query_logins_orb->lun_misc |= ORB_SET_LUN(lu->lun);
1020
1021         lu->query_logins_orb->reserved_resp_length =
1022                 ORB_SET_QUERY_LOGINS_RESP_LENGTH(
1023                         sizeof(struct sbp2_query_logins_response));
1024
1025         lu->query_logins_orb->status_fifo_hi =
1026                 ORB_SET_STATUS_FIFO_HI(lu->status_fifo_addr, hi->host->node_id);
1027         lu->query_logins_orb->status_fifo_lo =
1028                 ORB_SET_STATUS_FIFO_LO(lu->status_fifo_addr);
1029
1030         sbp2util_cpu_to_be32_buffer(lu->query_logins_orb,
1031                                     sizeof(struct sbp2_query_logins_orb));
1032
1033         memset(lu->query_logins_response, 0,
1034                sizeof(struct sbp2_query_logins_response));
1035
1036         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1037         data[1] = lu->query_logins_orb_dma;
1038         sbp2util_cpu_to_be32_buffer(data, 8);
1039
1040         hpsb_node_write(lu->ne, lu->management_agent_addr, data, 8);
1041
1042         if (sbp2util_access_timeout(lu, 2*HZ)) {
1043                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1044                 return -EIO;
1045         }
1046
1047         if (lu->status_block.ORB_offset_lo != lu->query_logins_orb_dma) {
1048                 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
1049                 return -EIO;
1050         }
1051
1052         if (STATUS_TEST_RDS(lu->status_block.ORB_offset_hi_misc)) {
1053                 SBP2_INFO("Error querying logins to SBP-2 device - failed");
1054                 return -EIO;
1055         }
1056
1057         sbp2util_cpu_to_be32_buffer(lu->query_logins_response,
1058                                     sizeof(struct sbp2_query_logins_response));
1059
1060         max_logins = RESPONSE_GET_MAX_LOGINS(
1061                         lu->query_logins_response->length_max_logins);
1062         SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1063
1064         active_logins = RESPONSE_GET_ACTIVE_LOGINS(
1065                         lu->query_logins_response->length_max_logins);
1066         SBP2_INFO("Number of active logins: %d", active_logins);
1067
1068         if (active_logins >= max_logins) {
1069                 return -EIO;
1070         }
1071
1072         return 0;
1073 }
1074
1075 static int sbp2_login_device(struct sbp2_lu *lu)
1076 {
1077         struct sbp2_fwhost_info *hi = lu->hi;
1078         quadlet_t data[2];
1079
1080         if (!lu->login_orb)
1081                 return -EIO;
1082
1083         if (!sbp2_exclusive_login && sbp2_query_logins(lu)) {
1084                 SBP2_INFO("Device does not support any more concurrent logins");
1085                 return -EIO;
1086         }
1087
1088         /* assume no password */
1089         lu->login_orb->password_hi = 0;
1090         lu->login_orb->password_lo = 0;
1091
1092         lu->login_orb->login_response_lo = lu->login_response_dma;
1093         lu->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1094         lu->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1095
1096         /* one second reconnect time */
1097         lu->login_orb->lun_misc |= ORB_SET_RECONNECT(0);
1098         lu->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(sbp2_exclusive_login);
1099         lu->login_orb->lun_misc |= ORB_SET_NOTIFY(1);
1100         lu->login_orb->lun_misc |= ORB_SET_LUN(lu->lun);
1101
1102         lu->login_orb->passwd_resp_lengths =
1103                 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1104
1105         lu->login_orb->status_fifo_hi =
1106                 ORB_SET_STATUS_FIFO_HI(lu->status_fifo_addr, hi->host->node_id);
1107         lu->login_orb->status_fifo_lo =
1108                 ORB_SET_STATUS_FIFO_LO(lu->status_fifo_addr);
1109
1110         sbp2util_cpu_to_be32_buffer(lu->login_orb,
1111                                     sizeof(struct sbp2_login_orb));
1112
1113         memset(lu->login_response, 0, sizeof(struct sbp2_login_response));
1114
1115         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1116         data[1] = lu->login_orb_dma;
1117         sbp2util_cpu_to_be32_buffer(data, 8);
1118
1119         hpsb_node_write(lu->ne, lu->management_agent_addr, data, 8);
1120
1121         /* wait up to 20 seconds for login status */
1122         if (sbp2util_access_timeout(lu, 20*HZ)) {
1123                 SBP2_ERR("Error logging into SBP-2 device - timed out");
1124                 return -EIO;
1125         }
1126
1127         /* make sure that the returned status matches the login ORB */
1128         if (lu->status_block.ORB_offset_lo != lu->login_orb_dma) {
1129                 SBP2_ERR("Error logging into SBP-2 device - timed out");
1130                 return -EIO;
1131         }
1132
1133         if (STATUS_TEST_RDS(lu->status_block.ORB_offset_hi_misc)) {
1134                 SBP2_ERR("Error logging into SBP-2 device - failed");
1135                 return -EIO;
1136         }
1137
1138         sbp2util_cpu_to_be32_buffer(lu->login_response,
1139                                     sizeof(struct sbp2_login_response));
1140         lu->command_block_agent_addr =
1141                         ((u64)lu->login_response->command_block_agent_hi) << 32;
1142         lu->command_block_agent_addr |=
1143                         ((u64)lu->login_response->command_block_agent_lo);
1144         lu->command_block_agent_addr &= 0x0000ffffffffffffULL;
1145
1146         SBP2_INFO("Logged into SBP-2 device");
1147         return 0;
1148 }
1149
1150 static int sbp2_logout_device(struct sbp2_lu *lu)
1151 {
1152         struct sbp2_fwhost_info *hi = lu->hi;
1153         quadlet_t data[2];
1154         int error;
1155
1156         lu->logout_orb->reserved1 = 0x0;
1157         lu->logout_orb->reserved2 = 0x0;
1158         lu->logout_orb->reserved3 = 0x0;
1159         lu->logout_orb->reserved4 = 0x0;
1160
1161         lu->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1162         lu->logout_orb->login_ID_misc |=
1163                         ORB_SET_LOGIN_ID(lu->login_response->length_login_ID);
1164         lu->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1165
1166         lu->logout_orb->reserved5 = 0x0;
1167         lu->logout_orb->status_fifo_hi =
1168                 ORB_SET_STATUS_FIFO_HI(lu->status_fifo_addr, hi->host->node_id);
1169         lu->logout_orb->status_fifo_lo =
1170                 ORB_SET_STATUS_FIFO_LO(lu->status_fifo_addr);
1171
1172         sbp2util_cpu_to_be32_buffer(lu->logout_orb,
1173                                     sizeof(struct sbp2_logout_orb));
1174
1175         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1176         data[1] = lu->logout_orb_dma;
1177         sbp2util_cpu_to_be32_buffer(data, 8);
1178
1179         error = hpsb_node_write(lu->ne, lu->management_agent_addr, data, 8);
1180         if (error)
1181                 return error;
1182
1183         /* wait up to 1 second for the device to complete logout */
1184         if (sbp2util_access_timeout(lu, HZ))
1185                 return -EIO;
1186
1187         SBP2_INFO("Logged out of SBP-2 device");
1188         return 0;
1189 }
1190
1191 static int sbp2_reconnect_device(struct sbp2_lu *lu)
1192 {
1193         struct sbp2_fwhost_info *hi = lu->hi;
1194         quadlet_t data[2];
1195         int error;
1196
1197         lu->reconnect_orb->reserved1 = 0x0;
1198         lu->reconnect_orb->reserved2 = 0x0;
1199         lu->reconnect_orb->reserved3 = 0x0;
1200         lu->reconnect_orb->reserved4 = 0x0;
1201
1202         lu->reconnect_orb->login_ID_misc =
1203                         ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1204         lu->reconnect_orb->login_ID_misc |=
1205                         ORB_SET_LOGIN_ID(lu->login_response->length_login_ID);
1206         lu->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1207
1208         lu->reconnect_orb->reserved5 = 0x0;
1209         lu->reconnect_orb->status_fifo_hi =
1210                 ORB_SET_STATUS_FIFO_HI(lu->status_fifo_addr, hi->host->node_id);
1211         lu->reconnect_orb->status_fifo_lo =
1212                 ORB_SET_STATUS_FIFO_LO(lu->status_fifo_addr);
1213
1214         sbp2util_cpu_to_be32_buffer(lu->reconnect_orb,
1215                                     sizeof(struct sbp2_reconnect_orb));
1216
1217         data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1218         data[1] = lu->reconnect_orb_dma;
1219         sbp2util_cpu_to_be32_buffer(data, 8);
1220
1221         error = hpsb_node_write(lu->ne, lu->management_agent_addr, data, 8);
1222         if (error)
1223                 return error;
1224
1225         /* wait up to 1 second for reconnect status */
1226         if (sbp2util_access_timeout(lu, HZ)) {
1227                 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1228                 return -EIO;
1229         }
1230
1231         /* make sure that the returned status matches the reconnect ORB */
1232         if (lu->status_block.ORB_offset_lo != lu->reconnect_orb_dma) {
1233                 SBP2_ERR("Error reconnecting to SBP-2 device - timed out");
1234                 return -EIO;
1235         }
1236
1237         if (STATUS_TEST_RDS(lu->status_block.ORB_offset_hi_misc)) {
1238                 SBP2_ERR("Error reconnecting to SBP-2 device - failed");
1239                 return -EIO;
1240         }
1241
1242         SBP2_INFO("Reconnected to SBP-2 device");
1243         return 0;
1244 }
1245
1246 /*
1247  * Set the target node's Single Phase Retry limit. Affects the target's retry
1248  * behaviour if our node is too busy to accept requests.
1249  */
1250 static int sbp2_set_busy_timeout(struct sbp2_lu *lu)
1251 {
1252         quadlet_t data;
1253
1254         data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
1255         if (hpsb_node_write(lu->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1256                 SBP2_ERR("%s error", __FUNCTION__);
1257         return 0;
1258 }
1259
1260 static void sbp2_parse_unit_directory(struct sbp2_lu *lu,
1261                                       struct unit_directory *ud)
1262 {
1263         struct csr1212_keyval *kv;
1264         struct csr1212_dentry *dentry;
1265         u64 management_agent_addr;
1266         u32 unit_characteristics, firmware_revision;
1267         unsigned workarounds;
1268         int i;
1269
1270         management_agent_addr = 0;
1271         unit_characteristics = 0;
1272         firmware_revision = 0;
1273
1274         csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1275                 switch (kv->key.id) {
1276                 case CSR1212_KV_ID_DEPENDENT_INFO:
1277                         if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET)
1278                                 management_agent_addr =
1279                                     CSR1212_REGISTER_SPACE_BASE +
1280                                     (kv->value.csr_offset << 2);
1281
1282                         else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE)
1283                                 lu->lun = ORB_SET_LUN(kv->value.immediate);
1284                         break;
1285
1286                 case SBP2_UNIT_CHARACTERISTICS_KEY:
1287                         /* FIXME: This is ignored so far.
1288                          * See SBP-2 clause 7.4.8. */
1289                         unit_characteristics = kv->value.immediate;
1290                         break;
1291
1292                 case SBP2_FIRMWARE_REVISION_KEY:
1293                         firmware_revision = kv->value.immediate;
1294                         break;
1295
1296                 default:
1297                         /* FIXME: Check for SBP2_DEVICE_TYPE_AND_LUN_KEY.
1298                          * Its "ordered" bit has consequences for command ORB
1299                          * list handling. See SBP-2 clauses 4.6, 7.4.11, 10.2 */
1300                         break;
1301                 }
1302         }
1303
1304         workarounds = sbp2_default_workarounds;
1305
1306         if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1307                 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1308                         if (sbp2_workarounds_table[i].firmware_revision &&
1309                             sbp2_workarounds_table[i].firmware_revision !=
1310                             (firmware_revision & 0xffff00))
1311                                 continue;
1312                         if (sbp2_workarounds_table[i].model_id &&
1313                             sbp2_workarounds_table[i].model_id != ud->model_id)
1314                                 continue;
1315                         workarounds |= sbp2_workarounds_table[i].workarounds;
1316                         break;
1317                 }
1318
1319         if (workarounds)
1320                 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1321                           "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1322                           " model_id 0x%06x)",
1323                           NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1324                           workarounds, firmware_revision,
1325                           ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1326                           ud->model_id);
1327
1328         /* We would need one SCSI host template for each target to adjust
1329          * max_sectors on the fly, therefore warn only. */
1330         if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1331             (sbp2_max_sectors * 512) > (128 * 1024))
1332                 SBP2_INFO("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1333                           "max transfer size. WARNING: Current max_sectors "
1334                           "setting is larger than 128KB (%d sectors)",
1335                           NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1336                           sbp2_max_sectors);
1337
1338         /* If this is a logical unit directory entry, process the parent
1339          * to get the values. */
1340         if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1341                 struct unit_directory *parent_ud = container_of(
1342                         ud->device.parent, struct unit_directory, device);
1343                 sbp2_parse_unit_directory(lu, parent_ud);
1344         } else {
1345                 lu->management_agent_addr = management_agent_addr;
1346                 lu->workarounds = workarounds;
1347                 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
1348                         lu->lun = ORB_SET_LUN(ud->lun);
1349         }
1350 }
1351
1352 #define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1353
1354 /*
1355  * This function is called in order to determine the max speed and packet
1356  * size we can use in our ORBs. Note, that we (the driver and host) only
1357  * initiate the transaction. The SBP-2 device actually transfers the data
1358  * (by reading from the DMA area we tell it). This means that the SBP-2
1359  * device decides the actual maximum data it can transfer. We just tell it
1360  * the speed that it needs to use, and the max_rec the host supports, and
1361  * it takes care of the rest.
1362  */
1363 static int sbp2_max_speed_and_size(struct sbp2_lu *lu)
1364 {
1365         struct sbp2_fwhost_info *hi = lu->hi;
1366         u8 payload;
1367
1368         lu->speed_code = hi->host->speed[NODEID_TO_NODE(lu->ne->nodeid)];
1369
1370         if (lu->speed_code > sbp2_max_speed) {
1371                 lu->speed_code = sbp2_max_speed;
1372                 SBP2_INFO("Reducing speed to %s",
1373                           hpsb_speedto_str[sbp2_max_speed]);
1374         }
1375
1376         /* Payload size is the lesser of what our speed supports and what
1377          * our host supports.  */
1378         payload = min(sbp2_speedto_max_payload[lu->speed_code],
1379                       (u8) (hi->host->csr.max_rec - 1));
1380
1381         /* If physical DMA is off, work around limitation in ohci1394:
1382          * packet size must not exceed PAGE_SIZE */
1383         if (lu->ne->host->low_addr_space < (1ULL << 32))
1384                 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1385                        payload)
1386                         payload--;
1387
1388         SBP2_INFO("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1389                   NODE_BUS_ARGS(hi->host, lu->ne->nodeid),
1390                   hpsb_speedto_str[lu->speed_code],
1391                   SBP2_PAYLOAD_TO_BYTES(payload));
1392
1393         lu->max_payload_size = payload;
1394         return 0;
1395 }
1396
1397 static int sbp2_agent_reset(struct sbp2_lu *lu, int wait)
1398 {
1399         quadlet_t data;
1400         u64 addr;
1401         int retval;
1402         unsigned long flags;
1403
1404         /* cancel_delayed_work(&lu->protocol_work); */
1405         if (wait)
1406                 flush_scheduled_work();
1407
1408         data = ntohl(SBP2_AGENT_RESET_DATA);
1409         addr = lu->command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1410
1411         if (wait)
1412                 retval = hpsb_node_write(lu->ne, addr, &data, 4);
1413         else
1414                 retval = sbp2util_node_write_no_wait(lu->ne, addr, &data, 4);
1415
1416         if (retval < 0) {
1417                 SBP2_ERR("hpsb_node_write failed.\n");
1418                 return -EIO;
1419         }
1420
1421         /* make sure that the ORB_POINTER is written on next command */
1422         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
1423         lu->last_orb = NULL;
1424         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
1425
1426         return 0;
1427 }
1428
1429 static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1430                                      struct sbp2_fwhost_info *hi,
1431                                      struct sbp2_command_info *cmd,
1432                                      unsigned int scsi_use_sg,
1433                                      struct scatterlist *sgpnt,
1434                                      u32 orb_direction,
1435                                      enum dma_data_direction dma_dir)
1436 {
1437         cmd->dma_dir = dma_dir;
1438         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1439         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1440
1441         /* special case if only one element (and less than 64KB in size) */
1442         if ((scsi_use_sg == 1) &&
1443             (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1444
1445                 cmd->dma_size = sgpnt[0].length;
1446                 cmd->dma_type = CMD_DMA_PAGE;
1447                 cmd->cmd_dma = dma_map_page(&hi->host->device,
1448                                             sgpnt[0].page, sgpnt[0].offset,
1449                                             cmd->dma_size, cmd->dma_dir);
1450
1451                 orb->data_descriptor_lo = cmd->cmd_dma;
1452                 orb->misc |= ORB_SET_DATA_SIZE(cmd->dma_size);
1453
1454         } else {
1455                 struct sbp2_unrestricted_page_table *sg_element =
1456                                                 &cmd->scatter_gather_element[0];
1457                 u32 sg_count, sg_len;
1458                 dma_addr_t sg_addr;
1459                 int i, count = dma_map_sg(&hi->host->device, sgpnt, scsi_use_sg,
1460                                           dma_dir);
1461
1462                 cmd->dma_size = scsi_use_sg;
1463                 cmd->sge_buffer = sgpnt;
1464
1465                 /* use page tables (s/g) */
1466                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1467                 orb->data_descriptor_lo = cmd->sge_dma;
1468
1469                 /* loop through and fill out our SBP-2 page tables
1470                  * (and split up anything too large) */
1471                 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1472                         sg_len = sg_dma_len(sgpnt);
1473                         sg_addr = sg_dma_address(sgpnt);
1474                         while (sg_len) {
1475                                 sg_element[sg_count].segment_base_lo = sg_addr;
1476                                 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1477                                         sg_element[sg_count].length_segment_base_hi =
1478                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1479                                         sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1480                                         sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1481                                 } else {
1482                                         sg_element[sg_count].length_segment_base_hi =
1483                                                 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1484                                         sg_len = 0;
1485                                 }
1486                                 sg_count++;
1487                         }
1488                 }
1489
1490                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1491
1492                 sbp2util_cpu_to_be32_buffer(sg_element,
1493                                 (sizeof(struct sbp2_unrestricted_page_table)) *
1494                                 sg_count);
1495         }
1496 }
1497
1498 static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1499                                         struct sbp2_fwhost_info *hi,
1500                                         struct sbp2_command_info *cmd,
1501                                         struct scatterlist *sgpnt,
1502                                         u32 orb_direction,
1503                                         unsigned int scsi_request_bufflen,
1504                                         void *scsi_request_buffer,
1505                                         enum dma_data_direction dma_dir)
1506 {
1507         cmd->dma_dir = dma_dir;
1508         cmd->dma_size = scsi_request_bufflen;
1509         cmd->dma_type = CMD_DMA_SINGLE;
1510         cmd->cmd_dma = dma_map_single(&hi->host->device, scsi_request_buffer,
1511                                       cmd->dma_size, cmd->dma_dir);
1512         orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1513         orb->misc |= ORB_SET_DIRECTION(orb_direction);
1514
1515         /* handle case where we get a command w/o s/g enabled
1516          * (but check for transfers larger than 64K) */
1517         if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1518
1519                 orb->data_descriptor_lo = cmd->cmd_dma;
1520                 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1521
1522         } else {
1523                 /* The buffer is too large. Turn this into page tables. */
1524
1525                 struct sbp2_unrestricted_page_table *sg_element =
1526                                                 &cmd->scatter_gather_element[0];
1527                 u32 sg_count, sg_len;
1528                 dma_addr_t sg_addr;
1529
1530                 orb->data_descriptor_lo = cmd->sge_dma;
1531                 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1532
1533                 /* fill out our SBP-2 page tables; split up the large buffer */
1534                 sg_count = 0;
1535                 sg_len = scsi_request_bufflen;
1536                 sg_addr = cmd->cmd_dma;
1537                 while (sg_len) {
1538                         sg_element[sg_count].segment_base_lo = sg_addr;
1539                         if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1540                                 sg_element[sg_count].length_segment_base_hi =
1541                                         PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1542                                 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1543                                 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1544                         } else {
1545                                 sg_element[sg_count].length_segment_base_hi =
1546                                         PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1547                                 sg_len = 0;
1548                         }
1549                         sg_count++;
1550                 }
1551
1552                 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1553
1554                 sbp2util_cpu_to_be32_buffer(sg_element,
1555                                 (sizeof(struct sbp2_unrestricted_page_table)) *
1556                                 sg_count);
1557         }
1558 }
1559
1560 static void sbp2_create_command_orb(struct sbp2_lu *lu,
1561                                     struct sbp2_command_info *cmd,
1562                                     unchar *scsi_cmd,
1563                                     unsigned int scsi_use_sg,
1564                                     unsigned int scsi_request_bufflen,
1565                                     void *scsi_request_buffer,
1566                                     enum dma_data_direction dma_dir)
1567 {
1568         struct sbp2_fwhost_info *hi = lu->hi;
1569         struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1570         struct sbp2_command_orb *orb = &cmd->command_orb;
1571         u32 orb_direction;
1572
1573         /*
1574          * Set-up our command ORB.
1575          *
1576          * NOTE: We're doing unrestricted page tables (s/g), as this is
1577          * best performance (at least with the devices I have). This means
1578          * that data_size becomes the number of s/g elements, and
1579          * page_size should be zero (for unrestricted).
1580          */
1581         orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1582         orb->next_ORB_lo = 0x0;
1583         orb->misc = ORB_SET_MAX_PAYLOAD(lu->max_payload_size);
1584         orb->misc |= ORB_SET_SPEED(lu->speed_code);
1585         orb->misc |= ORB_SET_NOTIFY(1);
1586
1587         if (dma_dir == DMA_NONE)
1588                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1589         else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
1590                 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
1591         else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
1592                 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
1593         else {
1594                 SBP2_INFO("Falling back to DMA_NONE");
1595                 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1596         }
1597
1598         /* set up our page table stuff */
1599         if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1600                 orb->data_descriptor_hi = 0x0;
1601                 orb->data_descriptor_lo = 0x0;
1602                 orb->misc |= ORB_SET_DIRECTION(1);
1603         } else if (scsi_use_sg)
1604                 sbp2_prep_command_orb_sg(orb, hi, cmd, scsi_use_sg, sgpnt,
1605                                          orb_direction, dma_dir);
1606         else
1607                 sbp2_prep_command_orb_no_sg(orb, hi, cmd, sgpnt, orb_direction,
1608                                             scsi_request_bufflen,
1609                                             scsi_request_buffer, dma_dir);
1610
1611         sbp2util_cpu_to_be32_buffer(orb, sizeof(*orb));
1612
1613         memset(orb->cdb, 0, 12);
1614         memcpy(orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1615 }
1616
1617 static void sbp2_link_orb_command(struct sbp2_lu *lu,
1618                                   struct sbp2_command_info *cmd)
1619 {
1620         struct sbp2_fwhost_info *hi = lu->hi;
1621         struct sbp2_command_orb *last_orb;
1622         dma_addr_t last_orb_dma;
1623         u64 addr = lu->command_block_agent_addr;
1624         quadlet_t data[2];
1625         size_t length;
1626         unsigned long flags;
1627
1628         dma_sync_single_for_device(&hi->host->device, cmd->command_orb_dma,
1629                                    sizeof(struct sbp2_command_orb),
1630                                    DMA_TO_DEVICE);
1631         dma_sync_single_for_device(&hi->host->device, cmd->sge_dma,
1632                                    sizeof(cmd->scatter_gather_element),
1633                                    DMA_BIDIRECTIONAL);
1634
1635         /* check to see if there are any previous orbs to use */
1636         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
1637         last_orb = lu->last_orb;
1638         last_orb_dma = lu->last_orb_dma;
1639         if (!last_orb) {
1640                 /*
1641                  * last_orb == NULL means: We know that the target's fetch agent
1642                  * is not active right now.
1643                  */
1644                 addr += SBP2_ORB_POINTER_OFFSET;
1645                 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1646                 data[1] = cmd->command_orb_dma;
1647                 sbp2util_cpu_to_be32_buffer(data, 8);
1648                 length = 8;
1649         } else {
1650                 /*
1651                  * last_orb != NULL means: We know that the target's fetch agent
1652                  * is (very probably) not dead or in reset state right now.
1653                  * We have an ORB already sent that we can append a new one to.
1654                  * The target's fetch agent may or may not have read this
1655                  * previous ORB yet.
1656                  */
1657                 dma_sync_single_for_cpu(&hi->host->device, last_orb_dma,
1658                                         sizeof(struct sbp2_command_orb),
1659                                         DMA_TO_DEVICE);
1660                 last_orb->next_ORB_lo = cpu_to_be32(cmd->command_orb_dma);
1661                 wmb();
1662                 /* Tells hardware that this pointer is valid */
1663                 last_orb->next_ORB_hi = 0;
1664                 dma_sync_single_for_device(&hi->host->device, last_orb_dma,
1665                                            sizeof(struct sbp2_command_orb),
1666                                            DMA_TO_DEVICE);
1667                 addr += SBP2_DOORBELL_OFFSET;
1668                 data[0] = 0;
1669                 length = 4;
1670         }
1671         lu->last_orb = &cmd->command_orb;
1672         lu->last_orb_dma = cmd->command_orb_dma;
1673         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
1674
1675         if (sbp2util_node_write_no_wait(lu->ne, addr, data, length)) {
1676                 /*
1677                  * sbp2util_node_write_no_wait failed. We certainly ran out
1678                  * of transaction labels, perhaps just because there were no
1679                  * context switches which gave khpsbpkt a chance to collect
1680                  * free tlabels. Try again in non-atomic context. If necessary,
1681                  * the workqueue job will sleep to guaranteedly get a tlabel.
1682                  * We do not accept new commands until the job is over.
1683                  */
1684                 scsi_block_requests(lu->shost);
1685                 PREPARE_WORK(&lu->protocol_work,
1686                              last_orb ? sbp2util_write_doorbell:
1687                                         sbp2util_write_orb_pointer
1688                              /* */);
1689                 schedule_work(&lu->protocol_work);
1690         }
1691 }
1692
1693 static int sbp2_send_command(struct sbp2_lu *lu, struct scsi_cmnd *SCpnt,
1694                              void (*done)(struct scsi_cmnd *))
1695 {
1696         unchar *scsi_cmd = (unchar *)SCpnt->cmnd;
1697         unsigned int request_bufflen = SCpnt->request_bufflen;
1698         struct sbp2_command_info *cmd;
1699
1700         cmd = sbp2util_allocate_command_orb(lu, SCpnt, done);
1701         if (!cmd)
1702                 return -EIO;
1703
1704         sbp2_create_command_orb(lu, cmd, scsi_cmd, SCpnt->use_sg,
1705                                 request_bufflen, SCpnt->request_buffer,
1706                                 SCpnt->sc_data_direction);
1707         sbp2_link_orb_command(lu, cmd);
1708
1709         return 0;
1710 }
1711
1712 /*
1713  * Translates SBP-2 status into SCSI sense data for check conditions
1714  */
1715 static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status,
1716                                               unchar *sense_data)
1717 {
1718         /* OK, it's pretty ugly... ;-) */
1719         sense_data[0] = 0x70;
1720         sense_data[1] = 0x0;
1721         sense_data[2] = sbp2_status[9];
1722         sense_data[3] = sbp2_status[12];
1723         sense_data[4] = sbp2_status[13];
1724         sense_data[5] = sbp2_status[14];
1725         sense_data[6] = sbp2_status[15];
1726         sense_data[7] = 10;
1727         sense_data[8] = sbp2_status[16];
1728         sense_data[9] = sbp2_status[17];
1729         sense_data[10] = sbp2_status[18];
1730         sense_data[11] = sbp2_status[19];
1731         sense_data[12] = sbp2_status[10];
1732         sense_data[13] = sbp2_status[11];
1733         sense_data[14] = sbp2_status[20];
1734         sense_data[15] = sbp2_status[21];
1735
1736         return sbp2_status[8] & 0x3f;
1737 }
1738
1739 static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
1740                                     int destid, quadlet_t *data, u64 addr,
1741                                     size_t length, u16 fl)
1742 {
1743         struct sbp2_fwhost_info *hi;
1744         struct sbp2_lu *lu = NULL, *lu_tmp;
1745         struct scsi_cmnd *SCpnt = NULL;
1746         struct sbp2_status_block *sb;
1747         u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
1748         struct sbp2_command_info *cmd;
1749         unsigned long flags;
1750
1751         if (unlikely(length < 8 || length > sizeof(struct sbp2_status_block))) {
1752                 SBP2_ERR("Wrong size of status block");
1753                 return RCODE_ADDRESS_ERROR;
1754         }
1755         if (unlikely(!host)) {
1756                 SBP2_ERR("host is NULL - this is bad!");
1757                 return RCODE_ADDRESS_ERROR;
1758         }
1759         hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
1760         if (unlikely(!hi)) {
1761                 SBP2_ERR("host info is NULL - this is bad!");
1762                 return RCODE_ADDRESS_ERROR;
1763         }
1764
1765         /* Find the unit which wrote the status. */
1766         list_for_each_entry(lu_tmp, &hi->logical_units, lu_list) {
1767                 if (lu_tmp->ne->nodeid == nodeid &&
1768                     lu_tmp->status_fifo_addr == addr) {
1769                         lu = lu_tmp;
1770                         break;
1771                 }
1772         }
1773         if (unlikely(!lu)) {
1774                 SBP2_ERR("lu is NULL - device is gone?");
1775                 return RCODE_ADDRESS_ERROR;
1776         }
1777
1778         /* Put response into lu status fifo buffer. The first two bytes
1779          * come in big endian bit order. Often the target writes only a
1780          * truncated status block, minimally the first two quadlets. The rest
1781          * is implied to be zeros. */
1782         sb = &lu->status_block;
1783         memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
1784         memcpy(sb, data, length);
1785         sbp2util_be32_to_cpu_buffer(sb, 8);
1786
1787         /* Ignore unsolicited status. Handle command ORB status. */
1788         if (unlikely(STATUS_GET_SRC(sb->ORB_offset_hi_misc) == 2))
1789                 cmd = NULL;
1790         else
1791                 cmd = sbp2util_find_command_for_orb(lu, sb->ORB_offset_lo);
1792         if (cmd) {
1793                 dma_sync_single_for_cpu(&hi->host->device, cmd->command_orb_dma,
1794                                         sizeof(struct sbp2_command_orb),
1795                                         DMA_TO_DEVICE);
1796                 dma_sync_single_for_cpu(&hi->host->device, cmd->sge_dma,
1797                                         sizeof(cmd->scatter_gather_element),
1798                                         DMA_BIDIRECTIONAL);
1799                 /* Grab SCSI command pointers and check status. */
1800                 /*
1801                  * FIXME: If the src field in the status is 1, the ORB DMA must
1802                  * not be reused until status for a subsequent ORB is received.
1803                  */
1804                 SCpnt = cmd->Current_SCpnt;
1805                 spin_lock_irqsave(&lu->cmd_orb_lock, flags);
1806                 sbp2util_mark_command_completed(lu, cmd);
1807                 spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
1808
1809                 if (SCpnt) {
1810                         u32 h = sb->ORB_offset_hi_misc;
1811                         u32 r = STATUS_GET_RESP(h);
1812
1813                         if (r != RESP_STATUS_REQUEST_COMPLETE) {
1814                                 SBP2_INFO("resp 0x%x, sbp_status 0x%x",
1815                                           r, STATUS_GET_SBP_STATUS(h));
1816                                 scsi_status =
1817                                         r == RESP_STATUS_TRANSPORT_FAILURE ?
1818                                         SBP2_SCSI_STATUS_BUSY :
1819                                         SBP2_SCSI_STATUS_COMMAND_TERMINATED;
1820                         }
1821
1822                         if (STATUS_GET_LEN(h) > 1)
1823                                 scsi_status = sbp2_status_to_sense_data(
1824                                         (unchar *)sb, SCpnt->sense_buffer);
1825
1826                         if (STATUS_TEST_DEAD(h))
1827                                 sbp2_agent_reset(lu, 0);
1828                 }
1829
1830                 /* Check here to see if there are no commands in-use. If there
1831                  * are none, we know that the fetch agent left the active state
1832                  * _and_ that we did not reactivate it yet. Therefore clear
1833                  * last_orb so that next time we write directly to the
1834                  * ORB_POINTER register. That way the fetch agent does not need
1835                  * to refetch the next_ORB. */
1836                 spin_lock_irqsave(&lu->cmd_orb_lock, flags);
1837                 if (list_empty(&lu->cmd_orb_inuse))
1838                         lu->last_orb = NULL;
1839                 spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
1840
1841         } else {
1842                 /* It's probably status after a management request. */
1843                 if ((sb->ORB_offset_lo == lu->reconnect_orb_dma) ||
1844                     (sb->ORB_offset_lo == lu->login_orb_dma) ||
1845                     (sb->ORB_offset_lo == lu->query_logins_orb_dma) ||
1846                     (sb->ORB_offset_lo == lu->logout_orb_dma)) {
1847                         lu->access_complete = 1;
1848                         wake_up_interruptible(&sbp2_access_wq);
1849                 }
1850         }
1851
1852         if (SCpnt)
1853                 sbp2scsi_complete_command(lu, scsi_status, SCpnt,
1854                                           cmd->Current_done);
1855         return RCODE_COMPLETE;
1856 }
1857
1858 /**************************************
1859  * SCSI interface related section
1860  **************************************/
1861
1862 static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
1863                                  void (*done)(struct scsi_cmnd *))
1864 {
1865         struct sbp2_lu *lu = (struct sbp2_lu *)SCpnt->device->host->hostdata[0];
1866         struct sbp2_fwhost_info *hi;
1867         int result = DID_NO_CONNECT << 16;
1868
1869         if (unlikely(!sbp2util_node_is_available(lu)))
1870                 goto done;
1871
1872         hi = lu->hi;
1873
1874         if (unlikely(!hi)) {
1875                 SBP2_ERR("sbp2_fwhost_info is NULL - this is bad!");
1876                 goto done;
1877         }
1878
1879         /* Multiple units are currently represented to the SCSI core as separate
1880          * targets, not as one target with multiple LUs. Therefore return
1881          * selection time-out to any IO directed at non-zero LUNs. */
1882         if (unlikely(SCpnt->device->lun))
1883                 goto done;
1884
1885         /* handle the request sense command here (auto-request sense) */
1886         if (SCpnt->cmnd[0] == REQUEST_SENSE) {
1887                 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer,
1888                        SCpnt->request_bufflen);
1889                 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
1890                 sbp2scsi_complete_command(lu, SBP2_SCSI_STATUS_GOOD, SCpnt,
1891                                           done);
1892                 return 0;
1893         }
1894
1895         if (unlikely(!hpsb_node_entry_valid(lu->ne))) {
1896                 SBP2_ERR("Bus reset in progress - rejecting command");
1897                 result = DID_BUS_BUSY << 16;
1898                 goto done;
1899         }
1900
1901         /* Bidirectional commands are not yet implemented,
1902          * and unknown transfer direction not handled. */
1903         if (unlikely(SCpnt->sc_data_direction == DMA_BIDIRECTIONAL)) {
1904                 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
1905                 result = DID_ERROR << 16;
1906                 goto done;
1907         }
1908
1909         if (sbp2_send_command(lu, SCpnt, done)) {
1910                 SBP2_ERR("Error sending SCSI command");
1911                 sbp2scsi_complete_command(lu,
1912                                           SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
1913                                           SCpnt, done);
1914         }
1915         return 0;
1916
1917 done:
1918         SCpnt->result = result;
1919         done(SCpnt);
1920         return 0;
1921 }
1922
1923 static void sbp2scsi_complete_all_commands(struct sbp2_lu *lu, u32 status)
1924 {
1925         struct sbp2_fwhost_info *hi = lu->hi;
1926         struct list_head *lh;
1927         struct sbp2_command_info *cmd;
1928         unsigned long flags;
1929
1930         spin_lock_irqsave(&lu->cmd_orb_lock, flags);
1931         while (!list_empty(&lu->cmd_orb_inuse)) {
1932                 lh = lu->cmd_orb_inuse.next;
1933                 cmd = list_entry(lh, struct sbp2_command_info, list);
1934                 dma_sync_single_for_cpu(&hi->host->device, cmd->command_orb_dma,
1935                                         sizeof(struct sbp2_command_orb),
1936                                         DMA_TO_DEVICE);
1937                 dma_sync_single_for_cpu(&hi->host->device, cmd->sge_dma,
1938                                         sizeof(cmd->scatter_gather_element),
1939                                         DMA_BIDIRECTIONAL);
1940                 sbp2util_mark_command_completed(lu, cmd);
1941                 if (cmd->Current_SCpnt) {
1942                         cmd->Current_SCpnt->result = status << 16;
1943                         cmd->Current_done(cmd->Current_SCpnt);
1944                 }
1945         }
1946         spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
1947
1948         return;
1949 }
1950
1951 /*
1952  * Complete a regular SCSI command. Can be called in atomic context.
1953  */
1954 static void sbp2scsi_complete_command(struct sbp2_lu *lu, u32 scsi_status,
1955                                       struct scsi_cmnd *SCpnt,
1956                                       void (*done)(struct scsi_cmnd *))
1957 {
1958         if (!SCpnt) {
1959                 SBP2_ERR("SCpnt is NULL");
1960                 return;
1961         }
1962
1963         switch (scsi_status) {
1964         case SBP2_SCSI_STATUS_GOOD:
1965                 SCpnt->result = DID_OK << 16;
1966                 break;
1967
1968         case SBP2_SCSI_STATUS_BUSY:
1969                 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
1970                 SCpnt->result = DID_BUS_BUSY << 16;
1971                 break;
1972
1973         case SBP2_SCSI_STATUS_CHECK_CONDITION:
1974                 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
1975                 break;
1976
1977         case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
1978                 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
1979                 SCpnt->result = DID_NO_CONNECT << 16;
1980                 scsi_print_command(SCpnt);
1981                 break;
1982
1983         case SBP2_SCSI_STATUS_CONDITION_MET:
1984         case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
1985         case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
1986                 SBP2_ERR("Bad SCSI status = %x", scsi_status);
1987                 SCpnt->result = DID_ERROR << 16;
1988                 scsi_print_command(SCpnt);
1989                 break;
1990
1991         default:
1992                 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
1993                 SCpnt->result = DID_ERROR << 16;
1994         }
1995
1996         /* If a bus reset is in progress and there was an error, complete
1997          * the command as busy so that it will get retried. */
1998         if (!hpsb_node_entry_valid(lu->ne)
1999             && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
2000                 SBP2_ERR("Completing command with busy (bus reset)");
2001                 SCpnt->result = DID_BUS_BUSY << 16;
2002         }
2003
2004         /* Tell the SCSI stack that we're done with this command. */
2005         done(SCpnt);
2006 }
2007
2008 static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
2009 {
2010         struct sbp2_lu *lu = (struct sbp2_lu *)sdev->host->hostdata[0];
2011
2012         lu->sdev = sdev;
2013         sdev->allow_restart = 1;
2014
2015         if (lu->workarounds & SBP2_WORKAROUND_INQUIRY_36)
2016                 sdev->inquiry_len = 36;
2017         return 0;
2018 }
2019
2020 static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2021 {
2022         struct sbp2_lu *lu = (struct sbp2_lu *)sdev->host->hostdata[0];
2023
2024         blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
2025         sdev->use_10_for_rw = 1;
2026
2027         if (sdev->type == TYPE_DISK &&
2028             lu->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2029                 sdev->skip_ms_page_8 = 1;
2030         if (lu->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2031                 sdev->fix_capacity = 1;
2032         return 0;
2033 }
2034
2035 static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2036 {
2037         ((struct sbp2_lu *)sdev->host->hostdata[0])->sdev = NULL;
2038         return;
2039 }
2040
2041 /*
2042  * Called by scsi stack when something has really gone wrong.
2043  * Usually called when a command has timed-out for some reason.
2044  */
2045 static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2046 {
2047         struct sbp2_lu *lu = (struct sbp2_lu *)SCpnt->device->host->hostdata[0];
2048         struct sbp2_fwhost_info *hi = lu->hi;
2049         struct sbp2_command_info *cmd;
2050         unsigned long flags;
2051
2052         SBP2_INFO("aborting sbp2 command");
2053         scsi_print_command(SCpnt);
2054
2055         if (sbp2util_node_is_available(lu)) {
2056                 sbp2_agent_reset(lu, 1);
2057
2058                 /* Return a matching command structure to the free pool. */
2059                 spin_lock_irqsave(&lu->cmd_orb_lock, flags);
2060                 cmd = sbp2util_find_command_for_SCpnt(lu, SCpnt);
2061                 if (cmd) {
2062                         dma_sync_single_for_cpu(&hi->host->device,
2063                                         cmd->command_orb_dma,
2064                                         sizeof(struct sbp2_command_orb),
2065                                         DMA_TO_DEVICE);
2066                         dma_sync_single_for_cpu(&hi->host->device, cmd->sge_dma,
2067                                         sizeof(cmd->scatter_gather_element),
2068                                         DMA_BIDIRECTIONAL);
2069                         sbp2util_mark_command_completed(lu, cmd);
2070                         if (cmd->Current_SCpnt) {
2071                                 cmd->Current_SCpnt->result = DID_ABORT << 16;
2072                                 cmd->Current_done(cmd->Current_SCpnt);
2073                         }
2074                 }
2075                 spin_unlock_irqrestore(&lu->cmd_orb_lock, flags);
2076
2077                 sbp2scsi_complete_all_commands(lu, DID_BUS_BUSY);
2078         }
2079
2080         return SUCCESS;
2081 }
2082
2083 /*
2084  * Called by scsi stack when something has really gone wrong.
2085  */
2086 static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
2087 {
2088         struct sbp2_lu *lu = (struct sbp2_lu *)SCpnt->device->host->hostdata[0];
2089
2090         SBP2_INFO("reset requested");
2091
2092         if (sbp2util_node_is_available(lu)) {
2093                 SBP2_INFO("generating sbp2 fetch agent reset");
2094                 sbp2_agent_reset(lu, 1);
2095         }
2096
2097         return SUCCESS;
2098 }
2099
2100 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2101                                            struct device_attribute *attr,
2102                                            char *buf)
2103 {
2104         struct scsi_device *sdev;
2105         struct sbp2_lu *lu;
2106
2107         if (!(sdev = to_scsi_device(dev)))
2108                 return 0;
2109
2110         if (!(lu = (struct sbp2_lu *)sdev->host->hostdata[0]))
2111                 return 0;
2112
2113         return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)lu->ne->guid,
2114                        lu->ud->id, ORB_SET_LUN(lu->lun));
2115 }
2116
2117 MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2118 MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2119 MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2120 MODULE_LICENSE("GPL");
2121
2122 static int sbp2_module_init(void)
2123 {
2124         int ret;
2125
2126         if (sbp2_serialize_io) {
2127                 sbp2_shost_template.can_queue = 1;
2128                 sbp2_shost_template.cmd_per_lun = 1;
2129         }
2130
2131         if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2132             (sbp2_max_sectors * 512) > (128 * 1024))
2133                 sbp2_max_sectors = 128 * 1024 / 512;
2134         sbp2_shost_template.max_sectors = sbp2_max_sectors;
2135
2136         hpsb_register_highlevel(&sbp2_highlevel);
2137         ret = hpsb_register_protocol(&sbp2_driver);
2138         if (ret) {
2139                 SBP2_ERR("Failed to register protocol");
2140                 hpsb_unregister_highlevel(&sbp2_highlevel);
2141                 return ret;
2142         }
2143         return 0;
2144 }
2145
2146 static void __exit sbp2_module_exit(void)
2147 {
2148         hpsb_unregister_protocol(&sbp2_driver);
2149         hpsb_unregister_highlevel(&sbp2_highlevel);
2150 }
2151
2152 module_init(sbp2_module_init);
2153 module_exit(sbp2_module_exit);