blob: a15e3c7d21d3d80886702e3ec5b36e64cdb449ee [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * SBP2 driver (SCSI over IEEE1394)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05003 *
Kristian Høgsberg27a15e52007-02-06 14:49:39 -05004 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05005 *
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
Kristian Høgsbergc781c062007-05-07 20:33:32 -040021/*
22 * The basic structure of this driver is based on the old storage driver,
Kristian Høgsberg27a15e52007-02-06 14:49:39 -050023 * 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
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050031#include <linux/kernel.h>
32#include <linux/module.h>
Stefan Richter5cd54c92007-06-17 23:55:41 +020033#include <linux/moduleparam.h>
Stefan Richterfe69ca32006-12-28 12:46:54 +010034#include <linux/mod_devicetable.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050035#include <linux/device.h>
Andrew Morton0b5b2902006-12-27 14:49:23 -080036#include <linux/scatterlist.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050037#include <linux/dma-mapping.h>
Stefan Richtercf47c7a2007-06-17 23:52:08 +020038#include <linux/blkdev.h>
Stefan Richtere7cdf232007-07-01 13:54:57 +020039#include <linux/string.h>
Stefan Richter2df222b2007-08-13 17:48:25 +020040#include <linux/stringify.h>
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -050041#include <linux/timer.h>
Stefan Richterdf8ec242007-08-12 12:51:18 +020042#include <linux/workqueue.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010043#include <asm/system.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050044
45#include <scsi/scsi.h>
46#include <scsi/scsi_cmnd.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050047#include <scsi/scsi_device.h>
48#include <scsi/scsi_host.h>
49
50#include "fw-transaction.h"
51#include "fw-topology.h"
52#include "fw-device.h"
53
Stefan Richter5cd54c92007-06-17 23:55:41 +020054/*
55 * So far only bridges from Oxford Semiconductor are known to support
56 * concurrent logins. Depending on firmware, four or two concurrent logins
57 * are possible on OXFW911 and newer Oxsemi bridges.
58 *
59 * Concurrent logins are useful together with cluster filesystems.
60 */
61static int sbp2_param_exclusive_login = 1;
62module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
63MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
64 "(default = Y, use N for concurrent initiators)");
65
Stefan Richter2df222b2007-08-13 17:48:25 +020066/*
67 * Flags for firmware oddities
68 *
69 * - 128kB max transfer
70 * Limit transfer size. Necessary for some old bridges.
71 *
72 * - 36 byte inquiry
73 * When scsi_mod probes the device, let the inquiry command look like that
74 * from MS Windows.
75 *
76 * - skip mode page 8
77 * Suppress sending of mode_sense for mode page 8 if the device pretends to
78 * support the SCSI Primary Block commands instead of Reduced Block Commands.
79 *
80 * - fix capacity
81 * Tell sd_mod to correct the last sector number reported by read_capacity.
82 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
83 * Don't use this with devices which don't have this bug.
84 *
85 * - override internal blacklist
86 * Instead of adding to the built-in blacklist, use only the workarounds
87 * specified in the module load parameter.
88 * Useful if a blacklist entry interfered with a non-broken device.
89 */
90#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
91#define SBP2_WORKAROUND_INQUIRY_36 0x2
92#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
93#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
94#define SBP2_WORKAROUND_OVERRIDE 0x100
95
96static int sbp2_param_workarounds;
97module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
98MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
99 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
100 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
101 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
102 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
103 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
104 ", or a combination)");
105
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500106/* I don't know why the SCSI stack doesn't define something like this... */
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400107typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500108
109static const char sbp2_driver_name[] = "sbp2";
110
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200111/*
112 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
113 * and one struct scsi_device per sbp2_logical_unit.
114 */
115struct sbp2_logical_unit {
116 struct sbp2_target *tgt;
117 struct list_head link;
118 struct scsi_device *sdev;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500119 struct fw_address_handler address_handler;
120 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200121
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500122 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200123 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500124 int login_id;
125
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400126 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200127 * The generation is updated once we've logged in or reconnected
128 * to the logical unit. Thus, I/O to the device will automatically
129 * fail and get retried if it happens in a window where the device
130 * is not ready, e.g. after a bus reset but before we reconnect.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400131 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500132 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500133 int retries;
134 struct delayed_work work;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500135};
136
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200137/*
138 * We create one struct sbp2_target per IEEE 1212 Unit Directory
139 * and one struct Scsi_Host per sbp2_target.
140 */
141struct sbp2_target {
142 struct kref kref;
143 struct fw_unit *unit;
Stefan Richter05cca732008-01-26 17:42:45 +0100144 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200145
146 u64 management_agent_address;
147 int directory_id;
148 int node_id;
149 int address_high;
Stefan Richter05cca732008-01-26 17:42:45 +0100150 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500151 unsigned int mgt_orb_timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200152};
153
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100154/*
155 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
Jarod Wilson384170d2008-01-25 23:31:12 -0500156 * provided in the config rom. Most devices do provide a value, which
157 * we'll use for login management orbs, but with some sane limits.
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100158 */
Jarod Wilson384170d2008-01-25 23:31:12 -0500159#define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
160#define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
Stefan Richter05cca732008-01-26 17:42:45 +0100161#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500162#define SBP2_ORB_NULL 0x80000000
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100163#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500164
165#define SBP2_DIRECTION_TO_MEDIA 0x0
166#define SBP2_DIRECTION_FROM_MEDIA 0x1
167
168/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500169#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200170#define SBP2_CSR_FIRMWARE_REVISION 0x3c
171#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
172#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500173
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500174/* Management orb opcodes */
175#define SBP2_LOGIN_REQUEST 0x0
176#define SBP2_QUERY_LOGINS_REQUEST 0x1
177#define SBP2_RECONNECT_REQUEST 0x3
178#define SBP2_SET_PASSWORD_REQUEST 0x4
179#define SBP2_LOGOUT_REQUEST 0x7
180#define SBP2_ABORT_TASK_REQUEST 0xb
181#define SBP2_ABORT_TASK_SET 0xc
182#define SBP2_LOGICAL_UNIT_RESET 0xe
183#define SBP2_TARGET_RESET_REQUEST 0xf
184
185/* Offsets for command block agent registers */
186#define SBP2_AGENT_STATE 0x00
187#define SBP2_AGENT_RESET 0x04
188#define SBP2_ORB_POINTER 0x08
189#define SBP2_DOORBELL 0x10
190#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
191
192/* Status write response codes */
193#define SBP2_STATUS_REQUEST_COMPLETE 0x0
194#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
195#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
196#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
197
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400198#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
199#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
200#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
201#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
202#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
203#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
204#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
205#define STATUS_GET_DATA(v) ((v).data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500206
207struct sbp2_status {
208 u32 status;
209 u32 orb_low;
210 u8 data[24];
211};
212
213struct sbp2_pointer {
214 u32 high;
215 u32 low;
216};
217
218struct sbp2_orb {
219 struct fw_transaction t;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400220 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500221 dma_addr_t request_bus;
222 int rcode;
223 struct sbp2_pointer pointer;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400224 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500225 struct list_head link;
226};
227
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400228#define MANAGEMENT_ORB_LUN(v) ((v))
229#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
230#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200231#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400232#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
233#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500234
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400235#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
236#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500237
238struct sbp2_management_orb {
239 struct sbp2_orb base;
240 struct {
241 struct sbp2_pointer password;
242 struct sbp2_pointer response;
243 u32 misc;
244 u32 length;
245 struct sbp2_pointer status_fifo;
246 } request;
247 __be32 response[4];
248 dma_addr_t response_bus;
249 struct completion done;
250 struct sbp2_status status;
251};
252
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400253#define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
254#define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500255
256struct sbp2_login_response {
257 u32 misc;
258 struct sbp2_pointer command_block_agent;
259 u32 reconnect_hold;
260};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400261#define COMMAND_ORB_DATA_SIZE(v) ((v))
262#define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
263#define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
264#define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
265#define COMMAND_ORB_SPEED(v) ((v) << 24)
266#define COMMAND_ORB_DIRECTION(v) ((v) << 27)
267#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
268#define COMMAND_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500269
270struct sbp2_command_orb {
271 struct sbp2_orb base;
272 struct {
273 struct sbp2_pointer next;
274 struct sbp2_pointer data_descriptor;
275 u32 misc;
276 u8 command_block[12];
277 } request;
278 struct scsi_cmnd *cmd;
279 scsi_done_fn_t done;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200280 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500281
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200282 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500283 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500284};
285
286/*
287 * List of devices with known bugs.
288 *
289 * The firmware_revision field, masked with 0xffff00, is the best
290 * indicator for the type of bridge chip of a device. It yields a few
291 * false positives but this did not break correctly behaving devices
292 * so far. We use ~0 as a wildcard, since the 24 bit values we get
293 * from the config rom can never match that.
294 */
295static const struct {
296 u32 firmware_revision;
297 u32 model;
Stefan Richter05cca732008-01-26 17:42:45 +0100298 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500299} sbp2_workarounds_table[] = {
300 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
301 .firmware_revision = 0x002800,
302 .model = 0x001010,
303 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
304 SBP2_WORKAROUND_MODE_SENSE_8,
305 },
306 /* Initio bridges, actually only needed for some older ones */ {
307 .firmware_revision = 0x000200,
308 .model = ~0,
309 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
310 },
311 /* Symbios bridge */ {
312 .firmware_revision = 0xa0b800,
313 .model = ~0,
314 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
315 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400316
317 /*
318 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500319 * these iPods do not feature the read_capacity bug according
320 * to one report. Read_capacity behaviour as well as model_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400321 * could change due to Apple-supplied firmware updates though.
322 */
323
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500324 /* iPod 4th generation. */ {
325 .firmware_revision = 0x0a2700,
326 .model = 0x000021,
327 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
328 },
329 /* iPod mini */ {
330 .firmware_revision = 0x0a2700,
331 .model = 0x000023,
332 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
333 },
334 /* iPod Photo */ {
335 .firmware_revision = 0x0a2700,
336 .model = 0x00007e,
337 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
338 }
339};
340
341static void
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400342free_orb(struct kref *kref)
343{
344 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
345
346 kfree(orb);
347}
348
349static void
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500350sbp2_status_write(struct fw_card *card, struct fw_request *request,
351 int tcode, int destination, int source,
352 int generation, int speed,
353 unsigned long long offset,
354 void *payload, size_t length, void *callback_data)
355{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200356 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500357 struct sbp2_orb *orb;
358 struct sbp2_status status;
359 size_t header_size;
360 unsigned long flags;
361
362 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400363 length == 0 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500364 fw_send_response(card, request, RCODE_TYPE_ERROR);
365 return;
366 }
367
368 header_size = min(length, 2 * sizeof(u32));
369 fw_memcpy_from_be32(&status, payload, header_size);
370 if (length > header_size)
371 memcpy(status.data, payload + 8, length - header_size);
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400372 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500373 fw_notify("non-orb related status write, not handled\n");
374 fw_send_response(card, request, RCODE_COMPLETE);
375 return;
376 }
377
378 /* Lookup the orb corresponding to this status write. */
379 spin_lock_irqsave(&card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200380 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400381 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400382 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
383 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500384 list_del(&orb->link);
385 break;
386 }
387 }
388 spin_unlock_irqrestore(&card->lock, flags);
389
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200390 if (&orb->link != &lu->orb_list)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500391 orb->callback(orb, &status);
392 else
393 fw_error("status write for unknown orb\n");
394
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400395 kref_put(&orb->kref, free_orb);
396
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500397 fw_send_response(card, request, RCODE_COMPLETE);
398}
399
400static void
401complete_transaction(struct fw_card *card, int rcode,
402 void *payload, size_t length, void *data)
403{
404 struct sbp2_orb *orb = data;
405 unsigned long flags;
406
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400407 /*
408 * This is a little tricky. We can get the status write for
409 * the orb before we get this callback. The status write
410 * handler above will assume the orb pointer transaction was
411 * successful and set the rcode to RCODE_COMPLETE for the orb.
412 * So this callback only sets the rcode if it hasn't already
413 * been set and only does the cleanup if the transaction
414 * failed and we didn't already get a status write.
415 */
416 spin_lock_irqsave(&card->lock, flags);
417
418 if (orb->rcode == -1)
419 orb->rcode = rcode;
420 if (orb->rcode != RCODE_COMPLETE) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500421 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200422 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500423 orb->callback(orb, NULL);
Stefan Richter1b34e972007-08-25 10:40:42 +0200424 } else {
425 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500426 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400427
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400428 kref_put(&orb->kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500429}
430
431static void
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200432sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500433 int node_id, int generation, u64 offset)
434{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200435 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500436 unsigned long flags;
437
438 orb->pointer.high = 0;
439 orb->pointer.low = orb->request_bus;
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400440 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500441
442 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200443 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500444 spin_unlock_irqrestore(&device->card->lock, flags);
445
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400446 /* Take a ref for the orb list and for the transaction callback. */
447 kref_get(&orb->kref);
448 kref_get(&orb->kref);
449
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500450 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200451 node_id, generation, device->max_speed, offset,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400452 &orb->pointer, sizeof(orb->pointer),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500453 complete_transaction, orb);
454}
455
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200456static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500457{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200458 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500459 struct sbp2_orb *orb, *next;
460 struct list_head list;
461 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500462 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500463
464 INIT_LIST_HEAD(&list);
465 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200466 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500467 spin_unlock_irqrestore(&device->card->lock, flags);
468
469 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500470 retval = 0;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500471 if (fw_cancel_transaction(device->card, &orb->t) == 0)
472 continue;
473
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500474 orb->rcode = RCODE_CANCELLED;
475 orb->callback(orb, NULL);
476 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500477
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500478 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500479}
480
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500481static void
482complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
483{
484 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400485 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500486
487 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400488 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500489 complete(&orb->done);
490}
491
492static int
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200493sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
494 int generation, int function, int lun_or_login_id,
495 void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500496{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200497 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500498 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100499 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500500 int retval = -ENOMEM;
501
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400502 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500503 if (orb == NULL)
504 return -ENOMEM;
505
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400506 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500507 orb->response_bus =
508 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400509 sizeof(orb->response), DMA_FROM_DEVICE);
Kristian Høgsberg82eff9d2007-02-06 14:49:40 -0500510 if (dma_mapping_error(orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200511 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500512
513 orb->request.response.high = 0;
514 orb->request.response.low = orb->response_bus;
515
516 orb->request.misc =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400517 MANAGEMENT_ORB_NOTIFY |
518 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200519 MANAGEMENT_ORB_LUN(lun_or_login_id);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500520 orb->request.length =
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400521 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500522
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200523 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
524 orb->request.status_fifo.low = lu->address_handler.offset;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500525
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500526 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100527 /* Ask for 2^2 == 4 seconds reconnect grace period */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500528 orb->request.misc |=
Stefan Richter14dc9922008-01-20 01:25:31 +0100529 MANAGEMENT_ORB_RECONNECT(2) |
530 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login);
Jarod Wilson384170d2008-01-25 23:31:12 -0500531 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100532 } else {
533 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500534 }
535
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400536 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500537
538 init_completion(&orb->done);
539 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500540
Stefan Richter7aa48482007-07-02 21:04:44 +0200541 orb->base.request_bus =
542 dma_map_single(device->card->device, &orb->request,
543 sizeof(orb->request), DMA_TO_DEVICE);
544 if (dma_mapping_error(orb->base.request_bus))
545 goto fail_mapping_request;
546
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200547 sbp2_send_orb(&orb->base, lu, node_id, generation,
548 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500549
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100550 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500551
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500552 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200553 if (sbp2_cancel_orbs(lu) == 0) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500554 fw_error("orb reply timed out, rcode=0x%02x\n",
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500555 orb->base.rcode);
556 goto out;
557 }
558
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500559 if (orb->base.rcode != RCODE_COMPLETE) {
560 fw_error("management write failed, rcode 0x%02x\n",
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500561 orb->base.rcode);
562 goto out;
563 }
564
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400565 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
566 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500567 fw_error("error status: %d:%d\n",
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400568 STATUS_GET_RESPONSE(orb->status),
569 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500570 goto out;
571 }
572
573 retval = 0;
574 out:
575 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400576 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200577 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500578 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400579 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200580 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500581 if (response)
582 fw_memcpy_from_be32(response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400583 orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400584 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500585
586 return retval;
587}
588
589static void
590complete_agent_reset_write(struct fw_card *card, int rcode,
591 void *payload, size_t length, void *data)
592{
593 struct fw_transaction *t = data;
594
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500595 kfree(t);
596}
597
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200598static int sbp2_agent_reset(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500599{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200600 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500601 struct fw_transaction *t;
602 static u32 zero;
603
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400604 t = kzalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500605 if (t == NULL)
606 return -ENOMEM;
607
608 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200609 lu->tgt->node_id, lu->generation, device->max_speed,
610 lu->command_block_agent_address + SBP2_AGENT_RESET,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400611 &zero, sizeof(zero), complete_agent_reset_write, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500612
613 return 0;
614}
615
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200616static void sbp2_release_target(struct kref *kref)
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400617{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200618 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
619 struct sbp2_logical_unit *lu, *next;
620 struct Scsi_Host *shost =
621 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richter4dccd022008-01-20 01:24:26 +0100622 struct fw_device *device = fw_device(tgt->unit->device.parent);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400623
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200624 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
625 if (lu->sdev)
626 scsi_remove_device(lu->sdev);
627
Stefan Richter4dccd022008-01-20 01:24:26 +0100628 if (!fw_device_is_shutdown(device))
629 sbp2_send_management_orb(lu, tgt->node_id,
630 lu->generation, SBP2_LOGOUT_REQUEST,
631 lu->login_id, NULL);
632
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200633 fw_core_remove_address_handler(&lu->address_handler);
634 list_del(&lu->link);
635 kfree(lu);
636 }
637 scsi_remove_host(shost);
638 fw_notify("released %s\n", tgt->unit->device.bus_id);
639
640 put_device(&tgt->unit->device);
641 scsi_host_put(shost);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400642}
643
Stefan Richterdf8ec242007-08-12 12:51:18 +0200644static struct workqueue_struct *sbp2_wq;
645
Stefan Richter285838e2007-11-07 01:12:51 +0100646/*
647 * Always get the target's kref when scheduling work on one its units.
648 * Each workqueue job is responsible to call sbp2_target_put() upon return.
649 */
650static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
651{
652 if (queue_delayed_work(sbp2_wq, &lu->work, delay))
653 kref_get(&lu->tgt->kref);
654}
655
656static void sbp2_target_put(struct sbp2_target *tgt)
657{
658 kref_put(&tgt->kref, sbp2_release_target);
659}
660
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200661static void sbp2_reconnect(struct work_struct *work);
662
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500663static void sbp2_login(struct work_struct *work)
664{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200665 struct sbp2_logical_unit *lu =
666 container_of(work, struct sbp2_logical_unit, work.work);
667 struct Scsi_Host *shost =
668 container_of((void *)lu->tgt, struct Scsi_Host, hostdata[0]);
669 struct scsi_device *sdev;
670 struct scsi_lun eight_bytes_lun;
671 struct fw_unit *unit = lu->tgt->unit;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500672 struct fw_device *device = fw_device(unit->device.parent);
673 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200674 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500675
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100676 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100677 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100678 node_id = device->node_id;
679 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500680
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200681 if (sbp2_send_management_orb(lu, node_id, generation,
682 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter285838e2007-11-07 01:12:51 +0100683 if (lu->retries++ < 5)
684 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
685 else
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200686 fw_error("failed to login to %s LUN %04x\n",
687 unit->device.bus_id, lu->lun);
Stefan Richter285838e2007-11-07 01:12:51 +0100688 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500689 }
690
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200691 lu->generation = generation;
692 lu->tgt->node_id = node_id;
693 lu->tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500694
695 /* Get command block agent offset and login id. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200696 lu->command_block_agent_address =
Kristian Høgsberg5c5539d2007-03-07 12:12:45 -0500697 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500698 response.command_block_agent.low;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200699 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500700
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200701 fw_notify("logged in to %s LUN %04x (%d retries)\n",
702 unit->device.bus_id, lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500703
704#if 0
705 /* FIXME: The linux1394 sbp2 does this last step. */
706 sbp2_set_busy_timeout(scsi_id);
707#endif
708
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200709 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
710 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500711
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200712 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
713 eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
714 eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
715
716 sdev = __scsi_add_device(shost, 0, 0,
717 scsilun_to_int(&eight_bytes_lun), lu);
718 if (IS_ERR(sdev)) {
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100719 smp_rmb(); /* generation may have changed */
720 generation = device->generation;
721 smp_rmb(); /* node_id must not be older than generation */
722
723 sbp2_send_management_orb(lu, device->node_id, generation,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200724 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400725 /*
726 * Set this back to sbp2_login so we fall back and
727 * retry login on bus reset.
728 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200729 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
730 } else {
731 lu->sdev = sdev;
732 scsi_device_put(sdev);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500733 }
Stefan Richter285838e2007-11-07 01:12:51 +0100734 out:
735 sbp2_target_put(lu->tgt);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500736}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500737
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200738static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
739{
740 struct sbp2_logical_unit *lu;
741
742 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
743 if (!lu)
744 return -ENOMEM;
745
746 lu->address_handler.length = 0x100;
747 lu->address_handler.address_callback = sbp2_status_write;
748 lu->address_handler.callback_data = lu;
749
750 if (fw_core_add_address_handler(&lu->address_handler,
751 &fw_high_memory_region) < 0) {
752 kfree(lu);
753 return -ENOMEM;
754 }
755
756 lu->tgt = tgt;
757 lu->sdev = NULL;
758 lu->lun = lun_entry & 0xffff;
759 lu->retries = 0;
760 INIT_LIST_HEAD(&lu->orb_list);
761 INIT_DELAYED_WORK(&lu->work, sbp2_login);
762
763 list_add_tail(&lu->link, &tgt->lu_list);
764 return 0;
765}
766
767static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
768{
769 struct fw_csr_iterator ci;
770 int key, value;
771
772 fw_csr_iterator_init(&ci, directory);
773 while (fw_csr_iterator_next(&ci, &key, &value))
774 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
775 sbp2_add_logical_unit(tgt, value) < 0)
776 return -ENOMEM;
777 return 0;
778}
779
780static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
781 u32 *model, u32 *firmware_revision)
782{
783 struct fw_csr_iterator ci;
784 int key, value;
Jarod Wilson384170d2008-01-25 23:31:12 -0500785 unsigned int timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200786
787 fw_csr_iterator_init(&ci, directory);
788 while (fw_csr_iterator_next(&ci, &key, &value)) {
789 switch (key) {
790
791 case CSR_DEPENDENT_INFO | CSR_OFFSET:
792 tgt->management_agent_address =
793 CSR_REGISTER_BASE + 4 * value;
794 break;
795
796 case CSR_DIRECTORY_ID:
797 tgt->directory_id = value;
798 break;
799
800 case CSR_MODEL:
801 *model = value;
802 break;
803
804 case SBP2_CSR_FIRMWARE_REVISION:
805 *firmware_revision = value;
806 break;
807
Jarod Wilson384170d2008-01-25 23:31:12 -0500808 case SBP2_CSR_UNIT_CHARACTERISTICS:
809 /* the timeout value is stored in 500ms units */
810 timeout = ((unsigned int) value >> 8 & 0xff) * 500;
811 timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
812 tgt->mgt_orb_timeout =
813 min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
814
815 if (timeout > tgt->mgt_orb_timeout)
816 fw_notify("%s: config rom contains %ds "
817 "management ORB timeout, limiting "
818 "to %ds\n", tgt->unit->device.bus_id,
819 timeout / 1000,
820 tgt->mgt_orb_timeout / 1000);
821 break;
822
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200823 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
824 if (sbp2_add_logical_unit(tgt, value) < 0)
825 return -ENOMEM;
826 break;
827
828 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
829 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
830 return -ENOMEM;
831 break;
832 }
833 }
834 return 0;
835}
836
837static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
838 u32 firmware_revision)
839{
840 int i;
Stefan Richter05cca732008-01-26 17:42:45 +0100841 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200842
Stefan Richter2df222b2007-08-13 17:48:25 +0200843 if (w)
844 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
845 "if you need the workarounds parameter for %s\n",
846 tgt->unit->device.bus_id);
847
848 if (w & SBP2_WORKAROUND_OVERRIDE)
849 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200850
851 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
852
853 if (sbp2_workarounds_table[i].firmware_revision !=
854 (firmware_revision & 0xffffff00))
855 continue;
856
857 if (sbp2_workarounds_table[i].model != model &&
858 sbp2_workarounds_table[i].model != ~0)
859 continue;
860
Stefan Richter2df222b2007-08-13 17:48:25 +0200861 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200862 break;
863 }
Stefan Richter2df222b2007-08-13 17:48:25 +0200864 out:
865 if (w)
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200866 fw_notify("Workarounds for %s: 0x%x "
867 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
868 tgt->unit->device.bus_id,
Stefan Richter2df222b2007-08-13 17:48:25 +0200869 w, firmware_revision, model);
870 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200871}
872
873static struct scsi_host_template scsi_driver_template;
874
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500875static int sbp2_probe(struct device *dev)
876{
877 struct fw_unit *unit = fw_unit(dev);
878 struct fw_device *device = fw_device(unit->device.parent);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200879 struct sbp2_target *tgt;
880 struct sbp2_logical_unit *lu;
881 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500882 u32 model, firmware_revision;
883
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200884 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
885 if (shost == NULL)
886 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500887
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200888 tgt = (struct sbp2_target *)shost->hostdata;
889 unit->device.driver_data = tgt;
890 tgt->unit = unit;
891 kref_init(&tgt->kref);
892 INIT_LIST_HEAD(&tgt->lu_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500893
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200894 if (fw_device_enable_phys_dma(device) < 0)
895 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500896
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200897 if (scsi_add_host(shost, &unit->device) < 0)
898 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500899
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200900 /* Initialize to values that won't match anything in our table. */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500901 firmware_revision = 0xff000000;
902 model = 0xff000000;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500903
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200904 /* implicit directory ID */
905 tgt->directory_id = ((unit->directory - device->config_rom) * 4
906 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500907
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200908 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
909 &firmware_revision) < 0)
910 goto fail_tgt_put;
911
912 sbp2_init_workarounds(tgt, model, firmware_revision);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500913
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400914 get_device(&unit->device);
915
Stefan Richter285838e2007-11-07 01:12:51 +0100916 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200917 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter285838e2007-11-07 01:12:51 +0100918 sbp2_queue_work(lu, 0);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500919 return 0;
Kristian Høgsbergad852742007-05-09 19:23:07 -0400920
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200921 fail_tgt_put:
Stefan Richter285838e2007-11-07 01:12:51 +0100922 sbp2_target_put(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200923 return -ENOMEM;
924
925 fail_shost_put:
926 scsi_host_put(shost);
927 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500928}
929
930static int sbp2_remove(struct device *dev)
931{
932 struct fw_unit *unit = fw_unit(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200933 struct sbp2_target *tgt = unit->device.driver_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500934
Stefan Richter285838e2007-11-07 01:12:51 +0100935 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500936 return 0;
937}
938
939static void sbp2_reconnect(struct work_struct *work)
940{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200941 struct sbp2_logical_unit *lu =
942 container_of(work, struct sbp2_logical_unit, work.work);
943 struct fw_unit *unit = lu->tgt->unit;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500944 struct fw_device *device = fw_device(unit->device.parent);
945 int generation, node_id, local_node_id;
946
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100947 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100948 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100949 node_id = device->node_id;
950 local_node_id = device->card->node_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500951
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200952 if (sbp2_send_management_orb(lu, node_id, generation,
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500953 SBP2_RECONNECT_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200954 lu->login_id, NULL) < 0) {
955 if (lu->retries++ >= 5) {
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500956 fw_error("failed to reconnect to %s\n",
957 unit->device.bus_id);
958 /* Fall back and try to log in again. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200959 lu->retries = 0;
960 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500961 }
Stefan Richter285838e2007-11-07 01:12:51 +0100962 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
963 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500964 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500965
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200966 lu->generation = generation;
967 lu->tgt->node_id = node_id;
968 lu->tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500969
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200970 fw_notify("reconnected to %s LUN %04x (%d retries)\n",
971 unit->device.bus_id, lu->lun, lu->retries);
972
973 sbp2_agent_reset(lu);
974 sbp2_cancel_orbs(lu);
Stefan Richter285838e2007-11-07 01:12:51 +0100975 out:
976 sbp2_target_put(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500977}
978
979static void sbp2_update(struct fw_unit *unit)
980{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200981 struct sbp2_target *tgt = unit->device.driver_data;
982 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500983
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200984 fw_device_enable_phys_dma(fw_device(unit->device.parent));
985
986 /*
987 * Fw-core serializes sbp2_update() against sbp2_remove().
988 * Iteration over tgt->lu_list is therefore safe here.
989 */
990 list_for_each_entry(lu, &tgt->lu_list, link) {
991 lu->retries = 0;
Stefan Richter285838e2007-11-07 01:12:51 +0100992 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200993 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500994}
995
996#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
997#define SBP2_SW_VERSION_ENTRY 0x00010483
998
Stefan Richter21ebcd12007-01-14 15:29:07 +0100999static const struct fw_device_id sbp2_id_table[] = {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001000 {
1001 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
1002 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
Stefan Richter5af4e5e2007-01-21 20:45:32 +01001003 .version = SBP2_SW_VERSION_ENTRY,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001004 },
1005 { }
1006};
1007
1008static struct fw_driver sbp2_driver = {
1009 .driver = {
1010 .owner = THIS_MODULE,
1011 .name = sbp2_driver_name,
1012 .bus = &fw_bus_type,
1013 .probe = sbp2_probe,
1014 .remove = sbp2_remove,
1015 },
1016 .update = sbp2_update,
1017 .id_table = sbp2_id_table,
1018};
1019
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001020static unsigned int
1021sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001022{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001023 int sam_status;
1024
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001025 sense_data[0] = 0x70;
1026 sense_data[1] = 0x0;
1027 sense_data[2] = sbp2_status[1];
1028 sense_data[3] = sbp2_status[4];
1029 sense_data[4] = sbp2_status[5];
1030 sense_data[5] = sbp2_status[6];
1031 sense_data[6] = sbp2_status[7];
1032 sense_data[7] = 10;
1033 sense_data[8] = sbp2_status[8];
1034 sense_data[9] = sbp2_status[9];
1035 sense_data[10] = sbp2_status[10];
1036 sense_data[11] = sbp2_status[11];
1037 sense_data[12] = sbp2_status[2];
1038 sense_data[13] = sbp2_status[3];
1039 sense_data[14] = sbp2_status[12];
1040 sense_data[15] = sbp2_status[13];
1041
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001042 sam_status = sbp2_status[0] & 0x3f;
1043
1044 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001045 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001046 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001047 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001048 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001049 case SAM_STAT_RESERVATION_CONFLICT:
1050 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001051 return DID_OK << 16 | sam_status;
1052
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001053 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001054 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001055 }
1056}
1057
1058static void
1059complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1060{
Jay Fenlason6f061482007-06-27 16:04:33 -04001061 struct sbp2_command_orb *orb =
1062 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001063 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001064 int result;
1065
1066 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001067 if (STATUS_GET_DEAD(*status))
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001068 sbp2_agent_reset(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001069
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001070 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001071 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001072 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001073 break;
1074 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001075 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001076 break;
1077 case SBP2_STATUS_ILLEGAL_REQUEST:
1078 case SBP2_STATUS_VENDOR_DEPENDENT:
1079 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001080 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001081 break;
1082 }
1083
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001084 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1085 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001086 orb->cmd->sense_buffer);
1087 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001088 /*
1089 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001090 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001091 * or when sending the write (less likely).
1092 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001093 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001094 }
1095
1096 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001097 sizeof(orb->request), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001098
Stefan Richter412edf62007-07-16 21:05:41 +02001099 if (scsi_sg_count(orb->cmd) > 0)
1100 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1101 scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001102 orb->cmd->sc_data_direction);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001103
1104 if (orb->page_table_bus != 0)
1105 dma_unmap_single(device->card->device, orb->page_table_bus,
Stefan Richterb4be0162007-07-02 22:07:34 +02001106 sizeof(orb->page_table), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001107
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001108 orb->cmd->result = result;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001109 orb->done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001110}
1111
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001112static int
1113sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1114 struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001115{
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001116 struct scatterlist *sg;
1117 int sg_len, l, i, j, count;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001118 dma_addr_t sg_addr;
1119
Stefan Richter412edf62007-07-16 21:05:41 +02001120 sg = scsi_sglist(orb->cmd);
1121 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001122 orb->cmd->sc_data_direction);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001123 if (count == 0)
1124 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001125
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001126 /*
1127 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001128 * the scatter list by converting it to an immediate block
1129 * request. This is also a workaround for broken devices such
1130 * as the second generation iPod which doesn't support page
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001131 * tables.
1132 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001133 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001134 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001135 orb->request.data_descriptor.low = sg_dma_address(sg);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001136 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001137 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001138 }
1139
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001140 /*
1141 * Convert the scatterlist to an sbp2 page table. If any
Kristian Høgsberg, Stefan Richter36abb3b2007-05-09 19:23:10 -04001142 * scatterlist entries are too big for sbp2, we split them as we
1143 * go. Even if we ask the block I/O layer to not give us sg
1144 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1145 * during DMA mapping, and Linux currently doesn't prevent this.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001146 */
Stefan Richterb7811da2008-01-15 21:10:50 +01001147 for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
1148 sg_len = sg_dma_len(sg);
1149 sg_addr = sg_dma_address(sg);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001150 while (sg_len) {
Stefan Richter332ef332007-07-01 13:56:03 +02001151 /* FIXME: This won't get us out of the pinch. */
1152 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1153 fw_error("page table overflow\n");
1154 goto fail_page_table;
1155 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001156 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1157 orb->page_table[j].low = sg_addr;
1158 orb->page_table[j].high = (l << 16);
1159 sg_addr += l;
1160 sg_len -= l;
1161 j++;
1162 }
1163 }
1164
Stefan Richterb4be0162007-07-02 22:07:34 +02001165 fw_memcpy_to_be32(orb->page_table, orb->page_table,
1166 sizeof(orb->page_table[0]) * j);
1167 orb->page_table_bus =
1168 dma_map_single(device->card->device, orb->page_table,
1169 sizeof(orb->page_table), DMA_TO_DEVICE);
1170 if (dma_mapping_error(orb->page_table_bus))
1171 goto fail_page_table;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001172
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001173 /*
1174 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001175 * to fill in the node ID part of the address. All other
1176 * pointers assume that the data referenced reside on the
1177 * initiator (i.e. us), but data_descriptor can refer to data
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001178 * on other nodes so we need to put our ID in descriptor.high.
1179 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001180 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001181 orb->request.data_descriptor.low = orb->page_table_bus;
1182 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001183 COMMAND_ORB_PAGE_TABLE_PRESENT |
1184 COMMAND_ORB_DATA_SIZE(j);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001185
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001186 return 0;
1187
1188 fail_page_table:
Stefan Richter412edf62007-07-16 21:05:41 +02001189 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001190 orb->cmd->sc_data_direction);
1191 fail:
1192 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001193}
1194
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001195/* SCSI stack integration */
1196
1197static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1198{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001199 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1200 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001201 struct sbp2_command_orb *orb;
Stefan Richter05cca732008-01-26 17:42:45 +01001202 unsigned int max_payload;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001203 int retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001204
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001205 /*
1206 * Bidirectional commands are not yet implemented, and unknown
1207 * transfer direction not handled.
1208 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001209 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richter8a8cea22007-06-09 19:26:22 +02001210 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001211 cmd->result = DID_ERROR << 16;
1212 done(cmd);
1213 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001214 }
1215
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001216 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001217 if (orb == NULL) {
1218 fw_notify("failed to alloc orb\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001219 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001220 }
1221
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001222 /* Initialize rcode to something not RCODE_COMPLETE. */
1223 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001224 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001225
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001226 orb->lu = lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001227 orb->done = done;
1228 orb->cmd = cmd;
1229
1230 orb->request.next.high = SBP2_ORB_NULL;
1231 orb->request.next.low = 0x0;
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001232 /*
1233 * At speed 100 we can do 512 bytes per packet, at speed 200,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001234 * 1024 bytes per packet etc. The SBP-2 max_payload field
1235 * specifies the max payload size as 2 ^ (max_payload + 2), so
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001236 * if we set this to max_speed + 7, we get the right value.
1237 */
Stefan Richter25659f72007-07-21 22:43:05 +02001238 max_payload = min(device->max_speed + 7,
1239 device->card->max_receive - 1);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001240 orb->request.misc =
Stefan Richter25659f72007-07-21 22:43:05 +02001241 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001242 COMMAND_ORB_SPEED(device->max_speed) |
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001243 COMMAND_ORB_NOTIFY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001244
1245 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1246 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001247 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001248 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1249 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001250 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001251
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001252 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1253 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001254
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001255 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001256
1257 memset(orb->request.command_block,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001258 0, sizeof(orb->request.command_block));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001259 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1260
1261 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001262 orb->base.request_bus =
1263 dma_map_single(device->card->device, &orb->request,
1264 sizeof(orb->request), DMA_TO_DEVICE);
1265 if (dma_mapping_error(orb->base.request_bus))
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001266 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001267
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001268 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1269 lu->command_block_agent_address + SBP2_ORB_POINTER);
1270 retval = 0;
1271 out:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001272 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001273 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001274}
1275
Stefan Richtercfb01382007-01-23 21:20:08 +01001276static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1277{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001278 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001279
1280 sdev->allow_restart = 1;
1281
James Bottomley465ff312008-01-01 10:00:10 -06001282 /*
1283 * Update the dma alignment (minimum alignment requirements for
1284 * start and end of DMA transfers) to be a sector
1285 */
1286 blk_queue_update_dma_alignment(sdev->request_queue, 511);
1287
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001288 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001289 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001290
Stefan Richtercfb01382007-01-23 21:20:08 +01001291 return 0;
1292}
1293
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001294static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1295{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001296 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001297
Stefan Richtercfb01382007-01-23 21:20:08 +01001298 sdev->use_10_for_rw = 1;
1299
1300 if (sdev->type == TYPE_ROM)
1301 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001302
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001303 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001304 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001305 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001306
1307 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001308 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001309
1310 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Stefan Richtercf47c7a2007-06-17 23:52:08 +02001311 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001312
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001313 return 0;
1314}
1315
1316/*
1317 * Called by scsi stack when something has really gone wrong. Usually
1318 * called when a command has timed-out for some reason.
1319 */
1320static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1321{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001322 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001323
1324 fw_notify("sbp2_scsi_abort\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001325 sbp2_agent_reset(lu);
1326 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001327
1328 return SUCCESS;
1329}
1330
Stefan Richter14e21982007-05-27 13:18:27 +02001331/*
1332 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1333 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1334 *
1335 * This is the concatenation of target port identifier and logical unit
1336 * identifier as per SAM-2...SAM-4 annex A.
1337 */
1338static ssize_t
1339sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1340 char *buf)
1341{
1342 struct scsi_device *sdev = to_scsi_device(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001343 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001344 struct fw_device *device;
Stefan Richter14e21982007-05-27 13:18:27 +02001345
1346 if (!sdev)
1347 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001348
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001349 lu = sdev->hostdata;
1350 device = fw_device(lu->tgt->unit->device.parent);
Stefan Richter14e21982007-05-27 13:18:27 +02001351
1352 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1353 device->config_rom[3], device->config_rom[4],
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001354 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001355}
1356
1357static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1358
1359static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1360 &dev_attr_ieee1394_id,
1361 NULL
1362};
1363
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001364static struct scsi_host_template scsi_driver_template = {
1365 .module = THIS_MODULE,
1366 .name = "SBP-2 IEEE-1394",
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -04001367 .proc_name = sbp2_driver_name,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001368 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001369 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001370 .slave_configure = sbp2_scsi_slave_configure,
1371 .eh_abort_handler = sbp2_scsi_abort,
1372 .this_id = -1,
1373 .sg_tablesize = SG_ALL,
1374 .use_clustering = ENABLE_CLUSTERING,
Stefan Richter02af8e72007-01-21 20:50:11 +01001375 .cmd_per_lun = 1,
1376 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001377 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001378};
1379
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001380MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1381MODULE_DESCRIPTION("SCSI over IEEE1394");
1382MODULE_LICENSE("GPL");
1383MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1384
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001385/* Provide a module alias so root-on-sbp2 initrds don't break. */
1386#ifndef CONFIG_IEEE1394_SBP2_MODULE
1387MODULE_ALIAS("sbp2");
1388#endif
1389
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001390static int __init sbp2_init(void)
1391{
Stefan Richterdf8ec242007-08-12 12:51:18 +02001392 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1393 if (!sbp2_wq)
1394 return -ENOMEM;
1395
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001396 return driver_register(&sbp2_driver.driver);
1397}
1398
1399static void __exit sbp2_cleanup(void)
1400{
1401 driver_unregister(&sbp2_driver.driver);
Stefan Richterdf8ec242007-08-12 12:51:18 +02001402 destroy_workqueue(sbp2_wq);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001403}
1404
1405module_init(sbp2_init);
1406module_exit(sbp2_cleanup);