blob: 914170bb50a8122fb41bbfb77c534cbe5be30510 [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>
Stefan Richter9220f192008-02-03 23:04:38 +010035#include <linux/delay.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050036#include <linux/device.h>
Andrew Morton0b5b2902006-12-27 14:49:23 -080037#include <linux/scatterlist.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050038#include <linux/dma-mapping.h>
Stefan Richtercf47c7a2007-06-17 23:52:08 +020039#include <linux/blkdev.h>
Stefan Richtere7cdf232007-07-01 13:54:57 +020040#include <linux/string.h>
Stefan Richter2df222b2007-08-13 17:48:25 +020041#include <linux/stringify.h>
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -050042#include <linux/timer.h>
Stefan Richterdf8ec242007-08-12 12:51:18 +020043#include <linux/workqueue.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010044#include <asm/system.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050045
46#include <scsi/scsi.h>
47#include <scsi/scsi_cmnd.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050048#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
Stefan Richter5cd54c92007-06-17 23:55:41 +020055/*
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
Stefan Richter2df222b2007-08-13 17:48:25 +020067/*
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 *
Stefan Richter9220f192008-02-03 23:04:38 +010086 * - delay inquiry
87 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
88 *
Stefan Richter2df222b2007-08-13 17:48:25 +020089 * - 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
Stefan Richter9220f192008-02-03 23:04:38 +010098#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
99#define SBP2_INQUIRY_DELAY 12
Stefan Richter2df222b2007-08-13 17:48:25 +0200100#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)
Stefan Richter9220f192008-02-03 23:04:38 +0100109 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
Stefan Richter2df222b2007-08-13 17:48:25 +0200110 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
111 ", or a combination)");
112
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500113/* I don't know why the SCSI stack doesn't define something like this... */
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400114typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500115
116static const char sbp2_driver_name[] = "sbp2";
117
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200118/*
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;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500126 struct fw_address_handler address_handler;
127 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200128
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500129 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200130 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500131 int login_id;
132
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400133 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200134 * 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.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400138 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500139 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500140 int retries;
141 struct delayed_work work;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500142};
143
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200144/*
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;
Stefan Richter48f18c72008-02-03 23:09:50 +0100151 const char *bus_id;
Stefan Richter05cca732008-01-26 17:42:45 +0100152 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200153
154 u64 management_agent_address;
155 int directory_id;
156 int node_id;
157 int address_high;
Stefan Richter05cca732008-01-26 17:42:45 +0100158 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500159 unsigned int mgt_orb_timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200160};
161
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100162/*
163 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
Jarod Wilson384170d2008-01-25 23:31:12 -0500164 * 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.
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100166 */
Jarod Wilson384170d2008-01-25 23:31:12 -0500167#define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
168#define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
Stefan Richter05cca732008-01-26 17:42:45 +0100169#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500170#define SBP2_ORB_NULL 0x80000000
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100171#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500172
173#define SBP2_DIRECTION_TO_MEDIA 0x0
174#define SBP2_DIRECTION_FROM_MEDIA 0x1
175
176/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500177#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200178#define SBP2_CSR_FIRMWARE_REVISION 0x3c
179#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
180#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500181
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500182/* 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
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400206#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)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500214
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;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400228 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500229 dma_addr_t request_bus;
230 int rcode;
231 struct sbp2_pointer pointer;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400232 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500233 struct list_head link;
234};
235
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400236#define MANAGEMENT_ORB_LUN(v) ((v))
237#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
238#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200239#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400240#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
241#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500242
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400243#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
244#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500245
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
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400261#define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
262#define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500263
264struct sbp2_login_response {
265 u32 misc;
266 struct sbp2_pointer command_block_agent;
267 u32 reconnect_hold;
268};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400269#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)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500277
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;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200288 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500289
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200290 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500291 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500292};
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;
Stefan Richter05cca732008-01-26 17:42:45 +0100306 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500307} 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 },
Stefan Richter9220f192008-02-03 23:04:38 +0100314 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
315 .firmware_revision = 0x002800,
316 .model = 0x000000,
317 .workarounds = SBP2_WORKAROUND_DELAY_INQUIRY,
318 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500319 /* 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 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400329
330 /*
331 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500332 * these iPods do not feature the read_capacity bug according
333 * to one report. Read_capacity behaviour as well as model_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400334 * could change due to Apple-supplied firmware updates though.
335 */
336
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500337 /* 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
354static void
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400355free_orb(struct kref *kref)
356{
357 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
358
359 kfree(orb);
360}
361
362static void
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500363sbp2_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{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200369 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500370 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 ||
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400376 length == 0 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500377 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);
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400385 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500386 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);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200393 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400394 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400395 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
396 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500397 list_del(&orb->link);
398 break;
399 }
400 }
401 spin_unlock_irqrestore(&card->lock, flags);
402
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200403 if (&orb->link != &lu->orb_list)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500404 orb->callback(orb, &status);
405 else
406 fw_error("status write for unknown orb\n");
407
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400408 kref_put(&orb->kref, free_orb);
409
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500410 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
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400420 /*
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) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500434 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200435 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500436 orb->callback(orb, NULL);
Stefan Richter1b34e972007-08-25 10:40:42 +0200437 } else {
438 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500439 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400440
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400441 kref_put(&orb->kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500442}
443
444static void
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200445sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500446 int node_id, int generation, u64 offset)
447{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200448 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500449 unsigned long flags;
450
451 orb->pointer.high = 0;
452 orb->pointer.low = orb->request_bus;
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400453 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500454
455 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200456 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500457 spin_unlock_irqrestore(&device->card->lock, flags);
458
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400459 /* Take a ref for the orb list and for the transaction callback. */
460 kref_get(&orb->kref);
461 kref_get(&orb->kref);
462
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500463 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200464 node_id, generation, device->max_speed, offset,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400465 &orb->pointer, sizeof(orb->pointer),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500466 complete_transaction, orb);
467}
468
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200469static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500470{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200471 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500472 struct sbp2_orb *orb, *next;
473 struct list_head list;
474 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500475 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500476
477 INIT_LIST_HEAD(&list);
478 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200479 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500480 spin_unlock_irqrestore(&device->card->lock, flags);
481
482 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500483 retval = 0;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500484 if (fw_cancel_transaction(device->card, &orb->t) == 0)
485 continue;
486
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500487 orb->rcode = RCODE_CANCELLED;
488 orb->callback(orb, NULL);
489 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500490
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500491 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500492}
493
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500494static void
495complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
496{
497 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400498 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500499
500 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400501 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500502 complete(&orb->done);
503}
504
505static int
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200506sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
507 int generation, int function, int lun_or_login_id,
508 void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500509{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200510 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500511 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100512 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500513 int retval = -ENOMEM;
514
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100515 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
516 return 0;
517
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400518 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500519 if (orb == NULL)
520 return -ENOMEM;
521
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400522 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500523 orb->response_bus =
524 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400525 sizeof(orb->response), DMA_FROM_DEVICE);
Kristian Høgsberg82eff9d2007-02-06 14:49:40 -0500526 if (dma_mapping_error(orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200527 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500528
529 orb->request.response.high = 0;
530 orb->request.response.low = orb->response_bus;
531
532 orb->request.misc =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400533 MANAGEMENT_ORB_NOTIFY |
534 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200535 MANAGEMENT_ORB_LUN(lun_or_login_id);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500536 orb->request.length =
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400537 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500538
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200539 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
540 orb->request.status_fifo.low = lu->address_handler.offset;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500541
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500542 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100543 /* Ask for 2^2 == 4 seconds reconnect grace period */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500544 orb->request.misc |=
Stefan Richter14dc9922008-01-20 01:25:31 +0100545 MANAGEMENT_ORB_RECONNECT(2) |
546 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login);
Jarod Wilson384170d2008-01-25 23:31:12 -0500547 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100548 } else {
549 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500550 }
551
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400552 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500553
554 init_completion(&orb->done);
555 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500556
Stefan Richter7aa48482007-07-02 21:04:44 +0200557 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
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200563 sbp2_send_orb(&orb->base, lu, node_id, generation,
564 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500565
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100566 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500567
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500568 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200569 if (sbp2_cancel_orbs(lu) == 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100570 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
571 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500572 goto out;
573 }
574
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500575 if (orb->base.rcode != RCODE_COMPLETE) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100576 fw_error("%s: management write failed, rcode 0x%02x\n",
577 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500578 goto out;
579 }
580
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400581 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
582 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100583 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400584 STATUS_GET_RESPONSE(orb->status),
585 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500586 goto out;
587 }
588
589 retval = 0;
590 out:
591 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400592 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200593 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500594 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400595 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200596 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500597 if (response)
598 fw_memcpy_from_be32(response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400599 orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400600 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500601
602 return retval;
603}
604
605static void
606complete_agent_reset_write(struct fw_card *card, int rcode,
Stefan Richtere0e602152008-02-03 23:08:58 +0100607 void *payload, size_t length, void *done)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500608{
Stefan Richtere0e602152008-02-03 23:08:58 +0100609 complete(done);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500610}
611
Stefan Richtere0e602152008-02-03 23:08:58 +0100612static 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;
618
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);
624}
625
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)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500634{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200635 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500636 struct fw_transaction *t;
Stefan Richtere0e602152008-02-03 23:08:58 +0100637 static u32 z;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500638
Stefan Richtere0e602152008-02-03 23:08:58 +0100639 t = kmalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500640 if (t == NULL)
Stefan Richtere0e602152008-02-03 23:08:58 +0100641 return;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500642
643 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200644 lu->tgt->node_id, lu->generation, device->max_speed,
645 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere0e602152008-02-03 23:08:58 +0100646 &z, sizeof(z), complete_agent_reset_write_no_wait, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500647}
648
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200649static void sbp2_release_target(struct kref *kref)
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400650{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200651 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]);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400655
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200656 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
657 if (lu->sdev)
658 scsi_remove_device(lu->sdev);
659
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100660 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
661 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
Stefan Richter4dccd022008-01-20 01:24:26 +0100662
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200663 fw_core_remove_address_handler(&lu->address_handler);
664 list_del(&lu->link);
665 kfree(lu);
666 }
667 scsi_remove_host(shost);
Stefan Richter48f18c72008-02-03 23:09:50 +0100668 fw_notify("released %s\n", tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200669
670 put_device(&tgt->unit->device);
671 scsi_host_put(shost);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400672}
673
Stefan Richterdf8ec242007-08-12 12:51:18 +0200674static struct workqueue_struct *sbp2_wq;
675
Stefan Richter285838e2007-11-07 01:12:51 +0100676/*
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
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200691static void sbp2_reconnect(struct work_struct *work);
692
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500693static void sbp2_login(struct work_struct *work)
694{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200695 struct sbp2_logical_unit *lu =
696 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +0100697 struct sbp2_target *tgt = lu->tgt;
698 struct fw_device *device = fw_device(tgt->unit->device.parent);
699 struct Scsi_Host *shost;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200700 struct scsi_device *sdev;
701 struct scsi_lun eight_bytes_lun;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500702 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200703 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500704
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100705 if (fw_device_is_shutdown(device))
706 goto out;
707
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100708 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100709 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100710 node_id = device->node_id;
711 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500712
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200713 if (sbp2_send_management_orb(lu, node_id, generation,
714 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter285838e2007-11-07 01:12:51 +0100715 if (lu->retries++ < 5)
716 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
717 else
Stefan Richter48f18c72008-02-03 23:09:50 +0100718 fw_error("%s: failed to login to LUN %04x\n",
719 tgt->bus_id, lu->lun);
Stefan Richter285838e2007-11-07 01:12:51 +0100720 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500721 }
722
Stefan Richter48f18c72008-02-03 23:09:50 +0100723 lu->generation = generation;
724 tgt->node_id = node_id;
725 tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500726
727 /* Get command block agent offset and login id. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200728 lu->command_block_agent_address =
Kristian Høgsberg5c5539d2007-03-07 12:12:45 -0500729 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500730 response.command_block_agent.low;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200731 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500732
Stefan Richter48f18c72008-02-03 23:09:50 +0100733 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
734 tgt->bus_id, lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500735
736#if 0
737 /* FIXME: The linux1394 sbp2 does this last step. */
738 sbp2_set_busy_timeout(scsi_id);
739#endif
740
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200741 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
742 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500743
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100744 /* This was a re-login. */
745 if (lu->sdev) {
746 sbp2_cancel_orbs(lu);
747 goto out;
748 }
749
Stefan Richter9220f192008-02-03 23:04:38 +0100750 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
751 ssleep(SBP2_INQUIRY_DELAY);
752
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200753 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;
Stefan Richter48f18c72008-02-03 23:09:50 +0100756 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200757
758 sdev = __scsi_add_device(shost, 0, 0,
759 scsilun_to_int(&eight_bytes_lun), lu);
760 if (IS_ERR(sdev)) {
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100761 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,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200766 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400767 /*
768 * Set this back to sbp2_login so we fall back and
769 * retry login on bus reset.
770 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200771 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
772 } else {
773 lu->sdev = sdev;
774 scsi_device_put(sdev);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500775 }
Stefan Richter285838e2007-11-07 01:12:51 +0100776 out:
Stefan Richter48f18c72008-02-03 23:09:50 +0100777 sbp2_target_put(tgt);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500778}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500779
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200780static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
781{
782 struct sbp2_logical_unit *lu;
783
784 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
785 if (!lu)
786 return -ENOMEM;
787
788 lu->address_handler.length = 0x100;
789 lu->address_handler.address_callback = sbp2_status_write;
790 lu->address_handler.callback_data = lu;
791
792 if (fw_core_add_address_handler(&lu->address_handler,
793 &fw_high_memory_region) < 0) {
794 kfree(lu);
795 return -ENOMEM;
796 }
797
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);
804
805 list_add_tail(&lu->link, &tgt->lu_list);
806 return 0;
807}
808
809static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
810{
811 struct fw_csr_iterator ci;
812 int key, value;
813
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;
Jarod Wilson384170d2008-01-25 23:31:12 -0500827 unsigned int timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200828
829 fw_csr_iterator_init(&ci, directory);
830 while (fw_csr_iterator_next(&ci, &key, &value)) {
831 switch (key) {
832
833 case CSR_DEPENDENT_INFO | CSR_OFFSET:
834 tgt->management_agent_address =
835 CSR_REGISTER_BASE + 4 * value;
836 break;
837
838 case CSR_DIRECTORY_ID:
839 tgt->directory_id = value;
840 break;
841
842 case CSR_MODEL:
843 *model = value;
844 break;
845
846 case SBP2_CSR_FIRMWARE_REVISION:
847 *firmware_revision = value;
848 break;
849
Jarod Wilson384170d2008-01-25 23:31:12 -0500850 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 "
Stefan Richter48f18c72008-02-03 23:09:50 +0100860 "to %ds\n", tgt->bus_id,
Jarod Wilson384170d2008-01-25 23:31:12 -0500861 timeout / 1000,
862 tgt->mgt_orb_timeout / 1000);
863 break;
864
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200865 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;
873 break;
874 }
875 }
876 return 0;
877}
878
879static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
880 u32 firmware_revision)
881{
882 int i;
Stefan Richter05cca732008-01-26 17:42:45 +0100883 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200884
Stefan Richter2df222b2007-08-13 17:48:25 +0200885 if (w)
886 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
887 "if you need the workarounds parameter for %s\n",
Stefan Richter48f18c72008-02-03 23:09:50 +0100888 tgt->bus_id);
Stefan Richter2df222b2007-08-13 17:48:25 +0200889
890 if (w & SBP2_WORKAROUND_OVERRIDE)
891 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200892
893 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
894
895 if (sbp2_workarounds_table[i].firmware_revision !=
896 (firmware_revision & 0xffffff00))
897 continue;
898
899 if (sbp2_workarounds_table[i].model != model &&
900 sbp2_workarounds_table[i].model != ~0)
901 continue;
902
Stefan Richter2df222b2007-08-13 17:48:25 +0200903 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200904 break;
905 }
Stefan Richter2df222b2007-08-13 17:48:25 +0200906 out:
907 if (w)
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200908 fw_notify("Workarounds for %s: 0x%x "
909 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
Stefan Richter48f18c72008-02-03 23:09:50 +0100910 tgt->bus_id, w, firmware_revision, model);
Stefan Richter2df222b2007-08-13 17:48:25 +0200911 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200912}
913
914static struct scsi_host_template scsi_driver_template;
915
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500916static 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);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200920 struct sbp2_target *tgt;
921 struct sbp2_logical_unit *lu;
922 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500923 u32 model, firmware_revision;
924
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200925 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
926 if (shost == NULL)
927 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500928
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200929 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);
Stefan Richter48f18c72008-02-03 23:09:50 +0100934 tgt->bus_id = unit->device.bus_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500935
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200936 if (fw_device_enable_phys_dma(device) < 0)
937 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500938
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200939 if (scsi_add_host(shost, &unit->device) < 0)
940 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500941
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200942 /* Initialize to values that won't match anything in our table. */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500943 firmware_revision = 0xff000000;
944 model = 0xff000000;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500945
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200946 /* implicit directory ID */
947 tgt->directory_id = ((unit->directory - device->config_rom) * 4
948 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500949
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200950 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);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500955
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400956 get_device(&unit->device);
957
Stefan Richter285838e2007-11-07 01:12:51 +0100958 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200959 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter285838e2007-11-07 01:12:51 +0100960 sbp2_queue_work(lu, 0);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500961 return 0;
Kristian Høgsbergad85274f2007-05-09 19:23:07 -0400962
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200963 fail_tgt_put:
Stefan Richter285838e2007-11-07 01:12:51 +0100964 sbp2_target_put(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200965 return -ENOMEM;
966
967 fail_shost_put:
968 scsi_host_put(shost);
969 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500970}
971
972static int sbp2_remove(struct device *dev)
973{
974 struct fw_unit *unit = fw_unit(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200975 struct sbp2_target *tgt = unit->device.driver_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500976
Stefan Richter285838e2007-11-07 01:12:51 +0100977 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500978 return 0;
979}
980
981static void sbp2_reconnect(struct work_struct *work)
982{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200983 struct sbp2_logical_unit *lu =
984 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +0100985 struct sbp2_target *tgt = lu->tgt;
986 struct fw_device *device = fw_device(tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500987 int generation, node_id, local_node_id;
988
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100989 if (fw_device_is_shutdown(device))
990 goto out;
991
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100992 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100993 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100994 node_id = device->node_id;
995 local_node_id = device->card->node_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500996
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200997 if (sbp2_send_management_orb(lu, node_id, generation,
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500998 SBP2_RECONNECT_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200999 lu->login_id, NULL) < 0) {
1000 if (lu->retries++ >= 5) {
Stefan Richter48f18c72008-02-03 23:09:50 +01001001 fw_error("%s: failed to reconnect\n", tgt->bus_id);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001002 /* Fall back and try to log in again. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001003 lu->retries = 0;
1004 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001005 }
Stefan Richter285838e2007-11-07 01:12:51 +01001006 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1007 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001008 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001009
Stefan Richter48f18c72008-02-03 23:09:50 +01001010 lu->generation = generation;
1011 tgt->node_id = node_id;
1012 tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001013
Stefan Richter48f18c72008-02-03 23:09:50 +01001014 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1015 tgt->bus_id, lu->lun, lu->retries);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001016
1017 sbp2_agent_reset(lu);
1018 sbp2_cancel_orbs(lu);
Stefan Richter285838e2007-11-07 01:12:51 +01001019 out:
Stefan Richter48f18c72008-02-03 23:09:50 +01001020 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001021}
1022
1023static void sbp2_update(struct fw_unit *unit)
1024{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001025 struct sbp2_target *tgt = unit->device.driver_data;
1026 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001027
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001028 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;
Stefan Richter285838e2007-11-07 01:12:51 +01001036 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001037 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001038}
1039
1040#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1041#define SBP2_SW_VERSION_ENTRY 0x00010483
1042
Stefan Richter21ebcd12007-01-14 15:29:07 +01001043static const struct fw_device_id sbp2_id_table[] = {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001044 {
1045 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
1046 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
Stefan Richter5af4e5e2007-01-21 20:45:32 +01001047 .version = SBP2_SW_VERSION_ENTRY,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001048 },
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
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001064static unsigned int
1065sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001066{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001067 int sam_status;
1068
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001069 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
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001086 sam_status = sbp2_status[0] & 0x3f;
1087
1088 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001089 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001090 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001091 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001092 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001093 case SAM_STAT_RESERVATION_CONFLICT:
1094 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001095 return DID_OK << 16 | sam_status;
1096
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001097 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001098 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001099 }
1100}
1101
1102static void
1103complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1104{
Jay Fenlason6f061482007-06-27 16:04:33 -04001105 struct sbp2_command_orb *orb =
1106 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001107 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001108 int result;
1109
1110 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001111 if (STATUS_GET_DEAD(*status))
Stefan Richtere0e602152008-02-03 23:08:58 +01001112 sbp2_agent_reset_no_wait(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001113
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001114 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001115 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001116 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001117 break;
1118 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001119 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001120 break;
1121 case SBP2_STATUS_ILLEGAL_REQUEST:
1122 case SBP2_STATUS_VENDOR_DEPENDENT:
1123 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001124 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001125 break;
1126 }
1127
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001128 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1129 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001130 orb->cmd->sense_buffer);
1131 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001132 /*
1133 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001134 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001135 * or when sending the write (less likely).
1136 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001137 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001138 }
1139
1140 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001141 sizeof(orb->request), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001142
Stefan Richter412edf62007-07-16 21:05:41 +02001143 if (scsi_sg_count(orb->cmd) > 0)
1144 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1145 scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001146 orb->cmd->sc_data_direction);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001147
1148 if (orb->page_table_bus != 0)
1149 dma_unmap_single(device->card->device, orb->page_table_bus,
Stefan Richterb4be0162007-07-02 22:07:34 +02001150 sizeof(orb->page_table), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001151
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001152 orb->cmd->result = result;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001153 orb->done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001154}
1155
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001156static int
1157sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1158 struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001159{
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001160 struct scatterlist *sg;
1161 int sg_len, l, i, j, count;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001162 dma_addr_t sg_addr;
1163
Stefan Richter412edf62007-07-16 21:05:41 +02001164 sg = scsi_sglist(orb->cmd);
1165 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001166 orb->cmd->sc_data_direction);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001167 if (count == 0)
1168 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001169
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001170 /*
1171 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001172 * 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
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001175 * tables.
1176 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001177 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001178 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001179 orb->request.data_descriptor.low = sg_dma_address(sg);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001180 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001181 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001182 }
1183
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001184 /*
1185 * Convert the scatterlist to an sbp2 page table. If any
Kristian Høgsberg, Stefan Richter36abb3b2007-05-09 19:23:10 -04001186 * 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.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001190 */
Stefan Richterb7811da2008-01-15 21:10:50 +01001191 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);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001194 while (sg_len) {
Stefan Richter332ef332007-07-01 13:56:03 +02001195 /* 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 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001200 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
Stefan Richterb4be0162007-07-02 22:07:34 +02001209 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;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001216
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001217 /*
1218 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001219 * 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
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001222 * on other nodes so we need to put our ID in descriptor.high.
1223 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001224 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001225 orb->request.data_descriptor.low = orb->page_table_bus;
1226 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001227 COMMAND_ORB_PAGE_TABLE_PRESENT |
1228 COMMAND_ORB_DATA_SIZE(j);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001229
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001230 return 0;
1231
1232 fail_page_table:
Stefan Richter412edf62007-07-16 21:05:41 +02001233 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001234 orb->cmd->sc_data_direction);
1235 fail:
1236 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001237}
1238
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001239/* SCSI stack integration */
1240
1241static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1242{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001243 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1244 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001245 struct sbp2_command_orb *orb;
Stefan Richter05cca732008-01-26 17:42:45 +01001246 unsigned int max_payload;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001247 int retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001248
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001249 /*
1250 * Bidirectional commands are not yet implemented, and unknown
1251 * transfer direction not handled.
1252 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001253 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richter8a8cea22007-06-09 19:26:22 +02001254 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001255 cmd->result = DID_ERROR << 16;
1256 done(cmd);
1257 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001258 }
1259
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001260 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001261 if (orb == NULL) {
1262 fw_notify("failed to alloc orb\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001263 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001264 }
1265
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001266 /* Initialize rcode to something not RCODE_COMPLETE. */
1267 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001268 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001269
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001270 orb->lu = lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001271 orb->done = done;
1272 orb->cmd = cmd;
1273
1274 orb->request.next.high = SBP2_ORB_NULL;
1275 orb->request.next.low = 0x0;
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001276 /*
1277 * At speed 100 we can do 512 bytes per packet, at speed 200,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001278 * 1024 bytes per packet etc. The SBP-2 max_payload field
1279 * specifies the max payload size as 2 ^ (max_payload + 2), so
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001280 * if we set this to max_speed + 7, we get the right value.
1281 */
Stefan Richter25659f72007-07-21 22:43:05 +02001282 max_payload = min(device->max_speed + 7,
1283 device->card->max_receive - 1);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001284 orb->request.misc =
Stefan Richter25659f72007-07-21 22:43:05 +02001285 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001286 COMMAND_ORB_SPEED(device->max_speed) |
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001287 COMMAND_ORB_NOTIFY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001288
1289 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1290 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001291 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001292 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1293 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001294 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001295
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001296 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1297 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001298
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001299 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001300
1301 memset(orb->request.command_block,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001302 0, sizeof(orb->request.command_block));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001303 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1304
1305 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001306 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))
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001310 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001311
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001312 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:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001316 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001317 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001318}
1319
Stefan Richtercfb01382007-01-23 21:20:08 +01001320static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1321{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001322 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001323
1324 sdev->allow_restart = 1;
1325
James Bottomley465ff312008-01-01 10:00:10 -06001326 /*
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
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001332 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001333 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001334
Stefan Richtercfb01382007-01-23 21:20:08 +01001335 return 0;
1336}
1337
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001338static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1339{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001340 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001341
Stefan Richtercfb01382007-01-23 21:20:08 +01001342 sdev->use_10_for_rw = 1;
1343
1344 if (sdev->type == TYPE_ROM)
1345 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001346
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001347 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001348 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001349 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001350
1351 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001352 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001353
1354 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Stefan Richtercf47c7a2007-06-17 23:52:08 +02001355 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001356
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001357 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{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001366 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001367
Stefan Richter48f18c72008-02-03 23:09:50 +01001368 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001369 sbp2_agent_reset(lu);
1370 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001371
1372 return SUCCESS;
1373}
1374
Stefan Richter14e21982007-05-27 13:18:27 +02001375/*
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);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001387 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001388 struct fw_device *device;
Stefan Richter14e21982007-05-27 13:18:27 +02001389
1390 if (!sdev)
1391 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001392
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001393 lu = sdev->hostdata;
1394 device = fw_device(lu->tgt->unit->device.parent);
Stefan Richter14e21982007-05-27 13:18:27 +02001395
1396 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1397 device->config_rom[3], device->config_rom[4],
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001398 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001399}
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
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001408static struct scsi_host_template scsi_driver_template = {
1409 .module = THIS_MODULE,
1410 .name = "SBP-2 IEEE-1394",
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -04001411 .proc_name = sbp2_driver_name,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001412 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001413 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001414 .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,
Stefan Richter02af8e72007-01-21 20:50:11 +01001419 .cmd_per_lun = 1,
1420 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001421 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001422};
1423
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001424MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1425MODULE_DESCRIPTION("SCSI over IEEE1394");
1426MODULE_LICENSE("GPL");
1427MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1428
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001429/* Provide a module alias so root-on-sbp2 initrds don't break. */
1430#ifndef CONFIG_IEEE1394_SBP2_MODULE
1431MODULE_ALIAS("sbp2");
1432#endif
1433
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001434static int __init sbp2_init(void)
1435{
Stefan Richterdf8ec242007-08-12 12:51:18 +02001436 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1437 if (!sbp2_wq)
1438 return -ENOMEM;
1439
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001440 return driver_register(&sbp2_driver.driver);
1441}
1442
1443static void __exit sbp2_cleanup(void)
1444{
1445 driver_unregister(&sbp2_driver.driver);
Stefan Richterdf8ec242007-08-12 12:51:18 +02001446 destroy_workqueue(sbp2_wq);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001447}
1448
1449module_init(sbp2_init);
1450module_exit(sbp2_cleanup);