2 * SBP2 driver (SCSI over IEEE1394)
4 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * The basic structure of this driver is based on the old storage driver,
23 * drivers/ieee1394/sbp2.c, originally written by
24 * James Goodwin <jamesg@filanet.com>
25 * with later contributions and ongoing maintenance from
26 * Ben Collins <bcollins@debian.org>,
27 * Stefan Richter <stefanr@s5r6.in-berlin.de>
31 #include <linux/blkdev.h>
32 #include <linux/bug.h>
33 #include <linux/completion.h>
34 #include <linux/delay.h>
35 #include <linux/device.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/firewire.h>
38 #include <linux/firewire-constants.h>
39 #include <linux/init.h>
40 #include <linux/jiffies.h>
41 #include <linux/kernel.h>
42 #include <linux/kref.h>
43 #include <linux/list.h>
44 #include <linux/mod_devicetable.h>
45 #include <linux/module.h>
46 #include <linux/moduleparam.h>
47 #include <linux/scatterlist.h>
48 #include <linux/slab.h>
49 #include <linux/spinlock.h>
50 #include <linux/string.h>
51 #include <linux/stringify.h>
52 #include <linux/workqueue.h>
54 #include <asm/byteorder.h>
55 #include <asm/system.h>
57 #include <scsi/scsi.h>
58 #include <scsi/scsi_cmnd.h>
59 #include <scsi/scsi_device.h>
60 #include <scsi/scsi_host.h>
63 * So far only bridges from Oxford Semiconductor are known to support
64 * concurrent logins. Depending on firmware, four or two concurrent logins
65 * are possible on OXFW911 and newer Oxsemi bridges.
67 * Concurrent logins are useful together with cluster filesystems.
69 static int sbp2_param_exclusive_login = 1;
70 module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
71 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
72 "(default = Y, use N for concurrent initiators)");
75 * Flags for firmware oddities
77 * - 128kB max transfer
78 * Limit transfer size. Necessary for some old bridges.
81 * When scsi_mod probes the device, let the inquiry command look like that
85 * Suppress sending of mode_sense for mode page 8 if the device pretends to
86 * support the SCSI Primary Block commands instead of Reduced Block Commands.
89 * Tell sd_mod to correct the last sector number reported by read_capacity.
90 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
91 * Don't use this with devices which don't have this bug.
94 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
97 * Set the power condition field in the START STOP UNIT commands sent by
98 * sd_mod on suspend, resume, and shutdown (if manage_start_stop is on).
99 * Some disks need this to spin down or to resume properly.
101 * - override internal blacklist
102 * Instead of adding to the built-in blacklist, use only the workarounds
103 * specified in the module load parameter.
104 * Useful if a blacklist entry interfered with a non-broken device.
106 #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
107 #define SBP2_WORKAROUND_INQUIRY_36 0x2
108 #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
109 #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
110 #define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
111 #define SBP2_INQUIRY_DELAY 12
112 #define SBP2_WORKAROUND_POWER_CONDITION 0x20
113 #define SBP2_WORKAROUND_OVERRIDE 0x100
115 static int sbp2_param_workarounds;
116 module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
117 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
118 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
119 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
120 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
121 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
122 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
123 ", set power condition in start stop unit = "
124 __stringify(SBP2_WORKAROUND_POWER_CONDITION)
125 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
126 ", or a combination)");
128 /* I don't know why the SCSI stack doesn't define something like this... */
129 typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
131 static const char sbp2_driver_name[] = "sbp2";
134 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
135 * and one struct scsi_device per sbp2_logical_unit.
137 struct sbp2_logical_unit {
138 struct sbp2_target *tgt;
139 struct list_head link;
140 struct fw_address_handler address_handler;
141 struct list_head orb_list;
143 u64 command_block_agent_address;
148 * The generation is updated once we've logged in or reconnected
149 * to the logical unit. Thus, I/O to the device will automatically
150 * fail and get retried if it happens in a window where the device
151 * is not ready, e.g. after a bus reset but before we reconnect.
155 struct delayed_work work;
161 * We create one struct sbp2_target per IEEE 1212 Unit Directory
162 * and one struct Scsi_Host per sbp2_target.
166 struct fw_unit *unit;
168 struct list_head lu_list;
170 u64 management_agent_address;
175 unsigned int workarounds;
176 unsigned int mgt_orb_timeout;
177 unsigned int max_payload;
179 int dont_block; /* counter for each logical unit */
180 int blocked; /* ditto */
183 static struct fw_device *target_device(struct sbp2_target *tgt)
185 return fw_parent_device(tgt->unit);
188 /* Impossible login_id, to detect logout attempt before successful login */
189 #define INVALID_LOGIN_ID 0x10000
192 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
193 * provided in the config rom. Most devices do provide a value, which
194 * we'll use for login management orbs, but with some sane limits.
196 #define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
197 #define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
198 #define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
199 #define SBP2_ORB_NULL 0x80000000
200 #define SBP2_RETRY_LIMIT 0xf /* 15 retries */
201 #define SBP2_CYCLE_LIMIT (0xc8 << 12) /* 200 125us cycles */
204 * There is no transport protocol limit to the CDB length, but we implement
205 * a fixed length only. 16 bytes is enough for disks larger than 2 TB.
207 #define SBP2_MAX_CDB_SIZE 16
210 * The default maximum s/g segment size of a FireWire controller is
211 * usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
212 * be quadlet-aligned, we set the length limit to 0xffff & ~3.
214 #define SBP2_MAX_SEG_SIZE 0xfffc
216 /* Unit directory keys */
217 #define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
218 #define SBP2_CSR_FIRMWARE_REVISION 0x3c
219 #define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
220 #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
222 /* Management orb opcodes */
223 #define SBP2_LOGIN_REQUEST 0x0
224 #define SBP2_QUERY_LOGINS_REQUEST 0x1
225 #define SBP2_RECONNECT_REQUEST 0x3
226 #define SBP2_SET_PASSWORD_REQUEST 0x4
227 #define SBP2_LOGOUT_REQUEST 0x7
228 #define SBP2_ABORT_TASK_REQUEST 0xb
229 #define SBP2_ABORT_TASK_SET 0xc
230 #define SBP2_LOGICAL_UNIT_RESET 0xe
231 #define SBP2_TARGET_RESET_REQUEST 0xf
233 /* Offsets for command block agent registers */
234 #define SBP2_AGENT_STATE 0x00
235 #define SBP2_AGENT_RESET 0x04
236 #define SBP2_ORB_POINTER 0x08
237 #define SBP2_DOORBELL 0x10
238 #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
240 /* Status write response codes */
241 #define SBP2_STATUS_REQUEST_COMPLETE 0x0
242 #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
243 #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
244 #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
246 #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
247 #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
248 #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
249 #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
250 #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
251 #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
252 #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
253 #define STATUS_GET_DATA(v) ((v).data)
261 struct sbp2_pointer {
267 struct fw_transaction t;
269 dma_addr_t request_bus;
271 struct sbp2_pointer pointer;
272 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
273 struct list_head link;
276 #define MANAGEMENT_ORB_LUN(v) ((v))
277 #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
278 #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
279 #define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
280 #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
281 #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
283 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
284 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
286 struct sbp2_management_orb {
287 struct sbp2_orb base;
289 struct sbp2_pointer password;
290 struct sbp2_pointer response;
293 struct sbp2_pointer status_fifo;
296 dma_addr_t response_bus;
297 struct completion done;
298 struct sbp2_status status;
301 struct sbp2_login_response {
303 struct sbp2_pointer command_block_agent;
304 __be32 reconnect_hold;
306 #define COMMAND_ORB_DATA_SIZE(v) ((v))
307 #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
308 #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
309 #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
310 #define COMMAND_ORB_SPEED(v) ((v) << 24)
311 #define COMMAND_ORB_DIRECTION ((1) << 27)
312 #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
313 #define COMMAND_ORB_NOTIFY ((1) << 31)
315 struct sbp2_command_orb {
316 struct sbp2_orb base;
318 struct sbp2_pointer next;
319 struct sbp2_pointer data_descriptor;
321 u8 command_block[SBP2_MAX_CDB_SIZE];
323 struct scsi_cmnd *cmd;
325 struct sbp2_logical_unit *lu;
327 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
328 dma_addr_t page_table_bus;
331 #define SBP2_ROM_VALUE_WILDCARD ~0 /* match all */
332 #define SBP2_ROM_VALUE_MISSING 0xff000000 /* not present in the unit dir. */
335 * List of devices with known bugs.
337 * The firmware_revision field, masked with 0xffff00, is the best
338 * indicator for the type of bridge chip of a device. It yields a few
339 * false positives but this did not break correctly behaving devices
342 static const struct {
343 u32 firmware_revision;
345 unsigned int workarounds;
346 } sbp2_workarounds_table[] = {
347 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
348 .firmware_revision = 0x002800,
350 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
351 SBP2_WORKAROUND_MODE_SENSE_8 |
352 SBP2_WORKAROUND_POWER_CONDITION,
354 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
355 .firmware_revision = 0x002800,
357 .workarounds = SBP2_WORKAROUND_DELAY_INQUIRY |
358 SBP2_WORKAROUND_POWER_CONDITION,
360 /* Initio bridges, actually only needed for some older ones */ {
361 .firmware_revision = 0x000200,
362 .model = SBP2_ROM_VALUE_WILDCARD,
363 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
365 /* PL-3507 bridge with Prolific firmware */ {
366 .firmware_revision = 0x012800,
367 .model = SBP2_ROM_VALUE_WILDCARD,
368 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
370 /* Symbios bridge */ {
371 .firmware_revision = 0xa0b800,
372 .model = SBP2_ROM_VALUE_WILDCARD,
373 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
375 /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
376 .firmware_revision = 0x002600,
377 .model = SBP2_ROM_VALUE_WILDCARD,
378 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
381 * iPod 2nd generation: needs 128k max transfer size workaround
382 * iPod 3rd generation: needs fix capacity workaround
385 .firmware_revision = 0x0a2700,
387 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS |
388 SBP2_WORKAROUND_FIX_CAPACITY,
390 /* iPod 4th generation */ {
391 .firmware_revision = 0x0a2700,
393 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
396 .firmware_revision = 0x0a2700,
398 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
401 .firmware_revision = 0x0a2700,
403 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
406 .firmware_revision = 0x0a2700,
408 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
412 static void free_orb(struct kref *kref)
414 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
419 static void sbp2_status_write(struct fw_card *card, struct fw_request *request,
420 int tcode, int destination, int source,
421 int generation, int speed,
422 unsigned long long offset,
423 void *payload, size_t length, void *callback_data)
425 struct sbp2_logical_unit *lu = callback_data;
426 struct sbp2_orb *orb;
427 struct sbp2_status status;
430 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
431 length < 8 || length > sizeof(status)) {
432 fw_send_response(card, request, RCODE_TYPE_ERROR);
436 status.status = be32_to_cpup(payload);
437 status.orb_low = be32_to_cpup(payload + 4);
438 memset(status.data, 0, sizeof(status.data));
440 memcpy(status.data, payload + 8, length - 8);
442 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
443 fw_notify("non-orb related status write, not handled\n");
444 fw_send_response(card, request, RCODE_COMPLETE);
448 /* Lookup the orb corresponding to this status write. */
449 spin_lock_irqsave(&card->lock, flags);
450 list_for_each_entry(orb, &lu->orb_list, link) {
451 if (STATUS_GET_ORB_HIGH(status) == 0 &&
452 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
453 orb->rcode = RCODE_COMPLETE;
454 list_del(&orb->link);
458 spin_unlock_irqrestore(&card->lock, flags);
460 if (&orb->link != &lu->orb_list) {
461 orb->callback(orb, &status);
462 kref_put(&orb->kref, free_orb);
464 fw_error("status write for unknown orb\n");
467 fw_send_response(card, request, RCODE_COMPLETE);
470 static void complete_transaction(struct fw_card *card, int rcode,
471 void *payload, size_t length, void *data)
473 struct sbp2_orb *orb = data;
477 * This is a little tricky. We can get the status write for
478 * the orb before we get this callback. The status write
479 * handler above will assume the orb pointer transaction was
480 * successful and set the rcode to RCODE_COMPLETE for the orb.
481 * So this callback only sets the rcode if it hasn't already
482 * been set and only does the cleanup if the transaction
483 * failed and we didn't already get a status write.
485 spin_lock_irqsave(&card->lock, flags);
487 if (orb->rcode == -1)
489 if (orb->rcode != RCODE_COMPLETE) {
490 list_del(&orb->link);
491 spin_unlock_irqrestore(&card->lock, flags);
492 orb->callback(orb, NULL);
494 spin_unlock_irqrestore(&card->lock, flags);
497 kref_put(&orb->kref, free_orb);
500 static void sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
501 int node_id, int generation, u64 offset)
503 struct fw_device *device = target_device(lu->tgt);
506 orb->pointer.high = 0;
507 orb->pointer.low = cpu_to_be32(orb->request_bus);
509 spin_lock_irqsave(&device->card->lock, flags);
510 list_add_tail(&orb->link, &lu->orb_list);
511 spin_unlock_irqrestore(&device->card->lock, flags);
513 /* Take a ref for the orb list and for the transaction callback. */
514 kref_get(&orb->kref);
515 kref_get(&orb->kref);
517 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
518 node_id, generation, device->max_speed, offset,
519 &orb->pointer, sizeof(orb->pointer),
520 complete_transaction, orb);
523 static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
525 struct fw_device *device = target_device(lu->tgt);
526 struct sbp2_orb *orb, *next;
527 struct list_head list;
529 int retval = -ENOENT;
531 INIT_LIST_HEAD(&list);
532 spin_lock_irqsave(&device->card->lock, flags);
533 list_splice_init(&lu->orb_list, &list);
534 spin_unlock_irqrestore(&device->card->lock, flags);
536 list_for_each_entry_safe(orb, next, &list, link) {
538 if (fw_cancel_transaction(device->card, &orb->t) == 0)
541 orb->rcode = RCODE_CANCELLED;
542 orb->callback(orb, NULL);
548 static void complete_management_orb(struct sbp2_orb *base_orb,
549 struct sbp2_status *status)
551 struct sbp2_management_orb *orb =
552 container_of(base_orb, struct sbp2_management_orb, base);
555 memcpy(&orb->status, status, sizeof(*status));
556 complete(&orb->done);
559 static int sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
560 int generation, int function,
561 int lun_or_login_id, void *response)
563 struct fw_device *device = target_device(lu->tgt);
564 struct sbp2_management_orb *orb;
565 unsigned int timeout;
566 int retval = -ENOMEM;
568 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
571 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
575 kref_init(&orb->base.kref);
577 dma_map_single(device->card->device, &orb->response,
578 sizeof(orb->response), DMA_FROM_DEVICE);
579 if (dma_mapping_error(device->card->device, orb->response_bus))
580 goto fail_mapping_response;
582 orb->request.response.high = 0;
583 orb->request.response.low = cpu_to_be32(orb->response_bus);
585 orb->request.misc = cpu_to_be32(
586 MANAGEMENT_ORB_NOTIFY |
587 MANAGEMENT_ORB_FUNCTION(function) |
588 MANAGEMENT_ORB_LUN(lun_or_login_id));
589 orb->request.length = cpu_to_be32(
590 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
592 orb->request.status_fifo.high =
593 cpu_to_be32(lu->address_handler.offset >> 32);
594 orb->request.status_fifo.low =
595 cpu_to_be32(lu->address_handler.offset);
597 if (function == SBP2_LOGIN_REQUEST) {
598 /* Ask for 2^2 == 4 seconds reconnect grace period */
599 orb->request.misc |= cpu_to_be32(
600 MANAGEMENT_ORB_RECONNECT(2) |
601 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
602 timeout = lu->tgt->mgt_orb_timeout;
604 timeout = SBP2_ORB_TIMEOUT;
607 init_completion(&orb->done);
608 orb->base.callback = complete_management_orb;
610 orb->base.request_bus =
611 dma_map_single(device->card->device, &orb->request,
612 sizeof(orb->request), DMA_TO_DEVICE);
613 if (dma_mapping_error(device->card->device, orb->base.request_bus))
614 goto fail_mapping_request;
616 sbp2_send_orb(&orb->base, lu, node_id, generation,
617 lu->tgt->management_agent_address);
619 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
622 if (sbp2_cancel_orbs(lu) == 0) {
623 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
624 lu->tgt->bus_id, orb->base.rcode);
628 if (orb->base.rcode != RCODE_COMPLETE) {
629 fw_error("%s: management write failed, rcode 0x%02x\n",
630 lu->tgt->bus_id, orb->base.rcode);
634 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
635 STATUS_GET_SBP_STATUS(orb->status) != 0) {
636 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
637 STATUS_GET_RESPONSE(orb->status),
638 STATUS_GET_SBP_STATUS(orb->status));
644 dma_unmap_single(device->card->device, orb->base.request_bus,
645 sizeof(orb->request), DMA_TO_DEVICE);
646 fail_mapping_request:
647 dma_unmap_single(device->card->device, orb->response_bus,
648 sizeof(orb->response), DMA_FROM_DEVICE);
649 fail_mapping_response:
651 memcpy(response, orb->response, sizeof(orb->response));
652 kref_put(&orb->base.kref, free_orb);
657 static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
659 struct fw_device *device = target_device(lu->tgt);
662 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
663 lu->tgt->node_id, lu->generation, device->max_speed,
664 lu->command_block_agent_address + SBP2_AGENT_RESET,
668 static void complete_agent_reset_write_no_wait(struct fw_card *card,
669 int rcode, void *payload, size_t length, void *data)
674 static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
676 struct fw_device *device = target_device(lu->tgt);
677 struct fw_transaction *t;
680 t = kmalloc(sizeof(*t), GFP_ATOMIC);
684 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
685 lu->tgt->node_id, lu->generation, device->max_speed,
686 lu->command_block_agent_address + SBP2_AGENT_RESET,
687 &d, sizeof(d), complete_agent_reset_write_no_wait, t);
690 static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
693 * We may access dont_block without taking card->lock here:
694 * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
695 * are currently serialized against each other.
696 * And a wrong result in sbp2_conditionally_block()'s access of
697 * dont_block is rather harmless, it simply misses its first chance.
699 --lu->tgt->dont_block;
703 * Blocks lu->tgt if all of the following conditions are met:
704 * - Login, INQUIRY, and high-level SCSI setup of all of the target's
705 * logical units have been finished (indicated by dont_block == 0).
706 * - lu->generation is stale.
708 * Note, scsi_block_requests() must be called while holding card->lock,
709 * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
710 * unblock the target.
712 static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
714 struct sbp2_target *tgt = lu->tgt;
715 struct fw_card *card = target_device(tgt)->card;
716 struct Scsi_Host *shost =
717 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
720 spin_lock_irqsave(&card->lock, flags);
721 if (!tgt->dont_block && !lu->blocked &&
722 lu->generation != card->generation) {
724 if (++tgt->blocked == 1)
725 scsi_block_requests(shost);
727 spin_unlock_irqrestore(&card->lock, flags);
731 * Unblocks lu->tgt as soon as all its logical units can be unblocked.
732 * Note, it is harmless to run scsi_unblock_requests() outside the
733 * card->lock protected section. On the other hand, running it inside
734 * the section might clash with shost->host_lock.
736 static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
738 struct sbp2_target *tgt = lu->tgt;
739 struct fw_card *card = target_device(tgt)->card;
740 struct Scsi_Host *shost =
741 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
743 bool unblock = false;
745 spin_lock_irqsave(&card->lock, flags);
746 if (lu->blocked && lu->generation == card->generation) {
748 unblock = --tgt->blocked == 0;
750 spin_unlock_irqrestore(&card->lock, flags);
753 scsi_unblock_requests(shost);
757 * Prevents future blocking of tgt and unblocks it.
758 * Note, it is harmless to run scsi_unblock_requests() outside the
759 * card->lock protected section. On the other hand, running it inside
760 * the section might clash with shost->host_lock.
762 static void sbp2_unblock(struct sbp2_target *tgt)
764 struct fw_card *card = target_device(tgt)->card;
765 struct Scsi_Host *shost =
766 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
769 spin_lock_irqsave(&card->lock, flags);
771 spin_unlock_irqrestore(&card->lock, flags);
773 scsi_unblock_requests(shost);
776 static int sbp2_lun2int(u16 lun)
778 struct scsi_lun eight_bytes_lun;
780 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
781 eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
782 eight_bytes_lun.scsi_lun[1] = lun & 0xff;
784 return scsilun_to_int(&eight_bytes_lun);
787 static void sbp2_release_target(struct kref *kref)
789 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
790 struct sbp2_logical_unit *lu, *next;
791 struct Scsi_Host *shost =
792 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
793 struct scsi_device *sdev;
794 struct fw_device *device = target_device(tgt);
796 /* prevent deadlocks */
799 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
800 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
802 scsi_remove_device(sdev);
803 scsi_device_put(sdev);
805 if (lu->login_id != INVALID_LOGIN_ID) {
806 int generation, node_id;
808 * tgt->node_id may be obsolete here if we failed
809 * during initial login or after a bus reset where
810 * the topology changed.
812 generation = device->generation;
813 smp_rmb(); /* node_id vs. generation */
814 node_id = device->node_id;
815 sbp2_send_management_orb(lu, node_id, generation,
819 fw_core_remove_address_handler(&lu->address_handler);
823 scsi_remove_host(shost);
824 fw_notify("released %s, target %d:0:0\n", tgt->bus_id, shost->host_no);
826 fw_unit_put(tgt->unit);
827 scsi_host_put(shost);
828 fw_device_put(device);
831 static struct workqueue_struct *sbp2_wq;
833 static void sbp2_target_put(struct sbp2_target *tgt)
835 kref_put(&tgt->kref, sbp2_release_target);
839 * Always get the target's kref when scheduling work on one its units.
840 * Each workqueue job is responsible to call sbp2_target_put() upon return.
842 static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
844 kref_get(&lu->tgt->kref);
845 if (!queue_delayed_work(sbp2_wq, &lu->work, delay))
846 sbp2_target_put(lu->tgt);
850 * Write retransmit retry values into the BUSY_TIMEOUT register.
851 * - The single-phase retry protocol is supported by all SBP-2 devices, but the
852 * default retry_limit value is 0 (i.e. never retry transmission). We write a
853 * saner value after logging into the device.
854 * - The dual-phase retry protocol is optional to implement, and if not
855 * supported, writes to the dual-phase portion of the register will be
856 * ignored. We try to write the original 1394-1995 default here.
857 * - In the case of devices that are also SBP-3-compliant, all writes are
858 * ignored, as the register is read-only, but contains single-phase retry of
859 * 15, which is what we're trying to set for all SBP-2 device anyway, so this
860 * write attempt is safe and yields more consistent behavior for all devices.
862 * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
863 * and section 6.4 of the SBP-3 spec for further details.
865 static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
867 struct fw_device *device = target_device(lu->tgt);
868 __be32 d = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
870 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
871 lu->tgt->node_id, lu->generation, device->max_speed,
872 CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT,
876 static void sbp2_reconnect(struct work_struct *work);
878 static void sbp2_login(struct work_struct *work)
880 struct sbp2_logical_unit *lu =
881 container_of(work, struct sbp2_logical_unit, work.work);
882 struct sbp2_target *tgt = lu->tgt;
883 struct fw_device *device = target_device(tgt);
884 struct Scsi_Host *shost;
885 struct scsi_device *sdev;
886 struct sbp2_login_response response;
887 int generation, node_id, local_node_id;
889 if (fw_device_is_shutdown(device))
892 generation = device->generation;
893 smp_rmb(); /* node IDs must not be older than generation */
894 node_id = device->node_id;
895 local_node_id = device->card->node_id;
897 /* If this is a re-login attempt, log out, or we might be rejected. */
899 sbp2_send_management_orb(lu, device->node_id, generation,
900 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
902 if (sbp2_send_management_orb(lu, node_id, generation,
903 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
904 if (lu->retries++ < 5) {
905 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
907 fw_error("%s: failed to login to LUN %04x\n",
908 tgt->bus_id, lu->lun);
909 /* Let any waiting I/O fail from now on. */
910 sbp2_unblock(lu->tgt);
915 tgt->node_id = node_id;
916 tgt->address_high = local_node_id << 16;
917 smp_wmb(); /* node IDs must not be older than generation */
918 lu->generation = generation;
920 lu->command_block_agent_address =
921 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
922 << 32) | be32_to_cpu(response.command_block_agent.low);
923 lu->login_id = be32_to_cpu(response.misc) & 0xffff;
925 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
926 tgt->bus_id, lu->lun, lu->retries);
928 /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
929 sbp2_set_busy_timeout(lu);
931 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
932 sbp2_agent_reset(lu);
934 /* This was a re-login. */
936 sbp2_cancel_orbs(lu);
937 sbp2_conditionally_unblock(lu);
941 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
942 ssleep(SBP2_INQUIRY_DELAY);
944 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
945 sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
947 * FIXME: We are unable to perform reconnects while in sbp2_login().
948 * Therefore __scsi_add_device() will get into trouble if a bus reset
949 * happens in parallel. It will either fail or leave us with an
950 * unusable sdev. As a workaround we check for this and retry the
951 * whole login and SCSI probing.
954 /* Reported error during __scsi_add_device() */
956 goto out_logout_login;
958 /* Unreported error during __scsi_add_device() */
959 smp_rmb(); /* get current card generation */
960 if (generation != device->card->generation) {
961 scsi_remove_device(sdev);
962 scsi_device_put(sdev);
963 goto out_logout_login;
966 /* No error during __scsi_add_device() */
968 scsi_device_put(sdev);
969 sbp2_allow_block(lu);
973 smp_rmb(); /* generation may have changed */
974 generation = device->generation;
975 smp_rmb(); /* node_id must not be older than generation */
977 sbp2_send_management_orb(lu, device->node_id, generation,
978 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
980 * If a bus reset happened, sbp2_update will have requeued
981 * lu->work already. Reset the work from reconnect to login.
983 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
985 sbp2_target_put(tgt);
988 static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
990 struct sbp2_logical_unit *lu;
992 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
996 lu->address_handler.length = 0x100;
997 lu->address_handler.address_callback = sbp2_status_write;
998 lu->address_handler.callback_data = lu;
1000 if (fw_core_add_address_handler(&lu->address_handler,
1001 &fw_high_memory_region) < 0) {
1007 lu->lun = lun_entry & 0xffff;
1008 lu->login_id = INVALID_LOGIN_ID;
1010 lu->has_sdev = false;
1011 lu->blocked = false;
1013 INIT_LIST_HEAD(&lu->orb_list);
1014 INIT_DELAYED_WORK(&lu->work, sbp2_login);
1016 list_add_tail(&lu->link, &tgt->lu_list);
1020 static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
1022 struct fw_csr_iterator ci;
1025 fw_csr_iterator_init(&ci, directory);
1026 while (fw_csr_iterator_next(&ci, &key, &value))
1027 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
1028 sbp2_add_logical_unit(tgt, value) < 0)
1033 static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
1034 u32 *model, u32 *firmware_revision)
1036 struct fw_csr_iterator ci;
1038 unsigned int timeout;
1040 fw_csr_iterator_init(&ci, directory);
1041 while (fw_csr_iterator_next(&ci, &key, &value)) {
1044 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1045 tgt->management_agent_address =
1046 CSR_REGISTER_BASE + 4 * value;
1049 case CSR_DIRECTORY_ID:
1050 tgt->directory_id = value;
1057 case SBP2_CSR_FIRMWARE_REVISION:
1058 *firmware_revision = value;
1061 case SBP2_CSR_UNIT_CHARACTERISTICS:
1062 /* the timeout value is stored in 500ms units */
1063 timeout = ((unsigned int) value >> 8 & 0xff) * 500;
1064 timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
1065 tgt->mgt_orb_timeout =
1066 min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
1068 if (timeout > tgt->mgt_orb_timeout)
1069 fw_notify("%s: config rom contains %ds "
1070 "management ORB timeout, limiting "
1071 "to %ds\n", tgt->bus_id,
1073 tgt->mgt_orb_timeout / 1000);
1076 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1077 if (sbp2_add_logical_unit(tgt, value) < 0)
1081 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
1082 /* Adjust for the increment in the iterator */
1083 if (sbp2_scan_logical_unit_dir(tgt, ci.p - 1 + value) < 0)
1091 static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1092 u32 firmware_revision)
1095 unsigned int w = sbp2_param_workarounds;
1098 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
1099 "if you need the workarounds parameter for %s\n",
1102 if (w & SBP2_WORKAROUND_OVERRIDE)
1105 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1107 if (sbp2_workarounds_table[i].firmware_revision !=
1108 (firmware_revision & 0xffffff00))
1111 if (sbp2_workarounds_table[i].model != model &&
1112 sbp2_workarounds_table[i].model != SBP2_ROM_VALUE_WILDCARD)
1115 w |= sbp2_workarounds_table[i].workarounds;
1120 fw_notify("Workarounds for %s: 0x%x "
1121 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
1122 tgt->bus_id, w, firmware_revision, model);
1123 tgt->workarounds = w;
1126 static struct scsi_host_template scsi_driver_template;
1128 static int sbp2_probe(struct device *dev)
1130 struct fw_unit *unit = fw_unit(dev);
1131 struct fw_device *device = fw_parent_device(unit);
1132 struct sbp2_target *tgt;
1133 struct sbp2_logical_unit *lu;
1134 struct Scsi_Host *shost;
1135 u32 model, firmware_revision;
1137 if (dma_get_max_seg_size(device->card->device) > SBP2_MAX_SEG_SIZE)
1138 BUG_ON(dma_set_max_seg_size(device->card->device,
1139 SBP2_MAX_SEG_SIZE));
1141 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1145 tgt = (struct sbp2_target *)shost->hostdata;
1146 dev_set_drvdata(&unit->device, tgt);
1148 kref_init(&tgt->kref);
1149 INIT_LIST_HEAD(&tgt->lu_list);
1150 tgt->bus_id = dev_name(&unit->device);
1151 tgt->guid = (u64)device->config_rom[3] << 32 | device->config_rom[4];
1153 if (fw_device_enable_phys_dma(device) < 0)
1154 goto fail_shost_put;
1156 shost->max_cmd_len = SBP2_MAX_CDB_SIZE;
1158 if (scsi_add_host(shost, &unit->device) < 0)
1159 goto fail_shost_put;
1161 fw_device_get(device);
1164 /* implicit directory ID */
1165 tgt->directory_id = ((unit->directory - device->config_rom) * 4
1166 + CSR_CONFIG_ROM) & 0xffffff;
1168 firmware_revision = SBP2_ROM_VALUE_MISSING;
1169 model = SBP2_ROM_VALUE_MISSING;
1171 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1172 &firmware_revision) < 0)
1175 sbp2_init_workarounds(tgt, model, firmware_revision);
1178 * At S100 we can do 512 bytes per packet, at S200 1024 bytes,
1179 * and so on up to 4096 bytes. The SBP-2 max_payload field
1180 * specifies the max payload size as 2 ^ (max_payload + 2), so
1181 * if we set this to max_speed + 7, we get the right value.
1183 tgt->max_payload = min(device->max_speed + 7, 10U);
1184 tgt->max_payload = min(tgt->max_payload, device->card->max_receive - 1);
1186 /* Do the login in a workqueue so we can easily reschedule retries. */
1187 list_for_each_entry(lu, &tgt->lu_list, link)
1188 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1192 sbp2_target_put(tgt);
1196 scsi_host_put(shost);
1200 static int sbp2_remove(struct device *dev)
1202 struct fw_unit *unit = fw_unit(dev);
1203 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
1205 sbp2_target_put(tgt);
1209 static void sbp2_reconnect(struct work_struct *work)
1211 struct sbp2_logical_unit *lu =
1212 container_of(work, struct sbp2_logical_unit, work.work);
1213 struct sbp2_target *tgt = lu->tgt;
1214 struct fw_device *device = target_device(tgt);
1215 int generation, node_id, local_node_id;
1217 if (fw_device_is_shutdown(device))
1220 generation = device->generation;
1221 smp_rmb(); /* node IDs must not be older than generation */
1222 node_id = device->node_id;
1223 local_node_id = device->card->node_id;
1225 if (sbp2_send_management_orb(lu, node_id, generation,
1226 SBP2_RECONNECT_REQUEST,
1227 lu->login_id, NULL) < 0) {
1229 * If reconnect was impossible even though we are in the
1230 * current generation, fall back and try to log in again.
1232 * We could check for "Function rejected" status, but
1233 * looking at the bus generation as simpler and more general.
1235 smp_rmb(); /* get current card generation */
1236 if (generation == device->card->generation ||
1237 lu->retries++ >= 5) {
1238 fw_error("%s: failed to reconnect\n", tgt->bus_id);
1240 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
1242 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1246 tgt->node_id = node_id;
1247 tgt->address_high = local_node_id << 16;
1248 smp_wmb(); /* node IDs must not be older than generation */
1249 lu->generation = generation;
1251 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1252 tgt->bus_id, lu->lun, lu->retries);
1254 sbp2_agent_reset(lu);
1255 sbp2_cancel_orbs(lu);
1256 sbp2_conditionally_unblock(lu);
1258 sbp2_target_put(tgt);
1261 static void sbp2_update(struct fw_unit *unit)
1263 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
1264 struct sbp2_logical_unit *lu;
1266 fw_device_enable_phys_dma(fw_parent_device(unit));
1269 * Fw-core serializes sbp2_update() against sbp2_remove().
1270 * Iteration over tgt->lu_list is therefore safe here.
1272 list_for_each_entry(lu, &tgt->lu_list, link) {
1273 sbp2_conditionally_block(lu);
1275 sbp2_queue_work(lu, 0);
1279 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1280 #define SBP2_SW_VERSION_ENTRY 0x00010483
1282 static const struct ieee1394_device_id sbp2_id_table[] = {
1284 .match_flags = IEEE1394_MATCH_SPECIFIER_ID |
1285 IEEE1394_MATCH_VERSION,
1286 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
1287 .version = SBP2_SW_VERSION_ENTRY,
1292 static struct fw_driver sbp2_driver = {
1294 .owner = THIS_MODULE,
1295 .name = sbp2_driver_name,
1296 .bus = &fw_bus_type,
1297 .probe = sbp2_probe,
1298 .remove = sbp2_remove,
1300 .update = sbp2_update,
1301 .id_table = sbp2_id_table,
1304 static void sbp2_unmap_scatterlist(struct device *card_device,
1305 struct sbp2_command_orb *orb)
1307 if (scsi_sg_count(orb->cmd))
1308 dma_unmap_sg(card_device, scsi_sglist(orb->cmd),
1309 scsi_sg_count(orb->cmd),
1310 orb->cmd->sc_data_direction);
1312 if (orb->request.misc & cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT))
1313 dma_unmap_single(card_device, orb->page_table_bus,
1314 sizeof(orb->page_table), DMA_TO_DEVICE);
1317 static unsigned int sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
1321 sense_data[0] = 0x70;
1322 sense_data[1] = 0x0;
1323 sense_data[2] = sbp2_status[1];
1324 sense_data[3] = sbp2_status[4];
1325 sense_data[4] = sbp2_status[5];
1326 sense_data[5] = sbp2_status[6];
1327 sense_data[6] = sbp2_status[7];
1329 sense_data[8] = sbp2_status[8];
1330 sense_data[9] = sbp2_status[9];
1331 sense_data[10] = sbp2_status[10];
1332 sense_data[11] = sbp2_status[11];
1333 sense_data[12] = sbp2_status[2];
1334 sense_data[13] = sbp2_status[3];
1335 sense_data[14] = sbp2_status[12];
1336 sense_data[15] = sbp2_status[13];
1338 sam_status = sbp2_status[0] & 0x3f;
1340 switch (sam_status) {
1342 case SAM_STAT_CHECK_CONDITION:
1343 case SAM_STAT_CONDITION_MET:
1345 case SAM_STAT_RESERVATION_CONFLICT:
1346 case SAM_STAT_COMMAND_TERMINATED:
1347 return DID_OK << 16 | sam_status;
1350 return DID_ERROR << 16;
1354 static void complete_command_orb(struct sbp2_orb *base_orb,
1355 struct sbp2_status *status)
1357 struct sbp2_command_orb *orb =
1358 container_of(base_orb, struct sbp2_command_orb, base);
1359 struct fw_device *device = target_device(orb->lu->tgt);
1362 if (status != NULL) {
1363 if (STATUS_GET_DEAD(*status))
1364 sbp2_agent_reset_no_wait(orb->lu);
1366 switch (STATUS_GET_RESPONSE(*status)) {
1367 case SBP2_STATUS_REQUEST_COMPLETE:
1368 result = DID_OK << 16;
1370 case SBP2_STATUS_TRANSPORT_FAILURE:
1371 result = DID_BUS_BUSY << 16;
1373 case SBP2_STATUS_ILLEGAL_REQUEST:
1374 case SBP2_STATUS_VENDOR_DEPENDENT:
1376 result = DID_ERROR << 16;
1380 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1381 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
1382 orb->cmd->sense_buffer);
1385 * If the orb completes with status == NULL, something
1386 * went wrong, typically a bus reset happened mid-orb
1387 * or when sending the write (less likely).
1389 result = DID_BUS_BUSY << 16;
1390 sbp2_conditionally_block(orb->lu);
1393 dma_unmap_single(device->card->device, orb->base.request_bus,
1394 sizeof(orb->request), DMA_TO_DEVICE);
1395 sbp2_unmap_scatterlist(device->card->device, orb);
1397 orb->cmd->result = result;
1398 orb->done(orb->cmd);
1401 static int sbp2_map_scatterlist(struct sbp2_command_orb *orb,
1402 struct fw_device *device, struct sbp2_logical_unit *lu)
1404 struct scatterlist *sg = scsi_sglist(orb->cmd);
1407 n = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1408 orb->cmd->sc_data_direction);
1413 * Handle the special case where there is only one element in
1414 * the scatter list by converting it to an immediate block
1415 * request. This is also a workaround for broken devices such
1416 * as the second generation iPod which doesn't support page
1420 orb->request.data_descriptor.high =
1421 cpu_to_be32(lu->tgt->address_high);
1422 orb->request.data_descriptor.low =
1423 cpu_to_be32(sg_dma_address(sg));
1424 orb->request.misc |=
1425 cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
1429 for_each_sg(sg, sg, n, i) {
1430 orb->page_table[i].high = cpu_to_be32(sg_dma_len(sg) << 16);
1431 orb->page_table[i].low = cpu_to_be32(sg_dma_address(sg));
1434 orb->page_table_bus =
1435 dma_map_single(device->card->device, orb->page_table,
1436 sizeof(orb->page_table), DMA_TO_DEVICE);
1437 if (dma_mapping_error(device->card->device, orb->page_table_bus))
1438 goto fail_page_table;
1441 * The data_descriptor pointer is the one case where we need
1442 * to fill in the node ID part of the address. All other
1443 * pointers assume that the data referenced reside on the
1444 * initiator (i.e. us), but data_descriptor can refer to data
1445 * on other nodes so we need to put our ID in descriptor.high.
1447 orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1448 orb->request.data_descriptor.low = cpu_to_be32(orb->page_table_bus);
1449 orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
1450 COMMAND_ORB_DATA_SIZE(n));
1455 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1456 scsi_sg_count(orb->cmd), orb->cmd->sc_data_direction);
1461 /* SCSI stack integration */
1463 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1465 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1466 struct fw_device *device = target_device(lu->tgt);
1467 struct sbp2_command_orb *orb;
1468 int generation, retval = SCSI_MLQUEUE_HOST_BUSY;
1471 * Bidirectional commands are not yet implemented, and unknown
1472 * transfer direction not handled.
1474 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
1475 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
1476 cmd->result = DID_ERROR << 16;
1481 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
1483 fw_notify("failed to alloc orb\n");
1484 return SCSI_MLQUEUE_HOST_BUSY;
1487 /* Initialize rcode to something not RCODE_COMPLETE. */
1488 orb->base.rcode = -1;
1489 kref_init(&orb->base.kref);
1495 orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
1496 orb->request.misc = cpu_to_be32(
1497 COMMAND_ORB_MAX_PAYLOAD(lu->tgt->max_payload) |
1498 COMMAND_ORB_SPEED(device->max_speed) |
1499 COMMAND_ORB_NOTIFY);
1501 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1502 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
1504 generation = device->generation;
1505 smp_rmb(); /* sbp2_map_scatterlist looks at tgt->address_high */
1507 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1510 memcpy(orb->request.command_block, cmd->cmnd, cmd->cmd_len);
1512 orb->base.callback = complete_command_orb;
1513 orb->base.request_bus =
1514 dma_map_single(device->card->device, &orb->request,
1515 sizeof(orb->request), DMA_TO_DEVICE);
1516 if (dma_mapping_error(device->card->device, orb->base.request_bus)) {
1517 sbp2_unmap_scatterlist(device->card->device, orb);
1521 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, generation,
1522 lu->command_block_agent_address + SBP2_ORB_POINTER);
1525 kref_put(&orb->base.kref, free_orb);
1529 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1531 struct sbp2_logical_unit *lu = sdev->hostdata;
1533 /* (Re-)Adding logical units via the SCSI stack is not supported. */
1537 sdev->allow_restart = 1;
1539 /* SBP-2 requires quadlet alignment of the data buffers. */
1540 blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
1542 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1543 sdev->inquiry_len = 36;
1548 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1550 struct sbp2_logical_unit *lu = sdev->hostdata;
1552 sdev->use_10_for_rw = 1;
1554 if (sbp2_param_exclusive_login)
1555 sdev->manage_start_stop = 1;
1557 if (sdev->type == TYPE_ROM)
1558 sdev->use_10_for_ms = 1;
1560 if (sdev->type == TYPE_DISK &&
1561 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1562 sdev->skip_ms_page_8 = 1;
1564 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
1565 sdev->fix_capacity = 1;
1567 if (lu->tgt->workarounds & SBP2_WORKAROUND_POWER_CONDITION)
1568 sdev->start_stop_pwr_cond = 1;
1570 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1571 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
1573 blk_queue_max_segment_size(sdev->request_queue, SBP2_MAX_SEG_SIZE);
1579 * Called by scsi stack when something has really gone wrong. Usually
1580 * called when a command has timed-out for some reason.
1582 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1584 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1586 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
1587 sbp2_agent_reset(lu);
1588 sbp2_cancel_orbs(lu);
1594 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1595 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1597 * This is the concatenation of target port identifier and logical unit
1598 * identifier as per SAM-2...SAM-4 annex A.
1600 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
1601 struct device_attribute *attr, char *buf)
1603 struct scsi_device *sdev = to_scsi_device(dev);
1604 struct sbp2_logical_unit *lu;
1609 lu = sdev->hostdata;
1611 return sprintf(buf, "%016llx:%06x:%04x\n",
1612 (unsigned long long)lu->tgt->guid,
1613 lu->tgt->directory_id, lu->lun);
1616 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1618 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1619 &dev_attr_ieee1394_id,
1623 static struct scsi_host_template scsi_driver_template = {
1624 .module = THIS_MODULE,
1625 .name = "SBP-2 IEEE-1394",
1626 .proc_name = sbp2_driver_name,
1627 .queuecommand = sbp2_scsi_queuecommand,
1628 .slave_alloc = sbp2_scsi_slave_alloc,
1629 .slave_configure = sbp2_scsi_slave_configure,
1630 .eh_abort_handler = sbp2_scsi_abort,
1632 .sg_tablesize = SG_ALL,
1633 .use_clustering = ENABLE_CLUSTERING,
1636 .sdev_attrs = sbp2_scsi_sysfs_attrs,
1639 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1640 MODULE_DESCRIPTION("SCSI over IEEE1394");
1641 MODULE_LICENSE("GPL");
1642 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1644 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1645 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1646 MODULE_ALIAS("sbp2");
1649 static int __init sbp2_init(void)
1651 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1655 return driver_register(&sbp2_driver.driver);
1658 static void __exit sbp2_cleanup(void)
1660 driver_unregister(&sbp2_driver.driver);
1661 destroy_workqueue(sbp2_wq);
1664 module_init(sbp2_init);
1665 module_exit(sbp2_cleanup);