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