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/kernel.h>
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/mod_devicetable.h>
35 #include <linux/device.h>
36 #include <linux/scatterlist.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/blkdev.h>
39 #include <linux/string.h>
40 #include <linux/stringify.h>
41 #include <linux/timer.h>
43 #include <scsi/scsi.h>
44 #include <scsi/scsi_cmnd.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_host.h>
48 #include "fw-transaction.h"
49 #include "fw-topology.h"
50 #include "fw-device.h"
53 * So far only bridges from Oxford Semiconductor are known to support
54 * concurrent logins. Depending on firmware, four or two concurrent logins
55 * are possible on OXFW911 and newer Oxsemi bridges.
57 * Concurrent logins are useful together with cluster filesystems.
59 static int sbp2_param_exclusive_login = 1;
60 module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
61 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
62 "(default = Y, use N for concurrent initiators)");
65 * Flags for firmware oddities
67 * - 128kB max transfer
68 * Limit transfer size. Necessary for some old bridges.
71 * When scsi_mod probes the device, let the inquiry command look like that
75 * Suppress sending of mode_sense for mode page 8 if the device pretends to
76 * support the SCSI Primary Block commands instead of Reduced Block Commands.
79 * Tell sd_mod to correct the last sector number reported by read_capacity.
80 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
81 * Don't use this with devices which don't have this bug.
83 * - override internal blacklist
84 * Instead of adding to the built-in blacklist, use only the workarounds
85 * specified in the module load parameter.
86 * Useful if a blacklist entry interfered with a non-broken device.
88 #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
89 #define SBP2_WORKAROUND_INQUIRY_36 0x2
90 #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
91 #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
92 #define SBP2_WORKAROUND_OVERRIDE 0x100
94 static int sbp2_param_workarounds;
95 module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
96 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
97 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
98 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
99 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
100 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
101 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
102 ", or a combination)");
104 /* I don't know why the SCSI stack doesn't define something like this... */
105 typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
107 static const char sbp2_driver_name[] = "sbp2";
110 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
111 * and one struct scsi_device per sbp2_logical_unit.
113 struct sbp2_logical_unit {
114 struct sbp2_target *tgt;
115 struct list_head link;
116 struct scsi_device *sdev;
117 struct fw_address_handler address_handler;
118 struct list_head orb_list;
120 u64 command_block_agent_address;
125 * The generation is updated once we've logged in or reconnected
126 * to the logical unit. Thus, I/O to the device will automatically
127 * fail and get retried if it happens in a window where the device
128 * is not ready, e.g. after a bus reset but before we reconnect.
132 struct delayed_work work;
136 * We create one struct sbp2_target per IEEE 1212 Unit Directory
137 * and one struct Scsi_Host per sbp2_target.
141 struct fw_unit *unit;
143 u64 management_agent_address;
148 unsigned workarounds;
149 struct list_head lu_list;
152 #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
153 #define SBP2_MAX_SECTORS 255 /* Max sectors supported */
154 #define SBP2_ORB_TIMEOUT 2000 /* Timeout in ms */
156 #define SBP2_ORB_NULL 0x80000000
158 #define SBP2_DIRECTION_TO_MEDIA 0x0
159 #define SBP2_DIRECTION_FROM_MEDIA 0x1
161 /* Unit directory keys */
162 #define SBP2_CSR_FIRMWARE_REVISION 0x3c
163 #define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
164 #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
166 /* Management orb opcodes */
167 #define SBP2_LOGIN_REQUEST 0x0
168 #define SBP2_QUERY_LOGINS_REQUEST 0x1
169 #define SBP2_RECONNECT_REQUEST 0x3
170 #define SBP2_SET_PASSWORD_REQUEST 0x4
171 #define SBP2_LOGOUT_REQUEST 0x7
172 #define SBP2_ABORT_TASK_REQUEST 0xb
173 #define SBP2_ABORT_TASK_SET 0xc
174 #define SBP2_LOGICAL_UNIT_RESET 0xe
175 #define SBP2_TARGET_RESET_REQUEST 0xf
177 /* Offsets for command block agent registers */
178 #define SBP2_AGENT_STATE 0x00
179 #define SBP2_AGENT_RESET 0x04
180 #define SBP2_ORB_POINTER 0x08
181 #define SBP2_DOORBELL 0x10
182 #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
184 /* Status write response codes */
185 #define SBP2_STATUS_REQUEST_COMPLETE 0x0
186 #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
187 #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
188 #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
190 #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
191 #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
192 #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
193 #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
194 #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
195 #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
196 #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
197 #define STATUS_GET_DATA(v) ((v).data)
205 struct sbp2_pointer {
211 struct fw_transaction t;
213 dma_addr_t request_bus;
215 struct sbp2_pointer pointer;
216 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
217 struct list_head link;
220 #define MANAGEMENT_ORB_LUN(v) ((v))
221 #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
222 #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
223 #define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
224 #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
225 #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
227 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
228 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
230 struct sbp2_management_orb {
231 struct sbp2_orb base;
233 struct sbp2_pointer password;
234 struct sbp2_pointer response;
237 struct sbp2_pointer status_fifo;
240 dma_addr_t response_bus;
241 struct completion done;
242 struct sbp2_status status;
245 #define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
246 #define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
248 struct sbp2_login_response {
250 struct sbp2_pointer command_block_agent;
253 #define COMMAND_ORB_DATA_SIZE(v) ((v))
254 #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
255 #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
256 #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
257 #define COMMAND_ORB_SPEED(v) ((v) << 24)
258 #define COMMAND_ORB_DIRECTION(v) ((v) << 27)
259 #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
260 #define COMMAND_ORB_NOTIFY ((1) << 31)
262 struct sbp2_command_orb {
263 struct sbp2_orb base;
265 struct sbp2_pointer next;
266 struct sbp2_pointer data_descriptor;
268 u8 command_block[12];
270 struct scsi_cmnd *cmd;
272 struct sbp2_logical_unit *lu;
274 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
275 dma_addr_t page_table_bus;
279 * List of devices with known bugs.
281 * The firmware_revision field, masked with 0xffff00, is the best
282 * indicator for the type of bridge chip of a device. It yields a few
283 * false positives but this did not break correctly behaving devices
284 * so far. We use ~0 as a wildcard, since the 24 bit values we get
285 * from the config rom can never match that.
287 static const struct {
288 u32 firmware_revision;
290 unsigned workarounds;
291 } sbp2_workarounds_table[] = {
292 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
293 .firmware_revision = 0x002800,
295 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
296 SBP2_WORKAROUND_MODE_SENSE_8,
298 /* Initio bridges, actually only needed for some older ones */ {
299 .firmware_revision = 0x000200,
301 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
303 /* Symbios bridge */ {
304 .firmware_revision = 0xa0b800,
306 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
310 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
311 * these iPods do not feature the read_capacity bug according
312 * to one report. Read_capacity behaviour as well as model_id
313 * could change due to Apple-supplied firmware updates though.
316 /* iPod 4th generation. */ {
317 .firmware_revision = 0x0a2700,
319 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
322 .firmware_revision = 0x0a2700,
324 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
327 .firmware_revision = 0x0a2700,
329 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
334 free_orb(struct kref *kref)
336 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
342 sbp2_status_write(struct fw_card *card, struct fw_request *request,
343 int tcode, int destination, int source,
344 int generation, int speed,
345 unsigned long long offset,
346 void *payload, size_t length, void *callback_data)
348 struct sbp2_logical_unit *lu = callback_data;
349 struct sbp2_orb *orb;
350 struct sbp2_status status;
354 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
355 length == 0 || length > sizeof(status)) {
356 fw_send_response(card, request, RCODE_TYPE_ERROR);
360 header_size = min(length, 2 * sizeof(u32));
361 fw_memcpy_from_be32(&status, payload, header_size);
362 if (length > header_size)
363 memcpy(status.data, payload + 8, length - header_size);
364 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
365 fw_notify("non-orb related status write, not handled\n");
366 fw_send_response(card, request, RCODE_COMPLETE);
370 /* Lookup the orb corresponding to this status write. */
371 spin_lock_irqsave(&card->lock, flags);
372 list_for_each_entry(orb, &lu->orb_list, link) {
373 if (STATUS_GET_ORB_HIGH(status) == 0 &&
374 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
375 orb->rcode = RCODE_COMPLETE;
376 list_del(&orb->link);
380 spin_unlock_irqrestore(&card->lock, flags);
382 if (&orb->link != &lu->orb_list)
383 orb->callback(orb, &status);
385 fw_error("status write for unknown orb\n");
387 kref_put(&orb->kref, free_orb);
389 fw_send_response(card, request, RCODE_COMPLETE);
393 complete_transaction(struct fw_card *card, int rcode,
394 void *payload, size_t length, void *data)
396 struct sbp2_orb *orb = data;
400 * This is a little tricky. We can get the status write for
401 * the orb before we get this callback. The status write
402 * handler above will assume the orb pointer transaction was
403 * successful and set the rcode to RCODE_COMPLETE for the orb.
404 * So this callback only sets the rcode if it hasn't already
405 * been set and only does the cleanup if the transaction
406 * failed and we didn't already get a status write.
408 spin_lock_irqsave(&card->lock, flags);
410 if (orb->rcode == -1)
412 if (orb->rcode != RCODE_COMPLETE) {
413 list_del(&orb->link);
414 spin_unlock_irqrestore(&card->lock, flags);
415 orb->callback(orb, NULL);
417 spin_unlock_irqrestore(&card->lock, flags);
420 kref_put(&orb->kref, free_orb);
424 sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
425 int node_id, int generation, u64 offset)
427 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
430 orb->pointer.high = 0;
431 orb->pointer.low = orb->request_bus;
432 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
434 spin_lock_irqsave(&device->card->lock, flags);
435 list_add_tail(&orb->link, &lu->orb_list);
436 spin_unlock_irqrestore(&device->card->lock, flags);
438 /* Take a ref for the orb list and for the transaction callback. */
439 kref_get(&orb->kref);
440 kref_get(&orb->kref);
442 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
443 node_id, generation, device->max_speed, offset,
444 &orb->pointer, sizeof(orb->pointer),
445 complete_transaction, orb);
448 static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
450 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
451 struct sbp2_orb *orb, *next;
452 struct list_head list;
454 int retval = -ENOENT;
456 INIT_LIST_HEAD(&list);
457 spin_lock_irqsave(&device->card->lock, flags);
458 list_splice_init(&lu->orb_list, &list);
459 spin_unlock_irqrestore(&device->card->lock, flags);
461 list_for_each_entry_safe(orb, next, &list, link) {
463 if (fw_cancel_transaction(device->card, &orb->t) == 0)
466 orb->rcode = RCODE_CANCELLED;
467 orb->callback(orb, NULL);
474 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
476 struct sbp2_management_orb *orb =
477 container_of(base_orb, struct sbp2_management_orb, base);
480 memcpy(&orb->status, status, sizeof(*status));
481 complete(&orb->done);
485 sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
486 int generation, int function, int lun_or_login_id,
489 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
490 struct sbp2_management_orb *orb;
491 int retval = -ENOMEM;
493 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
497 kref_init(&orb->base.kref);
499 dma_map_single(device->card->device, &orb->response,
500 sizeof(orb->response), DMA_FROM_DEVICE);
501 if (dma_mapping_error(orb->response_bus))
502 goto fail_mapping_response;
504 orb->request.response.high = 0;
505 orb->request.response.low = orb->response_bus;
508 MANAGEMENT_ORB_NOTIFY |
509 MANAGEMENT_ORB_FUNCTION(function) |
510 MANAGEMENT_ORB_LUN(lun_or_login_id);
511 orb->request.length =
512 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
514 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
515 orb->request.status_fifo.low = lu->address_handler.offset;
517 if (function == SBP2_LOGIN_REQUEST) {
519 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login) |
520 MANAGEMENT_ORB_RECONNECT(0);
523 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
525 init_completion(&orb->done);
526 orb->base.callback = complete_management_orb;
528 orb->base.request_bus =
529 dma_map_single(device->card->device, &orb->request,
530 sizeof(orb->request), DMA_TO_DEVICE);
531 if (dma_mapping_error(orb->base.request_bus))
532 goto fail_mapping_request;
534 sbp2_send_orb(&orb->base, lu, node_id, generation,
535 lu->tgt->management_agent_address);
537 wait_for_completion_timeout(&orb->done,
538 msecs_to_jiffies(SBP2_ORB_TIMEOUT));
541 if (sbp2_cancel_orbs(lu) == 0) {
542 fw_error("orb reply timed out, rcode=0x%02x\n",
547 if (orb->base.rcode != RCODE_COMPLETE) {
548 fw_error("management write failed, rcode 0x%02x\n",
553 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
554 STATUS_GET_SBP_STATUS(orb->status) != 0) {
555 fw_error("error status: %d:%d\n",
556 STATUS_GET_RESPONSE(orb->status),
557 STATUS_GET_SBP_STATUS(orb->status));
563 dma_unmap_single(device->card->device, orb->base.request_bus,
564 sizeof(orb->request), DMA_TO_DEVICE);
565 fail_mapping_request:
566 dma_unmap_single(device->card->device, orb->response_bus,
567 sizeof(orb->response), DMA_FROM_DEVICE);
568 fail_mapping_response:
570 fw_memcpy_from_be32(response,
571 orb->response, sizeof(orb->response));
572 kref_put(&orb->base.kref, free_orb);
578 complete_agent_reset_write(struct fw_card *card, int rcode,
579 void *payload, size_t length, void *data)
581 struct fw_transaction *t = data;
586 static int sbp2_agent_reset(struct sbp2_logical_unit *lu)
588 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
589 struct fw_transaction *t;
592 t = kzalloc(sizeof(*t), GFP_ATOMIC);
596 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
597 lu->tgt->node_id, lu->generation, device->max_speed,
598 lu->command_block_agent_address + SBP2_AGENT_RESET,
599 &zero, sizeof(zero), complete_agent_reset_write, t);
604 static void sbp2_release_target(struct kref *kref)
606 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
607 struct sbp2_logical_unit *lu, *next;
608 struct Scsi_Host *shost =
609 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
611 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
613 scsi_remove_device(lu->sdev);
615 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
616 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
617 fw_core_remove_address_handler(&lu->address_handler);
621 scsi_remove_host(shost);
622 fw_notify("released %s\n", tgt->unit->device.bus_id);
624 put_device(&tgt->unit->device);
625 scsi_host_put(shost);
628 static void sbp2_reconnect(struct work_struct *work);
630 static void sbp2_login(struct work_struct *work)
632 struct sbp2_logical_unit *lu =
633 container_of(work, struct sbp2_logical_unit, work.work);
634 struct Scsi_Host *shost =
635 container_of((void *)lu->tgt, struct Scsi_Host, hostdata[0]);
636 struct scsi_device *sdev;
637 struct scsi_lun eight_bytes_lun;
638 struct fw_unit *unit = lu->tgt->unit;
639 struct fw_device *device = fw_device(unit->device.parent);
640 struct sbp2_login_response response;
641 int generation, node_id, local_node_id;
643 generation = device->card->generation;
644 node_id = device->node->node_id;
645 local_node_id = device->card->local_node->node_id;
647 if (sbp2_send_management_orb(lu, node_id, generation,
648 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
649 if (lu->retries++ < 5) {
650 schedule_delayed_work(&lu->work, DIV_ROUND_UP(HZ, 5));
652 fw_error("failed to login to %s LUN %04x\n",
653 unit->device.bus_id, lu->lun);
654 kref_put(&lu->tgt->kref, sbp2_release_target);
659 lu->generation = generation;
660 lu->tgt->node_id = node_id;
661 lu->tgt->address_high = local_node_id << 16;
663 /* Get command block agent offset and login id. */
664 lu->command_block_agent_address =
665 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
666 response.command_block_agent.low;
667 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
669 fw_notify("logged in to %s LUN %04x (%d retries)\n",
670 unit->device.bus_id, lu->lun, lu->retries);
673 /* FIXME: The linux1394 sbp2 does this last step. */
674 sbp2_set_busy_timeout(scsi_id);
677 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
678 sbp2_agent_reset(lu);
680 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
681 eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
682 eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
684 sdev = __scsi_add_device(shost, 0, 0,
685 scsilun_to_int(&eight_bytes_lun), lu);
687 sbp2_send_management_orb(lu, node_id, generation,
688 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
690 * Set this back to sbp2_login so we fall back and
691 * retry login on bus reset.
693 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
696 scsi_device_put(sdev);
698 kref_put(&lu->tgt->kref, sbp2_release_target);
701 static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
703 struct sbp2_logical_unit *lu;
705 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
709 lu->address_handler.length = 0x100;
710 lu->address_handler.address_callback = sbp2_status_write;
711 lu->address_handler.callback_data = lu;
713 if (fw_core_add_address_handler(&lu->address_handler,
714 &fw_high_memory_region) < 0) {
721 lu->lun = lun_entry & 0xffff;
723 INIT_LIST_HEAD(&lu->orb_list);
724 INIT_DELAYED_WORK(&lu->work, sbp2_login);
726 list_add_tail(&lu->link, &tgt->lu_list);
730 static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
732 struct fw_csr_iterator ci;
735 fw_csr_iterator_init(&ci, directory);
736 while (fw_csr_iterator_next(&ci, &key, &value))
737 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
738 sbp2_add_logical_unit(tgt, value) < 0)
743 static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
744 u32 *model, u32 *firmware_revision)
746 struct fw_csr_iterator ci;
749 fw_csr_iterator_init(&ci, directory);
750 while (fw_csr_iterator_next(&ci, &key, &value)) {
753 case CSR_DEPENDENT_INFO | CSR_OFFSET:
754 tgt->management_agent_address =
755 CSR_REGISTER_BASE + 4 * value;
758 case CSR_DIRECTORY_ID:
759 tgt->directory_id = value;
766 case SBP2_CSR_FIRMWARE_REVISION:
767 *firmware_revision = value;
770 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
771 if (sbp2_add_logical_unit(tgt, value) < 0)
775 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
776 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
784 static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
785 u32 firmware_revision)
788 unsigned w = sbp2_param_workarounds;
791 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
792 "if you need the workarounds parameter for %s\n",
793 tgt->unit->device.bus_id);
795 if (w & SBP2_WORKAROUND_OVERRIDE)
798 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
800 if (sbp2_workarounds_table[i].firmware_revision !=
801 (firmware_revision & 0xffffff00))
804 if (sbp2_workarounds_table[i].model != model &&
805 sbp2_workarounds_table[i].model != ~0)
808 w |= sbp2_workarounds_table[i].workarounds;
813 fw_notify("Workarounds for %s: 0x%x "
814 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
815 tgt->unit->device.bus_id,
816 w, firmware_revision, model);
817 tgt->workarounds = w;
820 static struct scsi_host_template scsi_driver_template;
822 static int sbp2_probe(struct device *dev)
824 struct fw_unit *unit = fw_unit(dev);
825 struct fw_device *device = fw_device(unit->device.parent);
826 struct sbp2_target *tgt;
827 struct sbp2_logical_unit *lu;
828 struct Scsi_Host *shost;
829 u32 model, firmware_revision;
831 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
835 tgt = (struct sbp2_target *)shost->hostdata;
836 unit->device.driver_data = tgt;
838 kref_init(&tgt->kref);
839 INIT_LIST_HEAD(&tgt->lu_list);
841 if (fw_device_enable_phys_dma(device) < 0)
844 if (scsi_add_host(shost, &unit->device) < 0)
847 /* Initialize to values that won't match anything in our table. */
848 firmware_revision = 0xff000000;
851 /* implicit directory ID */
852 tgt->directory_id = ((unit->directory - device->config_rom) * 4
853 + CSR_CONFIG_ROM) & 0xffffff;
855 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
856 &firmware_revision) < 0)
859 sbp2_init_workarounds(tgt, model, firmware_revision);
861 get_device(&unit->device);
864 * We schedule work to do the login so we can easily
865 * reschedule retries. Always get the ref before scheduling
868 list_for_each_entry(lu, &tgt->lu_list, link)
869 if (schedule_delayed_work(&lu->work, 0))
870 kref_get(&tgt->kref);
874 kref_put(&tgt->kref, sbp2_release_target);
878 scsi_host_put(shost);
882 static int sbp2_remove(struct device *dev)
884 struct fw_unit *unit = fw_unit(dev);
885 struct sbp2_target *tgt = unit->device.driver_data;
887 kref_put(&tgt->kref, sbp2_release_target);
891 static void sbp2_reconnect(struct work_struct *work)
893 struct sbp2_logical_unit *lu =
894 container_of(work, struct sbp2_logical_unit, work.work);
895 struct fw_unit *unit = lu->tgt->unit;
896 struct fw_device *device = fw_device(unit->device.parent);
897 int generation, node_id, local_node_id;
899 generation = device->card->generation;
900 node_id = device->node->node_id;
901 local_node_id = device->card->local_node->node_id;
903 if (sbp2_send_management_orb(lu, node_id, generation,
904 SBP2_RECONNECT_REQUEST,
905 lu->login_id, NULL) < 0) {
906 if (lu->retries++ >= 5) {
907 fw_error("failed to reconnect to %s\n",
908 unit->device.bus_id);
909 /* Fall back and try to log in again. */
911 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
913 schedule_delayed_work(&lu->work, DIV_ROUND_UP(HZ, 5));
917 lu->generation = generation;
918 lu->tgt->node_id = node_id;
919 lu->tgt->address_high = local_node_id << 16;
921 fw_notify("reconnected to %s LUN %04x (%d retries)\n",
922 unit->device.bus_id, lu->lun, lu->retries);
924 sbp2_agent_reset(lu);
925 sbp2_cancel_orbs(lu);
927 kref_put(&lu->tgt->kref, sbp2_release_target);
930 static void sbp2_update(struct fw_unit *unit)
932 struct sbp2_target *tgt = unit->device.driver_data;
933 struct sbp2_logical_unit *lu;
935 fw_device_enable_phys_dma(fw_device(unit->device.parent));
938 * Fw-core serializes sbp2_update() against sbp2_remove().
939 * Iteration over tgt->lu_list is therefore safe here.
941 list_for_each_entry(lu, &tgt->lu_list, link) {
943 if (schedule_delayed_work(&lu->work, 0))
944 kref_get(&tgt->kref);
948 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
949 #define SBP2_SW_VERSION_ENTRY 0x00010483
951 static const struct fw_device_id sbp2_id_table[] = {
953 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
954 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
955 .version = SBP2_SW_VERSION_ENTRY,
960 static struct fw_driver sbp2_driver = {
962 .owner = THIS_MODULE,
963 .name = sbp2_driver_name,
966 .remove = sbp2_remove,
968 .update = sbp2_update,
969 .id_table = sbp2_id_table,
973 sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
977 sense_data[0] = 0x70;
979 sense_data[2] = sbp2_status[1];
980 sense_data[3] = sbp2_status[4];
981 sense_data[4] = sbp2_status[5];
982 sense_data[5] = sbp2_status[6];
983 sense_data[6] = sbp2_status[7];
985 sense_data[8] = sbp2_status[8];
986 sense_data[9] = sbp2_status[9];
987 sense_data[10] = sbp2_status[10];
988 sense_data[11] = sbp2_status[11];
989 sense_data[12] = sbp2_status[2];
990 sense_data[13] = sbp2_status[3];
991 sense_data[14] = sbp2_status[12];
992 sense_data[15] = sbp2_status[13];
994 sam_status = sbp2_status[0] & 0x3f;
996 switch (sam_status) {
998 case SAM_STAT_CHECK_CONDITION:
999 case SAM_STAT_CONDITION_MET:
1001 case SAM_STAT_RESERVATION_CONFLICT:
1002 case SAM_STAT_COMMAND_TERMINATED:
1003 return DID_OK << 16 | sam_status;
1006 return DID_ERROR << 16;
1011 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1013 struct sbp2_command_orb *orb =
1014 container_of(base_orb, struct sbp2_command_orb, base);
1015 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
1018 if (status != NULL) {
1019 if (STATUS_GET_DEAD(*status))
1020 sbp2_agent_reset(orb->lu);
1022 switch (STATUS_GET_RESPONSE(*status)) {
1023 case SBP2_STATUS_REQUEST_COMPLETE:
1024 result = DID_OK << 16;
1026 case SBP2_STATUS_TRANSPORT_FAILURE:
1027 result = DID_BUS_BUSY << 16;
1029 case SBP2_STATUS_ILLEGAL_REQUEST:
1030 case SBP2_STATUS_VENDOR_DEPENDENT:
1032 result = DID_ERROR << 16;
1036 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1037 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
1038 orb->cmd->sense_buffer);
1041 * If the orb completes with status == NULL, something
1042 * went wrong, typically a bus reset happened mid-orb
1043 * or when sending the write (less likely).
1045 result = DID_BUS_BUSY << 16;
1048 dma_unmap_single(device->card->device, orb->base.request_bus,
1049 sizeof(orb->request), DMA_TO_DEVICE);
1051 if (scsi_sg_count(orb->cmd) > 0)
1052 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1053 scsi_sg_count(orb->cmd),
1054 orb->cmd->sc_data_direction);
1056 if (orb->page_table_bus != 0)
1057 dma_unmap_single(device->card->device, orb->page_table_bus,
1058 sizeof(orb->page_table), DMA_TO_DEVICE);
1060 orb->cmd->result = result;
1061 orb->done(orb->cmd);
1065 sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1066 struct sbp2_logical_unit *lu)
1068 struct scatterlist *sg;
1069 int sg_len, l, i, j, count;
1072 sg = scsi_sglist(orb->cmd);
1073 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1074 orb->cmd->sc_data_direction);
1079 * Handle the special case where there is only one element in
1080 * the scatter list by converting it to an immediate block
1081 * request. This is also a workaround for broken devices such
1082 * as the second generation iPod which doesn't support page
1085 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
1086 orb->request.data_descriptor.high = lu->tgt->address_high;
1087 orb->request.data_descriptor.low = sg_dma_address(sg);
1088 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
1093 * Convert the scatterlist to an sbp2 page table. If any
1094 * scatterlist entries are too big for sbp2, we split them as we
1095 * go. Even if we ask the block I/O layer to not give us sg
1096 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1097 * during DMA mapping, and Linux currently doesn't prevent this.
1099 for (i = 0, j = 0; i < count; i++) {
1100 sg_len = sg_dma_len(sg + i);
1101 sg_addr = sg_dma_address(sg + i);
1103 /* FIXME: This won't get us out of the pinch. */
1104 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1105 fw_error("page table overflow\n");
1106 goto fail_page_table;
1108 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1109 orb->page_table[j].low = sg_addr;
1110 orb->page_table[j].high = (l << 16);
1117 fw_memcpy_to_be32(orb->page_table, orb->page_table,
1118 sizeof(orb->page_table[0]) * j);
1119 orb->page_table_bus =
1120 dma_map_single(device->card->device, orb->page_table,
1121 sizeof(orb->page_table), DMA_TO_DEVICE);
1122 if (dma_mapping_error(orb->page_table_bus))
1123 goto fail_page_table;
1126 * The data_descriptor pointer is the one case where we need
1127 * to fill in the node ID part of the address. All other
1128 * pointers assume that the data referenced reside on the
1129 * initiator (i.e. us), but data_descriptor can refer to data
1130 * on other nodes so we need to put our ID in descriptor.high.
1132 orb->request.data_descriptor.high = lu->tgt->address_high;
1133 orb->request.data_descriptor.low = orb->page_table_bus;
1134 orb->request.misc |=
1135 COMMAND_ORB_PAGE_TABLE_PRESENT |
1136 COMMAND_ORB_DATA_SIZE(j);
1141 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1142 orb->cmd->sc_data_direction);
1147 /* SCSI stack integration */
1149 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1151 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1152 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
1153 struct sbp2_command_orb *orb;
1154 unsigned max_payload;
1155 int retval = SCSI_MLQUEUE_HOST_BUSY;
1158 * Bidirectional commands are not yet implemented, and unknown
1159 * transfer direction not handled.
1161 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
1162 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
1163 cmd->result = DID_ERROR << 16;
1168 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
1170 fw_notify("failed to alloc orb\n");
1171 return SCSI_MLQUEUE_HOST_BUSY;
1174 /* Initialize rcode to something not RCODE_COMPLETE. */
1175 orb->base.rcode = -1;
1176 kref_init(&orb->base.kref);
1182 orb->request.next.high = SBP2_ORB_NULL;
1183 orb->request.next.low = 0x0;
1185 * At speed 100 we can do 512 bytes per packet, at speed 200,
1186 * 1024 bytes per packet etc. The SBP-2 max_payload field
1187 * specifies the max payload size as 2 ^ (max_payload + 2), so
1188 * if we set this to max_speed + 7, we get the right value.
1190 max_payload = min(device->max_speed + 7,
1191 device->card->max_receive - 1);
1193 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
1194 COMMAND_ORB_SPEED(device->max_speed) |
1197 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1198 orb->request.misc |=
1199 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
1200 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1201 orb->request.misc |=
1202 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
1204 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1207 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
1209 memset(orb->request.command_block,
1210 0, sizeof(orb->request.command_block));
1211 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1213 orb->base.callback = complete_command_orb;
1214 orb->base.request_bus =
1215 dma_map_single(device->card->device, &orb->request,
1216 sizeof(orb->request), DMA_TO_DEVICE);
1217 if (dma_mapping_error(orb->base.request_bus))
1220 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1221 lu->command_block_agent_address + SBP2_ORB_POINTER);
1224 kref_put(&orb->base.kref, free_orb);
1228 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1230 struct sbp2_logical_unit *lu = sdev->hostdata;
1232 sdev->allow_restart = 1;
1234 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1235 sdev->inquiry_len = 36;
1240 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1242 struct sbp2_logical_unit *lu = sdev->hostdata;
1244 sdev->use_10_for_rw = 1;
1246 if (sdev->type == TYPE_ROM)
1247 sdev->use_10_for_ms = 1;
1249 if (sdev->type == TYPE_DISK &&
1250 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1251 sdev->skip_ms_page_8 = 1;
1253 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
1254 sdev->fix_capacity = 1;
1256 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1257 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
1263 * Called by scsi stack when something has really gone wrong. Usually
1264 * called when a command has timed-out for some reason.
1266 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1268 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1270 fw_notify("sbp2_scsi_abort\n");
1271 sbp2_agent_reset(lu);
1272 sbp2_cancel_orbs(lu);
1278 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1279 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1281 * This is the concatenation of target port identifier and logical unit
1282 * identifier as per SAM-2...SAM-4 annex A.
1285 sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1288 struct scsi_device *sdev = to_scsi_device(dev);
1289 struct sbp2_logical_unit *lu;
1290 struct fw_device *device;
1295 lu = sdev->hostdata;
1296 device = fw_device(lu->tgt->unit->device.parent);
1298 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1299 device->config_rom[3], device->config_rom[4],
1300 lu->tgt->directory_id, lu->lun);
1303 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1305 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1306 &dev_attr_ieee1394_id,
1310 static struct scsi_host_template scsi_driver_template = {
1311 .module = THIS_MODULE,
1312 .name = "SBP-2 IEEE-1394",
1313 .proc_name = sbp2_driver_name,
1314 .queuecommand = sbp2_scsi_queuecommand,
1315 .slave_alloc = sbp2_scsi_slave_alloc,
1316 .slave_configure = sbp2_scsi_slave_configure,
1317 .eh_abort_handler = sbp2_scsi_abort,
1319 .sg_tablesize = SG_ALL,
1320 .use_clustering = ENABLE_CLUSTERING,
1323 .sdev_attrs = sbp2_scsi_sysfs_attrs,
1326 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1327 MODULE_DESCRIPTION("SCSI over IEEE1394");
1328 MODULE_LICENSE("GPL");
1329 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1331 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1332 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1333 MODULE_ALIAS("sbp2");
1336 static int __init sbp2_init(void)
1338 return driver_register(&sbp2_driver.driver);
1341 static void __exit sbp2_cleanup(void)
1343 driver_unregister(&sbp2_driver.driver);
1346 module_init(sbp2_init);
1347 module_exit(sbp2_cleanup);