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/delay.h>
33 #include <linux/device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/kernel.h>
36 #include <linux/mod_devicetable.h>
37 #include <linux/module.h>
38 #include <linux/moduleparam.h>
39 #include <linux/scatterlist.h>
40 #include <linux/string.h>
41 #include <linux/stringify.h>
42 #include <linux/timer.h>
43 #include <linux/workqueue.h>
44 #include <asm/system.h>
46 #include <scsi/scsi.h>
47 #include <scsi/scsi_cmnd.h>
48 #include <scsi/scsi_device.h>
49 #include <scsi/scsi_host.h>
51 #include "fw-device.h"
52 #include "fw-topology.h"
53 #include "fw-transaction.h"
56 * So far only bridges from Oxford Semiconductor are known to support
57 * concurrent logins. Depending on firmware, four or two concurrent logins
58 * are possible on OXFW911 and newer Oxsemi bridges.
60 * Concurrent logins are useful together with cluster filesystems.
62 static int sbp2_param_exclusive_login = 1;
63 module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
64 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
65 "(default = Y, use N for concurrent initiators)");
68 * Flags for firmware oddities
70 * - 128kB max transfer
71 * Limit transfer size. Necessary for some old bridges.
74 * When scsi_mod probes the device, let the inquiry command look like that
78 * Suppress sending of mode_sense for mode page 8 if the device pretends to
79 * support the SCSI Primary Block commands instead of Reduced Block Commands.
82 * Tell sd_mod to correct the last sector number reported by read_capacity.
83 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
84 * Don't use this with devices which don't have this bug.
87 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
89 * - override internal blacklist
90 * Instead of adding to the built-in blacklist, use only the workarounds
91 * specified in the module load parameter.
92 * Useful if a blacklist entry interfered with a non-broken device.
94 #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
95 #define SBP2_WORKAROUND_INQUIRY_36 0x2
96 #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
97 #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
98 #define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
99 #define SBP2_INQUIRY_DELAY 12
100 #define SBP2_WORKAROUND_OVERRIDE 0x100
102 static int sbp2_param_workarounds;
103 module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
104 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
105 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
106 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
107 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
108 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
109 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
110 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
111 ", or a combination)");
113 /* I don't know why the SCSI stack doesn't define something like this... */
114 typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
116 static const char sbp2_driver_name[] = "sbp2";
119 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
120 * and one struct scsi_device per sbp2_logical_unit.
122 struct sbp2_logical_unit {
123 struct sbp2_target *tgt;
124 struct list_head link;
125 struct fw_address_handler address_handler;
126 struct list_head orb_list;
128 u64 command_block_agent_address;
133 * The generation is updated once we've logged in or reconnected
134 * to the logical unit. Thus, I/O to the device will automatically
135 * fail and get retried if it happens in a window where the device
136 * is not ready, e.g. after a bus reset but before we reconnect.
140 struct delayed_work work;
146 * We create one struct sbp2_target per IEEE 1212 Unit Directory
147 * and one struct Scsi_Host per sbp2_target.
151 struct fw_unit *unit;
153 struct list_head lu_list;
155 u64 management_agent_address;
159 unsigned int workarounds;
160 unsigned int mgt_orb_timeout;
162 int dont_block; /* counter for each logical unit */
163 int blocked; /* ditto */
167 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
168 * provided in the config rom. Most devices do provide a value, which
169 * we'll use for login management orbs, but with some sane limits.
171 #define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
172 #define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
173 #define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
174 #define SBP2_ORB_NULL 0x80000000
175 #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
176 #define SBP2_RETRY_LIMIT 0xf /* 15 retries */
177 #define SBP2_CYCLE_LIMIT (0xc8 << 12) /* 200 125us cycles */
179 /* Unit directory keys */
180 #define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
181 #define SBP2_CSR_FIRMWARE_REVISION 0x3c
182 #define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
183 #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
185 /* Management orb opcodes */
186 #define SBP2_LOGIN_REQUEST 0x0
187 #define SBP2_QUERY_LOGINS_REQUEST 0x1
188 #define SBP2_RECONNECT_REQUEST 0x3
189 #define SBP2_SET_PASSWORD_REQUEST 0x4
190 #define SBP2_LOGOUT_REQUEST 0x7
191 #define SBP2_ABORT_TASK_REQUEST 0xb
192 #define SBP2_ABORT_TASK_SET 0xc
193 #define SBP2_LOGICAL_UNIT_RESET 0xe
194 #define SBP2_TARGET_RESET_REQUEST 0xf
196 /* Offsets for command block agent registers */
197 #define SBP2_AGENT_STATE 0x00
198 #define SBP2_AGENT_RESET 0x04
199 #define SBP2_ORB_POINTER 0x08
200 #define SBP2_DOORBELL 0x10
201 #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
203 /* Status write response codes */
204 #define SBP2_STATUS_REQUEST_COMPLETE 0x0
205 #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
206 #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
207 #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
209 #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
210 #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
211 #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
212 #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
213 #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
214 #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
215 #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
216 #define STATUS_GET_DATA(v) ((v).data)
224 struct sbp2_pointer {
230 struct fw_transaction t;
232 dma_addr_t request_bus;
234 struct sbp2_pointer pointer;
235 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
236 struct list_head link;
239 #define MANAGEMENT_ORB_LUN(v) ((v))
240 #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
241 #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
242 #define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
243 #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
244 #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
246 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
247 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
249 struct sbp2_management_orb {
250 struct sbp2_orb base;
252 struct sbp2_pointer password;
253 struct sbp2_pointer response;
256 struct sbp2_pointer status_fifo;
259 dma_addr_t response_bus;
260 struct completion done;
261 struct sbp2_status status;
264 struct sbp2_login_response {
266 struct sbp2_pointer command_block_agent;
267 __be32 reconnect_hold;
269 #define COMMAND_ORB_DATA_SIZE(v) ((v))
270 #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
271 #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
272 #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
273 #define COMMAND_ORB_SPEED(v) ((v) << 24)
274 #define COMMAND_ORB_DIRECTION ((1) << 27)
275 #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
276 #define COMMAND_ORB_NOTIFY ((1) << 31)
278 struct sbp2_command_orb {
279 struct sbp2_orb base;
281 struct sbp2_pointer next;
282 struct sbp2_pointer data_descriptor;
284 u8 command_block[12];
286 struct scsi_cmnd *cmd;
288 struct sbp2_logical_unit *lu;
290 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
291 dma_addr_t page_table_bus;
295 * List of devices with known bugs.
297 * The firmware_revision field, masked with 0xffff00, is the best
298 * indicator for the type of bridge chip of a device. It yields a few
299 * false positives but this did not break correctly behaving devices
300 * so far. We use ~0 as a wildcard, since the 24 bit values we get
301 * from the config rom can never match that.
303 static const struct {
304 u32 firmware_revision;
306 unsigned int workarounds;
307 } sbp2_workarounds_table[] = {
308 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
309 .firmware_revision = 0x002800,
311 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
312 SBP2_WORKAROUND_MODE_SENSE_8,
314 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
315 .firmware_revision = 0x002800,
317 .workarounds = SBP2_WORKAROUND_DELAY_INQUIRY,
319 /* Initio bridges, actually only needed for some older ones */ {
320 .firmware_revision = 0x000200,
322 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
324 /* Symbios bridge */ {
325 .firmware_revision = 0xa0b800,
327 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
329 /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
330 .firmware_revision = 0x002600,
332 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
336 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
337 * these iPods do not feature the read_capacity bug according
338 * to one report. Read_capacity behaviour as well as model_id
339 * could change due to Apple-supplied firmware updates though.
342 /* iPod 4th generation. */ {
343 .firmware_revision = 0x0a2700,
345 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
348 .firmware_revision = 0x0a2700,
350 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
353 .firmware_revision = 0x0a2700,
355 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
360 free_orb(struct kref *kref)
362 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
368 sbp2_status_write(struct fw_card *card, struct fw_request *request,
369 int tcode, int destination, int source,
370 int generation, int speed,
371 unsigned long long offset,
372 void *payload, size_t length, void *callback_data)
374 struct sbp2_logical_unit *lu = callback_data;
375 struct sbp2_orb *orb;
376 struct sbp2_status status;
380 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
381 length == 0 || length > sizeof(status)) {
382 fw_send_response(card, request, RCODE_TYPE_ERROR);
386 header_size = min(length, 2 * sizeof(u32));
387 fw_memcpy_from_be32(&status, payload, header_size);
388 if (length > header_size)
389 memcpy(status.data, payload + 8, length - header_size);
390 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
391 fw_notify("non-orb related status write, not handled\n");
392 fw_send_response(card, request, RCODE_COMPLETE);
396 /* Lookup the orb corresponding to this status write. */
397 spin_lock_irqsave(&card->lock, flags);
398 list_for_each_entry(orb, &lu->orb_list, link) {
399 if (STATUS_GET_ORB_HIGH(status) == 0 &&
400 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
401 orb->rcode = RCODE_COMPLETE;
402 list_del(&orb->link);
406 spin_unlock_irqrestore(&card->lock, flags);
408 if (&orb->link != &lu->orb_list)
409 orb->callback(orb, &status);
411 fw_error("status write for unknown orb\n");
413 kref_put(&orb->kref, free_orb);
415 fw_send_response(card, request, RCODE_COMPLETE);
419 complete_transaction(struct fw_card *card, int rcode,
420 void *payload, size_t length, void *data)
422 struct sbp2_orb *orb = data;
426 * This is a little tricky. We can get the status write for
427 * the orb before we get this callback. The status write
428 * handler above will assume the orb pointer transaction was
429 * successful and set the rcode to RCODE_COMPLETE for the orb.
430 * So this callback only sets the rcode if it hasn't already
431 * been set and only does the cleanup if the transaction
432 * failed and we didn't already get a status write.
434 spin_lock_irqsave(&card->lock, flags);
436 if (orb->rcode == -1)
438 if (orb->rcode != RCODE_COMPLETE) {
439 list_del(&orb->link);
440 spin_unlock_irqrestore(&card->lock, flags);
441 orb->callback(orb, NULL);
443 spin_unlock_irqrestore(&card->lock, flags);
446 kref_put(&orb->kref, free_orb);
450 sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
451 int node_id, int generation, u64 offset)
453 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
456 orb->pointer.high = 0;
457 orb->pointer.low = cpu_to_be32(orb->request_bus);
459 spin_lock_irqsave(&device->card->lock, flags);
460 list_add_tail(&orb->link, &lu->orb_list);
461 spin_unlock_irqrestore(&device->card->lock, flags);
463 /* Take a ref for the orb list and for the transaction callback. */
464 kref_get(&orb->kref);
465 kref_get(&orb->kref);
467 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
468 node_id, generation, device->max_speed, offset,
469 &orb->pointer, sizeof(orb->pointer),
470 complete_transaction, orb);
473 static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
475 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
476 struct sbp2_orb *orb, *next;
477 struct list_head list;
479 int retval = -ENOENT;
481 INIT_LIST_HEAD(&list);
482 spin_lock_irqsave(&device->card->lock, flags);
483 list_splice_init(&lu->orb_list, &list);
484 spin_unlock_irqrestore(&device->card->lock, flags);
486 list_for_each_entry_safe(orb, next, &list, link) {
488 if (fw_cancel_transaction(device->card, &orb->t) == 0)
491 orb->rcode = RCODE_CANCELLED;
492 orb->callback(orb, NULL);
499 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
501 struct sbp2_management_orb *orb =
502 container_of(base_orb, struct sbp2_management_orb, base);
505 memcpy(&orb->status, status, sizeof(*status));
506 complete(&orb->done);
510 sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
511 int generation, int function, int lun_or_login_id,
514 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
515 struct sbp2_management_orb *orb;
516 unsigned int timeout;
517 int retval = -ENOMEM;
519 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
522 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
526 kref_init(&orb->base.kref);
528 dma_map_single(device->card->device, &orb->response,
529 sizeof(orb->response), DMA_FROM_DEVICE);
530 if (dma_mapping_error(orb->response_bus))
531 goto fail_mapping_response;
533 orb->request.response.high = 0;
534 orb->request.response.low = cpu_to_be32(orb->response_bus);
536 orb->request.misc = cpu_to_be32(
537 MANAGEMENT_ORB_NOTIFY |
538 MANAGEMENT_ORB_FUNCTION(function) |
539 MANAGEMENT_ORB_LUN(lun_or_login_id));
540 orb->request.length = cpu_to_be32(
541 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
543 orb->request.status_fifo.high =
544 cpu_to_be32(lu->address_handler.offset >> 32);
545 orb->request.status_fifo.low =
546 cpu_to_be32(lu->address_handler.offset);
548 if (function == SBP2_LOGIN_REQUEST) {
549 /* Ask for 2^2 == 4 seconds reconnect grace period */
550 orb->request.misc |= cpu_to_be32(
551 MANAGEMENT_ORB_RECONNECT(2) |
552 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
553 timeout = lu->tgt->mgt_orb_timeout;
555 timeout = SBP2_ORB_TIMEOUT;
558 init_completion(&orb->done);
559 orb->base.callback = complete_management_orb;
561 orb->base.request_bus =
562 dma_map_single(device->card->device, &orb->request,
563 sizeof(orb->request), DMA_TO_DEVICE);
564 if (dma_mapping_error(orb->base.request_bus))
565 goto fail_mapping_request;
567 sbp2_send_orb(&orb->base, lu, node_id, generation,
568 lu->tgt->management_agent_address);
570 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
573 if (sbp2_cancel_orbs(lu) == 0) {
574 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
575 lu->tgt->bus_id, orb->base.rcode);
579 if (orb->base.rcode != RCODE_COMPLETE) {
580 fw_error("%s: management write failed, rcode 0x%02x\n",
581 lu->tgt->bus_id, orb->base.rcode);
585 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
586 STATUS_GET_SBP_STATUS(orb->status) != 0) {
587 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
588 STATUS_GET_RESPONSE(orb->status),
589 STATUS_GET_SBP_STATUS(orb->status));
595 dma_unmap_single(device->card->device, orb->base.request_bus,
596 sizeof(orb->request), DMA_TO_DEVICE);
597 fail_mapping_request:
598 dma_unmap_single(device->card->device, orb->response_bus,
599 sizeof(orb->response), DMA_FROM_DEVICE);
600 fail_mapping_response:
602 memcpy(response, orb->response, sizeof(orb->response));
603 kref_put(&orb->base.kref, free_orb);
609 complete_agent_reset_write(struct fw_card *card, int rcode,
610 void *payload, size_t length, void *done)
615 static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
617 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
618 DECLARE_COMPLETION_ONSTACK(done);
619 struct fw_transaction t;
622 fw_send_request(device->card, &t, TCODE_WRITE_QUADLET_REQUEST,
623 lu->tgt->node_id, lu->generation, device->max_speed,
624 lu->command_block_agent_address + SBP2_AGENT_RESET,
625 &z, sizeof(z), complete_agent_reset_write, &done);
626 wait_for_completion(&done);
630 complete_agent_reset_write_no_wait(struct fw_card *card, int rcode,
631 void *payload, size_t length, void *data)
636 static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
638 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
639 struct fw_transaction *t;
642 t = kmalloc(sizeof(*t), GFP_ATOMIC);
646 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
647 lu->tgt->node_id, lu->generation, device->max_speed,
648 lu->command_block_agent_address + SBP2_AGENT_RESET,
649 &z, sizeof(z), complete_agent_reset_write_no_wait, t);
652 static void sbp2_set_generation(struct sbp2_logical_unit *lu, int generation)
654 struct fw_card *card = fw_device(lu->tgt->unit->device.parent)->card;
657 /* serialize with comparisons of lu->generation and card->generation */
658 spin_lock_irqsave(&card->lock, flags);
659 lu->generation = generation;
660 spin_unlock_irqrestore(&card->lock, flags);
663 static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
666 * We may access dont_block without taking card->lock here:
667 * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
668 * are currently serialized against each other.
669 * And a wrong result in sbp2_conditionally_block()'s access of
670 * dont_block is rather harmless, it simply misses its first chance.
672 --lu->tgt->dont_block;
676 * Blocks lu->tgt if all of the following conditions are met:
677 * - Login, INQUIRY, and high-level SCSI setup of all of the target's
678 * logical units have been finished (indicated by dont_block == 0).
679 * - lu->generation is stale.
681 * Note, scsi_block_requests() must be called while holding card->lock,
682 * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
683 * unblock the target.
685 static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
687 struct sbp2_target *tgt = lu->tgt;
688 struct fw_card *card = fw_device(tgt->unit->device.parent)->card;
689 struct Scsi_Host *shost =
690 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
693 spin_lock_irqsave(&card->lock, flags);
694 if (!tgt->dont_block && !lu->blocked &&
695 lu->generation != card->generation) {
697 if (++tgt->blocked == 1)
698 scsi_block_requests(shost);
700 spin_unlock_irqrestore(&card->lock, flags);
704 * Unblocks lu->tgt as soon as all its logical units can be unblocked.
705 * Note, it is harmless to run scsi_unblock_requests() outside the
706 * card->lock protected section. On the other hand, running it inside
707 * the section might clash with shost->host_lock.
709 static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
711 struct sbp2_target *tgt = lu->tgt;
712 struct fw_card *card = fw_device(tgt->unit->device.parent)->card;
713 struct Scsi_Host *shost =
714 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
716 bool unblock = false;
718 spin_lock_irqsave(&card->lock, flags);
719 if (lu->blocked && lu->generation == card->generation) {
721 unblock = --tgt->blocked == 0;
723 spin_unlock_irqrestore(&card->lock, flags);
726 scsi_unblock_requests(shost);
730 * Prevents future blocking of tgt and unblocks it.
731 * Note, it is harmless to run scsi_unblock_requests() outside the
732 * card->lock protected section. On the other hand, running it inside
733 * the section might clash with shost->host_lock.
735 static void sbp2_unblock(struct sbp2_target *tgt)
737 struct fw_card *card = fw_device(tgt->unit->device.parent)->card;
738 struct Scsi_Host *shost =
739 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
742 spin_lock_irqsave(&card->lock, flags);
744 spin_unlock_irqrestore(&card->lock, flags);
746 scsi_unblock_requests(shost);
749 static int sbp2_lun2int(u16 lun)
751 struct scsi_lun eight_bytes_lun;
753 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
754 eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
755 eight_bytes_lun.scsi_lun[1] = lun & 0xff;
757 return scsilun_to_int(&eight_bytes_lun);
760 static void sbp2_release_target(struct kref *kref)
762 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
763 struct sbp2_logical_unit *lu, *next;
764 struct Scsi_Host *shost =
765 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
766 struct scsi_device *sdev;
767 struct fw_device *device = fw_device(tgt->unit->device.parent);
769 /* prevent deadlocks */
772 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
773 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
775 scsi_remove_device(sdev);
776 scsi_device_put(sdev);
778 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
779 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
781 fw_core_remove_address_handler(&lu->address_handler);
785 scsi_remove_host(shost);
786 fw_notify("released %s\n", tgt->bus_id);
788 fw_unit_put(tgt->unit);
789 scsi_host_put(shost);
790 fw_device_put(device);
793 static struct workqueue_struct *sbp2_wq;
796 * Always get the target's kref when scheduling work on one its units.
797 * Each workqueue job is responsible to call sbp2_target_put() upon return.
799 static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
801 if (queue_delayed_work(sbp2_wq, &lu->work, delay))
802 kref_get(&lu->tgt->kref);
805 static void sbp2_target_put(struct sbp2_target *tgt)
807 kref_put(&tgt->kref, sbp2_release_target);
811 complete_set_busy_timeout(struct fw_card *card, int rcode,
812 void *payload, size_t length, void *done)
818 * Write retransmit retry values into the BUSY_TIMEOUT register.
819 * - The single-phase retry protocol is supported by all SBP-2 devices, but the
820 * default retry_limit value is 0 (i.e. never retry transmission). We write a
821 * saner value after logging into the device.
822 * - The dual-phase retry protocol is optional to implement, and if not
823 * supported, writes to the dual-phase portion of the register will be
824 * ignored. We try to write the original 1394-1995 default here.
825 * - In the case of devices that are also SBP-3-compliant, all writes are
826 * ignored, as the register is read-only, but contains single-phase retry of
827 * 15, which is what we're trying to set for all SBP-2 device anyway, so this
828 * write attempt is safe and yields more consistent behavior for all devices.
830 * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
831 * and section 6.4 of the SBP-3 spec for further details.
833 static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
835 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
836 DECLARE_COMPLETION_ONSTACK(done);
837 struct fw_transaction t;
838 static __be32 busy_timeout;
840 busy_timeout = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
842 fw_send_request(device->card, &t, TCODE_WRITE_QUADLET_REQUEST,
843 lu->tgt->node_id, lu->generation, device->max_speed,
844 CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT, &busy_timeout,
845 sizeof(busy_timeout), complete_set_busy_timeout, &done);
846 wait_for_completion(&done);
849 static void sbp2_reconnect(struct work_struct *work);
851 static void sbp2_login(struct work_struct *work)
853 struct sbp2_logical_unit *lu =
854 container_of(work, struct sbp2_logical_unit, work.work);
855 struct sbp2_target *tgt = lu->tgt;
856 struct fw_device *device = fw_device(tgt->unit->device.parent);
857 struct Scsi_Host *shost;
858 struct scsi_device *sdev;
859 struct sbp2_login_response response;
860 int generation, node_id, local_node_id;
862 if (fw_device_is_shutdown(device))
865 generation = device->generation;
866 smp_rmb(); /* node_id must not be older than generation */
867 node_id = device->node_id;
868 local_node_id = device->card->node_id;
870 /* If this is a re-login attempt, log out, or we might be rejected. */
872 sbp2_send_management_orb(lu, device->node_id, generation,
873 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
875 if (sbp2_send_management_orb(lu, node_id, generation,
876 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
877 if (lu->retries++ < 5) {
878 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
880 fw_error("%s: failed to login to LUN %04x\n",
881 tgt->bus_id, lu->lun);
882 /* Let any waiting I/O fail from now on. */
883 sbp2_unblock(lu->tgt);
888 tgt->node_id = node_id;
889 tgt->address_high = local_node_id << 16;
890 sbp2_set_generation(lu, generation);
892 lu->command_block_agent_address =
893 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
894 << 32) | be32_to_cpu(response.command_block_agent.low);
895 lu->login_id = be32_to_cpu(response.misc) & 0xffff;
897 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
898 tgt->bus_id, lu->lun, lu->retries);
900 /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
901 sbp2_set_busy_timeout(lu);
903 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
904 sbp2_agent_reset(lu);
906 /* This was a re-login. */
908 sbp2_cancel_orbs(lu);
909 sbp2_conditionally_unblock(lu);
913 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
914 ssleep(SBP2_INQUIRY_DELAY);
916 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
917 sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
919 * FIXME: We are unable to perform reconnects while in sbp2_login().
920 * Therefore __scsi_add_device() will get into trouble if a bus reset
921 * happens in parallel. It will either fail or leave us with an
922 * unusable sdev. As a workaround we check for this and retry the
923 * whole login and SCSI probing.
926 /* Reported error during __scsi_add_device() */
928 goto out_logout_login;
930 /* Unreported error during __scsi_add_device() */
931 smp_rmb(); /* get current card generation */
932 if (generation != device->card->generation) {
933 scsi_remove_device(sdev);
934 scsi_device_put(sdev);
935 goto out_logout_login;
938 /* No error during __scsi_add_device() */
940 scsi_device_put(sdev);
941 sbp2_allow_block(lu);
945 smp_rmb(); /* generation may have changed */
946 generation = device->generation;
947 smp_rmb(); /* node_id must not be older than generation */
949 sbp2_send_management_orb(lu, device->node_id, generation,
950 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
952 * If a bus reset happened, sbp2_update will have requeued
953 * lu->work already. Reset the work from reconnect to login.
955 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
957 sbp2_target_put(tgt);
960 static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
962 struct sbp2_logical_unit *lu;
964 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
968 lu->address_handler.length = 0x100;
969 lu->address_handler.address_callback = sbp2_status_write;
970 lu->address_handler.callback_data = lu;
972 if (fw_core_add_address_handler(&lu->address_handler,
973 &fw_high_memory_region) < 0) {
979 lu->lun = lun_entry & 0xffff;
981 lu->has_sdev = false;
984 INIT_LIST_HEAD(&lu->orb_list);
985 INIT_DELAYED_WORK(&lu->work, sbp2_login);
987 list_add_tail(&lu->link, &tgt->lu_list);
991 static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
993 struct fw_csr_iterator ci;
996 fw_csr_iterator_init(&ci, directory);
997 while (fw_csr_iterator_next(&ci, &key, &value))
998 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
999 sbp2_add_logical_unit(tgt, value) < 0)
1004 static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
1005 u32 *model, u32 *firmware_revision)
1007 struct fw_csr_iterator ci;
1009 unsigned int timeout;
1011 fw_csr_iterator_init(&ci, directory);
1012 while (fw_csr_iterator_next(&ci, &key, &value)) {
1015 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1016 tgt->management_agent_address =
1017 CSR_REGISTER_BASE + 4 * value;
1020 case CSR_DIRECTORY_ID:
1021 tgt->directory_id = value;
1028 case SBP2_CSR_FIRMWARE_REVISION:
1029 *firmware_revision = value;
1032 case SBP2_CSR_UNIT_CHARACTERISTICS:
1033 /* the timeout value is stored in 500ms units */
1034 timeout = ((unsigned int) value >> 8 & 0xff) * 500;
1035 timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
1036 tgt->mgt_orb_timeout =
1037 min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
1039 if (timeout > tgt->mgt_orb_timeout)
1040 fw_notify("%s: config rom contains %ds "
1041 "management ORB timeout, limiting "
1042 "to %ds\n", tgt->bus_id,
1044 tgt->mgt_orb_timeout / 1000);
1047 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1048 if (sbp2_add_logical_unit(tgt, value) < 0)
1052 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
1053 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
1061 static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1062 u32 firmware_revision)
1065 unsigned int w = sbp2_param_workarounds;
1068 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
1069 "if you need the workarounds parameter for %s\n",
1072 if (w & SBP2_WORKAROUND_OVERRIDE)
1075 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1077 if (sbp2_workarounds_table[i].firmware_revision !=
1078 (firmware_revision & 0xffffff00))
1081 if (sbp2_workarounds_table[i].model != model &&
1082 sbp2_workarounds_table[i].model != ~0)
1085 w |= sbp2_workarounds_table[i].workarounds;
1090 fw_notify("Workarounds for %s: 0x%x "
1091 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
1092 tgt->bus_id, w, firmware_revision, model);
1093 tgt->workarounds = w;
1096 static struct scsi_host_template scsi_driver_template;
1098 static int sbp2_probe(struct device *dev)
1100 struct fw_unit *unit = fw_unit(dev);
1101 struct fw_device *device = fw_device(unit->device.parent);
1102 struct sbp2_target *tgt;
1103 struct sbp2_logical_unit *lu;
1104 struct Scsi_Host *shost;
1105 u32 model, firmware_revision;
1107 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1111 tgt = (struct sbp2_target *)shost->hostdata;
1112 unit->device.driver_data = tgt;
1114 kref_init(&tgt->kref);
1115 INIT_LIST_HEAD(&tgt->lu_list);
1116 tgt->bus_id = unit->device.bus_id;
1118 if (fw_device_enable_phys_dma(device) < 0)
1119 goto fail_shost_put;
1121 if (scsi_add_host(shost, &unit->device) < 0)
1122 goto fail_shost_put;
1124 fw_device_get(device);
1127 /* Initialize to values that won't match anything in our table. */
1128 firmware_revision = 0xff000000;
1131 /* implicit directory ID */
1132 tgt->directory_id = ((unit->directory - device->config_rom) * 4
1133 + CSR_CONFIG_ROM) & 0xffffff;
1135 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1136 &firmware_revision) < 0)
1139 sbp2_init_workarounds(tgt, model, firmware_revision);
1141 /* Do the login in a workqueue so we can easily reschedule retries. */
1142 list_for_each_entry(lu, &tgt->lu_list, link)
1143 sbp2_queue_work(lu, 0);
1147 sbp2_target_put(tgt);
1151 scsi_host_put(shost);
1155 static int sbp2_remove(struct device *dev)
1157 struct fw_unit *unit = fw_unit(dev);
1158 struct sbp2_target *tgt = unit->device.driver_data;
1160 sbp2_target_put(tgt);
1164 static void sbp2_reconnect(struct work_struct *work)
1166 struct sbp2_logical_unit *lu =
1167 container_of(work, struct sbp2_logical_unit, work.work);
1168 struct sbp2_target *tgt = lu->tgt;
1169 struct fw_device *device = fw_device(tgt->unit->device.parent);
1170 int generation, node_id, local_node_id;
1172 if (fw_device_is_shutdown(device))
1175 generation = device->generation;
1176 smp_rmb(); /* node_id must not be older than generation */
1177 node_id = device->node_id;
1178 local_node_id = device->card->node_id;
1180 if (sbp2_send_management_orb(lu, node_id, generation,
1181 SBP2_RECONNECT_REQUEST,
1182 lu->login_id, NULL) < 0) {
1184 * If reconnect was impossible even though we are in the
1185 * current generation, fall back and try to log in again.
1187 * We could check for "Function rejected" status, but
1188 * looking at the bus generation as simpler and more general.
1190 smp_rmb(); /* get current card generation */
1191 if (generation == device->card->generation ||
1192 lu->retries++ >= 5) {
1193 fw_error("%s: failed to reconnect\n", tgt->bus_id);
1195 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
1197 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1201 tgt->node_id = node_id;
1202 tgt->address_high = local_node_id << 16;
1203 sbp2_set_generation(lu, generation);
1205 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1206 tgt->bus_id, lu->lun, lu->retries);
1208 sbp2_agent_reset(lu);
1209 sbp2_cancel_orbs(lu);
1210 sbp2_conditionally_unblock(lu);
1212 sbp2_target_put(tgt);
1215 static void sbp2_update(struct fw_unit *unit)
1217 struct sbp2_target *tgt = unit->device.driver_data;
1218 struct sbp2_logical_unit *lu;
1220 fw_device_enable_phys_dma(fw_device(unit->device.parent));
1223 * Fw-core serializes sbp2_update() against sbp2_remove().
1224 * Iteration over tgt->lu_list is therefore safe here.
1226 list_for_each_entry(lu, &tgt->lu_list, link) {
1227 sbp2_conditionally_block(lu);
1229 sbp2_queue_work(lu, 0);
1233 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1234 #define SBP2_SW_VERSION_ENTRY 0x00010483
1236 static const struct fw_device_id sbp2_id_table[] = {
1238 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
1239 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
1240 .version = SBP2_SW_VERSION_ENTRY,
1245 static struct fw_driver sbp2_driver = {
1247 .owner = THIS_MODULE,
1248 .name = sbp2_driver_name,
1249 .bus = &fw_bus_type,
1250 .probe = sbp2_probe,
1251 .remove = sbp2_remove,
1253 .update = sbp2_update,
1254 .id_table = sbp2_id_table,
1258 sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
1262 sense_data[0] = 0x70;
1263 sense_data[1] = 0x0;
1264 sense_data[2] = sbp2_status[1];
1265 sense_data[3] = sbp2_status[4];
1266 sense_data[4] = sbp2_status[5];
1267 sense_data[5] = sbp2_status[6];
1268 sense_data[6] = sbp2_status[7];
1270 sense_data[8] = sbp2_status[8];
1271 sense_data[9] = sbp2_status[9];
1272 sense_data[10] = sbp2_status[10];
1273 sense_data[11] = sbp2_status[11];
1274 sense_data[12] = sbp2_status[2];
1275 sense_data[13] = sbp2_status[3];
1276 sense_data[14] = sbp2_status[12];
1277 sense_data[15] = sbp2_status[13];
1279 sam_status = sbp2_status[0] & 0x3f;
1281 switch (sam_status) {
1283 case SAM_STAT_CHECK_CONDITION:
1284 case SAM_STAT_CONDITION_MET:
1286 case SAM_STAT_RESERVATION_CONFLICT:
1287 case SAM_STAT_COMMAND_TERMINATED:
1288 return DID_OK << 16 | sam_status;
1291 return DID_ERROR << 16;
1296 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1298 struct sbp2_command_orb *orb =
1299 container_of(base_orb, struct sbp2_command_orb, base);
1300 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
1303 if (status != NULL) {
1304 if (STATUS_GET_DEAD(*status))
1305 sbp2_agent_reset_no_wait(orb->lu);
1307 switch (STATUS_GET_RESPONSE(*status)) {
1308 case SBP2_STATUS_REQUEST_COMPLETE:
1309 result = DID_OK << 16;
1311 case SBP2_STATUS_TRANSPORT_FAILURE:
1312 result = DID_BUS_BUSY << 16;
1314 case SBP2_STATUS_ILLEGAL_REQUEST:
1315 case SBP2_STATUS_VENDOR_DEPENDENT:
1317 result = DID_ERROR << 16;
1321 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1322 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
1323 orb->cmd->sense_buffer);
1326 * If the orb completes with status == NULL, something
1327 * went wrong, typically a bus reset happened mid-orb
1328 * or when sending the write (less likely).
1330 result = DID_BUS_BUSY << 16;
1331 sbp2_conditionally_block(orb->lu);
1334 dma_unmap_single(device->card->device, orb->base.request_bus,
1335 sizeof(orb->request), DMA_TO_DEVICE);
1337 if (scsi_sg_count(orb->cmd) > 0)
1338 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1339 scsi_sg_count(orb->cmd),
1340 orb->cmd->sc_data_direction);
1342 if (orb->page_table_bus != 0)
1343 dma_unmap_single(device->card->device, orb->page_table_bus,
1344 sizeof(orb->page_table), DMA_TO_DEVICE);
1346 orb->cmd->result = result;
1347 orb->done(orb->cmd);
1351 sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1352 struct sbp2_logical_unit *lu)
1354 struct scatterlist *sg;
1355 int sg_len, l, i, j, count;
1358 sg = scsi_sglist(orb->cmd);
1359 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1360 orb->cmd->sc_data_direction);
1365 * Handle the special case where there is only one element in
1366 * the scatter list by converting it to an immediate block
1367 * request. This is also a workaround for broken devices such
1368 * as the second generation iPod which doesn't support page
1371 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
1372 orb->request.data_descriptor.high =
1373 cpu_to_be32(lu->tgt->address_high);
1374 orb->request.data_descriptor.low =
1375 cpu_to_be32(sg_dma_address(sg));
1376 orb->request.misc |=
1377 cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
1382 * Convert the scatterlist to an sbp2 page table. If any
1383 * scatterlist entries are too big for sbp2, we split them as we
1384 * go. Even if we ask the block I/O layer to not give us sg
1385 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1386 * during DMA mapping, and Linux currently doesn't prevent this.
1388 for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
1389 sg_len = sg_dma_len(sg);
1390 sg_addr = sg_dma_address(sg);
1392 /* FIXME: This won't get us out of the pinch. */
1393 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1394 fw_error("page table overflow\n");
1395 goto fail_page_table;
1397 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1398 orb->page_table[j].low = cpu_to_be32(sg_addr);
1399 orb->page_table[j].high = cpu_to_be32(l << 16);
1406 orb->page_table_bus =
1407 dma_map_single(device->card->device, orb->page_table,
1408 sizeof(orb->page_table), DMA_TO_DEVICE);
1409 if (dma_mapping_error(orb->page_table_bus))
1410 goto fail_page_table;
1413 * The data_descriptor pointer is the one case where we need
1414 * to fill in the node ID part of the address. All other
1415 * pointers assume that the data referenced reside on the
1416 * initiator (i.e. us), but data_descriptor can refer to data
1417 * on other nodes so we need to put our ID in descriptor.high.
1419 orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1420 orb->request.data_descriptor.low = cpu_to_be32(orb->page_table_bus);
1421 orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
1422 COMMAND_ORB_DATA_SIZE(j));
1427 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1428 orb->cmd->sc_data_direction);
1433 /* SCSI stack integration */
1435 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1437 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1438 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
1439 struct sbp2_command_orb *orb;
1440 unsigned int max_payload;
1441 int retval = SCSI_MLQUEUE_HOST_BUSY;
1444 * Bidirectional commands are not yet implemented, and unknown
1445 * transfer direction not handled.
1447 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
1448 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
1449 cmd->result = DID_ERROR << 16;
1454 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
1456 fw_notify("failed to alloc orb\n");
1457 return SCSI_MLQUEUE_HOST_BUSY;
1460 /* Initialize rcode to something not RCODE_COMPLETE. */
1461 orb->base.rcode = -1;
1462 kref_init(&orb->base.kref);
1468 orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
1470 * At speed 100 we can do 512 bytes per packet, at speed 200,
1471 * 1024 bytes per packet etc. The SBP-2 max_payload field
1472 * specifies the max payload size as 2 ^ (max_payload + 2), so
1473 * if we set this to max_speed + 7, we get the right value.
1475 max_payload = min(device->max_speed + 7,
1476 device->card->max_receive - 1);
1477 orb->request.misc = cpu_to_be32(
1478 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
1479 COMMAND_ORB_SPEED(device->max_speed) |
1480 COMMAND_ORB_NOTIFY);
1482 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1483 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
1485 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1488 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1490 orb->base.callback = complete_command_orb;
1491 orb->base.request_bus =
1492 dma_map_single(device->card->device, &orb->request,
1493 sizeof(orb->request), DMA_TO_DEVICE);
1494 if (dma_mapping_error(orb->base.request_bus))
1497 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1498 lu->command_block_agent_address + SBP2_ORB_POINTER);
1501 kref_put(&orb->base.kref, free_orb);
1505 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1507 struct sbp2_logical_unit *lu = sdev->hostdata;
1509 /* (Re-)Adding logical units via the SCSI stack is not supported. */
1513 sdev->allow_restart = 1;
1515 /* SBP-2 requires quadlet alignment of the data buffers. */
1516 blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
1518 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1519 sdev->inquiry_len = 36;
1524 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1526 struct sbp2_logical_unit *lu = sdev->hostdata;
1528 sdev->use_10_for_rw = 1;
1530 if (sdev->type == TYPE_ROM)
1531 sdev->use_10_for_ms = 1;
1533 if (sdev->type == TYPE_DISK &&
1534 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1535 sdev->skip_ms_page_8 = 1;
1537 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
1538 sdev->fix_capacity = 1;
1540 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1541 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
1547 * Called by scsi stack when something has really gone wrong. Usually
1548 * called when a command has timed-out for some reason.
1550 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1552 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1554 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
1555 sbp2_agent_reset(lu);
1556 sbp2_cancel_orbs(lu);
1562 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1563 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1565 * This is the concatenation of target port identifier and logical unit
1566 * identifier as per SAM-2...SAM-4 annex A.
1569 sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1572 struct scsi_device *sdev = to_scsi_device(dev);
1573 struct sbp2_logical_unit *lu;
1574 struct fw_device *device;
1579 lu = sdev->hostdata;
1580 device = fw_device(lu->tgt->unit->device.parent);
1582 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1583 device->config_rom[3], device->config_rom[4],
1584 lu->tgt->directory_id, lu->lun);
1587 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1589 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1590 &dev_attr_ieee1394_id,
1594 static struct scsi_host_template scsi_driver_template = {
1595 .module = THIS_MODULE,
1596 .name = "SBP-2 IEEE-1394",
1597 .proc_name = sbp2_driver_name,
1598 .queuecommand = sbp2_scsi_queuecommand,
1599 .slave_alloc = sbp2_scsi_slave_alloc,
1600 .slave_configure = sbp2_scsi_slave_configure,
1601 .eh_abort_handler = sbp2_scsi_abort,
1603 .sg_tablesize = SG_ALL,
1604 .use_clustering = ENABLE_CLUSTERING,
1607 .sdev_attrs = sbp2_scsi_sysfs_attrs,
1610 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1611 MODULE_DESCRIPTION("SCSI over IEEE1394");
1612 MODULE_LICENSE("GPL");
1613 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1615 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1616 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1617 MODULE_ALIAS("sbp2");
1620 static int __init sbp2_init(void)
1622 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1626 return driver_register(&sbp2_driver.driver);
1629 static void __exit sbp2_cleanup(void)
1631 driver_unregister(&sbp2_driver.driver);
1632 destroy_workqueue(sbp2_wq);
1635 module_init(sbp2_init);
1636 module_exit(sbp2_cleanup);