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