firewire: fw-sbp2: don't add scsi_device twice
[deliverable/linux.git] / drivers / firewire / fw-sbp2.c
CommitLineData
c781c06d
KH
1/*
2 * SBP2 driver (SCSI over IEEE1394)
9ba136d0 3 *
27a15e50 4 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
9ba136d0
KH
5 *
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.
10 *
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.
15 *
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.
19 */
20
c781c06d
KH
21/*
22 * The basic structure of this driver is based on the old storage driver,
27a15e50
KH
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>
28 * and many others.
29 */
30
9ba136d0
KH
31#include <linux/kernel.h>
32#include <linux/module.h>
5cd54c94 33#include <linux/moduleparam.h>
fe69ca3a 34#include <linux/mod_devicetable.h>
9220f194 35#include <linux/delay.h>
9ba136d0 36#include <linux/device.h>
0b5b2903 37#include <linux/scatterlist.h>
9ba136d0 38#include <linux/dma-mapping.h>
cf47c7a2 39#include <linux/blkdev.h>
e7cdf237 40#include <linux/string.h>
2df222b8 41#include <linux/stringify.h>
1d3d52c5 42#include <linux/timer.h>
df8ec249 43#include <linux/workqueue.h>
b5d2a5e0 44#include <asm/system.h>
9ba136d0
KH
45
46#include <scsi/scsi.h>
47#include <scsi/scsi_cmnd.h>
9ba136d0
KH
48#include <scsi/scsi_device.h>
49#include <scsi/scsi_host.h>
50
51#include "fw-transaction.h"
52#include "fw-topology.h"
53#include "fw-device.h"
54
5cd54c94
SR
55/*
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.
59 *
60 * Concurrent logins are useful together with cluster filesystems.
61 */
62static int sbp2_param_exclusive_login = 1;
63module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
64MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
65 "(default = Y, use N for concurrent initiators)");
66
2df222b8
SR
67/*
68 * Flags for firmware oddities
69 *
70 * - 128kB max transfer
71 * Limit transfer size. Necessary for some old bridges.
72 *
73 * - 36 byte inquiry
74 * When scsi_mod probes the device, let the inquiry command look like that
75 * from MS Windows.
76 *
77 * - skip mode page 8
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.
80 *
81 * - fix capacity
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.
85 *
9220f194
SR
86 * - delay inquiry
87 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
88 *
2df222b8
SR
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.
93 */
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
9220f194
SR
98#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
99#define SBP2_INQUIRY_DELAY 12
2df222b8
SR
100#define SBP2_WORKAROUND_OVERRIDE 0x100
101
102static int sbp2_param_workarounds;
103module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
104MODULE_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)
9220f194 109 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
2df222b8
SR
110 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
111 ", or a combination)");
112
9ba136d0 113/* I don't know why the SCSI stack doesn't define something like this... */
a98e2719 114typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
9ba136d0
KH
115
116static const char sbp2_driver_name[] = "sbp2";
117
5a3c2be6
SR
118/*
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.
121 */
122struct sbp2_logical_unit {
123 struct sbp2_target *tgt;
124 struct list_head link;
125 struct scsi_device *sdev;
9ba136d0
KH
126 struct fw_address_handler address_handler;
127 struct list_head orb_list;
5a3c2be6 128
9ba136d0 129 u64 command_block_agent_address;
5a3c2be6 130 u16 lun;
9ba136d0
KH
131 int login_id;
132
c781c06d 133 /*
5a3c2be6
SR
134 * The generation is updated once we've logged in or reconnected
135 * to the logical unit. Thus, I/O to the device will automatically
136 * fail and get retried if it happens in a window where the device
137 * is not ready, e.g. after a bus reset but before we reconnect.
c781c06d 138 */
9ba136d0 139 int generation;
7f37c426
KH
140 int retries;
141 struct delayed_work work;
9ba136d0
KH
142};
143
5a3c2be6
SR
144/*
145 * We create one struct sbp2_target per IEEE 1212 Unit Directory
146 * and one struct Scsi_Host per sbp2_target.
147 */
148struct sbp2_target {
149 struct kref kref;
150 struct fw_unit *unit;
48f18c76 151 const char *bus_id;
05cca738 152 struct list_head lu_list;
5a3c2be6
SR
153
154 u64 management_agent_address;
155 int directory_id;
156 int node_id;
157 int address_high;
05cca738 158 unsigned int workarounds;
384170da 159 unsigned int mgt_orb_timeout;
5a3c2be6
SR
160};
161
a4c379c1
JW
162/*
163 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
384170da
JW
164 * provided in the config rom. Most devices do provide a value, which
165 * we'll use for login management orbs, but with some sane limits.
a4c379c1 166 */
384170da
JW
167#define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
168#define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
05cca738 169#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
9ba136d0 170#define SBP2_ORB_NULL 0x80000000
a4c379c1 171#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
9ba136d0
KH
172
173#define SBP2_DIRECTION_TO_MEDIA 0x0
174#define SBP2_DIRECTION_FROM_MEDIA 0x1
175
176/* Unit directory keys */
384170da 177#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
5a3c2be6
SR
178#define SBP2_CSR_FIRMWARE_REVISION 0x3c
179#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
180#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
9ba136d0 181
9ba136d0
KH
182/* Management orb opcodes */
183#define SBP2_LOGIN_REQUEST 0x0
184#define SBP2_QUERY_LOGINS_REQUEST 0x1
185#define SBP2_RECONNECT_REQUEST 0x3
186#define SBP2_SET_PASSWORD_REQUEST 0x4
187#define SBP2_LOGOUT_REQUEST 0x7
188#define SBP2_ABORT_TASK_REQUEST 0xb
189#define SBP2_ABORT_TASK_SET 0xc
190#define SBP2_LOGICAL_UNIT_RESET 0xe
191#define SBP2_TARGET_RESET_REQUEST 0xf
192
193/* Offsets for command block agent registers */
194#define SBP2_AGENT_STATE 0x00
195#define SBP2_AGENT_RESET 0x04
196#define SBP2_ORB_POINTER 0x08
197#define SBP2_DOORBELL 0x10
198#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
199
200/* Status write response codes */
201#define SBP2_STATUS_REQUEST_COMPLETE 0x0
202#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
203#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
204#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
205
a77754a7
KH
206#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
207#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
208#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
209#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
210#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
211#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
212#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
213#define STATUS_GET_DATA(v) ((v).data)
9ba136d0
KH
214
215struct sbp2_status {
216 u32 status;
217 u32 orb_low;
218 u8 data[24];
219};
220
221struct sbp2_pointer {
222 u32 high;
223 u32 low;
224};
225
226struct sbp2_orb {
227 struct fw_transaction t;
e57d2011 228 struct kref kref;
9ba136d0
KH
229 dma_addr_t request_bus;
230 int rcode;
231 struct sbp2_pointer pointer;
a98e2719 232 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
9ba136d0
KH
233 struct list_head link;
234};
235
a77754a7
KH
236#define MANAGEMENT_ORB_LUN(v) ((v))
237#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
238#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
5cd54c94 239#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
a77754a7
KH
240#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
241#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
9ba136d0 242
a77754a7
KH
243#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
244#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
9ba136d0
KH
245
246struct sbp2_management_orb {
247 struct sbp2_orb base;
248 struct {
249 struct sbp2_pointer password;
250 struct sbp2_pointer response;
251 u32 misc;
252 u32 length;
253 struct sbp2_pointer status_fifo;
254 } request;
255 __be32 response[4];
256 dma_addr_t response_bus;
257 struct completion done;
258 struct sbp2_status status;
259};
260
a77754a7
KH
261#define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
262#define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
9ba136d0
KH
263
264struct sbp2_login_response {
265 u32 misc;
266 struct sbp2_pointer command_block_agent;
267 u32 reconnect_hold;
268};
a77754a7
KH
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(v) ((v) << 27)
275#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
276#define COMMAND_ORB_NOTIFY ((1) << 31)
9ba136d0
KH
277
278struct sbp2_command_orb {
279 struct sbp2_orb base;
280 struct {
281 struct sbp2_pointer next;
282 struct sbp2_pointer data_descriptor;
283 u32 misc;
284 u8 command_block[12];
285 } request;
286 struct scsi_cmnd *cmd;
287 scsi_done_fn_t done;
5a3c2be6 288 struct sbp2_logical_unit *lu;
9ba136d0 289
9fb2dd12 290 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
9ba136d0 291 dma_addr_t page_table_bus;
9ba136d0
KH
292};
293
294/*
295 * List of devices with known bugs.
296 *
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.
302 */
303static const struct {
304 u32 firmware_revision;
305 u32 model;
05cca738 306 unsigned int workarounds;
9ba136d0
KH
307} sbp2_workarounds_table[] = {
308 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
309 .firmware_revision = 0x002800,
310 .model = 0x001010,
311 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
312 SBP2_WORKAROUND_MODE_SENSE_8,
313 },
9220f194
SR
314 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
315 .firmware_revision = 0x002800,
316 .model = 0x000000,
317 .workarounds = SBP2_WORKAROUND_DELAY_INQUIRY,
318 },
9ba136d0
KH
319 /* Initio bridges, actually only needed for some older ones */ {
320 .firmware_revision = 0x000200,
321 .model = ~0,
322 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
323 },
324 /* Symbios bridge */ {
325 .firmware_revision = 0xa0b800,
326 .model = ~0,
327 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
328 },
c781c06d
KH
329
330 /*
331 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
9ba136d0
KH
332 * these iPods do not feature the read_capacity bug according
333 * to one report. Read_capacity behaviour as well as model_id
c781c06d
KH
334 * could change due to Apple-supplied firmware updates though.
335 */
336
9ba136d0
KH
337 /* iPod 4th generation. */ {
338 .firmware_revision = 0x0a2700,
339 .model = 0x000021,
340 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
341 },
342 /* iPod mini */ {
343 .firmware_revision = 0x0a2700,
344 .model = 0x000023,
345 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
346 },
347 /* iPod Photo */ {
348 .firmware_revision = 0x0a2700,
349 .model = 0x00007e,
350 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
351 }
352};
353
e57d2011
KH
354static void
355free_orb(struct kref *kref)
356{
357 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
358
359 kfree(orb);
360}
361
9ba136d0
KH
362static void
363sbp2_status_write(struct fw_card *card, struct fw_request *request,
364 int tcode, int destination, int source,
365 int generation, int speed,
366 unsigned long long offset,
367 void *payload, size_t length, void *callback_data)
368{
5a3c2be6 369 struct sbp2_logical_unit *lu = callback_data;
9ba136d0
KH
370 struct sbp2_orb *orb;
371 struct sbp2_status status;
372 size_t header_size;
373 unsigned long flags;
374
375 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
2d826cc5 376 length == 0 || length > sizeof(status)) {
9ba136d0
KH
377 fw_send_response(card, request, RCODE_TYPE_ERROR);
378 return;
379 }
380
381 header_size = min(length, 2 * sizeof(u32));
382 fw_memcpy_from_be32(&status, payload, header_size);
383 if (length > header_size)
384 memcpy(status.data, payload + 8, length - header_size);
a77754a7 385 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
9ba136d0
KH
386 fw_notify("non-orb related status write, not handled\n");
387 fw_send_response(card, request, RCODE_COMPLETE);
388 return;
389 }
390
391 /* Lookup the orb corresponding to this status write. */
392 spin_lock_irqsave(&card->lock, flags);
5a3c2be6 393 list_for_each_entry(orb, &lu->orb_list, link) {
a77754a7 394 if (STATUS_GET_ORB_HIGH(status) == 0 &&
e57d2011
KH
395 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
396 orb->rcode = RCODE_COMPLETE;
9ba136d0
KH
397 list_del(&orb->link);
398 break;
399 }
400 }
401 spin_unlock_irqrestore(&card->lock, flags);
402
5a3c2be6 403 if (&orb->link != &lu->orb_list)
9ba136d0
KH
404 orb->callback(orb, &status);
405 else
406 fw_error("status write for unknown orb\n");
407
e57d2011
KH
408 kref_put(&orb->kref, free_orb);
409
9ba136d0
KH
410 fw_send_response(card, request, RCODE_COMPLETE);
411}
412
413static void
414complete_transaction(struct fw_card *card, int rcode,
415 void *payload, size_t length, void *data)
416{
417 struct sbp2_orb *orb = data;
418 unsigned long flags;
419
e57d2011
KH
420 /*
421 * This is a little tricky. We can get the status write for
422 * the orb before we get this callback. The status write
423 * handler above will assume the orb pointer transaction was
424 * successful and set the rcode to RCODE_COMPLETE for the orb.
425 * So this callback only sets the rcode if it hasn't already
426 * been set and only does the cleanup if the transaction
427 * failed and we didn't already get a status write.
428 */
429 spin_lock_irqsave(&card->lock, flags);
430
431 if (orb->rcode == -1)
432 orb->rcode = rcode;
433 if (orb->rcode != RCODE_COMPLETE) {
9ba136d0 434 list_del(&orb->link);
1b34e974 435 spin_unlock_irqrestore(&card->lock, flags);
9ba136d0 436 orb->callback(orb, NULL);
1b34e974
SR
437 } else {
438 spin_unlock_irqrestore(&card->lock, flags);
9ba136d0 439 }
e57d2011 440
e57d2011 441 kref_put(&orb->kref, free_orb);
9ba136d0
KH
442}
443
444static void
5a3c2be6 445sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
9ba136d0
KH
446 int node_id, int generation, u64 offset)
447{
5a3c2be6 448 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
9ba136d0
KH
449 unsigned long flags;
450
451 orb->pointer.high = 0;
452 orb->pointer.low = orb->request_bus;
2d826cc5 453 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
9ba136d0
KH
454
455 spin_lock_irqsave(&device->card->lock, flags);
5a3c2be6 456 list_add_tail(&orb->link, &lu->orb_list);
9ba136d0
KH
457 spin_unlock_irqrestore(&device->card->lock, flags);
458
e57d2011
KH
459 /* Take a ref for the orb list and for the transaction callback. */
460 kref_get(&orb->kref);
461 kref_get(&orb->kref);
462
9ba136d0 463 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
f1397490 464 node_id, generation, device->max_speed, offset,
2d826cc5 465 &orb->pointer, sizeof(orb->pointer),
9ba136d0
KH
466 complete_transaction, orb);
467}
468
5a3c2be6 469static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
9ba136d0 470{
5a3c2be6 471 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
9ba136d0
KH
472 struct sbp2_orb *orb, *next;
473 struct list_head list;
474 unsigned long flags;
2aaad97b 475 int retval = -ENOENT;
9ba136d0
KH
476
477 INIT_LIST_HEAD(&list);
478 spin_lock_irqsave(&device->card->lock, flags);
5a3c2be6 479 list_splice_init(&lu->orb_list, &list);
9ba136d0
KH
480 spin_unlock_irqrestore(&device->card->lock, flags);
481
482 list_for_each_entry_safe(orb, next, &list, link) {
2aaad97b 483 retval = 0;
730c32f5
KH
484 if (fw_cancel_transaction(device->card, &orb->t) == 0)
485 continue;
486
9ba136d0
KH
487 orb->rcode = RCODE_CANCELLED;
488 orb->callback(orb, NULL);
489 }
9ba136d0 490
2aaad97b 491 return retval;
1d3d52c5
KH
492}
493
9ba136d0
KH
494static void
495complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
496{
497 struct sbp2_management_orb *orb =
6f061487 498 container_of(base_orb, struct sbp2_management_orb, base);
9ba136d0
KH
499
500 if (status)
2d826cc5 501 memcpy(&orb->status, status, sizeof(*status));
9ba136d0
KH
502 complete(&orb->done);
503}
504
505static int
5a3c2be6
SR
506sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
507 int generation, int function, int lun_or_login_id,
508 void *response)
9ba136d0 509{
5a3c2be6 510 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
9ba136d0 511 struct sbp2_management_orb *orb;
a4c379c1 512 unsigned int timeout;
9ba136d0
KH
513 int retval = -ENOMEM;
514
be6f48b0
SR
515 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
516 return 0;
517
2d826cc5 518 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
9ba136d0
KH
519 if (orb == NULL)
520 return -ENOMEM;
521
e57d2011 522 kref_init(&orb->base.kref);
9ba136d0
KH
523 orb->response_bus =
524 dma_map_single(device->card->device, &orb->response,
2d826cc5 525 sizeof(orb->response), DMA_FROM_DEVICE);
82eff9db 526 if (dma_mapping_error(orb->response_bus))
7aa48481 527 goto fail_mapping_response;
9ba136d0
KH
528
529 orb->request.response.high = 0;
530 orb->request.response.low = orb->response_bus;
531
532 orb->request.misc =
a77754a7
KH
533 MANAGEMENT_ORB_NOTIFY |
534 MANAGEMENT_ORB_FUNCTION(function) |
5a3c2be6 535 MANAGEMENT_ORB_LUN(lun_or_login_id);
9ba136d0 536 orb->request.length =
2d826cc5 537 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
9ba136d0 538
5a3c2be6
SR
539 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
540 orb->request.status_fifo.low = lu->address_handler.offset;
9ba136d0 541
9ba136d0 542 if (function == SBP2_LOGIN_REQUEST) {
14dc992a 543 /* Ask for 2^2 == 4 seconds reconnect grace period */
9ba136d0 544 orb->request.misc |=
14dc992a
SR
545 MANAGEMENT_ORB_RECONNECT(2) |
546 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login);
384170da 547 timeout = lu->tgt->mgt_orb_timeout;
a4c379c1
JW
548 } else {
549 timeout = SBP2_ORB_TIMEOUT;
9ba136d0
KH
550 }
551
2d826cc5 552 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
9ba136d0
KH
553
554 init_completion(&orb->done);
555 orb->base.callback = complete_management_orb;
2aaad97b 556
7aa48481
SR
557 orb->base.request_bus =
558 dma_map_single(device->card->device, &orb->request,
559 sizeof(orb->request), DMA_TO_DEVICE);
560 if (dma_mapping_error(orb->base.request_bus))
561 goto fail_mapping_request;
562
5a3c2be6
SR
563 sbp2_send_orb(&orb->base, lu, node_id, generation,
564 lu->tgt->management_agent_address);
9ba136d0 565
a4c379c1 566 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
9ba136d0 567
9ba136d0 568 retval = -EIO;
5a3c2be6 569 if (sbp2_cancel_orbs(lu) == 0) {
48f18c76
SR
570 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
571 lu->tgt->bus_id, orb->base.rcode);
9ba136d0
KH
572 goto out;
573 }
574
2aaad97b 575 if (orb->base.rcode != RCODE_COMPLETE) {
48f18c76
SR
576 fw_error("%s: management write failed, rcode 0x%02x\n",
577 lu->tgt->bus_id, orb->base.rcode);
9ba136d0
KH
578 goto out;
579 }
580
a77754a7
KH
581 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
582 STATUS_GET_SBP_STATUS(orb->status) != 0) {
48f18c76 583 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
a77754a7
KH
584 STATUS_GET_RESPONSE(orb->status),
585 STATUS_GET_SBP_STATUS(orb->status));
9ba136d0
KH
586 goto out;
587 }
588
589 retval = 0;
590 out:
591 dma_unmap_single(device->card->device, orb->base.request_bus,
2d826cc5 592 sizeof(orb->request), DMA_TO_DEVICE);
7aa48481 593 fail_mapping_request:
9ba136d0 594 dma_unmap_single(device->card->device, orb->response_bus,
2d826cc5 595 sizeof(orb->response), DMA_FROM_DEVICE);
7aa48481 596 fail_mapping_response:
9ba136d0
KH
597 if (response)
598 fw_memcpy_from_be32(response,
2d826cc5 599 orb->response, sizeof(orb->response));
e57d2011 600 kref_put(&orb->base.kref, free_orb);
9ba136d0
KH
601
602 return retval;
603}
604
605static void
606complete_agent_reset_write(struct fw_card *card, int rcode,
e0e60215 607 void *payload, size_t length, void *done)
9ba136d0 608{
e0e60215
SR
609 complete(done);
610}
611
612static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
613{
614 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
615 DECLARE_COMPLETION_ONSTACK(done);
616 struct fw_transaction t;
617 static u32 z;
9ba136d0 618
e0e60215
SR
619 fw_send_request(device->card, &t, TCODE_WRITE_QUADLET_REQUEST,
620 lu->tgt->node_id, lu->generation, device->max_speed,
621 lu->command_block_agent_address + SBP2_AGENT_RESET,
622 &z, sizeof(z), complete_agent_reset_write, &done);
623 wait_for_completion(&done);
9ba136d0
KH
624}
625
e0e60215
SR
626static void
627complete_agent_reset_write_no_wait(struct fw_card *card, int rcode,
628 void *payload, size_t length, void *data)
629{
630 kfree(data);
631}
632
633static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
9ba136d0 634{
5a3c2be6 635 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
9ba136d0 636 struct fw_transaction *t;
e0e60215 637 static u32 z;
9ba136d0 638
e0e60215 639 t = kmalloc(sizeof(*t), GFP_ATOMIC);
9ba136d0 640 if (t == NULL)
e0e60215 641 return;
9ba136d0
KH
642
643 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
5a3c2be6
SR
644 lu->tgt->node_id, lu->generation, device->max_speed,
645 lu->command_block_agent_address + SBP2_AGENT_RESET,
e0e60215 646 &z, sizeof(z), complete_agent_reset_write_no_wait, t);
9ba136d0
KH
647}
648
5a3c2be6 649static void sbp2_release_target(struct kref *kref)
b3d6e151 650{
5a3c2be6
SR
651 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
652 struct sbp2_logical_unit *lu, *next;
653 struct Scsi_Host *shost =
654 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
655
656 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
657 if (lu->sdev)
658 scsi_remove_device(lu->sdev);
659
be6f48b0
SR
660 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
661 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
4dccd020 662
5a3c2be6
SR
663 fw_core_remove_address_handler(&lu->address_handler);
664 list_del(&lu->link);
665 kfree(lu);
666 }
667 scsi_remove_host(shost);
48f18c76 668 fw_notify("released %s\n", tgt->bus_id);
5a3c2be6
SR
669
670 put_device(&tgt->unit->device);
671 scsi_host_put(shost);
b3d6e151
KH
672}
673
df8ec249
SR
674static struct workqueue_struct *sbp2_wq;
675
285838eb
SR
676/*
677 * Always get the target's kref when scheduling work on one its units.
678 * Each workqueue job is responsible to call sbp2_target_put() upon return.
679 */
680static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
681{
682 if (queue_delayed_work(sbp2_wq, &lu->work, delay))
683 kref_get(&lu->tgt->kref);
684}
685
686static void sbp2_target_put(struct sbp2_target *tgt)
687{
688 kref_put(&tgt->kref, sbp2_release_target);
689}
690
5a3c2be6
SR
691static void sbp2_reconnect(struct work_struct *work);
692
7f37c426
KH
693static void sbp2_login(struct work_struct *work)
694{
5a3c2be6
SR
695 struct sbp2_logical_unit *lu =
696 container_of(work, struct sbp2_logical_unit, work.work);
48f18c76
SR
697 struct sbp2_target *tgt = lu->tgt;
698 struct fw_device *device = fw_device(tgt->unit->device.parent);
699 struct Scsi_Host *shost;
5a3c2be6
SR
700 struct scsi_device *sdev;
701 struct scsi_lun eight_bytes_lun;
7f37c426 702 struct sbp2_login_response response;
5a3c2be6 703 int generation, node_id, local_node_id;
7f37c426 704
be6f48b0
SR
705 if (fw_device_is_shutdown(device))
706 goto out;
707
5a8a1bcd 708 generation = device->generation;
b5d2a5e0 709 smp_rmb(); /* node_id must not be older than generation */
5a8a1bcd
SR
710 node_id = device->node_id;
711 local_node_id = device->card->node_id;
7f37c426 712
5a3c2be6
SR
713 if (sbp2_send_management_orb(lu, node_id, generation,
714 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
285838eb
SR
715 if (lu->retries++ < 5)
716 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
717 else
48f18c76
SR
718 fw_error("%s: failed to login to LUN %04x\n",
719 tgt->bus_id, lu->lun);
285838eb 720 goto out;
7f37c426
KH
721 }
722
48f18c76
SR
723 lu->generation = generation;
724 tgt->node_id = node_id;
725 tgt->address_high = local_node_id << 16;
7f37c426
KH
726
727 /* Get command block agent offset and login id. */
5a3c2be6 728 lu->command_block_agent_address =
5c5539d8 729 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
7f37c426 730 response.command_block_agent.low;
5a3c2be6 731 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
7f37c426 732
48f18c76
SR
733 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
734 tgt->bus_id, lu->lun, lu->retries);
7f37c426
KH
735
736#if 0
737 /* FIXME: The linux1394 sbp2 does this last step. */
738 sbp2_set_busy_timeout(scsi_id);
739#endif
740
5a3c2be6
SR
741 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
742 sbp2_agent_reset(lu);
743
0fa6dfdb
SR
744 /* This was a re-login. */
745 if (lu->sdev) {
746 sbp2_cancel_orbs(lu);
747 goto out;
748 }
749
9220f194
SR
750 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
751 ssleep(SBP2_INQUIRY_DELAY);
752
5a3c2be6
SR
753 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
754 eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
755 eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
48f18c76 756 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
7f37c426 757
5a3c2be6
SR
758 sdev = __scsi_add_device(shost, 0, 0,
759 scsilun_to_int(&eight_bytes_lun), lu);
760 if (IS_ERR(sdev)) {
1b9c12ba
SR
761 smp_rmb(); /* generation may have changed */
762 generation = device->generation;
763 smp_rmb(); /* node_id must not be older than generation */
764
765 sbp2_send_management_orb(lu, device->node_id, generation,
5a3c2be6 766 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
c781c06d
KH
767 /*
768 * Set this back to sbp2_login so we fall back and
769 * retry login on bus reset.
770 */
5a3c2be6
SR
771 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
772 } else {
773 lu->sdev = sdev;
774 scsi_device_put(sdev);
7f37c426 775 }
285838eb 776 out:
48f18c76 777 sbp2_target_put(tgt);
7f37c426 778}
9ba136d0 779
5a3c2be6 780static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
9ba136d0 781{
5a3c2be6 782 struct sbp2_logical_unit *lu;
9ba136d0 783
5a3c2be6
SR
784 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
785 if (!lu)
786 return -ENOMEM;
9ba136d0 787
5a3c2be6
SR
788 lu->address_handler.length = 0x100;
789 lu->address_handler.address_callback = sbp2_status_write;
790 lu->address_handler.callback_data = lu;
9ba136d0 791
5a3c2be6
SR
792 if (fw_core_add_address_handler(&lu->address_handler,
793 &fw_high_memory_region) < 0) {
794 kfree(lu);
795 return -ENOMEM;
796 }
9ba136d0 797
5a3c2be6
SR
798 lu->tgt = tgt;
799 lu->sdev = NULL;
800 lu->lun = lun_entry & 0xffff;
801 lu->retries = 0;
802 INIT_LIST_HEAD(&lu->orb_list);
803 INIT_DELAYED_WORK(&lu->work, sbp2_login);
9ba136d0 804
5a3c2be6
SR
805 list_add_tail(&lu->link, &tgt->lu_list);
806 return 0;
807}
ad85274f 808
5a3c2be6
SR
809static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
810{
811 struct fw_csr_iterator ci;
812 int key, value;
9ba136d0 813
5a3c2be6
SR
814 fw_csr_iterator_init(&ci, directory);
815 while (fw_csr_iterator_next(&ci, &key, &value))
816 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
817 sbp2_add_logical_unit(tgt, value) < 0)
818 return -ENOMEM;
819 return 0;
820}
821
822static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
823 u32 *model, u32 *firmware_revision)
824{
825 struct fw_csr_iterator ci;
826 int key, value;
384170da 827 unsigned int timeout;
5a3c2be6
SR
828
829 fw_csr_iterator_init(&ci, directory);
9ba136d0
KH
830 while (fw_csr_iterator_next(&ci, &key, &value)) {
831 switch (key) {
5a3c2be6 832
9ba136d0 833 case CSR_DEPENDENT_INFO | CSR_OFFSET:
5a3c2be6
SR
834 tgt->management_agent_address =
835 CSR_REGISTER_BASE + 4 * value;
9ba136d0 836 break;
5a3c2be6
SR
837
838 case CSR_DIRECTORY_ID:
839 tgt->directory_id = value;
9ba136d0 840 break;
5a3c2be6 841
9ba136d0 842 case CSR_MODEL:
5a3c2be6
SR
843 *model = value;
844 break;
845
846 case SBP2_CSR_FIRMWARE_REVISION:
847 *firmware_revision = value;
848 break;
849
384170da
JW
850 case SBP2_CSR_UNIT_CHARACTERISTICS:
851 /* the timeout value is stored in 500ms units */
852 timeout = ((unsigned int) value >> 8 & 0xff) * 500;
853 timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
854 tgt->mgt_orb_timeout =
855 min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
856
857 if (timeout > tgt->mgt_orb_timeout)
858 fw_notify("%s: config rom contains %ds "
859 "management ORB timeout, limiting "
48f18c76 860 "to %ds\n", tgt->bus_id,
384170da
JW
861 timeout / 1000,
862 tgt->mgt_orb_timeout / 1000);
863 break;
864
5a3c2be6
SR
865 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
866 if (sbp2_add_logical_unit(tgt, value) < 0)
867 return -ENOMEM;
868 break;
869
870 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
871 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
872 return -ENOMEM;
9ba136d0
KH
873 break;
874 }
875 }
5a3c2be6
SR
876 return 0;
877}
878
879static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
880 u32 firmware_revision)
881{
882 int i;
05cca738 883 unsigned int w = sbp2_param_workarounds;
2df222b8
SR
884
885 if (w)
886 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
887 "if you need the workarounds parameter for %s\n",
48f18c76 888 tgt->bus_id);
5a3c2be6 889
2df222b8
SR
890 if (w & SBP2_WORKAROUND_OVERRIDE)
891 goto out;
9ba136d0
KH
892
893 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
5a3c2be6 894
9ba136d0
KH
895 if (sbp2_workarounds_table[i].firmware_revision !=
896 (firmware_revision & 0xffffff00))
897 continue;
5a3c2be6 898
9ba136d0
KH
899 if (sbp2_workarounds_table[i].model != model &&
900 sbp2_workarounds_table[i].model != ~0)
901 continue;
5a3c2be6 902
2df222b8 903 w |= sbp2_workarounds_table[i].workarounds;
9ba136d0
KH
904 break;
905 }
2df222b8
SR
906 out:
907 if (w)
5a3c2be6 908 fw_notify("Workarounds for %s: 0x%x "
9ba136d0 909 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
48f18c76 910 tgt->bus_id, w, firmware_revision, model);
2df222b8 911 tgt->workarounds = w;
5a3c2be6
SR
912}
913
914static struct scsi_host_template scsi_driver_template;
915
916static int sbp2_probe(struct device *dev)
917{
918 struct fw_unit *unit = fw_unit(dev);
919 struct fw_device *device = fw_device(unit->device.parent);
920 struct sbp2_target *tgt;
921 struct sbp2_logical_unit *lu;
922 struct Scsi_Host *shost;
923 u32 model, firmware_revision;
924
925 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
926 if (shost == NULL)
927 return -ENOMEM;
928
929 tgt = (struct sbp2_target *)shost->hostdata;
930 unit->device.driver_data = tgt;
931 tgt->unit = unit;
932 kref_init(&tgt->kref);
933 INIT_LIST_HEAD(&tgt->lu_list);
48f18c76 934 tgt->bus_id = unit->device.bus_id;
5a3c2be6
SR
935
936 if (fw_device_enable_phys_dma(device) < 0)
937 goto fail_shost_put;
938
939 if (scsi_add_host(shost, &unit->device) < 0)
940 goto fail_shost_put;
941
942 /* Initialize to values that won't match anything in our table. */
943 firmware_revision = 0xff000000;
944 model = 0xff000000;
945
946 /* implicit directory ID */
947 tgt->directory_id = ((unit->directory - device->config_rom) * 4
948 + CSR_CONFIG_ROM) & 0xffffff;
949
950 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
951 &firmware_revision) < 0)
952 goto fail_tgt_put;
953
954 sbp2_init_workarounds(tgt, model, firmware_revision);
9ba136d0 955
b3d6e151
KH
956 get_device(&unit->device);
957
285838eb 958 /* Do the login in a workqueue so we can easily reschedule retries. */
5a3c2be6 959 list_for_each_entry(lu, &tgt->lu_list, link)
285838eb 960 sbp2_queue_work(lu, 0);
9ba136d0 961 return 0;
ad85274f 962
5a3c2be6 963 fail_tgt_put:
285838eb 964 sbp2_target_put(tgt);
5a3c2be6
SR
965 return -ENOMEM;
966
967 fail_shost_put:
968 scsi_host_put(shost);
969 return -ENOMEM;
9ba136d0
KH
970}
971
972static int sbp2_remove(struct device *dev)
973{
974 struct fw_unit *unit = fw_unit(dev);
5a3c2be6 975 struct sbp2_target *tgt = unit->device.driver_data;
9ba136d0 976
285838eb 977 sbp2_target_put(tgt);
9ba136d0
KH
978 return 0;
979}
980
981static void sbp2_reconnect(struct work_struct *work)
982{
5a3c2be6
SR
983 struct sbp2_logical_unit *lu =
984 container_of(work, struct sbp2_logical_unit, work.work);
48f18c76
SR
985 struct sbp2_target *tgt = lu->tgt;
986 struct fw_device *device = fw_device(tgt->unit->device.parent);
9ba136d0
KH
987 int generation, node_id, local_node_id;
988
be6f48b0
SR
989 if (fw_device_is_shutdown(device))
990 goto out;
991
5a8a1bcd 992 generation = device->generation;
b5d2a5e0 993 smp_rmb(); /* node_id must not be older than generation */
5a8a1bcd
SR
994 node_id = device->node_id;
995 local_node_id = device->card->node_id;
9ba136d0 996
5a3c2be6 997 if (sbp2_send_management_orb(lu, node_id, generation,
7f37c426 998 SBP2_RECONNECT_REQUEST,
5a3c2be6
SR
999 lu->login_id, NULL) < 0) {
1000 if (lu->retries++ >= 5) {
48f18c76 1001 fw_error("%s: failed to reconnect\n", tgt->bus_id);
7f37c426 1002 /* Fall back and try to log in again. */
5a3c2be6
SR
1003 lu->retries = 0;
1004 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
7f37c426 1005 }
285838eb
SR
1006 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1007 goto out;
7f37c426 1008 }
9ba136d0 1009
48f18c76
SR
1010 lu->generation = generation;
1011 tgt->node_id = node_id;
1012 tgt->address_high = local_node_id << 16;
7f37c426 1013
48f18c76
SR
1014 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1015 tgt->bus_id, lu->lun, lu->retries);
5a3c2be6
SR
1016
1017 sbp2_agent_reset(lu);
1018 sbp2_cancel_orbs(lu);
285838eb 1019 out:
48f18c76 1020 sbp2_target_put(tgt);
9ba136d0
KH
1021}
1022
1023static void sbp2_update(struct fw_unit *unit)
1024{
5a3c2be6
SR
1025 struct sbp2_target *tgt = unit->device.driver_data;
1026 struct sbp2_logical_unit *lu;
9ba136d0 1027
5a3c2be6
SR
1028 fw_device_enable_phys_dma(fw_device(unit->device.parent));
1029
1030 /*
1031 * Fw-core serializes sbp2_update() against sbp2_remove().
1032 * Iteration over tgt->lu_list is therefore safe here.
1033 */
1034 list_for_each_entry(lu, &tgt->lu_list, link) {
1035 lu->retries = 0;
285838eb 1036 sbp2_queue_work(lu, 0);
5a3c2be6 1037 }
9ba136d0
KH
1038}
1039
1040#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1041#define SBP2_SW_VERSION_ENTRY 0x00010483
1042
21ebcd12 1043static const struct fw_device_id sbp2_id_table[] = {
9ba136d0
KH
1044 {
1045 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
1046 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
5af4e5ea 1047 .version = SBP2_SW_VERSION_ENTRY,
9ba136d0
KH
1048 },
1049 { }
1050};
1051
1052static struct fw_driver sbp2_driver = {
1053 .driver = {
1054 .owner = THIS_MODULE,
1055 .name = sbp2_driver_name,
1056 .bus = &fw_bus_type,
1057 .probe = sbp2_probe,
1058 .remove = sbp2_remove,
1059 },
1060 .update = sbp2_update,
1061 .id_table = sbp2_id_table,
1062};
1063
fbb5423c
KH
1064static unsigned int
1065sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
9ba136d0 1066{
fbb5423c
KH
1067 int sam_status;
1068
9ba136d0
KH
1069 sense_data[0] = 0x70;
1070 sense_data[1] = 0x0;
1071 sense_data[2] = sbp2_status[1];
1072 sense_data[3] = sbp2_status[4];
1073 sense_data[4] = sbp2_status[5];
1074 sense_data[5] = sbp2_status[6];
1075 sense_data[6] = sbp2_status[7];
1076 sense_data[7] = 10;
1077 sense_data[8] = sbp2_status[8];
1078 sense_data[9] = sbp2_status[9];
1079 sense_data[10] = sbp2_status[10];
1080 sense_data[11] = sbp2_status[11];
1081 sense_data[12] = sbp2_status[2];
1082 sense_data[13] = sbp2_status[3];
1083 sense_data[14] = sbp2_status[12];
1084 sense_data[15] = sbp2_status[13];
1085
fbb5423c 1086 sam_status = sbp2_status[0] & 0x3f;
9ba136d0 1087
fbb5423c
KH
1088 switch (sam_status) {
1089 case SAM_STAT_GOOD:
9ba136d0 1090 case SAM_STAT_CHECK_CONDITION:
9ba136d0 1091 case SAM_STAT_CONDITION_MET:
fbb5423c 1092 case SAM_STAT_BUSY:
9ba136d0
KH
1093 case SAM_STAT_RESERVATION_CONFLICT:
1094 case SAM_STAT_COMMAND_TERMINATED:
fbb5423c
KH
1095 return DID_OK << 16 | sam_status;
1096
9ba136d0 1097 default:
fbb5423c 1098 return DID_ERROR << 16;
9ba136d0
KH
1099 }
1100}
1101
1102static void
1103complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1104{
6f061487
JF
1105 struct sbp2_command_orb *orb =
1106 container_of(base_orb, struct sbp2_command_orb, base);
5a3c2be6 1107 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
9ba136d0
KH
1108 int result;
1109
1110 if (status != NULL) {
a77754a7 1111 if (STATUS_GET_DEAD(*status))
e0e60215 1112 sbp2_agent_reset_no_wait(orb->lu);
9ba136d0 1113
a77754a7 1114 switch (STATUS_GET_RESPONSE(*status)) {
9ba136d0 1115 case SBP2_STATUS_REQUEST_COMPLETE:
fbb5423c 1116 result = DID_OK << 16;
9ba136d0
KH
1117 break;
1118 case SBP2_STATUS_TRANSPORT_FAILURE:
fbb5423c 1119 result = DID_BUS_BUSY << 16;
9ba136d0
KH
1120 break;
1121 case SBP2_STATUS_ILLEGAL_REQUEST:
1122 case SBP2_STATUS_VENDOR_DEPENDENT:
1123 default:
fbb5423c 1124 result = DID_ERROR << 16;
9ba136d0
KH
1125 break;
1126 }
1127
a77754a7
KH
1128 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1129 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
9ba136d0
KH
1130 orb->cmd->sense_buffer);
1131 } else {
c781c06d
KH
1132 /*
1133 * If the orb completes with status == NULL, something
9ba136d0 1134 * went wrong, typically a bus reset happened mid-orb
c781c06d
KH
1135 * or when sending the write (less likely).
1136 */
fbb5423c 1137 result = DID_BUS_BUSY << 16;
9ba136d0
KH
1138 }
1139
1140 dma_unmap_single(device->card->device, orb->base.request_bus,
2d826cc5 1141 sizeof(orb->request), DMA_TO_DEVICE);
9ba136d0 1142
412edf65
SR
1143 if (scsi_sg_count(orb->cmd) > 0)
1144 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1145 scsi_sg_count(orb->cmd),
9ba136d0 1146 orb->cmd->sc_data_direction);
9ba136d0
KH
1147
1148 if (orb->page_table_bus != 0)
1149 dma_unmap_single(device->card->device, orb->page_table_bus,
b4be016a 1150 sizeof(orb->page_table), DMA_TO_DEVICE);
9ba136d0 1151
fbb5423c 1152 orb->cmd->result = result;
9ba136d0 1153 orb->done(orb->cmd);
9ba136d0
KH
1154}
1155
5a3c2be6
SR
1156static int
1157sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1158 struct sbp2_logical_unit *lu)
9ba136d0 1159{
9ba136d0
KH
1160 struct scatterlist *sg;
1161 int sg_len, l, i, j, count;
9ba136d0
KH
1162 dma_addr_t sg_addr;
1163
412edf65
SR
1164 sg = scsi_sglist(orb->cmd);
1165 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
9ba136d0 1166 orb->cmd->sc_data_direction);
95ffc5e3
KH
1167 if (count == 0)
1168 goto fail;
9ba136d0 1169
c781c06d
KH
1170 /*
1171 * Handle the special case where there is only one element in
9ba136d0
KH
1172 * the scatter list by converting it to an immediate block
1173 * request. This is also a workaround for broken devices such
1174 * as the second generation iPod which doesn't support page
c781c06d
KH
1175 * tables.
1176 */
9ba136d0 1177 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
5a3c2be6 1178 orb->request.data_descriptor.high = lu->tgt->address_high;
9ba136d0 1179 orb->request.data_descriptor.low = sg_dma_address(sg);
5a3c2be6 1180 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
95ffc5e3 1181 return 0;
9ba136d0
KH
1182 }
1183
c781c06d
KH
1184 /*
1185 * Convert the scatterlist to an sbp2 page table. If any
36abb3b1
KHSR
1186 * scatterlist entries are too big for sbp2, we split them as we
1187 * go. Even if we ask the block I/O layer to not give us sg
1188 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1189 * during DMA mapping, and Linux currently doesn't prevent this.
c781c06d 1190 */
b7811da2
SR
1191 for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
1192 sg_len = sg_dma_len(sg);
1193 sg_addr = sg_dma_address(sg);
9ba136d0 1194 while (sg_len) {
332ef331
SR
1195 /* FIXME: This won't get us out of the pinch. */
1196 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1197 fw_error("page table overflow\n");
1198 goto fail_page_table;
1199 }
9ba136d0
KH
1200 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1201 orb->page_table[j].low = sg_addr;
1202 orb->page_table[j].high = (l << 16);
1203 sg_addr += l;
1204 sg_len -= l;
1205 j++;
1206 }
1207 }
1208
b4be016a
SR
1209 fw_memcpy_to_be32(orb->page_table, orb->page_table,
1210 sizeof(orb->page_table[0]) * j);
1211 orb->page_table_bus =
1212 dma_map_single(device->card->device, orb->page_table,
1213 sizeof(orb->page_table), DMA_TO_DEVICE);
1214 if (dma_mapping_error(orb->page_table_bus))
1215 goto fail_page_table;
9ba136d0 1216
c781c06d
KH
1217 /*
1218 * The data_descriptor pointer is the one case where we need
9ba136d0
KH
1219 * to fill in the node ID part of the address. All other
1220 * pointers assume that the data referenced reside on the
1221 * initiator (i.e. us), but data_descriptor can refer to data
c781c06d
KH
1222 * on other nodes so we need to put our ID in descriptor.high.
1223 */
5a3c2be6 1224 orb->request.data_descriptor.high = lu->tgt->address_high;
9ba136d0
KH
1225 orb->request.data_descriptor.low = orb->page_table_bus;
1226 orb->request.misc |=
a77754a7
KH
1227 COMMAND_ORB_PAGE_TABLE_PRESENT |
1228 COMMAND_ORB_DATA_SIZE(j);
9ba136d0 1229
95ffc5e3
KH
1230 return 0;
1231
1232 fail_page_table:
412edf65 1233 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
95ffc5e3
KH
1234 orb->cmd->sc_data_direction);
1235 fail:
1236 return -ENOMEM;
9ba136d0
KH
1237}
1238
9ba136d0
KH
1239/* SCSI stack integration */
1240
1241static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1242{
5a3c2be6
SR
1243 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1244 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
9ba136d0 1245 struct sbp2_command_orb *orb;
05cca738 1246 unsigned int max_payload;
5a3c2be6 1247 int retval = SCSI_MLQUEUE_HOST_BUSY;
9ba136d0 1248
c781c06d
KH
1249 /*
1250 * Bidirectional commands are not yet implemented, and unknown
1251 * transfer direction not handled.
1252 */
9ba136d0 1253 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
8a8cea27 1254 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
e1b68c4d
KH
1255 cmd->result = DID_ERROR << 16;
1256 done(cmd);
1257 return 0;
9ba136d0
KH
1258 }
1259
2d826cc5 1260 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
9ba136d0
KH
1261 if (orb == NULL) {
1262 fw_notify("failed to alloc orb\n");
5a3c2be6 1263 return SCSI_MLQUEUE_HOST_BUSY;
9ba136d0
KH
1264 }
1265
12f26aa1
KH
1266 /* Initialize rcode to something not RCODE_COMPLETE. */
1267 orb->base.rcode = -1;
e57d2011 1268 kref_init(&orb->base.kref);
9ba136d0 1269
5a3c2be6 1270 orb->lu = lu;
9ba136d0
KH
1271 orb->done = done;
1272 orb->cmd = cmd;
1273
1274 orb->request.next.high = SBP2_ORB_NULL;
1275 orb->request.next.low = 0x0;
c781c06d
KH
1276 /*
1277 * At speed 100 we can do 512 bytes per packet, at speed 200,
9ba136d0
KH
1278 * 1024 bytes per packet etc. The SBP-2 max_payload field
1279 * specifies the max payload size as 2 ^ (max_payload + 2), so
c781c06d
KH
1280 * if we set this to max_speed + 7, we get the right value.
1281 */
25659f71
SR
1282 max_payload = min(device->max_speed + 7,
1283 device->card->max_receive - 1);
9ba136d0 1284 orb->request.misc =
25659f71 1285 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
f1397490 1286 COMMAND_ORB_SPEED(device->max_speed) |
a77754a7 1287 COMMAND_ORB_NOTIFY;
9ba136d0
KH
1288
1289 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1290 orb->request.misc |=
a77754a7 1291 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
9ba136d0
KH
1292 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1293 orb->request.misc |=
a77754a7 1294 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
9ba136d0 1295
5a3c2be6
SR
1296 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1297 goto out;
9ba136d0 1298
2d826cc5 1299 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
9ba136d0
KH
1300
1301 memset(orb->request.command_block,
2d826cc5 1302 0, sizeof(orb->request.command_block));
9ba136d0
KH
1303 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1304
1305 orb->base.callback = complete_command_orb;
8526392a
SR
1306 orb->base.request_bus =
1307 dma_map_single(device->card->device, &orb->request,
1308 sizeof(orb->request), DMA_TO_DEVICE);
1309 if (dma_mapping_error(orb->base.request_bus))
5a3c2be6 1310 goto out;
82eff9db 1311
5a3c2be6
SR
1312 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1313 lu->command_block_agent_address + SBP2_ORB_POINTER);
1314 retval = 0;
1315 out:
e57d2011 1316 kref_put(&orb->base.kref, free_orb);
5a3c2be6 1317 return retval;
9ba136d0
KH
1318}
1319
cfb01381
SR
1320static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1321{
5a3c2be6 1322 struct sbp2_logical_unit *lu = sdev->hostdata;
cfb01381
SR
1323
1324 sdev->allow_restart = 1;
1325
465ff318
JB
1326 /*
1327 * Update the dma alignment (minimum alignment requirements for
1328 * start and end of DMA transfers) to be a sector
1329 */
1330 blk_queue_update_dma_alignment(sdev->request_queue, 511);
1331
5a3c2be6 1332 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
cfb01381 1333 sdev->inquiry_len = 36;
5a3c2be6 1334
cfb01381
SR
1335 return 0;
1336}
1337
9ba136d0
KH
1338static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1339{
5a3c2be6 1340 struct sbp2_logical_unit *lu = sdev->hostdata;
9ba136d0 1341
cfb01381
SR
1342 sdev->use_10_for_rw = 1;
1343
1344 if (sdev->type == TYPE_ROM)
1345 sdev->use_10_for_ms = 1;
5a3c2be6 1346
9ba136d0 1347 if (sdev->type == TYPE_DISK &&
5a3c2be6 1348 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
9ba136d0 1349 sdev->skip_ms_page_8 = 1;
5a3c2be6
SR
1350
1351 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
9ba136d0 1352 sdev->fix_capacity = 1;
5a3c2be6
SR
1353
1354 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
cf47c7a2 1355 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
5a3c2be6 1356
9ba136d0
KH
1357 return 0;
1358}
1359
1360/*
1361 * Called by scsi stack when something has really gone wrong. Usually
1362 * called when a command has timed-out for some reason.
1363 */
1364static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1365{
5a3c2be6 1366 struct sbp2_logical_unit *lu = cmd->device->hostdata;
9ba136d0 1367
48f18c76 1368 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
5a3c2be6
SR
1369 sbp2_agent_reset(lu);
1370 sbp2_cancel_orbs(lu);
9ba136d0
KH
1371
1372 return SUCCESS;
1373}
1374
14e21986
SR
1375/*
1376 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1377 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1378 *
1379 * This is the concatenation of target port identifier and logical unit
1380 * identifier as per SAM-2...SAM-4 annex A.
1381 */
1382static ssize_t
1383sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1384 char *buf)
1385{
1386 struct scsi_device *sdev = to_scsi_device(dev);
5a3c2be6 1387 struct sbp2_logical_unit *lu;
14e21986 1388 struct fw_device *device;
14e21986
SR
1389
1390 if (!sdev)
1391 return 0;
14e21986 1392
5a3c2be6
SR
1393 lu = sdev->hostdata;
1394 device = fw_device(lu->tgt->unit->device.parent);
14e21986
SR
1395
1396 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1397 device->config_rom[3], device->config_rom[4],
5a3c2be6 1398 lu->tgt->directory_id, lu->lun);
14e21986
SR
1399}
1400
1401static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1402
1403static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1404 &dev_attr_ieee1394_id,
1405 NULL
1406};
1407
9ba136d0
KH
1408static struct scsi_host_template scsi_driver_template = {
1409 .module = THIS_MODULE,
1410 .name = "SBP-2 IEEE-1394",
b02b6bc4 1411 .proc_name = sbp2_driver_name,
9ba136d0 1412 .queuecommand = sbp2_scsi_queuecommand,
cfb01381 1413 .slave_alloc = sbp2_scsi_slave_alloc,
9ba136d0
KH
1414 .slave_configure = sbp2_scsi_slave_configure,
1415 .eh_abort_handler = sbp2_scsi_abort,
1416 .this_id = -1,
1417 .sg_tablesize = SG_ALL,
1418 .use_clustering = ENABLE_CLUSTERING,
02af8e70
SR
1419 .cmd_per_lun = 1,
1420 .can_queue = 1,
14e21986 1421 .sdev_attrs = sbp2_scsi_sysfs_attrs,
9ba136d0
KH
1422};
1423
9ba136d0
KH
1424MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1425MODULE_DESCRIPTION("SCSI over IEEE1394");
1426MODULE_LICENSE("GPL");
1427MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1428
1e4c7b0d
OH
1429/* Provide a module alias so root-on-sbp2 initrds don't break. */
1430#ifndef CONFIG_IEEE1394_SBP2_MODULE
1431MODULE_ALIAS("sbp2");
1432#endif
1433
9ba136d0
KH
1434static int __init sbp2_init(void)
1435{
df8ec249
SR
1436 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1437 if (!sbp2_wq)
1438 return -ENOMEM;
1439
9ba136d0
KH
1440 return driver_register(&sbp2_driver.driver);
1441}
1442
1443static void __exit sbp2_cleanup(void)
1444{
1445 driver_unregister(&sbp2_driver.driver);
df8ec249 1446 destroy_workqueue(sbp2_wq);
9ba136d0
KH
1447}
1448
1449module_init(sbp2_init);
1450module_exit(sbp2_cleanup);
This page took 0.197083 seconds and 5 git commands to generate.