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