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>
42 #include <linux/workqueue.h>
44 #include <scsi/scsi.h>
45 #include <scsi/scsi_cmnd.h>
46 #include <scsi/scsi_device.h>
47 #include <scsi/scsi_host.h>
49 #include "fw-transaction.h"
50 #include "fw-topology.h"
51 #include "fw-device.h"
54 * So far only bridges from Oxford Semiconductor are known to support
55 * concurrent logins. Depending on firmware, four or two concurrent logins
56 * are possible on OXFW911 and newer Oxsemi bridges.
58 * Concurrent logins are useful together with cluster filesystems.
60 static int sbp2_param_exclusive_login = 1;
61 module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
62 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
63 "(default = Y, use N for concurrent initiators)");
66 * Flags for firmware oddities
68 * - 128kB max transfer
69 * Limit transfer size. Necessary for some old bridges.
72 * When scsi_mod probes the device, let the inquiry command look like that
76 * Suppress sending of mode_sense for mode page 8 if the device pretends to
77 * support the SCSI Primary Block commands instead of Reduced Block Commands.
80 * Tell sd_mod to correct the last sector number reported by read_capacity.
81 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
82 * Don't use this with devices which don't have this bug.
84 * - override internal blacklist
85 * Instead of adding to the built-in blacklist, use only the workarounds
86 * specified in the module load parameter.
87 * Useful if a blacklist entry interfered with a non-broken device.
89 #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
90 #define SBP2_WORKAROUND_INQUIRY_36 0x2
91 #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
92 #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
93 #define SBP2_WORKAROUND_OVERRIDE 0x100
95 static int sbp2_param_workarounds;
96 module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
97 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
98 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
99 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
100 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
101 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
102 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
103 ", or a combination)");
105 /* I don't know why the SCSI stack doesn't define something like this... */
106 typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
108 static const char sbp2_driver_name[] = "sbp2";
111 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
112 * and one struct scsi_device per sbp2_logical_unit.
114 struct sbp2_logical_unit {
115 struct sbp2_target *tgt;
116 struct list_head link;
117 struct scsi_device *sdev;
118 struct fw_address_handler address_handler;
119 struct list_head orb_list;
121 u64 command_block_agent_address;
126 * The generation is updated once we've logged in or reconnected
127 * to the logical unit. Thus, I/O to the device will automatically
128 * fail and get retried if it happens in a window where the device
129 * is not ready, e.g. after a bus reset but before we reconnect.
133 struct delayed_work work;
137 * We create one struct sbp2_target per IEEE 1212 Unit Directory
138 * and one struct Scsi_Host per sbp2_target.
142 struct fw_unit *unit;
144 u64 management_agent_address;
149 unsigned workarounds;
150 struct list_head lu_list;
153 #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
154 #define SBP2_ORB_TIMEOUT 2000 /* Timeout in ms */
155 #define SBP2_ORB_NULL 0x80000000
157 #define SBP2_DIRECTION_TO_MEDIA 0x0
158 #define SBP2_DIRECTION_FROM_MEDIA 0x1
160 /* Unit directory keys */
161 #define SBP2_CSR_FIRMWARE_REVISION 0x3c
162 #define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
163 #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
165 /* Management orb opcodes */
166 #define SBP2_LOGIN_REQUEST 0x0
167 #define SBP2_QUERY_LOGINS_REQUEST 0x1
168 #define SBP2_RECONNECT_REQUEST 0x3
169 #define SBP2_SET_PASSWORD_REQUEST 0x4
170 #define SBP2_LOGOUT_REQUEST 0x7
171 #define SBP2_ABORT_TASK_REQUEST 0xb
172 #define SBP2_ABORT_TASK_SET 0xc
173 #define SBP2_LOGICAL_UNIT_RESET 0xe
174 #define SBP2_TARGET_RESET_REQUEST 0xf
176 /* Offsets for command block agent registers */
177 #define SBP2_AGENT_STATE 0x00
178 #define SBP2_AGENT_RESET 0x04
179 #define SBP2_ORB_POINTER 0x08
180 #define SBP2_DOORBELL 0x10
181 #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
183 /* Status write response codes */
184 #define SBP2_STATUS_REQUEST_COMPLETE 0x0
185 #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
186 #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
187 #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
189 #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
190 #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
191 #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
192 #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
193 #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
194 #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
195 #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
196 #define STATUS_GET_DATA(v) ((v).data)
204 struct sbp2_pointer {
210 struct fw_transaction t;
212 dma_addr_t request_bus;
214 struct sbp2_pointer pointer;
215 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
216 struct list_head link;
219 #define MANAGEMENT_ORB_LUN(v) ((v))
220 #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
221 #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
222 #define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
223 #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
224 #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
226 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
227 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
229 struct sbp2_management_orb {
230 struct sbp2_orb base;
232 struct sbp2_pointer password;
233 struct sbp2_pointer response;
236 struct sbp2_pointer status_fifo;
239 dma_addr_t response_bus;
240 struct completion done;
241 struct sbp2_status status;
244 #define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
245 #define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
247 struct sbp2_login_response {
249 struct sbp2_pointer command_block_agent;
252 #define COMMAND_ORB_DATA_SIZE(v) ((v))
253 #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
254 #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
255 #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
256 #define COMMAND_ORB_SPEED(v) ((v) << 24)
257 #define COMMAND_ORB_DIRECTION(v) ((v) << 27)
258 #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
259 #define COMMAND_ORB_NOTIFY ((1) << 31)
261 struct sbp2_command_orb {
262 struct sbp2_orb base;
264 struct sbp2_pointer next;
265 struct sbp2_pointer data_descriptor;
267 u8 command_block[12];
269 struct scsi_cmnd *cmd;
271 struct sbp2_logical_unit *lu;
273 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
274 dma_addr_t page_table_bus;
278 * List of devices with known bugs.
280 * The firmware_revision field, masked with 0xffff00, is the best
281 * indicator for the type of bridge chip of a device. It yields a few
282 * false positives but this did not break correctly behaving devices
283 * so far. We use ~0 as a wildcard, since the 24 bit values we get
284 * from the config rom can never match that.
286 static const struct {
287 u32 firmware_revision;
289 unsigned workarounds;
290 } sbp2_workarounds_table[] = {
291 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
292 .firmware_revision = 0x002800,
294 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
295 SBP2_WORKAROUND_MODE_SENSE_8,
297 /* Initio bridges, actually only needed for some older ones */ {
298 .firmware_revision = 0x000200,
300 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
302 /* Symbios bridge */ {
303 .firmware_revision = 0xa0b800,
305 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
309 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
310 * these iPods do not feature the read_capacity bug according
311 * to one report. Read_capacity behaviour as well as model_id
312 * could change due to Apple-supplied firmware updates though.
315 /* iPod 4th generation. */ {
316 .firmware_revision = 0x0a2700,
318 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
321 .firmware_revision = 0x0a2700,
323 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
326 .firmware_revision = 0x0a2700,
328 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
333 free_orb(struct kref *kref)
335 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
341 sbp2_status_write(struct fw_card *card, struct fw_request *request,
342 int tcode, int destination, int source,
343 int generation, int speed,
344 unsigned long long offset,
345 void *payload, size_t length, void *callback_data)
347 struct sbp2_logical_unit *lu = callback_data;
348 struct sbp2_orb *orb;
349 struct sbp2_status status;
353 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
354 length == 0 || length > sizeof(status)) {
355 fw_send_response(card, request, RCODE_TYPE_ERROR);
359 header_size = min(length, 2 * sizeof(u32));
360 fw_memcpy_from_be32(&status, payload, header_size);
361 if (length > header_size)
362 memcpy(status.data, payload + 8, length - header_size);
363 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
364 fw_notify("non-orb related status write, not handled\n");
365 fw_send_response(card, request, RCODE_COMPLETE);
369 /* Lookup the orb corresponding to this status write. */
370 spin_lock_irqsave(&card->lock, flags);
371 list_for_each_entry(orb, &lu->orb_list, link) {
372 if (STATUS_GET_ORB_HIGH(status) == 0 &&
373 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
374 orb->rcode = RCODE_COMPLETE;
375 list_del(&orb->link);
379 spin_unlock_irqrestore(&card->lock, flags);
381 if (&orb->link != &lu->orb_list)
382 orb->callback(orb, &status);
384 fw_error("status write for unknown orb\n");
386 kref_put(&orb->kref, free_orb);
388 fw_send_response(card, request, RCODE_COMPLETE);
392 complete_transaction(struct fw_card *card, int rcode,
393 void *payload, size_t length, void *data)
395 struct sbp2_orb *orb = data;
399 * This is a little tricky. We can get the status write for
400 * the orb before we get this callback. The status write
401 * handler above will assume the orb pointer transaction was
402 * successful and set the rcode to RCODE_COMPLETE for the orb.
403 * So this callback only sets the rcode if it hasn't already
404 * been set and only does the cleanup if the transaction
405 * failed and we didn't already get a status write.
407 spin_lock_irqsave(&card->lock, flags);
409 if (orb->rcode == -1)
411 if (orb->rcode != RCODE_COMPLETE) {
412 list_del(&orb->link);
413 spin_unlock_irqrestore(&card->lock, flags);
414 orb->callback(orb, NULL);
416 spin_unlock_irqrestore(&card->lock, flags);
419 kref_put(&orb->kref, free_orb);
423 sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
424 int node_id, int generation, u64 offset)
426 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
429 orb->pointer.high = 0;
430 orb->pointer.low = orb->request_bus;
431 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
433 spin_lock_irqsave(&device->card->lock, flags);
434 list_add_tail(&orb->link, &lu->orb_list);
435 spin_unlock_irqrestore(&device->card->lock, flags);
437 /* Take a ref for the orb list and for the transaction callback. */
438 kref_get(&orb->kref);
439 kref_get(&orb->kref);
441 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
442 node_id, generation, device->max_speed, offset,
443 &orb->pointer, sizeof(orb->pointer),
444 complete_transaction, orb);
447 static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
449 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
450 struct sbp2_orb *orb, *next;
451 struct list_head list;
453 int retval = -ENOENT;
455 INIT_LIST_HEAD(&list);
456 spin_lock_irqsave(&device->card->lock, flags);
457 list_splice_init(&lu->orb_list, &list);
458 spin_unlock_irqrestore(&device->card->lock, flags);
460 list_for_each_entry_safe(orb, next, &list, link) {
462 if (fw_cancel_transaction(device->card, &orb->t) == 0)
465 orb->rcode = RCODE_CANCELLED;
466 orb->callback(orb, NULL);
473 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
475 struct sbp2_management_orb *orb =
476 container_of(base_orb, struct sbp2_management_orb, base);
479 memcpy(&orb->status, status, sizeof(*status));
480 complete(&orb->done);
484 sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
485 int generation, int function, int lun_or_login_id,
488 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
489 struct sbp2_management_orb *orb;
490 int retval = -ENOMEM;
492 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
496 kref_init(&orb->base.kref);
498 dma_map_single(device->card->device, &orb->response,
499 sizeof(orb->response), DMA_FROM_DEVICE);
500 if (dma_mapping_error(orb->response_bus))
501 goto fail_mapping_response;
503 orb->request.response.high = 0;
504 orb->request.response.low = orb->response_bus;
507 MANAGEMENT_ORB_NOTIFY |
508 MANAGEMENT_ORB_FUNCTION(function) |
509 MANAGEMENT_ORB_LUN(lun_or_login_id);
510 orb->request.length =
511 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
513 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
514 orb->request.status_fifo.low = lu->address_handler.offset;
516 if (function == SBP2_LOGIN_REQUEST) {
518 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login) |
519 MANAGEMENT_ORB_RECONNECT(0);
522 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
524 init_completion(&orb->done);
525 orb->base.callback = complete_management_orb;
527 orb->base.request_bus =
528 dma_map_single(device->card->device, &orb->request,
529 sizeof(orb->request), DMA_TO_DEVICE);
530 if (dma_mapping_error(orb->base.request_bus))
531 goto fail_mapping_request;
533 sbp2_send_orb(&orb->base, lu, node_id, generation,
534 lu->tgt->management_agent_address);
536 wait_for_completion_timeout(&orb->done,
537 msecs_to_jiffies(SBP2_ORB_TIMEOUT));
540 if (sbp2_cancel_orbs(lu) == 0) {
541 fw_error("orb reply timed out, rcode=0x%02x\n",
546 if (orb->base.rcode != RCODE_COMPLETE) {
547 fw_error("management write failed, rcode 0x%02x\n",
552 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
553 STATUS_GET_SBP_STATUS(orb->status) != 0) {
554 fw_error("error status: %d:%d\n",
555 STATUS_GET_RESPONSE(orb->status),
556 STATUS_GET_SBP_STATUS(orb->status));
562 dma_unmap_single(device->card->device, orb->base.request_bus,
563 sizeof(orb->request), DMA_TO_DEVICE);
564 fail_mapping_request:
565 dma_unmap_single(device->card->device, orb->response_bus,
566 sizeof(orb->response), DMA_FROM_DEVICE);
567 fail_mapping_response:
569 fw_memcpy_from_be32(response,
570 orb->response, sizeof(orb->response));
571 kref_put(&orb->base.kref, free_orb);
577 complete_agent_reset_write(struct fw_card *card, int rcode,
578 void *payload, size_t length, void *data)
580 struct fw_transaction *t = data;
585 static int sbp2_agent_reset(struct sbp2_logical_unit *lu)
587 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
588 struct fw_transaction *t;
591 t = kzalloc(sizeof(*t), GFP_ATOMIC);
595 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
596 lu->tgt->node_id, lu->generation, device->max_speed,
597 lu->command_block_agent_address + SBP2_AGENT_RESET,
598 &zero, sizeof(zero), complete_agent_reset_write, t);
603 static void sbp2_release_target(struct kref *kref)
605 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
606 struct sbp2_logical_unit *lu, *next;
607 struct Scsi_Host *shost =
608 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
610 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
612 scsi_remove_device(lu->sdev);
614 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
615 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
616 fw_core_remove_address_handler(&lu->address_handler);
620 scsi_remove_host(shost);
621 fw_notify("released %s\n", tgt->unit->device.bus_id);
623 put_device(&tgt->unit->device);
624 scsi_host_put(shost);
627 static struct workqueue_struct *sbp2_wq;
630 * Always get the target's kref when scheduling work on one its units.
631 * Each workqueue job is responsible to call sbp2_target_put() upon return.
633 static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
635 if (queue_delayed_work(sbp2_wq, &lu->work, delay))
636 kref_get(&lu->tgt->kref);
639 static void sbp2_target_put(struct sbp2_target *tgt)
641 kref_put(&tgt->kref, sbp2_release_target);
644 static void sbp2_reconnect(struct work_struct *work);
646 static void sbp2_login(struct work_struct *work)
648 struct sbp2_logical_unit *lu =
649 container_of(work, struct sbp2_logical_unit, work.work);
650 struct Scsi_Host *shost =
651 container_of((void *)lu->tgt, struct Scsi_Host, hostdata[0]);
652 struct scsi_device *sdev;
653 struct scsi_lun eight_bytes_lun;
654 struct fw_unit *unit = lu->tgt->unit;
655 struct fw_device *device = fw_device(unit->device.parent);
656 struct sbp2_login_response response;
657 int generation, node_id, local_node_id;
659 generation = device->card->generation;
660 node_id = device->node->node_id;
661 local_node_id = device->card->local_node->node_id;
663 if (sbp2_send_management_orb(lu, node_id, generation,
664 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
665 if (lu->retries++ < 5)
666 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
668 fw_error("failed to login to %s LUN %04x\n",
669 unit->device.bus_id, lu->lun);
673 lu->generation = generation;
674 lu->tgt->node_id = node_id;
675 lu->tgt->address_high = local_node_id << 16;
677 /* Get command block agent offset and login id. */
678 lu->command_block_agent_address =
679 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
680 response.command_block_agent.low;
681 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
683 fw_notify("logged in to %s LUN %04x (%d retries)\n",
684 unit->device.bus_id, lu->lun, lu->retries);
687 /* FIXME: The linux1394 sbp2 does this last step. */
688 sbp2_set_busy_timeout(scsi_id);
691 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
692 sbp2_agent_reset(lu);
694 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
695 eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
696 eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
698 sdev = __scsi_add_device(shost, 0, 0,
699 scsilun_to_int(&eight_bytes_lun), lu);
701 sbp2_send_management_orb(lu, node_id, generation,
702 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
704 * Set this back to sbp2_login so we fall back and
705 * retry login on bus reset.
707 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
710 scsi_device_put(sdev);
713 sbp2_target_put(lu->tgt);
716 static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
718 struct sbp2_logical_unit *lu;
720 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
724 lu->address_handler.length = 0x100;
725 lu->address_handler.address_callback = sbp2_status_write;
726 lu->address_handler.callback_data = lu;
728 if (fw_core_add_address_handler(&lu->address_handler,
729 &fw_high_memory_region) < 0) {
736 lu->lun = lun_entry & 0xffff;
738 INIT_LIST_HEAD(&lu->orb_list);
739 INIT_DELAYED_WORK(&lu->work, sbp2_login);
741 list_add_tail(&lu->link, &tgt->lu_list);
745 static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
747 struct fw_csr_iterator ci;
750 fw_csr_iterator_init(&ci, directory);
751 while (fw_csr_iterator_next(&ci, &key, &value))
752 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
753 sbp2_add_logical_unit(tgt, value) < 0)
758 static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
759 u32 *model, u32 *firmware_revision)
761 struct fw_csr_iterator ci;
764 fw_csr_iterator_init(&ci, directory);
765 while (fw_csr_iterator_next(&ci, &key, &value)) {
768 case CSR_DEPENDENT_INFO | CSR_OFFSET:
769 tgt->management_agent_address =
770 CSR_REGISTER_BASE + 4 * value;
773 case CSR_DIRECTORY_ID:
774 tgt->directory_id = value;
781 case SBP2_CSR_FIRMWARE_REVISION:
782 *firmware_revision = value;
785 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
786 if (sbp2_add_logical_unit(tgt, value) < 0)
790 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
791 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
799 static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
800 u32 firmware_revision)
803 unsigned w = sbp2_param_workarounds;
806 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
807 "if you need the workarounds parameter for %s\n",
808 tgt->unit->device.bus_id);
810 if (w & SBP2_WORKAROUND_OVERRIDE)
813 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
815 if (sbp2_workarounds_table[i].firmware_revision !=
816 (firmware_revision & 0xffffff00))
819 if (sbp2_workarounds_table[i].model != model &&
820 sbp2_workarounds_table[i].model != ~0)
823 w |= sbp2_workarounds_table[i].workarounds;
828 fw_notify("Workarounds for %s: 0x%x "
829 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
830 tgt->unit->device.bus_id,
831 w, firmware_revision, model);
832 tgt->workarounds = w;
835 static struct scsi_host_template scsi_driver_template;
837 static int sbp2_probe(struct device *dev)
839 struct fw_unit *unit = fw_unit(dev);
840 struct fw_device *device = fw_device(unit->device.parent);
841 struct sbp2_target *tgt;
842 struct sbp2_logical_unit *lu;
843 struct Scsi_Host *shost;
844 u32 model, firmware_revision;
846 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
850 tgt = (struct sbp2_target *)shost->hostdata;
851 unit->device.driver_data = tgt;
853 kref_init(&tgt->kref);
854 INIT_LIST_HEAD(&tgt->lu_list);
856 if (fw_device_enable_phys_dma(device) < 0)
859 if (scsi_add_host(shost, &unit->device) < 0)
862 /* Initialize to values that won't match anything in our table. */
863 firmware_revision = 0xff000000;
866 /* implicit directory ID */
867 tgt->directory_id = ((unit->directory - device->config_rom) * 4
868 + CSR_CONFIG_ROM) & 0xffffff;
870 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
871 &firmware_revision) < 0)
874 sbp2_init_workarounds(tgt, model, firmware_revision);
876 get_device(&unit->device);
878 /* Do the login in a workqueue so we can easily reschedule retries. */
879 list_for_each_entry(lu, &tgt->lu_list, link)
880 sbp2_queue_work(lu, 0);
884 sbp2_target_put(tgt);
888 scsi_host_put(shost);
892 static int sbp2_remove(struct device *dev)
894 struct fw_unit *unit = fw_unit(dev);
895 struct sbp2_target *tgt = unit->device.driver_data;
897 sbp2_target_put(tgt);
901 static void sbp2_reconnect(struct work_struct *work)
903 struct sbp2_logical_unit *lu =
904 container_of(work, struct sbp2_logical_unit, work.work);
905 struct fw_unit *unit = lu->tgt->unit;
906 struct fw_device *device = fw_device(unit->device.parent);
907 int generation, node_id, local_node_id;
909 generation = device->card->generation;
910 node_id = device->node->node_id;
911 local_node_id = device->card->local_node->node_id;
913 if (sbp2_send_management_orb(lu, node_id, generation,
914 SBP2_RECONNECT_REQUEST,
915 lu->login_id, NULL) < 0) {
916 if (lu->retries++ >= 5) {
917 fw_error("failed to reconnect to %s\n",
918 unit->device.bus_id);
919 /* Fall back and try to log in again. */
921 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
923 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
927 lu->generation = generation;
928 lu->tgt->node_id = node_id;
929 lu->tgt->address_high = local_node_id << 16;
931 fw_notify("reconnected to %s LUN %04x (%d retries)\n",
932 unit->device.bus_id, lu->lun, lu->retries);
934 sbp2_agent_reset(lu);
935 sbp2_cancel_orbs(lu);
937 sbp2_target_put(lu->tgt);
940 static void sbp2_update(struct fw_unit *unit)
942 struct sbp2_target *tgt = unit->device.driver_data;
943 struct sbp2_logical_unit *lu;
945 fw_device_enable_phys_dma(fw_device(unit->device.parent));
948 * Fw-core serializes sbp2_update() against sbp2_remove().
949 * Iteration over tgt->lu_list is therefore safe here.
951 list_for_each_entry(lu, &tgt->lu_list, link) {
953 sbp2_queue_work(lu, 0);
957 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
958 #define SBP2_SW_VERSION_ENTRY 0x00010483
960 static const struct fw_device_id sbp2_id_table[] = {
962 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
963 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
964 .version = SBP2_SW_VERSION_ENTRY,
969 static struct fw_driver sbp2_driver = {
971 .owner = THIS_MODULE,
972 .name = sbp2_driver_name,
975 .remove = sbp2_remove,
977 .update = sbp2_update,
978 .id_table = sbp2_id_table,
982 sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
986 sense_data[0] = 0x70;
988 sense_data[2] = sbp2_status[1];
989 sense_data[3] = sbp2_status[4];
990 sense_data[4] = sbp2_status[5];
991 sense_data[5] = sbp2_status[6];
992 sense_data[6] = sbp2_status[7];
994 sense_data[8] = sbp2_status[8];
995 sense_data[9] = sbp2_status[9];
996 sense_data[10] = sbp2_status[10];
997 sense_data[11] = sbp2_status[11];
998 sense_data[12] = sbp2_status[2];
999 sense_data[13] = sbp2_status[3];
1000 sense_data[14] = sbp2_status[12];
1001 sense_data[15] = sbp2_status[13];
1003 sam_status = sbp2_status[0] & 0x3f;
1005 switch (sam_status) {
1007 case SAM_STAT_CHECK_CONDITION:
1008 case SAM_STAT_CONDITION_MET:
1010 case SAM_STAT_RESERVATION_CONFLICT:
1011 case SAM_STAT_COMMAND_TERMINATED:
1012 return DID_OK << 16 | sam_status;
1015 return DID_ERROR << 16;
1020 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1022 struct sbp2_command_orb *orb =
1023 container_of(base_orb, struct sbp2_command_orb, base);
1024 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
1027 if (status != NULL) {
1028 if (STATUS_GET_DEAD(*status))
1029 sbp2_agent_reset(orb->lu);
1031 switch (STATUS_GET_RESPONSE(*status)) {
1032 case SBP2_STATUS_REQUEST_COMPLETE:
1033 result = DID_OK << 16;
1035 case SBP2_STATUS_TRANSPORT_FAILURE:
1036 result = DID_BUS_BUSY << 16;
1038 case SBP2_STATUS_ILLEGAL_REQUEST:
1039 case SBP2_STATUS_VENDOR_DEPENDENT:
1041 result = DID_ERROR << 16;
1045 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1046 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
1047 orb->cmd->sense_buffer);
1050 * If the orb completes with status == NULL, something
1051 * went wrong, typically a bus reset happened mid-orb
1052 * or when sending the write (less likely).
1054 result = DID_BUS_BUSY << 16;
1057 dma_unmap_single(device->card->device, orb->base.request_bus,
1058 sizeof(orb->request), DMA_TO_DEVICE);
1060 if (scsi_sg_count(orb->cmd) > 0)
1061 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1062 scsi_sg_count(orb->cmd),
1063 orb->cmd->sc_data_direction);
1065 if (orb->page_table_bus != 0)
1066 dma_unmap_single(device->card->device, orb->page_table_bus,
1067 sizeof(orb->page_table), DMA_TO_DEVICE);
1069 orb->cmd->result = result;
1070 orb->done(orb->cmd);
1074 sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1075 struct sbp2_logical_unit *lu)
1077 struct scatterlist *sg;
1078 int sg_len, l, i, j, count;
1081 sg = scsi_sglist(orb->cmd);
1082 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1083 orb->cmd->sc_data_direction);
1088 * Handle the special case where there is only one element in
1089 * the scatter list by converting it to an immediate block
1090 * request. This is also a workaround for broken devices such
1091 * as the second generation iPod which doesn't support page
1094 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
1095 orb->request.data_descriptor.high = lu->tgt->address_high;
1096 orb->request.data_descriptor.low = sg_dma_address(sg);
1097 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
1102 * Convert the scatterlist to an sbp2 page table. If any
1103 * scatterlist entries are too big for sbp2, we split them as we
1104 * go. Even if we ask the block I/O layer to not give us sg
1105 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1106 * during DMA mapping, and Linux currently doesn't prevent this.
1108 for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
1109 sg_len = sg_dma_len(sg);
1110 sg_addr = sg_dma_address(sg);
1112 /* FIXME: This won't get us out of the pinch. */
1113 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1114 fw_error("page table overflow\n");
1115 goto fail_page_table;
1117 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1118 orb->page_table[j].low = sg_addr;
1119 orb->page_table[j].high = (l << 16);
1126 fw_memcpy_to_be32(orb->page_table, orb->page_table,
1127 sizeof(orb->page_table[0]) * j);
1128 orb->page_table_bus =
1129 dma_map_single(device->card->device, orb->page_table,
1130 sizeof(orb->page_table), DMA_TO_DEVICE);
1131 if (dma_mapping_error(orb->page_table_bus))
1132 goto fail_page_table;
1135 * The data_descriptor pointer is the one case where we need
1136 * to fill in the node ID part of the address. All other
1137 * pointers assume that the data referenced reside on the
1138 * initiator (i.e. us), but data_descriptor can refer to data
1139 * on other nodes so we need to put our ID in descriptor.high.
1141 orb->request.data_descriptor.high = lu->tgt->address_high;
1142 orb->request.data_descriptor.low = orb->page_table_bus;
1143 orb->request.misc |=
1144 COMMAND_ORB_PAGE_TABLE_PRESENT |
1145 COMMAND_ORB_DATA_SIZE(j);
1150 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1151 orb->cmd->sc_data_direction);
1156 /* SCSI stack integration */
1158 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1160 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1161 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
1162 struct sbp2_command_orb *orb;
1163 unsigned max_payload;
1164 int retval = SCSI_MLQUEUE_HOST_BUSY;
1167 * Bidirectional commands are not yet implemented, and unknown
1168 * transfer direction not handled.
1170 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
1171 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
1172 cmd->result = DID_ERROR << 16;
1177 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
1179 fw_notify("failed to alloc orb\n");
1180 return SCSI_MLQUEUE_HOST_BUSY;
1183 /* Initialize rcode to something not RCODE_COMPLETE. */
1184 orb->base.rcode = -1;
1185 kref_init(&orb->base.kref);
1191 orb->request.next.high = SBP2_ORB_NULL;
1192 orb->request.next.low = 0x0;
1194 * At speed 100 we can do 512 bytes per packet, at speed 200,
1195 * 1024 bytes per packet etc. The SBP-2 max_payload field
1196 * specifies the max payload size as 2 ^ (max_payload + 2), so
1197 * if we set this to max_speed + 7, we get the right value.
1199 max_payload = min(device->max_speed + 7,
1200 device->card->max_receive - 1);
1202 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
1203 COMMAND_ORB_SPEED(device->max_speed) |
1206 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1207 orb->request.misc |=
1208 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
1209 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1210 orb->request.misc |=
1211 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
1213 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1216 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
1218 memset(orb->request.command_block,
1219 0, sizeof(orb->request.command_block));
1220 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1222 orb->base.callback = complete_command_orb;
1223 orb->base.request_bus =
1224 dma_map_single(device->card->device, &orb->request,
1225 sizeof(orb->request), DMA_TO_DEVICE);
1226 if (dma_mapping_error(orb->base.request_bus))
1229 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1230 lu->command_block_agent_address + SBP2_ORB_POINTER);
1233 kref_put(&orb->base.kref, free_orb);
1237 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1239 struct sbp2_logical_unit *lu = sdev->hostdata;
1241 sdev->allow_restart = 1;
1244 * Update the dma alignment (minimum alignment requirements for
1245 * start and end of DMA transfers) to be a sector
1247 blk_queue_update_dma_alignment(sdev->request_queue, 511);
1249 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1250 sdev->inquiry_len = 36;
1255 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1257 struct sbp2_logical_unit *lu = sdev->hostdata;
1259 sdev->use_10_for_rw = 1;
1261 if (sdev->type == TYPE_ROM)
1262 sdev->use_10_for_ms = 1;
1264 if (sdev->type == TYPE_DISK &&
1265 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1266 sdev->skip_ms_page_8 = 1;
1268 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
1269 sdev->fix_capacity = 1;
1271 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1272 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
1278 * Called by scsi stack when something has really gone wrong. Usually
1279 * called when a command has timed-out for some reason.
1281 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1283 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1285 fw_notify("sbp2_scsi_abort\n");
1286 sbp2_agent_reset(lu);
1287 sbp2_cancel_orbs(lu);
1293 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1294 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1296 * This is the concatenation of target port identifier and logical unit
1297 * identifier as per SAM-2...SAM-4 annex A.
1300 sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1303 struct scsi_device *sdev = to_scsi_device(dev);
1304 struct sbp2_logical_unit *lu;
1305 struct fw_device *device;
1310 lu = sdev->hostdata;
1311 device = fw_device(lu->tgt->unit->device.parent);
1313 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1314 device->config_rom[3], device->config_rom[4],
1315 lu->tgt->directory_id, lu->lun);
1318 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1320 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1321 &dev_attr_ieee1394_id,
1325 static struct scsi_host_template scsi_driver_template = {
1326 .module = THIS_MODULE,
1327 .name = "SBP-2 IEEE-1394",
1328 .proc_name = sbp2_driver_name,
1329 .queuecommand = sbp2_scsi_queuecommand,
1330 .slave_alloc = sbp2_scsi_slave_alloc,
1331 .slave_configure = sbp2_scsi_slave_configure,
1332 .eh_abort_handler = sbp2_scsi_abort,
1334 .sg_tablesize = SG_ALL,
1335 .use_clustering = ENABLE_CLUSTERING,
1338 .sdev_attrs = sbp2_scsi_sysfs_attrs,
1341 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1342 MODULE_DESCRIPTION("SCSI over IEEE1394");
1343 MODULE_LICENSE("GPL");
1344 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1346 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1347 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1348 MODULE_ALIAS("sbp2");
1351 static int __init sbp2_init(void)
1353 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1357 return driver_register(&sbp2_driver.driver);
1360 static void __exit sbp2_cleanup(void)
1362 driver_unregister(&sbp2_driver.driver);
1363 destroy_workqueue(sbp2_wq);
1366 module_init(sbp2_init);
1367 module_exit(sbp2_cleanup);