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/mod_devicetable.h>
34 #include <linux/device.h>
35 #include <linux/scatterlist.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/blkdev.h>
38 #include <linux/timer.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_dbg.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_host.h>
46 #include "fw-transaction.h"
47 #include "fw-topology.h"
48 #include "fw-device.h"
50 /* I don't know why the SCSI stack doesn't define something like this... */
51 typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
53 static const char sbp2_driver_name[] = "sbp2";
58 struct fw_address_handler address_handler;
59 struct list_head orb_list;
60 u64 management_agent_address;
61 u64 command_block_agent_address;
66 * We cache these addresses and only update them once we've
67 * logged in or reconnected to the sbp2 device. That way, any
68 * IO to the device will automatically fail and get retried if
69 * it happens in a window where the device is not ready to
70 * handle it (e.g. after a bus reset but before we reconnect).
77 struct delayed_work work;
80 #define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
81 #define SBP2_MAX_SECTORS 255 /* Max sectors supported */
82 #define SBP2_ORB_TIMEOUT 2000 /* Timeout in ms */
84 #define SBP2_ORB_NULL 0x80000000
86 #define SBP2_DIRECTION_TO_MEDIA 0x0
87 #define SBP2_DIRECTION_FROM_MEDIA 0x1
89 /* Unit directory keys */
90 #define SBP2_COMMAND_SET_SPECIFIER 0x38
91 #define SBP2_COMMAND_SET 0x39
92 #define SBP2_COMMAND_SET_REVISION 0x3b
93 #define SBP2_FIRMWARE_REVISION 0x3c
95 /* Flags for detected oddities and brokeness */
96 #define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
97 #define SBP2_WORKAROUND_INQUIRY_36 0x2
98 #define SBP2_WORKAROUND_MODE_SENSE_8 0x4
99 #define SBP2_WORKAROUND_FIX_CAPACITY 0x8
100 #define SBP2_WORKAROUND_OVERRIDE 0x100
102 /* Management orb opcodes */
103 #define SBP2_LOGIN_REQUEST 0x0
104 #define SBP2_QUERY_LOGINS_REQUEST 0x1
105 #define SBP2_RECONNECT_REQUEST 0x3
106 #define SBP2_SET_PASSWORD_REQUEST 0x4
107 #define SBP2_LOGOUT_REQUEST 0x7
108 #define SBP2_ABORT_TASK_REQUEST 0xb
109 #define SBP2_ABORT_TASK_SET 0xc
110 #define SBP2_LOGICAL_UNIT_RESET 0xe
111 #define SBP2_TARGET_RESET_REQUEST 0xf
113 /* Offsets for command block agent registers */
114 #define SBP2_AGENT_STATE 0x00
115 #define SBP2_AGENT_RESET 0x04
116 #define SBP2_ORB_POINTER 0x08
117 #define SBP2_DOORBELL 0x10
118 #define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
120 /* Status write response codes */
121 #define SBP2_STATUS_REQUEST_COMPLETE 0x0
122 #define SBP2_STATUS_TRANSPORT_FAILURE 0x1
123 #define SBP2_STATUS_ILLEGAL_REQUEST 0x2
124 #define SBP2_STATUS_VENDOR_DEPENDENT 0x3
126 #define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
127 #define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
128 #define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
129 #define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
130 #define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
131 #define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
132 #define STATUS_GET_ORB_LOW(v) ((v).orb_low)
133 #define STATUS_GET_DATA(v) ((v).data)
141 struct sbp2_pointer {
147 struct fw_transaction t;
148 dma_addr_t request_bus;
150 struct sbp2_pointer pointer;
151 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
152 struct list_head link;
155 #define MANAGEMENT_ORB_LUN(v) ((v))
156 #define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
157 #define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
158 #define MANAGEMENT_ORB_EXCLUSIVE ((1) << 28)
159 #define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
160 #define MANAGEMENT_ORB_NOTIFY ((1) << 31)
162 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
163 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
165 struct sbp2_management_orb {
166 struct sbp2_orb base;
168 struct sbp2_pointer password;
169 struct sbp2_pointer response;
172 struct sbp2_pointer status_fifo;
175 dma_addr_t response_bus;
176 struct completion done;
177 struct sbp2_status status;
180 #define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
181 #define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
183 struct sbp2_login_response {
185 struct sbp2_pointer command_block_agent;
188 #define COMMAND_ORB_DATA_SIZE(v) ((v))
189 #define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
190 #define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
191 #define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
192 #define COMMAND_ORB_SPEED(v) ((v) << 24)
193 #define COMMAND_ORB_DIRECTION(v) ((v) << 27)
194 #define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
195 #define COMMAND_ORB_NOTIFY ((1) << 31)
197 struct sbp2_command_orb {
198 struct sbp2_orb base;
200 struct sbp2_pointer next;
201 struct sbp2_pointer data_descriptor;
203 u8 command_block[12];
205 struct scsi_cmnd *cmd;
207 struct fw_unit *unit;
209 struct sbp2_pointer page_table[SG_ALL];
210 dma_addr_t page_table_bus;
214 * List of devices with known bugs.
216 * The firmware_revision field, masked with 0xffff00, is the best
217 * indicator for the type of bridge chip of a device. It yields a few
218 * false positives but this did not break correctly behaving devices
219 * so far. We use ~0 as a wildcard, since the 24 bit values we get
220 * from the config rom can never match that.
222 static const struct {
223 u32 firmware_revision;
225 unsigned workarounds;
226 } sbp2_workarounds_table[] = {
227 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
228 .firmware_revision = 0x002800,
230 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
231 SBP2_WORKAROUND_MODE_SENSE_8,
233 /* Initio bridges, actually only needed for some older ones */ {
234 .firmware_revision = 0x000200,
236 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
238 /* Symbios bridge */ {
239 .firmware_revision = 0xa0b800,
241 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
245 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
246 * these iPods do not feature the read_capacity bug according
247 * to one report. Read_capacity behaviour as well as model_id
248 * could change due to Apple-supplied firmware updates though.
251 /* iPod 4th generation. */ {
252 .firmware_revision = 0x0a2700,
254 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
257 .firmware_revision = 0x0a2700,
259 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
262 .firmware_revision = 0x0a2700,
264 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
269 sbp2_status_write(struct fw_card *card, struct fw_request *request,
270 int tcode, int destination, int source,
271 int generation, int speed,
272 unsigned long long offset,
273 void *payload, size_t length, void *callback_data)
275 struct sbp2_device *sd = callback_data;
276 struct sbp2_orb *orb;
277 struct sbp2_status status;
281 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
282 length == 0 || length > sizeof(status)) {
283 fw_send_response(card, request, RCODE_TYPE_ERROR);
287 header_size = min(length, 2 * sizeof(u32));
288 fw_memcpy_from_be32(&status, payload, header_size);
289 if (length > header_size)
290 memcpy(status.data, payload + 8, length - header_size);
291 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
292 fw_notify("non-orb related status write, not handled\n");
293 fw_send_response(card, request, RCODE_COMPLETE);
297 /* Lookup the orb corresponding to this status write. */
298 spin_lock_irqsave(&card->lock, flags);
299 list_for_each_entry(orb, &sd->orb_list, link) {
300 if (STATUS_GET_ORB_HIGH(status) == 0 &&
301 STATUS_GET_ORB_LOW(status) == orb->request_bus &&
302 orb->rcode == RCODE_COMPLETE) {
303 list_del(&orb->link);
307 spin_unlock_irqrestore(&card->lock, flags);
309 if (&orb->link != &sd->orb_list)
310 orb->callback(orb, &status);
312 fw_error("status write for unknown orb\n");
314 fw_send_response(card, request, RCODE_COMPLETE);
318 complete_transaction(struct fw_card *card, int rcode,
319 void *payload, size_t length, void *data)
321 struct sbp2_orb *orb = data;
325 if (rcode != RCODE_COMPLETE) {
326 spin_lock_irqsave(&card->lock, flags);
327 list_del(&orb->link);
328 spin_unlock_irqrestore(&card->lock, flags);
329 orb->callback(orb, NULL);
334 sbp2_send_orb(struct sbp2_orb *orb, struct fw_unit *unit,
335 int node_id, int generation, u64 offset)
337 struct fw_device *device = fw_device(unit->device.parent);
338 struct sbp2_device *sd = unit->device.driver_data;
341 orb->pointer.high = 0;
342 orb->pointer.low = orb->request_bus;
343 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
345 spin_lock_irqsave(&device->card->lock, flags);
346 list_add_tail(&orb->link, &sd->orb_list);
347 spin_unlock_irqrestore(&device->card->lock, flags);
349 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
350 node_id, generation, device->max_speed, offset,
351 &orb->pointer, sizeof(orb->pointer),
352 complete_transaction, orb);
355 static int sbp2_cancel_orbs(struct fw_unit *unit)
357 struct fw_device *device = fw_device(unit->device.parent);
358 struct sbp2_device *sd = unit->device.driver_data;
359 struct sbp2_orb *orb, *next;
360 struct list_head list;
362 int retval = -ENOENT;
364 INIT_LIST_HEAD(&list);
365 spin_lock_irqsave(&device->card->lock, flags);
366 list_splice_init(&sd->orb_list, &list);
367 spin_unlock_irqrestore(&device->card->lock, flags);
369 list_for_each_entry_safe(orb, next, &list, link) {
371 if (fw_cancel_transaction(device->card, &orb->t) == 0)
374 orb->rcode = RCODE_CANCELLED;
375 orb->callback(orb, NULL);
382 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
384 struct sbp2_management_orb *orb =
385 (struct sbp2_management_orb *)base_orb;
388 memcpy(&orb->status, status, sizeof(*status));
389 complete(&orb->done);
393 sbp2_send_management_orb(struct fw_unit *unit, int node_id, int generation,
394 int function, int lun, void *response)
396 struct fw_device *device = fw_device(unit->device.parent);
397 struct sbp2_device *sd = unit->device.driver_data;
398 struct sbp2_management_orb *orb;
399 int retval = -ENOMEM;
401 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
406 * The sbp2 device is going to send a block read request to
407 * read out the request from host memory, so map it for dma.
409 orb->base.request_bus =
410 dma_map_single(device->card->device, &orb->request,
411 sizeof(orb->request), DMA_TO_DEVICE);
412 if (dma_mapping_error(orb->base.request_bus))
416 dma_map_single(device->card->device, &orb->response,
417 sizeof(orb->response), DMA_FROM_DEVICE);
418 if (dma_mapping_error(orb->response_bus))
421 orb->request.response.high = 0;
422 orb->request.response.low = orb->response_bus;
425 MANAGEMENT_ORB_NOTIFY |
426 MANAGEMENT_ORB_FUNCTION(function) |
427 MANAGEMENT_ORB_LUN(lun);
428 orb->request.length =
429 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
431 orb->request.status_fifo.high = sd->address_handler.offset >> 32;
432 orb->request.status_fifo.low = sd->address_handler.offset;
435 * FIXME: Yeah, ok this isn't elegant, we hardwire exclusive
436 * login and 1 second reconnect time. The reconnect setting
437 * is probably fine, but the exclusive login should be an option.
439 if (function == SBP2_LOGIN_REQUEST) {
441 MANAGEMENT_ORB_EXCLUSIVE |
442 MANAGEMENT_ORB_RECONNECT(0);
445 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
447 init_completion(&orb->done);
448 orb->base.callback = complete_management_orb;
450 sbp2_send_orb(&orb->base, unit,
451 node_id, generation, sd->management_agent_address);
453 wait_for_completion_timeout(&orb->done,
454 msecs_to_jiffies(SBP2_ORB_TIMEOUT));
457 if (sbp2_cancel_orbs(unit) == 0) {
458 fw_error("orb reply timed out, rcode=0x%02x\n",
463 if (orb->base.rcode != RCODE_COMPLETE) {
464 fw_error("management write failed, rcode 0x%02x\n",
469 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
470 STATUS_GET_SBP_STATUS(orb->status) != 0) {
471 fw_error("error status: %d:%d\n",
472 STATUS_GET_RESPONSE(orb->status),
473 STATUS_GET_SBP_STATUS(orb->status));
479 dma_unmap_single(device->card->device, orb->base.request_bus,
480 sizeof(orb->request), DMA_TO_DEVICE);
481 dma_unmap_single(device->card->device, orb->response_bus,
482 sizeof(orb->response), DMA_FROM_DEVICE);
485 fw_memcpy_from_be32(response,
486 orb->response, sizeof(orb->response));
493 complete_agent_reset_write(struct fw_card *card, int rcode,
494 void *payload, size_t length, void *data)
496 struct fw_transaction *t = data;
501 static int sbp2_agent_reset(struct fw_unit *unit)
503 struct fw_device *device = fw_device(unit->device.parent);
504 struct sbp2_device *sd = unit->device.driver_data;
505 struct fw_transaction *t;
508 t = kzalloc(sizeof(*t), GFP_ATOMIC);
512 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
513 sd->node_id, sd->generation, SCODE_400,
514 sd->command_block_agent_address + SBP2_AGENT_RESET,
515 &zero, sizeof(zero), complete_agent_reset_write, t);
520 static void sbp2_reconnect(struct work_struct *work);
521 static struct scsi_host_template scsi_driver_template;
523 static void release_sbp2_device(struct kref *kref)
525 struct sbp2_device *sd = container_of(kref, struct sbp2_device, kref);
526 struct Scsi_Host *host =
527 container_of((void *)sd, struct Scsi_Host, hostdata[0]);
529 scsi_remove_host(host);
530 sbp2_send_management_orb(sd->unit, sd->node_id, sd->generation,
531 SBP2_LOGOUT_REQUEST, sd->login_id, NULL);
532 fw_core_remove_address_handler(&sd->address_handler);
533 fw_notify("removed sbp2 unit %s\n", sd->unit->device.bus_id);
534 put_device(&sd->unit->device);
538 static void sbp2_login(struct work_struct *work)
540 struct sbp2_device *sd =
541 container_of(work, struct sbp2_device, work.work);
542 struct Scsi_Host *host =
543 container_of((void *)sd, struct Scsi_Host, hostdata[0]);
544 struct fw_unit *unit = sd->unit;
545 struct fw_device *device = fw_device(unit->device.parent);
546 struct sbp2_login_response response;
547 int generation, node_id, local_node_id, lun, retval;
549 /* FIXME: Make this work for multi-lun devices. */
552 generation = device->card->generation;
553 node_id = device->node->node_id;
554 local_node_id = device->card->local_node->node_id;
556 if (sbp2_send_management_orb(unit, node_id, generation,
557 SBP2_LOGIN_REQUEST, lun, &response) < 0) {
558 if (sd->retries++ < 5) {
559 schedule_delayed_work(&sd->work, DIV_ROUND_UP(HZ, 5));
561 fw_error("failed to login to %s\n",
562 unit->device.bus_id);
563 kref_put(&sd->kref, release_sbp2_device);
568 sd->generation = generation;
569 sd->node_id = node_id;
570 sd->address_high = local_node_id << 16;
572 /* Get command block agent offset and login id. */
573 sd->command_block_agent_address =
574 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
575 response.command_block_agent.low;
576 sd->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
578 fw_notify("logged in to sbp2 unit %s (%d retries)\n",
579 unit->device.bus_id, sd->retries);
580 fw_notify(" - management_agent_address: 0x%012llx\n",
581 (unsigned long long) sd->management_agent_address);
582 fw_notify(" - command_block_agent_address: 0x%012llx\n",
583 (unsigned long long) sd->command_block_agent_address);
584 fw_notify(" - status write address: 0x%012llx\n",
585 (unsigned long long) sd->address_handler.offset);
588 /* FIXME: The linux1394 sbp2 does this last step. */
589 sbp2_set_busy_timeout(scsi_id);
592 PREPARE_DELAYED_WORK(&sd->work, sbp2_reconnect);
593 sbp2_agent_reset(unit);
595 /* FIXME: Loop over luns here. */
597 retval = scsi_add_device(host, 0, 0, lun);
599 sbp2_send_management_orb(unit, sd->node_id, sd->generation,
600 SBP2_LOGOUT_REQUEST, sd->login_id,
603 * Set this back to sbp2_login so we fall back and
604 * retry login on bus reset.
606 PREPARE_DELAYED_WORK(&sd->work, sbp2_login);
608 kref_put(&sd->kref, release_sbp2_device);
611 static int sbp2_probe(struct device *dev)
613 struct fw_unit *unit = fw_unit(dev);
614 struct fw_device *device = fw_device(unit->device.parent);
615 struct sbp2_device *sd;
616 struct fw_csr_iterator ci;
617 struct Scsi_Host *host;
618 int i, key, value, err;
619 u32 model, firmware_revision;
622 host = scsi_host_alloc(&scsi_driver_template, sizeof(*sd));
626 sd = (struct sbp2_device *) host->hostdata;
627 unit->device.driver_data = sd;
629 INIT_LIST_HEAD(&sd->orb_list);
630 kref_init(&sd->kref);
632 sd->address_handler.length = 0x100;
633 sd->address_handler.address_callback = sbp2_status_write;
634 sd->address_handler.callback_data = sd;
636 err = fw_core_add_address_handler(&sd->address_handler,
637 &fw_high_memory_region);
641 err = fw_device_enable_phys_dma(device);
643 goto fail_address_handler;
645 err = scsi_add_host(host, &unit->device);
647 goto fail_address_handler;
650 * Scan unit directory to get management agent address,
651 * firmware revison and model. Initialize firmware_revision
652 * and model to values that wont match anything in our table.
654 firmware_revision = 0xff000000;
656 fw_csr_iterator_init(&ci, unit->directory);
657 while (fw_csr_iterator_next(&ci, &key, &value)) {
659 case CSR_DEPENDENT_INFO | CSR_OFFSET:
660 sd->management_agent_address =
661 0xfffff0000000ULL + 4 * value;
663 case SBP2_FIRMWARE_REVISION:
664 firmware_revision = value;
672 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
673 if (sbp2_workarounds_table[i].firmware_revision !=
674 (firmware_revision & 0xffffff00))
676 if (sbp2_workarounds_table[i].model != model &&
677 sbp2_workarounds_table[i].model != ~0)
679 sd->workarounds |= sbp2_workarounds_table[i].workarounds;
684 fw_notify("Workarounds for node %s: 0x%x "
685 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
687 sd->workarounds, firmware_revision, model);
689 get_device(&unit->device);
692 * We schedule work to do the login so we can easily
693 * reschedule retries. Always get the ref before scheduling
696 INIT_DELAYED_WORK(&sd->work, sbp2_login);
697 if (schedule_delayed_work(&sd->work, 0))
702 fail_address_handler:
703 fw_core_remove_address_handler(&sd->address_handler);
710 static int sbp2_remove(struct device *dev)
712 struct fw_unit *unit = fw_unit(dev);
713 struct sbp2_device *sd = unit->device.driver_data;
715 kref_put(&sd->kref, release_sbp2_device);
720 static void sbp2_reconnect(struct work_struct *work)
722 struct sbp2_device *sd =
723 container_of(work, struct sbp2_device, work.work);
724 struct fw_unit *unit = sd->unit;
725 struct fw_device *device = fw_device(unit->device.parent);
726 int generation, node_id, local_node_id;
728 generation = device->card->generation;
729 node_id = device->node->node_id;
730 local_node_id = device->card->local_node->node_id;
732 if (sbp2_send_management_orb(unit, node_id, generation,
733 SBP2_RECONNECT_REQUEST,
734 sd->login_id, NULL) < 0) {
735 if (sd->retries++ >= 5) {
736 fw_error("failed to reconnect to %s\n",
737 unit->device.bus_id);
738 /* Fall back and try to log in again. */
740 PREPARE_DELAYED_WORK(&sd->work, sbp2_login);
742 schedule_delayed_work(&sd->work, DIV_ROUND_UP(HZ, 5));
746 sd->generation = generation;
747 sd->node_id = node_id;
748 sd->address_high = local_node_id << 16;
750 fw_notify("reconnected to unit %s (%d retries)\n",
751 unit->device.bus_id, sd->retries);
752 sbp2_agent_reset(unit);
753 sbp2_cancel_orbs(unit);
754 kref_put(&sd->kref, release_sbp2_device);
757 static void sbp2_update(struct fw_unit *unit)
759 struct fw_device *device = fw_device(unit->device.parent);
760 struct sbp2_device *sd = unit->device.driver_data;
763 fw_device_enable_phys_dma(device);
764 if (schedule_delayed_work(&sd->work, 0))
768 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
769 #define SBP2_SW_VERSION_ENTRY 0x00010483
771 static const struct fw_device_id sbp2_id_table[] = {
773 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
774 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
775 .version = SBP2_SW_VERSION_ENTRY,
780 static struct fw_driver sbp2_driver = {
782 .owner = THIS_MODULE,
783 .name = sbp2_driver_name,
786 .remove = sbp2_remove,
788 .update = sbp2_update,
789 .id_table = sbp2_id_table,
793 sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
797 sense_data[0] = 0x70;
799 sense_data[2] = sbp2_status[1];
800 sense_data[3] = sbp2_status[4];
801 sense_data[4] = sbp2_status[5];
802 sense_data[5] = sbp2_status[6];
803 sense_data[6] = sbp2_status[7];
805 sense_data[8] = sbp2_status[8];
806 sense_data[9] = sbp2_status[9];
807 sense_data[10] = sbp2_status[10];
808 sense_data[11] = sbp2_status[11];
809 sense_data[12] = sbp2_status[2];
810 sense_data[13] = sbp2_status[3];
811 sense_data[14] = sbp2_status[12];
812 sense_data[15] = sbp2_status[13];
814 sam_status = sbp2_status[0] & 0x3f;
816 switch (sam_status) {
818 case SAM_STAT_CHECK_CONDITION:
819 case SAM_STAT_CONDITION_MET:
821 case SAM_STAT_RESERVATION_CONFLICT:
822 case SAM_STAT_COMMAND_TERMINATED:
823 return DID_OK << 16 | sam_status;
826 return DID_ERROR << 16;
831 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
833 struct sbp2_command_orb *orb = (struct sbp2_command_orb *)base_orb;
834 struct fw_unit *unit = orb->unit;
835 struct fw_device *device = fw_device(unit->device.parent);
836 struct scatterlist *sg;
839 if (status != NULL) {
840 if (STATUS_GET_DEAD(*status))
841 sbp2_agent_reset(unit);
843 switch (STATUS_GET_RESPONSE(*status)) {
844 case SBP2_STATUS_REQUEST_COMPLETE:
845 result = DID_OK << 16;
847 case SBP2_STATUS_TRANSPORT_FAILURE:
848 result = DID_BUS_BUSY << 16;
850 case SBP2_STATUS_ILLEGAL_REQUEST:
851 case SBP2_STATUS_VENDOR_DEPENDENT:
853 result = DID_ERROR << 16;
857 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
858 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
859 orb->cmd->sense_buffer);
862 * If the orb completes with status == NULL, something
863 * went wrong, typically a bus reset happened mid-orb
864 * or when sending the write (less likely).
866 result = DID_BUS_BUSY << 16;
869 dma_unmap_single(device->card->device, orb->base.request_bus,
870 sizeof(orb->request), DMA_TO_DEVICE);
872 if (orb->cmd->use_sg > 0) {
873 sg = (struct scatterlist *)orb->cmd->request_buffer;
874 dma_unmap_sg(device->card->device, sg, orb->cmd->use_sg,
875 orb->cmd->sc_data_direction);
878 if (orb->page_table_bus != 0)
879 dma_unmap_single(device->card->device, orb->page_table_bus,
880 sizeof(orb->page_table_bus), DMA_TO_DEVICE);
882 orb->cmd->result = result;
887 static int sbp2_command_orb_map_scatterlist(struct sbp2_command_orb *orb)
889 struct sbp2_device *sd =
890 (struct sbp2_device *)orb->cmd->device->host->hostdata;
891 struct fw_unit *unit = sd->unit;
892 struct fw_device *device = fw_device(unit->device.parent);
893 struct scatterlist *sg;
894 int sg_len, l, i, j, count;
898 sg = (struct scatterlist *)orb->cmd->request_buffer;
899 count = dma_map_sg(device->card->device, sg, orb->cmd->use_sg,
900 orb->cmd->sc_data_direction);
905 * Handle the special case where there is only one element in
906 * the scatter list by converting it to an immediate block
907 * request. This is also a workaround for broken devices such
908 * as the second generation iPod which doesn't support page
911 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
912 orb->request.data_descriptor.high = sd->address_high;
913 orb->request.data_descriptor.low = sg_dma_address(sg);
915 COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
920 * Convert the scatterlist to an sbp2 page table. If any
921 * scatterlist entries are too big for sbp2, we split them as we
922 * go. Even if we ask the block I/O layer to not give us sg
923 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
924 * during DMA mapping, and Linux currently doesn't prevent this.
926 for (i = 0, j = 0; i < count; i++) {
927 sg_len = sg_dma_len(sg + i);
928 sg_addr = sg_dma_address(sg + i);
930 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
931 orb->page_table[j].low = sg_addr;
932 orb->page_table[j].high = (l << 16);
939 size = sizeof(orb->page_table[0]) * j;
942 * The data_descriptor pointer is the one case where we need
943 * to fill in the node ID part of the address. All other
944 * pointers assume that the data referenced reside on the
945 * initiator (i.e. us), but data_descriptor can refer to data
946 * on other nodes so we need to put our ID in descriptor.high.
949 orb->page_table_bus =
950 dma_map_single(device->card->device, orb->page_table,
951 size, DMA_TO_DEVICE);
952 if (dma_mapping_error(orb->page_table_bus))
953 goto fail_page_table;
954 orb->request.data_descriptor.high = sd->address_high;
955 orb->request.data_descriptor.low = orb->page_table_bus;
957 COMMAND_ORB_PAGE_TABLE_PRESENT |
958 COMMAND_ORB_DATA_SIZE(j);
960 fw_memcpy_to_be32(orb->page_table, orb->page_table, size);
965 dma_unmap_sg(device->card->device, sg, orb->cmd->use_sg,
966 orb->cmd->sc_data_direction);
971 /* SCSI stack integration */
973 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
975 struct sbp2_device *sd =
976 (struct sbp2_device *)cmd->device->host->hostdata;
977 struct fw_unit *unit = sd->unit;
978 struct fw_device *device = fw_device(unit->device.parent);
979 struct sbp2_command_orb *orb;
982 * Bidirectional commands are not yet implemented, and unknown
983 * transfer direction not handled.
985 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
986 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
987 cmd->result = DID_ERROR << 16;
992 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
994 fw_notify("failed to alloc orb\n");
998 /* Initialize rcode to something not RCODE_COMPLETE. */
999 orb->base.rcode = -1;
1000 orb->base.request_bus =
1001 dma_map_single(device->card->device, &orb->request,
1002 sizeof(orb->request), DMA_TO_DEVICE);
1003 if (dma_mapping_error(orb->base.request_bus))
1010 orb->request.next.high = SBP2_ORB_NULL;
1011 orb->request.next.low = 0x0;
1013 * At speed 100 we can do 512 bytes per packet, at speed 200,
1014 * 1024 bytes per packet etc. The SBP-2 max_payload field
1015 * specifies the max payload size as 2 ^ (max_payload + 2), so
1016 * if we set this to max_speed + 7, we get the right value.
1019 COMMAND_ORB_MAX_PAYLOAD(device->max_speed + 7) |
1020 COMMAND_ORB_SPEED(device->max_speed) |
1023 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1024 orb->request.misc |=
1025 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
1026 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1027 orb->request.misc |=
1028 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
1030 if (cmd->use_sg && sbp2_command_orb_map_scatterlist(orb) < 0)
1031 goto fail_map_payload;
1033 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
1035 memset(orb->request.command_block,
1036 0, sizeof(orb->request.command_block));
1037 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1039 orb->base.callback = complete_command_orb;
1041 sbp2_send_orb(&orb->base, unit, sd->node_id, sd->generation,
1042 sd->command_block_agent_address + SBP2_ORB_POINTER);
1047 dma_unmap_single(device->card->device, orb->base.request_bus,
1048 sizeof(orb->request), DMA_TO_DEVICE);
1052 return SCSI_MLQUEUE_HOST_BUSY;
1055 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1057 struct sbp2_device *sd = (struct sbp2_device *)sdev->host->hostdata;
1059 sdev->allow_restart = 1;
1061 if (sd->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1062 sdev->inquiry_len = 36;
1066 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1068 struct sbp2_device *sd = (struct sbp2_device *)sdev->host->hostdata;
1069 struct fw_unit *unit = sd->unit;
1071 sdev->use_10_for_rw = 1;
1073 if (sdev->type == TYPE_ROM)
1074 sdev->use_10_for_ms = 1;
1075 if (sdev->type == TYPE_DISK &&
1076 sd->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1077 sdev->skip_ms_page_8 = 1;
1078 if (sd->workarounds & SBP2_WORKAROUND_FIX_CAPACITY) {
1079 fw_notify("setting fix_capacity for %s\n", unit->device.bus_id);
1080 sdev->fix_capacity = 1;
1082 if (sd->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1083 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
1088 * Called by scsi stack when something has really gone wrong. Usually
1089 * called when a command has timed-out for some reason.
1091 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1093 struct sbp2_device *sd =
1094 (struct sbp2_device *)cmd->device->host->hostdata;
1095 struct fw_unit *unit = sd->unit;
1097 fw_notify("sbp2_scsi_abort\n");
1098 sbp2_agent_reset(unit);
1099 sbp2_cancel_orbs(unit);
1105 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1106 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1108 * This is the concatenation of target port identifier and logical unit
1109 * identifier as per SAM-2...SAM-4 annex A.
1112 sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1115 struct scsi_device *sdev = to_scsi_device(dev);
1116 struct sbp2_device *sd;
1117 struct fw_unit *unit;
1118 struct fw_device *device;
1120 struct fw_csr_iterator ci;
1121 int key, value, lun;
1125 sd = (struct sbp2_device *)sdev->host->hostdata;
1127 device = fw_device(unit->device.parent);
1129 /* implicit directory ID */
1130 directory_id = ((unit->directory - device->config_rom) * 4
1131 + CSR_CONFIG_ROM) & 0xffffff;
1133 /* explicit directory ID, overrides implicit ID if present */
1134 fw_csr_iterator_init(&ci, unit->directory);
1135 while (fw_csr_iterator_next(&ci, &key, &value))
1136 if (key == CSR_DIRECTORY_ID) {
1137 directory_id = value;
1141 /* FIXME: Make this work for multi-lun devices. */
1144 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1145 device->config_rom[3], device->config_rom[4],
1149 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1151 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1152 &dev_attr_ieee1394_id,
1156 static struct scsi_host_template scsi_driver_template = {
1157 .module = THIS_MODULE,
1158 .name = "SBP-2 IEEE-1394",
1159 .proc_name = (char *)sbp2_driver_name,
1160 .queuecommand = sbp2_scsi_queuecommand,
1161 .slave_alloc = sbp2_scsi_slave_alloc,
1162 .slave_configure = sbp2_scsi_slave_configure,
1163 .eh_abort_handler = sbp2_scsi_abort,
1165 .sg_tablesize = SG_ALL,
1166 .use_clustering = ENABLE_CLUSTERING,
1169 .sdev_attrs = sbp2_scsi_sysfs_attrs,
1172 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1173 MODULE_DESCRIPTION("SCSI over IEEE1394");
1174 MODULE_LICENSE("GPL");
1175 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1177 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1178 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1179 MODULE_ALIAS("sbp2");
1182 static int __init sbp2_init(void)
1184 return driver_register(&sbp2_driver.driver);
1187 static void __exit sbp2_cleanup(void)
1189 driver_unregister(&sbp2_driver.driver);
1192 module_init(sbp2_init);
1193 module_exit(sbp2_cleanup);