blob: 41841a3e3f99c9acd4c4fc72c972626d8dffdcee [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
Stefan Richter7bb6bf72008-02-03 23:12:17 +010031#include <linux/blkdev.h>
Stefan Richter09b12dd2008-08-14 21:47:21 +020032#include <linux/bug.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020033#include <linux/completion.h>
Stefan Richter9220f192008-02-03 23:04:38 +010034#include <linux/delay.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050035#include <linux/device.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050036#include <linux/dma-mapping.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020037#include <linux/firewire.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020038#include <linux/firewire-constants.h>
39#include <linux/init.h>
40#include <linux/jiffies.h>
Stefan Richter7bb6bf72008-02-03 23:12:17 +010041#include <linux/kernel.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020042#include <linux/kref.h>
43#include <linux/list.h>
Stefan Richter7bb6bf72008-02-03 23:12:17 +010044#include <linux/mod_devicetable.h>
45#include <linux/module.h>
46#include <linux/moduleparam.h>
47#include <linux/scatterlist.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020048#include <linux/slab.h>
49#include <linux/spinlock.h>
Stefan Richtere7cdf232007-07-01 13:54:57 +020050#include <linux/string.h>
Stefan Richter2df222b2007-08-13 17:48:25 +020051#include <linux/stringify.h>
Stefan Richterdf8ec242007-08-12 12:51:18 +020052#include <linux/workqueue.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020053
54#include <asm/byteorder.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010055#include <asm/system.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050056
57#include <scsi/scsi.h>
58#include <scsi/scsi_cmnd.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050059#include <scsi/scsi_device.h>
60#include <scsi/scsi_host.h>
61
Stefan Richter5cd54c92007-06-17 23:55:41 +020062/*
63 * So far only bridges from Oxford Semiconductor are known to support
64 * concurrent logins. Depending on firmware, four or two concurrent logins
65 * are possible on OXFW911 and newer Oxsemi bridges.
66 *
67 * Concurrent logins are useful together with cluster filesystems.
68 */
69static int sbp2_param_exclusive_login = 1;
70module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
71MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
72 "(default = Y, use N for concurrent initiators)");
73
Stefan Richter2df222b2007-08-13 17:48:25 +020074/*
75 * Flags for firmware oddities
76 *
77 * - 128kB max transfer
78 * Limit transfer size. Necessary for some old bridges.
79 *
80 * - 36 byte inquiry
81 * When scsi_mod probes the device, let the inquiry command look like that
82 * from MS Windows.
83 *
84 * - skip mode page 8
85 * Suppress sending of mode_sense for mode page 8 if the device pretends to
86 * support the SCSI Primary Block commands instead of Reduced Block Commands.
87 *
88 * - fix capacity
89 * Tell sd_mod to correct the last sector number reported by read_capacity.
90 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
91 * Don't use this with devices which don't have this bug.
92 *
Stefan Richter9220f192008-02-03 23:04:38 +010093 * - delay inquiry
94 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
95 *
Stefan Richterffcaade2008-05-11 00:35:04 +020096 * - power condition
97 * Set the power condition field in the START STOP UNIT commands sent by
98 * sd_mod on suspend, resume, and shutdown (if manage_start_stop is on).
99 * Some disks need this to spin down or to resume properly.
100 *
Stefan Richter2df222b2007-08-13 17:48:25 +0200101 * - override internal blacklist
102 * Instead of adding to the built-in blacklist, use only the workarounds
103 * specified in the module load parameter.
104 * Useful if a blacklist entry interfered with a non-broken device.
105 */
106#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
107#define SBP2_WORKAROUND_INQUIRY_36 0x2
108#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
109#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
Stefan Richter9220f192008-02-03 23:04:38 +0100110#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
111#define SBP2_INQUIRY_DELAY 12
Stefan Richterffcaade2008-05-11 00:35:04 +0200112#define SBP2_WORKAROUND_POWER_CONDITION 0x20
Stefan Richter2df222b2007-08-13 17:48:25 +0200113#define SBP2_WORKAROUND_OVERRIDE 0x100
114
115static int sbp2_param_workarounds;
116module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
117MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
118 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
119 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
120 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
121 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
Stefan Richter9220f192008-02-03 23:04:38 +0100122 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
Stefan Richterffcaade2008-05-11 00:35:04 +0200123 ", set power condition in start stop unit = "
124 __stringify(SBP2_WORKAROUND_POWER_CONDITION)
Stefan Richter2df222b2007-08-13 17:48:25 +0200125 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
126 ", or a combination)");
127
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500128static const char sbp2_driver_name[] = "sbp2";
129
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200130/*
131 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
132 * and one struct scsi_device per sbp2_logical_unit.
133 */
134struct sbp2_logical_unit {
135 struct sbp2_target *tgt;
136 struct list_head link;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500137 struct fw_address_handler address_handler;
138 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200139
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500140 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200141 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500142 int login_id;
143
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400144 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200145 * The generation is updated once we've logged in or reconnected
146 * to the logical unit. Thus, I/O to the device will automatically
147 * fail and get retried if it happens in a window where the device
148 * is not ready, e.g. after a bus reset but before we reconnect.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400149 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500150 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500151 int retries;
152 struct delayed_work work;
Stefan Richterf8436152008-02-26 23:30:02 +0100153 bool has_sdev;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100154 bool blocked;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500155};
156
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200157/*
158 * We create one struct sbp2_target per IEEE 1212 Unit Directory
159 * and one struct Scsi_Host per sbp2_target.
160 */
161struct sbp2_target {
162 struct kref kref;
163 struct fw_unit *unit;
Stefan Richter48f18c72008-02-03 23:09:50 +0100164 const char *bus_id;
Stefan Richter05cca732008-01-26 17:42:45 +0100165 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200166
167 u64 management_agent_address;
Stefan Richterc9755e12008-03-24 20:54:28 +0100168 u64 guid;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200169 int directory_id;
170 int node_id;
171 int address_high;
Stefan Richter05cca732008-01-26 17:42:45 +0100172 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500173 unsigned int mgt_orb_timeout;
Stefan Richtera08e1002009-01-24 19:41:46 +0100174 unsigned int max_payload;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100175
176 int dont_block; /* counter for each logical unit */
177 int blocked; /* ditto */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200178};
179
Stefan Richtere5110d02009-06-06 18:35:27 +0200180static struct fw_device *target_device(struct sbp2_target *tgt)
181{
182 return fw_parent_device(tgt->unit);
183}
184
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400185/* Impossible login_id, to detect logout attempt before successful login */
186#define INVALID_LOGIN_ID 0x10000
187
Stefan Richtereaf76e02009-10-08 00:39:31 +0200188#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500189#define SBP2_ORB_NULL 0x80000000
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500190#define SBP2_RETRY_LIMIT 0xf /* 15 retries */
191#define SBP2_CYCLE_LIMIT (0xc8 << 12) /* 200 125us cycles */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500192
Stefan Richter09b12dd2008-08-14 21:47:21 +0200193/*
Stefan Richteraf271942009-06-30 20:27:59 +0200194 * There is no transport protocol limit to the CDB length, but we implement
195 * a fixed length only. 16 bytes is enough for disks larger than 2 TB.
196 */
197#define SBP2_MAX_CDB_SIZE 16
198
199/*
Stefan Richter09b12dd2008-08-14 21:47:21 +0200200 * The default maximum s/g segment size of a FireWire controller is
201 * usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
202 * be quadlet-aligned, we set the length limit to 0xffff & ~3.
203 */
204#define SBP2_MAX_SEG_SIZE 0xfffc
205
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500206/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500207#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200208#define SBP2_CSR_FIRMWARE_REVISION 0x3c
209#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
210#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500211
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500212/* Management orb opcodes */
213#define SBP2_LOGIN_REQUEST 0x0
214#define SBP2_QUERY_LOGINS_REQUEST 0x1
215#define SBP2_RECONNECT_REQUEST 0x3
216#define SBP2_SET_PASSWORD_REQUEST 0x4
217#define SBP2_LOGOUT_REQUEST 0x7
218#define SBP2_ABORT_TASK_REQUEST 0xb
219#define SBP2_ABORT_TASK_SET 0xc
220#define SBP2_LOGICAL_UNIT_RESET 0xe
221#define SBP2_TARGET_RESET_REQUEST 0xf
222
223/* Offsets for command block agent registers */
224#define SBP2_AGENT_STATE 0x00
225#define SBP2_AGENT_RESET 0x04
226#define SBP2_ORB_POINTER 0x08
227#define SBP2_DOORBELL 0x10
228#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
229
230/* Status write response codes */
231#define SBP2_STATUS_REQUEST_COMPLETE 0x0
232#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
233#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
234#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
235
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400236#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
237#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
238#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
239#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
240#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
241#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
242#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
243#define STATUS_GET_DATA(v) ((v).data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500244
245struct sbp2_status {
246 u32 status;
247 u32 orb_low;
248 u8 data[24];
249};
250
251struct sbp2_pointer {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100252 __be32 high;
253 __be32 low;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500254};
255
256struct sbp2_orb {
257 struct fw_transaction t;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400258 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500259 dma_addr_t request_bus;
260 int rcode;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400261 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500262 struct list_head link;
263};
264
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400265#define MANAGEMENT_ORB_LUN(v) ((v))
266#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
267#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200268#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400269#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
270#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500271
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400272#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
273#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500274
275struct sbp2_management_orb {
276 struct sbp2_orb base;
277 struct {
278 struct sbp2_pointer password;
279 struct sbp2_pointer response;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100280 __be32 misc;
281 __be32 length;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500282 struct sbp2_pointer status_fifo;
283 } request;
284 __be32 response[4];
285 dma_addr_t response_bus;
286 struct completion done;
287 struct sbp2_status status;
288};
289
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500290struct sbp2_login_response {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100291 __be32 misc;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500292 struct sbp2_pointer command_block_agent;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100293 __be32 reconnect_hold;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500294};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400295#define COMMAND_ORB_DATA_SIZE(v) ((v))
296#define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
297#define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
298#define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
299#define COMMAND_ORB_SPEED(v) ((v) << 24)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +0100300#define COMMAND_ORB_DIRECTION ((1) << 27)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400301#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
302#define COMMAND_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500303
304struct sbp2_command_orb {
305 struct sbp2_orb base;
306 struct {
307 struct sbp2_pointer next;
308 struct sbp2_pointer data_descriptor;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100309 __be32 misc;
Stefan Richteraf271942009-06-30 20:27:59 +0200310 u8 command_block[SBP2_MAX_CDB_SIZE];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500311 } request;
312 struct scsi_cmnd *cmd;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200313 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500314
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200315 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500316 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500317};
318
Stefan Richterf7460722009-01-24 19:41:46 +0100319#define SBP2_ROM_VALUE_WILDCARD ~0 /* match all */
320#define SBP2_ROM_VALUE_MISSING 0xff000000 /* not present in the unit dir. */
321
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500322/*
323 * List of devices with known bugs.
324 *
325 * The firmware_revision field, masked with 0xffff00, is the best
326 * indicator for the type of bridge chip of a device. It yields a few
327 * false positives but this did not break correctly behaving devices
Stefan Richterf7460722009-01-24 19:41:46 +0100328 * so far.
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500329 */
330static const struct {
331 u32 firmware_revision;
332 u32 model;
Stefan Richter05cca732008-01-26 17:42:45 +0100333 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500334} sbp2_workarounds_table[] = {
335 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
336 .firmware_revision = 0x002800,
337 .model = 0x001010,
338 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
Stefan Richterffcaade2008-05-11 00:35:04 +0200339 SBP2_WORKAROUND_MODE_SENSE_8 |
340 SBP2_WORKAROUND_POWER_CONDITION,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500341 },
Stefan Richter9220f192008-02-03 23:04:38 +0100342 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
343 .firmware_revision = 0x002800,
344 .model = 0x000000,
Stefan Richter3c5f8032009-09-06 19:33:50 +0200345 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
Stefan Richter9220f192008-02-03 23:04:38 +0100346 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500347 /* Initio bridges, actually only needed for some older ones */ {
348 .firmware_revision = 0x000200,
Stefan Richterf7460722009-01-24 19:41:46 +0100349 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500350 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
351 },
Stefan Richterffcaade2008-05-11 00:35:04 +0200352 /* PL-3507 bridge with Prolific firmware */ {
353 .firmware_revision = 0x012800,
Stefan Richterf7460722009-01-24 19:41:46 +0100354 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richterffcaade2008-05-11 00:35:04 +0200355 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
356 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500357 /* Symbios bridge */ {
358 .firmware_revision = 0xa0b800,
Stefan Richterf7460722009-01-24 19:41:46 +0100359 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500360 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
361 },
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100362 /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
363 .firmware_revision = 0x002600,
Stefan Richterf7460722009-01-24 19:41:46 +0100364 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100365 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
366 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400367 /*
Stefan Richterc8c47072009-01-29 00:11:59 +0100368 * iPod 2nd generation: needs 128k max transfer size workaround
369 * iPod 3rd generation: needs fix capacity workaround
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400370 */
Stefan Richterc8c47072009-01-29 00:11:59 +0100371 {
372 .firmware_revision = 0x0a2700,
373 .model = 0x000000,
374 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS |
375 SBP2_WORKAROUND_FIX_CAPACITY,
376 },
377 /* iPod 4th generation */ {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500378 .firmware_revision = 0x0a2700,
379 .model = 0x000021,
380 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
381 },
382 /* iPod mini */ {
383 .firmware_revision = 0x0a2700,
Stefan Richter031bb272008-11-22 12:38:58 +0100384 .model = 0x000022,
385 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
386 },
387 /* iPod mini */ {
388 .firmware_revision = 0x0a2700,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500389 .model = 0x000023,
390 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
391 },
392 /* iPod Photo */ {
393 .firmware_revision = 0x0a2700,
394 .model = 0x00007e,
395 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
396 }
397};
398
Stefan Richter53dca512008-12-14 21:47:04 +0100399static void free_orb(struct kref *kref)
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400400{
401 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
402
403 kfree(orb);
404}
405
Stefan Richter53dca512008-12-14 21:47:04 +0100406static void sbp2_status_write(struct fw_card *card, struct fw_request *request,
407 int tcode, int destination, int source,
Stefan Richter33e553f2010-06-20 22:50:35 +0200408 int generation, unsigned long long offset,
Stefan Richter53dca512008-12-14 21:47:04 +0100409 void *payload, size_t length, void *callback_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500410{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200411 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500412 struct sbp2_orb *orb;
413 struct sbp2_status status;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500414 unsigned long flags;
415
416 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
Stefan Richter094614f2009-09-06 18:51:27 +0200417 length < 8 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500418 fw_send_response(card, request, RCODE_TYPE_ERROR);
419 return;
420 }
421
Stefan Richter094614f2009-09-06 18:51:27 +0200422 status.status = be32_to_cpup(payload);
423 status.orb_low = be32_to_cpup(payload + 4);
424 memset(status.data, 0, sizeof(status.data));
425 if (length > 8)
426 memcpy(status.data, payload + 8, length - 8);
427
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400428 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500429 fw_notify("non-orb related status write, not handled\n");
430 fw_send_response(card, request, RCODE_COMPLETE);
431 return;
432 }
433
434 /* Lookup the orb corresponding to this status write. */
435 spin_lock_irqsave(&card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200436 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400437 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400438 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
439 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500440 list_del(&orb->link);
441 break;
442 }
443 }
444 spin_unlock_irqrestore(&card->lock, flags);
445
Stefan Richterbaed6b82009-09-03 23:07:35 +0200446 if (&orb->link != &lu->orb_list) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500447 orb->callback(orb, &status);
Stefan Richter6c743402010-08-16 21:58:03 +0200448 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richterbaed6b82009-09-03 23:07:35 +0200449 } else {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500450 fw_error("status write for unknown orb\n");
Stefan Richterbaed6b82009-09-03 23:07:35 +0200451 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400452
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500453 fw_send_response(card, request, RCODE_COMPLETE);
454}
455
Stefan Richter53dca512008-12-14 21:47:04 +0100456static void complete_transaction(struct fw_card *card, int rcode,
457 void *payload, size_t length, void *data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500458{
459 struct sbp2_orb *orb = data;
460 unsigned long flags;
461
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400462 /*
463 * This is a little tricky. We can get the status write for
464 * the orb before we get this callback. The status write
465 * handler above will assume the orb pointer transaction was
466 * successful and set the rcode to RCODE_COMPLETE for the orb.
467 * So this callback only sets the rcode if it hasn't already
468 * been set and only does the cleanup if the transaction
469 * failed and we didn't already get a status write.
470 */
471 spin_lock_irqsave(&card->lock, flags);
472
473 if (orb->rcode == -1)
474 orb->rcode = rcode;
Stefan Richter7a4e1e92011-03-15 00:04:42 +0100475 if (orb->rcode != RCODE_COMPLETE) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500476 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200477 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter6c743402010-08-16 21:58:03 +0200478
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500479 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200480 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richter1b34e972007-08-25 10:40:42 +0200481 } else {
482 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500483 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400484
Stefan Richter6c743402010-08-16 21:58:03 +0200485 kref_put(&orb->kref, free_orb); /* transaction callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500486}
487
Stefan Richter53dca512008-12-14 21:47:04 +0100488static void sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
489 int node_id, int generation, u64 offset)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500490{
Stefan Richtere5110d02009-06-06 18:35:27 +0200491 struct fw_device *device = target_device(lu->tgt);
Stefan Richter81bf52d2011-05-01 21:06:42 +0200492 struct sbp2_pointer orb_pointer;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500493 unsigned long flags;
494
Stefan Richter81bf52d2011-05-01 21:06:42 +0200495 orb_pointer.high = 0;
496 orb_pointer.low = cpu_to_be32(orb->request_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500497
498 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200499 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500500 spin_unlock_irqrestore(&device->card->lock, flags);
501
Stefan Richter6c743402010-08-16 21:58:03 +0200502 kref_get(&orb->kref); /* transaction callback reference */
503 kref_get(&orb->kref); /* orb callback reference */
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400504
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500505 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200506 node_id, generation, device->max_speed, offset,
Stefan Richter81bf52d2011-05-01 21:06:42 +0200507 &orb_pointer, 8, complete_transaction, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500508}
509
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200510static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500511{
Stefan Richtere5110d02009-06-06 18:35:27 +0200512 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500513 struct sbp2_orb *orb, *next;
514 struct list_head list;
515 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500516 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500517
518 INIT_LIST_HEAD(&list);
519 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200520 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500521 spin_unlock_irqrestore(&device->card->lock, flags);
522
523 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500524 retval = 0;
Stefan Richter7a4e1e92011-03-15 00:04:42 +0100525 if (fw_cancel_transaction(device->card, &orb->t) == 0)
526 continue;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500527
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500528 orb->rcode = RCODE_CANCELLED;
529 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200530 kref_put(&orb->kref, free_orb); /* orb callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500531 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500532
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500533 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500534}
535
Stefan Richter53dca512008-12-14 21:47:04 +0100536static void complete_management_orb(struct sbp2_orb *base_orb,
537 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500538{
539 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400540 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500541
542 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400543 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500544 complete(&orb->done);
545}
546
Stefan Richter53dca512008-12-14 21:47:04 +0100547static int sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
548 int generation, int function,
549 int lun_or_login_id, void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500550{
Stefan Richtere5110d02009-06-06 18:35:27 +0200551 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500552 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100553 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500554 int retval = -ENOMEM;
555
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100556 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
557 return 0;
558
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400559 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500560 if (orb == NULL)
561 return -ENOMEM;
562
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400563 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500564 orb->response_bus =
565 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400566 sizeof(orb->response), DMA_FROM_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700567 if (dma_mapping_error(device->card->device, orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200568 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500569
Stefan Richter71ee9f02008-02-28 20:51:11 +0100570 orb->request.response.high = 0;
571 orb->request.response.low = cpu_to_be32(orb->response_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500572
Stefan Richter71ee9f02008-02-28 20:51:11 +0100573 orb->request.misc = cpu_to_be32(
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400574 MANAGEMENT_ORB_NOTIFY |
575 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100576 MANAGEMENT_ORB_LUN(lun_or_login_id));
577 orb->request.length = cpu_to_be32(
578 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500579
Stefan Richter71ee9f02008-02-28 20:51:11 +0100580 orb->request.status_fifo.high =
581 cpu_to_be32(lu->address_handler.offset >> 32);
582 orb->request.status_fifo.low =
583 cpu_to_be32(lu->address_handler.offset);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500584
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500585 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100586 /* Ask for 2^2 == 4 seconds reconnect grace period */
Stefan Richter71ee9f02008-02-28 20:51:11 +0100587 orb->request.misc |= cpu_to_be32(
Stefan Richter14dc9922008-01-20 01:25:31 +0100588 MANAGEMENT_ORB_RECONNECT(2) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100589 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
Jarod Wilson384170d2008-01-25 23:31:12 -0500590 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100591 } else {
592 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500593 }
594
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500595 init_completion(&orb->done);
596 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500597
Stefan Richter7aa48482007-07-02 21:04:44 +0200598 orb->base.request_bus =
599 dma_map_single(device->card->device, &orb->request,
600 sizeof(orb->request), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700601 if (dma_mapping_error(device->card->device, orb->base.request_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200602 goto fail_mapping_request;
603
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200604 sbp2_send_orb(&orb->base, lu, node_id, generation,
605 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500606
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100607 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500608
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500609 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200610 if (sbp2_cancel_orbs(lu) == 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100611 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
612 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500613 goto out;
614 }
615
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500616 if (orb->base.rcode != RCODE_COMPLETE) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100617 fw_error("%s: management write failed, rcode 0x%02x\n",
618 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500619 goto out;
620 }
621
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400622 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
623 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100624 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400625 STATUS_GET_RESPONSE(orb->status),
626 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500627 goto out;
628 }
629
630 retval = 0;
631 out:
632 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400633 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200634 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500635 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400636 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200637 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500638 if (response)
Stefan Richter71ee9f02008-02-28 20:51:11 +0100639 memcpy(response, orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400640 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500641
642 return retval;
643}
644
Stefan Richtere0e60212008-02-03 23:08:58 +0100645static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
646{
Stefan Richtere5110d02009-06-06 18:35:27 +0200647 struct fw_device *device = target_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200648 __be32 d = 0;
Stefan Richtere0e60212008-02-03 23:08:58 +0100649
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200650 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
651 lu->tgt->node_id, lu->generation, device->max_speed,
652 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc82010-06-12 20:29:07 +0200653 &d, 4);
Stefan Richtere0e60212008-02-03 23:08:58 +0100654}
655
Stefan Richter53dca512008-12-14 21:47:04 +0100656static void complete_agent_reset_write_no_wait(struct fw_card *card,
657 int rcode, void *payload, size_t length, void *data)
Stefan Richtere0e60212008-02-03 23:08:58 +0100658{
659 kfree(data);
660}
661
662static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500663{
Stefan Richtere5110d02009-06-06 18:35:27 +0200664 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500665 struct fw_transaction *t;
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200666 static __be32 d;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500667
Stefan Richtere0e60212008-02-03 23:08:58 +0100668 t = kmalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500669 if (t == NULL)
Stefan Richtere0e60212008-02-03 23:08:58 +0100670 return;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500671
672 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200673 lu->tgt->node_id, lu->generation, device->max_speed,
674 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc82010-06-12 20:29:07 +0200675 &d, 4, complete_agent_reset_write_no_wait, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500676}
677
Stefan Richter2e2705b2008-02-16 16:37:28 +0100678static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
679{
680 /*
681 * We may access dont_block without taking card->lock here:
682 * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
683 * are currently serialized against each other.
684 * And a wrong result in sbp2_conditionally_block()'s access of
685 * dont_block is rather harmless, it simply misses its first chance.
686 */
687 --lu->tgt->dont_block;
688}
689
690/*
691 * Blocks lu->tgt if all of the following conditions are met:
692 * - Login, INQUIRY, and high-level SCSI setup of all of the target's
693 * logical units have been finished (indicated by dont_block == 0).
694 * - lu->generation is stale.
695 *
696 * Note, scsi_block_requests() must be called while holding card->lock,
697 * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
698 * unblock the target.
699 */
700static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
701{
702 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200703 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100704 struct Scsi_Host *shost =
705 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
706 unsigned long flags;
707
708 spin_lock_irqsave(&card->lock, flags);
709 if (!tgt->dont_block && !lu->blocked &&
710 lu->generation != card->generation) {
711 lu->blocked = true;
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100712 if (++tgt->blocked == 1)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100713 scsi_block_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100714 }
715 spin_unlock_irqrestore(&card->lock, flags);
716}
717
718/*
719 * Unblocks lu->tgt as soon as all its logical units can be unblocked.
720 * Note, it is harmless to run scsi_unblock_requests() outside the
721 * card->lock protected section. On the other hand, running it inside
722 * the section might clash with shost->host_lock.
723 */
724static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
725{
726 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200727 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100728 struct Scsi_Host *shost =
729 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
730 unsigned long flags;
731 bool unblock = false;
732
733 spin_lock_irqsave(&card->lock, flags);
734 if (lu->blocked && lu->generation == card->generation) {
735 lu->blocked = false;
736 unblock = --tgt->blocked == 0;
737 }
738 spin_unlock_irqrestore(&card->lock, flags);
739
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100740 if (unblock)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100741 scsi_unblock_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100742}
743
744/*
745 * Prevents future blocking of tgt and unblocks it.
746 * Note, it is harmless to run scsi_unblock_requests() outside the
747 * card->lock protected section. On the other hand, running it inside
748 * the section might clash with shost->host_lock.
749 */
750static void sbp2_unblock(struct sbp2_target *tgt)
751{
Stefan Richtere5110d02009-06-06 18:35:27 +0200752 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100753 struct Scsi_Host *shost =
754 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
755 unsigned long flags;
756
757 spin_lock_irqsave(&card->lock, flags);
758 ++tgt->dont_block;
759 spin_unlock_irqrestore(&card->lock, flags);
760
761 scsi_unblock_requests(shost);
762}
763
Stefan Richterf8436152008-02-26 23:30:02 +0100764static int sbp2_lun2int(u16 lun)
765{
766 struct scsi_lun eight_bytes_lun;
767
768 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
769 eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
770 eight_bytes_lun.scsi_lun[1] = lun & 0xff;
771
772 return scsilun_to_int(&eight_bytes_lun);
773}
774
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200775static void sbp2_release_target(struct kref *kref)
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400776{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200777 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
778 struct sbp2_logical_unit *lu, *next;
779 struct Scsi_Host *shost =
780 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richterf8436152008-02-26 23:30:02 +0100781 struct scsi_device *sdev;
Stefan Richtere5110d02009-06-06 18:35:27 +0200782 struct fw_device *device = target_device(tgt);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400783
Stefan Richter2e2705b2008-02-16 16:37:28 +0100784 /* prevent deadlocks */
785 sbp2_unblock(tgt);
786
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200787 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
Stefan Richterf8436152008-02-26 23:30:02 +0100788 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
789 if (sdev) {
790 scsi_remove_device(sdev);
791 scsi_device_put(sdev);
Stefan Richter33f1c6c2008-02-19 09:05:49 +0100792 }
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400793 if (lu->login_id != INVALID_LOGIN_ID) {
794 int generation, node_id;
795 /*
796 * tgt->node_id may be obsolete here if we failed
797 * during initial login or after a bus reset where
798 * the topology changed.
799 */
800 generation = device->generation;
801 smp_rmb(); /* node_id vs. generation */
802 node_id = device->node_id;
803 sbp2_send_management_orb(lu, node_id, generation,
804 SBP2_LOGOUT_REQUEST,
805 lu->login_id, NULL);
806 }
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200807 fw_core_remove_address_handler(&lu->address_handler);
808 list_del(&lu->link);
809 kfree(lu);
810 }
811 scsi_remove_host(shost);
Stefan Richterf32ddad2008-04-24 23:17:47 +0200812 fw_notify("released %s, target %d:0:0\n", tgt->bus_id, shost->host_no);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200813
Stefan Richter1dc3bea2008-02-24 19:01:21 +0100814 fw_unit_put(tgt->unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200815 scsi_host_put(shost);
Stefan Richter855c6032008-02-27 22:14:27 +0100816 fw_device_put(device);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400817}
818
Stefan Richter9fb551b2009-10-08 00:41:10 +0200819static void sbp2_target_get(struct sbp2_target *tgt)
820{
821 kref_get(&tgt->kref);
822}
Stefan Richterdf8ec242007-08-12 12:51:18 +0200823
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400824static void sbp2_target_put(struct sbp2_target *tgt)
825{
826 kref_put(&tgt->kref, sbp2_release_target);
827}
828
Stefan Richter285838e2007-11-07 01:12:51 +0100829/*
830 * Always get the target's kref when scheduling work on one its units.
831 * Each workqueue job is responsible to call sbp2_target_put() upon return.
832 */
833static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
834{
Stefan Richter9fb551b2009-10-08 00:41:10 +0200835 sbp2_target_get(lu->tgt);
Stefan Richter105e53f2011-05-01 20:50:31 +0200836 if (!queue_delayed_work(fw_workqueue, &lu->work, delay))
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400837 sbp2_target_put(lu->tgt);
Stefan Richter285838e2007-11-07 01:12:51 +0100838}
839
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500840/*
841 * Write retransmit retry values into the BUSY_TIMEOUT register.
842 * - The single-phase retry protocol is supported by all SBP-2 devices, but the
843 * default retry_limit value is 0 (i.e. never retry transmission). We write a
844 * saner value after logging into the device.
845 * - The dual-phase retry protocol is optional to implement, and if not
846 * supported, writes to the dual-phase portion of the register will be
847 * ignored. We try to write the original 1394-1995 default here.
848 * - In the case of devices that are also SBP-3-compliant, all writes are
849 * ignored, as the register is read-only, but contains single-phase retry of
850 * 15, which is what we're trying to set for all SBP-2 device anyway, so this
851 * write attempt is safe and yields more consistent behavior for all devices.
852 *
853 * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
854 * and section 6.4 of the SBP-3 spec for further details.
855 */
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500856static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
857{
Stefan Richtere5110d02009-06-06 18:35:27 +0200858 struct fw_device *device = target_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200859 __be32 d = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500860
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200861 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
862 lu->tgt->node_id, lu->generation, device->max_speed,
Stefan Richtere847cc82010-06-12 20:29:07 +0200863 CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT, &d, 4);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500864}
865
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200866static void sbp2_reconnect(struct work_struct *work);
867
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500868static void sbp2_login(struct work_struct *work)
869{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200870 struct sbp2_logical_unit *lu =
871 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +0100872 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200873 struct fw_device *device = target_device(tgt);
Stefan Richter48f18c72008-02-03 23:09:50 +0100874 struct Scsi_Host *shost;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200875 struct scsi_device *sdev;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500876 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200877 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500878
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100879 if (fw_device_is_shutdown(device))
880 goto out;
881
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100882 generation = device->generation;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100883 smp_rmb(); /* node IDs must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100884 node_id = device->node_id;
885 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500886
Stefan Richterce896d92008-02-03 23:11:39 +0100887 /* If this is a re-login attempt, log out, or we might be rejected. */
Stefan Richterf8436152008-02-26 23:30:02 +0100888 if (lu->has_sdev)
Stefan Richterce896d92008-02-03 23:11:39 +0100889 sbp2_send_management_orb(lu, device->node_id, generation,
890 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
891
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200892 if (sbp2_send_management_orb(lu, node_id, generation,
893 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter2e2705b2008-02-16 16:37:28 +0100894 if (lu->retries++ < 5) {
Stefan Richter285838e2007-11-07 01:12:51 +0100895 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Stefan Richter2e2705b2008-02-16 16:37:28 +0100896 } else {
Stefan Richter48f18c72008-02-03 23:09:50 +0100897 fw_error("%s: failed to login to LUN %04x\n",
898 tgt->bus_id, lu->lun);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100899 /* Let any waiting I/O fail from now on. */
900 sbp2_unblock(lu->tgt);
901 }
Stefan Richter285838e2007-11-07 01:12:51 +0100902 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500903 }
904
Stefan Richter48f18c72008-02-03 23:09:50 +0100905 tgt->node_id = node_id;
906 tgt->address_high = local_node_id << 16;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100907 smp_wmb(); /* node IDs must not be older than generation */
908 lu->generation = generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500909
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200910 lu->command_block_agent_address =
Stefan Richter71ee9f02008-02-28 20:51:11 +0100911 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
912 << 32) | be32_to_cpu(response.command_block_agent.low);
913 lu->login_id = be32_to_cpu(response.misc) & 0xffff;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500914
Stefan Richter48f18c72008-02-03 23:09:50 +0100915 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
916 tgt->bus_id, lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500917
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500918 /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
919 sbp2_set_busy_timeout(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500920
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200921 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
922 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500923
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100924 /* This was a re-login. */
Stefan Richterf8436152008-02-26 23:30:02 +0100925 if (lu->has_sdev) {
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100926 sbp2_cancel_orbs(lu);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100927 sbp2_conditionally_unblock(lu);
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100928 goto out;
929 }
930
Stefan Richter9220f192008-02-03 23:04:38 +0100931 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
932 ssleep(SBP2_INQUIRY_DELAY);
933
Stefan Richter48f18c72008-02-03 23:09:50 +0100934 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richterf8436152008-02-26 23:30:02 +0100935 sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
Stefan Richtere80de372008-02-15 21:29:02 +0100936 /*
937 * FIXME: We are unable to perform reconnects while in sbp2_login().
938 * Therefore __scsi_add_device() will get into trouble if a bus reset
939 * happens in parallel. It will either fail or leave us with an
940 * unusable sdev. As a workaround we check for this and retry the
941 * whole login and SCSI probing.
942 */
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100943
Stefan Richtere80de372008-02-15 21:29:02 +0100944 /* Reported error during __scsi_add_device() */
945 if (IS_ERR(sdev))
946 goto out_logout_login;
947
Stefan Richtere80de372008-02-15 21:29:02 +0100948 /* Unreported error during __scsi_add_device() */
949 smp_rmb(); /* get current card generation */
950 if (generation != device->card->generation) {
951 scsi_remove_device(sdev);
Stefan Richter33f1c6c2008-02-19 09:05:49 +0100952 scsi_device_put(sdev);
Stefan Richtere80de372008-02-15 21:29:02 +0100953 goto out_logout_login;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500954 }
Stefan Richtere80de372008-02-15 21:29:02 +0100955
956 /* No error during __scsi_add_device() */
Stefan Richterf8436152008-02-26 23:30:02 +0100957 lu->has_sdev = true;
958 scsi_device_put(sdev);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100959 sbp2_allow_block(lu);
Stefan Richtere80de372008-02-15 21:29:02 +0100960 goto out;
961
962 out_logout_login:
963 smp_rmb(); /* generation may have changed */
964 generation = device->generation;
965 smp_rmb(); /* node_id must not be older than generation */
966
967 sbp2_send_management_orb(lu, device->node_id, generation,
968 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
969 /*
970 * If a bus reset happened, sbp2_update will have requeued
971 * lu->work already. Reset the work from reconnect to login.
972 */
973 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Stefan Richter285838e2007-11-07 01:12:51 +0100974 out:
Stefan Richter48f18c72008-02-03 23:09:50 +0100975 sbp2_target_put(tgt);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500976}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500977
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200978static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
979{
980 struct sbp2_logical_unit *lu;
981
982 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
983 if (!lu)
984 return -ENOMEM;
985
986 lu->address_handler.length = 0x100;
987 lu->address_handler.address_callback = sbp2_status_write;
988 lu->address_handler.callback_data = lu;
989
990 if (fw_core_add_address_handler(&lu->address_handler,
991 &fw_high_memory_region) < 0) {
992 kfree(lu);
993 return -ENOMEM;
994 }
995
Stefan Richterf8436152008-02-26 23:30:02 +0100996 lu->tgt = tgt;
997 lu->lun = lun_entry & 0xffff;
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400998 lu->login_id = INVALID_LOGIN_ID;
Stefan Richterf8436152008-02-26 23:30:02 +0100999 lu->retries = 0;
1000 lu->has_sdev = false;
1001 lu->blocked = false;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001002 ++tgt->dont_block;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001003 INIT_LIST_HEAD(&lu->orb_list);
1004 INIT_DELAYED_WORK(&lu->work, sbp2_login);
1005
1006 list_add_tail(&lu->link, &tgt->lu_list);
1007 return 0;
1008}
1009
Stefan Richter13b302d2009-12-26 01:44:10 +01001010static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt,
1011 const u32 *directory)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001012{
1013 struct fw_csr_iterator ci;
1014 int key, value;
1015
1016 fw_csr_iterator_init(&ci, directory);
1017 while (fw_csr_iterator_next(&ci, &key, &value))
1018 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
1019 sbp2_add_logical_unit(tgt, value) < 0)
1020 return -ENOMEM;
1021 return 0;
1022}
1023
Stefan Richter13b302d2009-12-26 01:44:10 +01001024static int sbp2_scan_unit_dir(struct sbp2_target *tgt, const u32 *directory,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001025 u32 *model, u32 *firmware_revision)
1026{
1027 struct fw_csr_iterator ci;
1028 int key, value;
1029
1030 fw_csr_iterator_init(&ci, directory);
1031 while (fw_csr_iterator_next(&ci, &key, &value)) {
1032 switch (key) {
1033
1034 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1035 tgt->management_agent_address =
1036 CSR_REGISTER_BASE + 4 * value;
1037 break;
1038
1039 case CSR_DIRECTORY_ID:
1040 tgt->directory_id = value;
1041 break;
1042
1043 case CSR_MODEL:
1044 *model = value;
1045 break;
1046
1047 case SBP2_CSR_FIRMWARE_REVISION:
1048 *firmware_revision = value;
1049 break;
1050
Jarod Wilson384170d2008-01-25 23:31:12 -05001051 case SBP2_CSR_UNIT_CHARACTERISTICS:
1052 /* the timeout value is stored in 500ms units */
Stefan Richtereaf76e02009-10-08 00:39:31 +02001053 tgt->mgt_orb_timeout = (value >> 8 & 0xff) * 500;
Jarod Wilson384170d2008-01-25 23:31:12 -05001054 break;
1055
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001056 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1057 if (sbp2_add_logical_unit(tgt, value) < 0)
1058 return -ENOMEM;
1059 break;
1060
1061 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
Richard Sharpe0e3e2ea2008-06-24 19:11:13 -07001062 /* Adjust for the increment in the iterator */
1063 if (sbp2_scan_logical_unit_dir(tgt, ci.p - 1 + value) < 0)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001064 return -ENOMEM;
1065 break;
1066 }
1067 }
1068 return 0;
1069}
1070
Stefan Richtereaf76e02009-10-08 00:39:31 +02001071/*
1072 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
1073 * provided in the config rom. Most devices do provide a value, which
1074 * we'll use for login management orbs, but with some sane limits.
1075 */
1076static void sbp2_clamp_management_orb_timeout(struct sbp2_target *tgt)
1077{
1078 unsigned int timeout = tgt->mgt_orb_timeout;
1079
1080 if (timeout > 40000)
1081 fw_notify("%s: %ds mgt_ORB_timeout limited to 40s\n",
1082 tgt->bus_id, timeout / 1000);
1083
1084 tgt->mgt_orb_timeout = clamp_val(timeout, 5000, 40000);
1085}
1086
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001087static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1088 u32 firmware_revision)
1089{
1090 int i;
Stefan Richter05cca732008-01-26 17:42:45 +01001091 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001092
Stefan Richter2df222b2007-08-13 17:48:25 +02001093 if (w)
1094 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
1095 "if you need the workarounds parameter for %s\n",
Stefan Richter48f18c72008-02-03 23:09:50 +01001096 tgt->bus_id);
Stefan Richter2df222b2007-08-13 17:48:25 +02001097
1098 if (w & SBP2_WORKAROUND_OVERRIDE)
1099 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001100
1101 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1102
1103 if (sbp2_workarounds_table[i].firmware_revision !=
1104 (firmware_revision & 0xffffff00))
1105 continue;
1106
1107 if (sbp2_workarounds_table[i].model != model &&
Stefan Richterf7460722009-01-24 19:41:46 +01001108 sbp2_workarounds_table[i].model != SBP2_ROM_VALUE_WILDCARD)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001109 continue;
1110
Stefan Richter2df222b2007-08-13 17:48:25 +02001111 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001112 break;
1113 }
Stefan Richter2df222b2007-08-13 17:48:25 +02001114 out:
1115 if (w)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001116 fw_notify("Workarounds for %s: 0x%x "
1117 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
Stefan Richter48f18c72008-02-03 23:09:50 +01001118 tgt->bus_id, w, firmware_revision, model);
Stefan Richter2df222b2007-08-13 17:48:25 +02001119 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001120}
1121
1122static struct scsi_host_template scsi_driver_template;
1123
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001124static int sbp2_probe(struct device *dev)
1125{
1126 struct fw_unit *unit = fw_unit(dev);
Stefan Richtere5110d02009-06-06 18:35:27 +02001127 struct fw_device *device = fw_parent_device(unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001128 struct sbp2_target *tgt;
1129 struct sbp2_logical_unit *lu;
1130 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001131 u32 model, firmware_revision;
1132
Stefan Richter09b12dd2008-08-14 21:47:21 +02001133 if (dma_get_max_seg_size(device->card->device) > SBP2_MAX_SEG_SIZE)
1134 BUG_ON(dma_set_max_seg_size(device->card->device,
1135 SBP2_MAX_SEG_SIZE));
1136
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001137 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1138 if (shost == NULL)
1139 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001140
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001141 tgt = (struct sbp2_target *)shost->hostdata;
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001142 dev_set_drvdata(&unit->device, tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001143 tgt->unit = unit;
1144 kref_init(&tgt->kref);
1145 INIT_LIST_HEAD(&tgt->lu_list);
Kay Sieversa1f64812008-10-30 01:41:56 +01001146 tgt->bus_id = dev_name(&unit->device);
Stefan Richterc9755e12008-03-24 20:54:28 +01001147 tgt->guid = (u64)device->config_rom[3] << 32 | device->config_rom[4];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001148
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001149 if (fw_device_enable_phys_dma(device) < 0)
1150 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001151
Stefan Richteraf271942009-06-30 20:27:59 +02001152 shost->max_cmd_len = SBP2_MAX_CDB_SIZE;
1153
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001154 if (scsi_add_host(shost, &unit->device) < 0)
1155 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001156
Stefan Richter855c6032008-02-27 22:14:27 +01001157 fw_device_get(device);
Stefan Richter1dc3bea2008-02-24 19:01:21 +01001158 fw_unit_get(unit);
Stefan Richter855c6032008-02-27 22:14:27 +01001159
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001160 /* implicit directory ID */
1161 tgt->directory_id = ((unit->directory - device->config_rom) * 4
1162 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001163
Stefan Richterf7460722009-01-24 19:41:46 +01001164 firmware_revision = SBP2_ROM_VALUE_MISSING;
1165 model = SBP2_ROM_VALUE_MISSING;
1166
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001167 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1168 &firmware_revision) < 0)
1169 goto fail_tgt_put;
1170
Stefan Richtereaf76e02009-10-08 00:39:31 +02001171 sbp2_clamp_management_orb_timeout(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001172 sbp2_init_workarounds(tgt, model, firmware_revision);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001173
Stefan Richtera08e1002009-01-24 19:41:46 +01001174 /*
1175 * At S100 we can do 512 bytes per packet, at S200 1024 bytes,
1176 * and so on up to 4096 bytes. The SBP-2 max_payload field
1177 * specifies the max payload size as 2 ^ (max_payload + 2), so
1178 * if we set this to max_speed + 7, we get the right value.
1179 */
1180 tgt->max_payload = min(device->max_speed + 7, 10U);
1181 tgt->max_payload = min(tgt->max_payload, device->card->max_receive - 1);
1182
Stefan Richter285838e2007-11-07 01:12:51 +01001183 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001184 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter0dcfeb72008-10-22 00:28:36 +02001185 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001186 return 0;
Kristian Høgsbergad852742007-05-09 19:23:07 -04001187
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001188 fail_tgt_put:
Stefan Richter285838e2007-11-07 01:12:51 +01001189 sbp2_target_put(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001190 return -ENOMEM;
1191
1192 fail_shost_put:
1193 scsi_host_put(shost);
1194 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001195}
1196
1197static int sbp2_remove(struct device *dev)
1198{
1199 struct fw_unit *unit = fw_unit(dev);
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001200 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001201
Stefan Richter285838e2007-11-07 01:12:51 +01001202 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001203 return 0;
1204}
1205
1206static void sbp2_reconnect(struct work_struct *work)
1207{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001208 struct sbp2_logical_unit *lu =
1209 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +01001210 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +02001211 struct fw_device *device = target_device(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001212 int generation, node_id, local_node_id;
1213
Stefan Richterbe6f48b2008-01-27 19:14:44 +01001214 if (fw_device_is_shutdown(device))
1215 goto out;
1216
Stefan Richter5a8a1bc2008-01-24 01:53:19 +01001217 generation = device->generation;
Stefan Richter621f6dd2008-10-26 11:04:20 +01001218 smp_rmb(); /* node IDs must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +01001219 node_id = device->node_id;
1220 local_node_id = device->card->node_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001221
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001222 if (sbp2_send_management_orb(lu, node_id, generation,
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001223 SBP2_RECONNECT_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001224 lu->login_id, NULL) < 0) {
Stefan Richterce896d92008-02-03 23:11:39 +01001225 /*
1226 * If reconnect was impossible even though we are in the
1227 * current generation, fall back and try to log in again.
1228 *
1229 * We could check for "Function rejected" status, but
1230 * looking at the bus generation as simpler and more general.
1231 */
1232 smp_rmb(); /* get current card generation */
1233 if (generation == device->card->generation ||
1234 lu->retries++ >= 5) {
Stefan Richter48f18c72008-02-03 23:09:50 +01001235 fw_error("%s: failed to reconnect\n", tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001236 lu->retries = 0;
1237 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001238 }
Stefan Richter285838e2007-11-07 01:12:51 +01001239 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1240 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001241 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001242
Stefan Richter48f18c72008-02-03 23:09:50 +01001243 tgt->node_id = node_id;
1244 tgt->address_high = local_node_id << 16;
Stefan Richter621f6dd2008-10-26 11:04:20 +01001245 smp_wmb(); /* node IDs must not be older than generation */
1246 lu->generation = generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001247
Stefan Richter48f18c72008-02-03 23:09:50 +01001248 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1249 tgt->bus_id, lu->lun, lu->retries);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001250
1251 sbp2_agent_reset(lu);
1252 sbp2_cancel_orbs(lu);
Stefan Richter2e2705b2008-02-16 16:37:28 +01001253 sbp2_conditionally_unblock(lu);
Stefan Richter285838e2007-11-07 01:12:51 +01001254 out:
Stefan Richter48f18c72008-02-03 23:09:50 +01001255 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001256}
1257
1258static void sbp2_update(struct fw_unit *unit)
1259{
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001260 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001261 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001262
Stefan Richtere5110d02009-06-06 18:35:27 +02001263 fw_device_enable_phys_dma(fw_parent_device(unit));
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001264
1265 /*
1266 * Fw-core serializes sbp2_update() against sbp2_remove().
1267 * Iteration over tgt->lu_list is therefore safe here.
1268 */
1269 list_for_each_entry(lu, &tgt->lu_list, link) {
Stefan Richter2e2705b2008-02-16 16:37:28 +01001270 sbp2_conditionally_block(lu);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001271 lu->retries = 0;
Stefan Richter285838e2007-11-07 01:12:51 +01001272 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001273 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001274}
1275
1276#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1277#define SBP2_SW_VERSION_ENTRY 0x00010483
1278
Stefan Richterb3b29882009-02-15 23:12:34 +01001279static const struct ieee1394_device_id sbp2_id_table[] = {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001280 {
Stefan Richterb3b29882009-02-15 23:12:34 +01001281 .match_flags = IEEE1394_MATCH_SPECIFIER_ID |
1282 IEEE1394_MATCH_VERSION,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001283 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
Stefan Richter5af4e5e2007-01-21 20:45:32 +01001284 .version = SBP2_SW_VERSION_ENTRY,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001285 },
1286 { }
1287};
1288
1289static struct fw_driver sbp2_driver = {
1290 .driver = {
1291 .owner = THIS_MODULE,
1292 .name = sbp2_driver_name,
1293 .bus = &fw_bus_type,
1294 .probe = sbp2_probe,
1295 .remove = sbp2_remove,
1296 },
1297 .update = sbp2_update,
1298 .id_table = sbp2_id_table,
1299};
1300
Stefan Richter5e212562009-01-28 01:03:34 +01001301static void sbp2_unmap_scatterlist(struct device *card_device,
1302 struct sbp2_command_orb *orb)
1303{
1304 if (scsi_sg_count(orb->cmd))
1305 dma_unmap_sg(card_device, scsi_sglist(orb->cmd),
1306 scsi_sg_count(orb->cmd),
1307 orb->cmd->sc_data_direction);
1308
1309 if (orb->request.misc & cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT))
1310 dma_unmap_single(card_device, orb->page_table_bus,
1311 sizeof(orb->page_table), DMA_TO_DEVICE);
1312}
1313
Stefan Richter53dca512008-12-14 21:47:04 +01001314static unsigned int sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001315{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001316 int sam_status;
1317
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001318 sense_data[0] = 0x70;
1319 sense_data[1] = 0x0;
1320 sense_data[2] = sbp2_status[1];
1321 sense_data[3] = sbp2_status[4];
1322 sense_data[4] = sbp2_status[5];
1323 sense_data[5] = sbp2_status[6];
1324 sense_data[6] = sbp2_status[7];
1325 sense_data[7] = 10;
1326 sense_data[8] = sbp2_status[8];
1327 sense_data[9] = sbp2_status[9];
1328 sense_data[10] = sbp2_status[10];
1329 sense_data[11] = sbp2_status[11];
1330 sense_data[12] = sbp2_status[2];
1331 sense_data[13] = sbp2_status[3];
1332 sense_data[14] = sbp2_status[12];
1333 sense_data[15] = sbp2_status[13];
1334
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001335 sam_status = sbp2_status[0] & 0x3f;
1336
1337 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001338 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001339 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001340 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001341 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001342 case SAM_STAT_RESERVATION_CONFLICT:
1343 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001344 return DID_OK << 16 | sam_status;
1345
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001346 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001347 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001348 }
1349}
1350
Stefan Richter53dca512008-12-14 21:47:04 +01001351static void complete_command_orb(struct sbp2_orb *base_orb,
1352 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001353{
Jay Fenlason6f061482007-06-27 16:04:33 -04001354 struct sbp2_command_orb *orb =
1355 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richtere5110d02009-06-06 18:35:27 +02001356 struct fw_device *device = target_device(orb->lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001357 int result;
1358
1359 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001360 if (STATUS_GET_DEAD(*status))
Stefan Richtere0e60212008-02-03 23:08:58 +01001361 sbp2_agent_reset_no_wait(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001362
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001363 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001364 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001365 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001366 break;
1367 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001368 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001369 break;
1370 case SBP2_STATUS_ILLEGAL_REQUEST:
1371 case SBP2_STATUS_VENDOR_DEPENDENT:
1372 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001373 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001374 break;
1375 }
1376
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001377 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1378 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001379 orb->cmd->sense_buffer);
1380 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001381 /*
1382 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001383 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001384 * or when sending the write (less likely).
1385 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001386 result = DID_BUS_BUSY << 16;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001387 sbp2_conditionally_block(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001388 }
1389
1390 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001391 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001392 sbp2_unmap_scatterlist(device->card->device, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001393
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001394 orb->cmd->result = result;
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001395 orb->cmd->scsi_done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001396}
1397
Stefan Richter53dca512008-12-14 21:47:04 +01001398static int sbp2_map_scatterlist(struct sbp2_command_orb *orb,
1399 struct fw_device *device, struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001400{
Stefan Richter09b12dd2008-08-14 21:47:21 +02001401 struct scatterlist *sg = scsi_sglist(orb->cmd);
1402 int i, n;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001403
Stefan Richter09b12dd2008-08-14 21:47:21 +02001404 n = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1405 orb->cmd->sc_data_direction);
1406 if (n == 0)
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001407 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001408
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001409 /*
1410 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001411 * the scatter list by converting it to an immediate block
1412 * request. This is also a workaround for broken devices such
1413 * as the second generation iPod which doesn't support page
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001414 * tables.
1415 */
Stefan Richter09b12dd2008-08-14 21:47:21 +02001416 if (n == 1) {
Stefan Richter71ee9f02008-02-28 20:51:11 +01001417 orb->request.data_descriptor.high =
1418 cpu_to_be32(lu->tgt->address_high);
1419 orb->request.data_descriptor.low =
1420 cpu_to_be32(sg_dma_address(sg));
1421 orb->request.misc |=
1422 cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001423 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001424 }
1425
Stefan Richter09b12dd2008-08-14 21:47:21 +02001426 for_each_sg(sg, sg, n, i) {
1427 orb->page_table[i].high = cpu_to_be32(sg_dma_len(sg) << 16);
1428 orb->page_table[i].low = cpu_to_be32(sg_dma_address(sg));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001429 }
1430
Stefan Richterb4be0162007-07-02 22:07:34 +02001431 orb->page_table_bus =
1432 dma_map_single(device->card->device, orb->page_table,
1433 sizeof(orb->page_table), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -07001434 if (dma_mapping_error(device->card->device, orb->page_table_bus))
Stefan Richterb4be0162007-07-02 22:07:34 +02001435 goto fail_page_table;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001436
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001437 /*
1438 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001439 * to fill in the node ID part of the address. All other
1440 * pointers assume that the data referenced reside on the
1441 * initiator (i.e. us), but data_descriptor can refer to data
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001442 * on other nodes so we need to put our ID in descriptor.high.
1443 */
Stefan Richter71ee9f02008-02-28 20:51:11 +01001444 orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1445 orb->request.data_descriptor.low = cpu_to_be32(orb->page_table_bus);
1446 orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
Stefan Richter09b12dd2008-08-14 21:47:21 +02001447 COMMAND_ORB_DATA_SIZE(n));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001448
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001449 return 0;
1450
1451 fail_page_table:
Stefan Richter09b12dd2008-08-14 21:47:21 +02001452 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1453 scsi_sg_count(orb->cmd), orb->cmd->sc_data_direction);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001454 fail:
1455 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001456}
1457
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001458/* SCSI stack integration */
1459
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001460static int sbp2_scsi_queuecommand(struct Scsi_Host *shost,
1461 struct scsi_cmnd *cmd)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001462{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001463 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Stefan Richtere5110d02009-06-06 18:35:27 +02001464 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001465 struct sbp2_command_orb *orb;
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001466 int generation, retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001467
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001468 /*
1469 * Bidirectional commands are not yet implemented, and unknown
1470 * transfer direction not handled.
1471 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001472 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richter8a8cea22007-06-09 19:26:22 +02001473 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001474 cmd->result = DID_ERROR << 16;
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001475 cmd->scsi_done(cmd);
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001476 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001477 }
1478
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001479 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001480 if (orb == NULL) {
1481 fw_notify("failed to alloc orb\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001482 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001483 }
1484
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001485 /* Initialize rcode to something not RCODE_COMPLETE. */
1486 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001487 kref_init(&orb->base.kref);
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001488 orb->lu = lu;
1489 orb->cmd = cmd;
Stefan Richtera08e1002009-01-24 19:41:46 +01001490 orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
Stefan Richter71ee9f02008-02-28 20:51:11 +01001491 orb->request.misc = cpu_to_be32(
Stefan Richtera08e1002009-01-24 19:41:46 +01001492 COMMAND_ORB_MAX_PAYLOAD(lu->tgt->max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001493 COMMAND_ORB_SPEED(device->max_speed) |
Stefan Richter71ee9f02008-02-28 20:51:11 +01001494 COMMAND_ORB_NOTIFY);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001495
1496 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +01001497 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001498
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001499 generation = device->generation;
1500 smp_rmb(); /* sbp2_map_scatterlist looks at tgt->address_high */
1501
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001502 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1503 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001504
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001505 memcpy(orb->request.command_block, cmd->cmnd, cmd->cmd_len);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001506
1507 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001508 orb->base.request_bus =
1509 dma_map_single(device->card->device, &orb->request,
1510 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001511 if (dma_mapping_error(device->card->device, orb->base.request_bus)) {
1512 sbp2_unmap_scatterlist(device->card->device, orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001513 goto out;
Stefan Richter5e212562009-01-28 01:03:34 +01001514 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001515
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001516 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, generation,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001517 lu->command_block_agent_address + SBP2_ORB_POINTER);
1518 retval = 0;
1519 out:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001520 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001521 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001522}
1523
Stefan Richtercfb01382007-01-23 21:20:08 +01001524static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1525{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001526 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001527
Stefan Richter5513c5f2008-02-17 14:56:19 +01001528 /* (Re-)Adding logical units via the SCSI stack is not supported. */
1529 if (!lu)
1530 return -ENOSYS;
1531
Stefan Richtercfb01382007-01-23 21:20:08 +01001532 sdev->allow_restart = 1;
1533
Stefan Richter8ac3a472008-01-27 22:31:27 +01001534 /* SBP-2 requires quadlet alignment of the data buffers. */
1535 blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
James Bottomley465ff312008-01-01 10:00:10 -06001536
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001537 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001538 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001539
Stefan Richtercfb01382007-01-23 21:20:08 +01001540 return 0;
1541}
1542
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001543static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1544{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001545 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001546
Stefan Richtercfb01382007-01-23 21:20:08 +01001547 sdev->use_10_for_rw = 1;
1548
Stefan Richter2635f962008-05-11 00:36:47 +02001549 if (sbp2_param_exclusive_login)
1550 sdev->manage_start_stop = 1;
1551
Stefan Richtercfb01382007-01-23 21:20:08 +01001552 if (sdev->type == TYPE_ROM)
1553 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001554
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001555 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001556 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001557 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001558
1559 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001560 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001561
Stefan Richterffcaade2008-05-11 00:35:04 +02001562 if (lu->tgt->workarounds & SBP2_WORKAROUND_POWER_CONDITION)
1563 sdev->start_stop_pwr_cond = 1;
1564
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001565 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001566 blk_queue_max_hw_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001567
Stefan Richter09b12dd2008-08-14 21:47:21 +02001568 blk_queue_max_segment_size(sdev->request_queue, SBP2_MAX_SEG_SIZE);
1569
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001570 return 0;
1571}
1572
1573/*
1574 * Called by scsi stack when something has really gone wrong. Usually
1575 * called when a command has timed-out for some reason.
1576 */
1577static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1578{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001579 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001580
Stefan Richter48f18c72008-02-03 23:09:50 +01001581 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001582 sbp2_agent_reset(lu);
1583 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001584
1585 return SUCCESS;
1586}
1587
Stefan Richter14e21982007-05-27 13:18:27 +02001588/*
1589 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1590 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1591 *
1592 * This is the concatenation of target port identifier and logical unit
1593 * identifier as per SAM-2...SAM-4 annex A.
1594 */
Stefan Richter53dca512008-12-14 21:47:04 +01001595static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
1596 struct device_attribute *attr, char *buf)
Stefan Richter14e21982007-05-27 13:18:27 +02001597{
1598 struct scsi_device *sdev = to_scsi_device(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001599 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001600
1601 if (!sdev)
1602 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001603
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001604 lu = sdev->hostdata;
Stefan Richter14e21982007-05-27 13:18:27 +02001605
Stefan Richterc9755e12008-03-24 20:54:28 +01001606 return sprintf(buf, "%016llx:%06x:%04x\n",
1607 (unsigned long long)lu->tgt->guid,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001608 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001609}
1610
1611static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1612
1613static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1614 &dev_attr_ieee1394_id,
1615 NULL
1616};
1617
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001618static struct scsi_host_template scsi_driver_template = {
1619 .module = THIS_MODULE,
1620 .name = "SBP-2 IEEE-1394",
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -04001621 .proc_name = sbp2_driver_name,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001622 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001623 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001624 .slave_configure = sbp2_scsi_slave_configure,
1625 .eh_abort_handler = sbp2_scsi_abort,
1626 .this_id = -1,
1627 .sg_tablesize = SG_ALL,
1628 .use_clustering = ENABLE_CLUSTERING,
Stefan Richter02af8e72007-01-21 20:50:11 +01001629 .cmd_per_lun = 1,
1630 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001631 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001632};
1633
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001634MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1635MODULE_DESCRIPTION("SCSI over IEEE1394");
1636MODULE_LICENSE("GPL");
1637MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1638
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001639/* Provide a module alias so root-on-sbp2 initrds don't break. */
1640#ifndef CONFIG_IEEE1394_SBP2_MODULE
1641MODULE_ALIAS("sbp2");
1642#endif
1643
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001644static int __init sbp2_init(void)
1645{
1646 return driver_register(&sbp2_driver.driver);
1647}
1648
1649static void __exit sbp2_cleanup(void)
1650{
1651 driver_unregister(&sbp2_driver.driver);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001652}
1653
1654module_init(sbp2_init);
1655module_exit(sbp2_cleanup);