blob: bfae4b309791103e48b2bb704300d1cd84da9750 [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 -0500128/* I don't know why the SCSI stack doesn't define something like this... */
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400129typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500130
131static const char sbp2_driver_name[] = "sbp2";
132
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200133/*
134 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
135 * and one struct scsi_device per sbp2_logical_unit.
136 */
137struct sbp2_logical_unit {
138 struct sbp2_target *tgt;
139 struct list_head link;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500140 struct fw_address_handler address_handler;
141 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200142
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500143 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200144 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500145 int login_id;
146
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400147 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200148 * The generation is updated once we've logged in or reconnected
149 * to the logical unit. Thus, I/O to the device will automatically
150 * fail and get retried if it happens in a window where the device
151 * is not ready, e.g. after a bus reset but before we reconnect.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400152 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500153 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500154 int retries;
155 struct delayed_work work;
Stefan Richterf8436152008-02-26 23:30:02 +0100156 bool has_sdev;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100157 bool blocked;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500158};
159
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200160/*
161 * We create one struct sbp2_target per IEEE 1212 Unit Directory
162 * and one struct Scsi_Host per sbp2_target.
163 */
164struct sbp2_target {
165 struct kref kref;
166 struct fw_unit *unit;
Stefan Richter48f18c72008-02-03 23:09:50 +0100167 const char *bus_id;
Stefan Richter05cca7382008-01-26 17:42:45 +0100168 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200169
170 u64 management_agent_address;
Stefan Richterc9755e12008-03-24 20:54:28 +0100171 u64 guid;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200172 int directory_id;
173 int node_id;
174 int address_high;
Stefan Richter05cca7382008-01-26 17:42:45 +0100175 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500176 unsigned int mgt_orb_timeout;
Stefan Richtera08e1002009-01-24 19:41:46 +0100177 unsigned int max_payload;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100178
179 int dont_block; /* counter for each logical unit */
180 int blocked; /* ditto */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200181};
182
Stefan Richtere5110d02009-06-06 18:35:27 +0200183static struct fw_device *target_device(struct sbp2_target *tgt)
184{
185 return fw_parent_device(tgt->unit);
186}
187
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400188/* Impossible login_id, to detect logout attempt before successful login */
189#define INVALID_LOGIN_ID 0x10000
190
Stefan Richtereaf76e02009-10-08 00:39:31 +0200191#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500192#define SBP2_ORB_NULL 0x80000000
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500193#define SBP2_RETRY_LIMIT 0xf /* 15 retries */
194#define SBP2_CYCLE_LIMIT (0xc8 << 12) /* 200 125us cycles */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500195
Stefan Richter09b12dd2008-08-14 21:47:21 +0200196/*
Stefan Richteraf271942009-06-30 20:27:59 +0200197 * There is no transport protocol limit to the CDB length, but we implement
198 * a fixed length only. 16 bytes is enough for disks larger than 2 TB.
199 */
200#define SBP2_MAX_CDB_SIZE 16
201
202/*
Stefan Richter09b12dd2008-08-14 21:47:21 +0200203 * The default maximum s/g segment size of a FireWire controller is
204 * usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
205 * be quadlet-aligned, we set the length limit to 0xffff & ~3.
206 */
207#define SBP2_MAX_SEG_SIZE 0xfffc
208
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500209/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500210#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200211#define SBP2_CSR_FIRMWARE_REVISION 0x3c
212#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
213#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500214
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500215/* Management orb opcodes */
216#define SBP2_LOGIN_REQUEST 0x0
217#define SBP2_QUERY_LOGINS_REQUEST 0x1
218#define SBP2_RECONNECT_REQUEST 0x3
219#define SBP2_SET_PASSWORD_REQUEST 0x4
220#define SBP2_LOGOUT_REQUEST 0x7
221#define SBP2_ABORT_TASK_REQUEST 0xb
222#define SBP2_ABORT_TASK_SET 0xc
223#define SBP2_LOGICAL_UNIT_RESET 0xe
224#define SBP2_TARGET_RESET_REQUEST 0xf
225
226/* Offsets for command block agent registers */
227#define SBP2_AGENT_STATE 0x00
228#define SBP2_AGENT_RESET 0x04
229#define SBP2_ORB_POINTER 0x08
230#define SBP2_DOORBELL 0x10
231#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
232
233/* Status write response codes */
234#define SBP2_STATUS_REQUEST_COMPLETE 0x0
235#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
236#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
237#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
238
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400239#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
240#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
241#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
242#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
243#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
244#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
245#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
246#define STATUS_GET_DATA(v) ((v).data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500247
248struct sbp2_status {
249 u32 status;
250 u32 orb_low;
251 u8 data[24];
252};
253
254struct sbp2_pointer {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100255 __be32 high;
256 __be32 low;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500257};
258
259struct sbp2_orb {
260 struct fw_transaction t;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400261 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500262 dma_addr_t request_bus;
263 int rcode;
264 struct sbp2_pointer pointer;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400265 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500266 struct list_head link;
267};
268
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400269#define MANAGEMENT_ORB_LUN(v) ((v))
270#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
271#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200272#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400273#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
274#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500275
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400276#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
277#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500278
279struct sbp2_management_orb {
280 struct sbp2_orb base;
281 struct {
282 struct sbp2_pointer password;
283 struct sbp2_pointer response;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100284 __be32 misc;
285 __be32 length;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500286 struct sbp2_pointer status_fifo;
287 } request;
288 __be32 response[4];
289 dma_addr_t response_bus;
290 struct completion done;
291 struct sbp2_status status;
292};
293
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500294struct sbp2_login_response {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100295 __be32 misc;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500296 struct sbp2_pointer command_block_agent;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100297 __be32 reconnect_hold;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500298};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400299#define COMMAND_ORB_DATA_SIZE(v) ((v))
300#define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
301#define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
302#define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
303#define COMMAND_ORB_SPEED(v) ((v) << 24)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +0100304#define COMMAND_ORB_DIRECTION ((1) << 27)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400305#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
306#define COMMAND_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500307
308struct sbp2_command_orb {
309 struct sbp2_orb base;
310 struct {
311 struct sbp2_pointer next;
312 struct sbp2_pointer data_descriptor;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100313 __be32 misc;
Stefan Richteraf271942009-06-30 20:27:59 +0200314 u8 command_block[SBP2_MAX_CDB_SIZE];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500315 } request;
316 struct scsi_cmnd *cmd;
317 scsi_done_fn_t done;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200318 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500319
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200320 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500321 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500322};
323
Stefan Richterf7460722009-01-24 19:41:46 +0100324#define SBP2_ROM_VALUE_WILDCARD ~0 /* match all */
325#define SBP2_ROM_VALUE_MISSING 0xff000000 /* not present in the unit dir. */
326
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500327/*
328 * List of devices with known bugs.
329 *
330 * The firmware_revision field, masked with 0xffff00, is the best
331 * indicator for the type of bridge chip of a device. It yields a few
332 * false positives but this did not break correctly behaving devices
Stefan Richterf7460722009-01-24 19:41:46 +0100333 * so far.
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500334 */
335static const struct {
336 u32 firmware_revision;
337 u32 model;
Stefan Richter05cca7382008-01-26 17:42:45 +0100338 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500339} sbp2_workarounds_table[] = {
340 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
341 .firmware_revision = 0x002800,
342 .model = 0x001010,
343 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
Stefan Richterffcaade2008-05-11 00:35:04 +0200344 SBP2_WORKAROUND_MODE_SENSE_8 |
345 SBP2_WORKAROUND_POWER_CONDITION,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500346 },
Stefan Richter9220f192008-02-03 23:04:38 +0100347 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
348 .firmware_revision = 0x002800,
349 .model = 0x000000,
Stefan Richter3c5f8032009-09-06 19:33:50 +0200350 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
Stefan Richter9220f192008-02-03 23:04:38 +0100351 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500352 /* Initio bridges, actually only needed for some older ones */ {
353 .firmware_revision = 0x000200,
Stefan Richterf7460722009-01-24 19:41:46 +0100354 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500355 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
356 },
Stefan Richterffcaade2008-05-11 00:35:04 +0200357 /* PL-3507 bridge with Prolific firmware */ {
358 .firmware_revision = 0x012800,
Stefan Richterf7460722009-01-24 19:41:46 +0100359 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richterffcaade2008-05-11 00:35:04 +0200360 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
361 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500362 /* Symbios bridge */ {
363 .firmware_revision = 0xa0b800,
Stefan Richterf7460722009-01-24 19:41:46 +0100364 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500365 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
366 },
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100367 /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
368 .firmware_revision = 0x002600,
Stefan Richterf7460722009-01-24 19:41:46 +0100369 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100370 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
371 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400372 /*
Stefan Richterc8c47072009-01-29 00:11:59 +0100373 * iPod 2nd generation: needs 128k max transfer size workaround
374 * iPod 3rd generation: needs fix capacity workaround
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400375 */
Stefan Richterc8c47072009-01-29 00:11:59 +0100376 {
377 .firmware_revision = 0x0a2700,
378 .model = 0x000000,
379 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS |
380 SBP2_WORKAROUND_FIX_CAPACITY,
381 },
382 /* iPod 4th generation */ {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500383 .firmware_revision = 0x0a2700,
384 .model = 0x000021,
385 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
386 },
387 /* iPod mini */ {
388 .firmware_revision = 0x0a2700,
Stefan Richter031bb272008-11-22 12:38:58 +0100389 .model = 0x000022,
390 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
391 },
392 /* iPod mini */ {
393 .firmware_revision = 0x0a2700,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500394 .model = 0x000023,
395 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
396 },
397 /* iPod Photo */ {
398 .firmware_revision = 0x0a2700,
399 .model = 0x00007e,
400 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
401 }
402};
403
Stefan Richter53dca512008-12-14 21:47:04 +0100404static void free_orb(struct kref *kref)
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400405{
406 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
407
408 kfree(orb);
409}
410
Stefan Richter53dca512008-12-14 21:47:04 +0100411static void sbp2_status_write(struct fw_card *card, struct fw_request *request,
412 int tcode, int destination, int source,
Stefan Richter33e553f2010-06-20 22:50:35 +0200413 int generation, unsigned long long offset,
Stefan Richter53dca512008-12-14 21:47:04 +0100414 void *payload, size_t length, void *callback_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500415{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200416 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500417 struct sbp2_orb *orb;
418 struct sbp2_status status;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500419 unsigned long flags;
420
421 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
Stefan Richter094614f2009-09-06 18:51:27 +0200422 length < 8 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500423 fw_send_response(card, request, RCODE_TYPE_ERROR);
424 return;
425 }
426
Stefan Richter094614f2009-09-06 18:51:27 +0200427 status.status = be32_to_cpup(payload);
428 status.orb_low = be32_to_cpup(payload + 4);
429 memset(status.data, 0, sizeof(status.data));
430 if (length > 8)
431 memcpy(status.data, payload + 8, length - 8);
432
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400433 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500434 fw_notify("non-orb related status write, not handled\n");
435 fw_send_response(card, request, RCODE_COMPLETE);
436 return;
437 }
438
439 /* Lookup the orb corresponding to this status write. */
440 spin_lock_irqsave(&card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200441 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400442 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400443 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
444 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500445 list_del(&orb->link);
446 break;
447 }
448 }
449 spin_unlock_irqrestore(&card->lock, flags);
450
Stefan Richterbaed6b82009-09-03 23:07:35 +0200451 if (&orb->link != &lu->orb_list) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500452 orb->callback(orb, &status);
Stefan Richter6c743402010-08-16 21:58:03 +0200453 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richterbaed6b82009-09-03 23:07:35 +0200454 } else {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500455 fw_error("status write for unknown orb\n");
Stefan Richterbaed6b82009-09-03 23:07:35 +0200456 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400457
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500458 fw_send_response(card, request, RCODE_COMPLETE);
459}
460
Stefan Richter53dca512008-12-14 21:47:04 +0100461static void complete_transaction(struct fw_card *card, int rcode,
462 void *payload, size_t length, void *data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500463{
464 struct sbp2_orb *orb = data;
465 unsigned long flags;
466
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400467 /*
468 * This is a little tricky. We can get the status write for
469 * the orb before we get this callback. The status write
470 * handler above will assume the orb pointer transaction was
471 * successful and set the rcode to RCODE_COMPLETE for the orb.
472 * So this callback only sets the rcode if it hasn't already
473 * been set and only does the cleanup if the transaction
474 * failed and we didn't already get a status write.
Stefan Richtera481e972010-08-16 22:13:34 +0200475 *
476 * Here we treat RCODE_CANCELLED like RCODE_COMPLETE because some
477 * OXUF936QSE firmwares occasionally respond after Split_Timeout and
478 * complete the ORB just fine. Note, we also get RCODE_CANCELLED
479 * from sbp2_cancel_orbs() if fw_cancel_transaction() == 0.
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400480 */
481 spin_lock_irqsave(&card->lock, flags);
482
483 if (orb->rcode == -1)
484 orb->rcode = rcode;
Stefan Richtera481e972010-08-16 22:13:34 +0200485
486 if (orb->rcode != RCODE_COMPLETE && orb->rcode != RCODE_CANCELLED) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500487 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200488 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter6c743402010-08-16 21:58:03 +0200489
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500490 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200491 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richter1b34e972007-08-25 10:40:42 +0200492 } else {
493 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500494 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400495
Stefan Richter6c743402010-08-16 21:58:03 +0200496 kref_put(&orb->kref, free_orb); /* transaction callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500497}
498
Stefan Richter53dca512008-12-14 21:47:04 +0100499static void sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
500 int node_id, int generation, u64 offset)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500501{
Stefan Richtere5110d02009-06-06 18:35:27 +0200502 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500503 unsigned long flags;
504
505 orb->pointer.high = 0;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100506 orb->pointer.low = cpu_to_be32(orb->request_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500507
508 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200509 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500510 spin_unlock_irqrestore(&device->card->lock, flags);
511
Stefan Richter6c743402010-08-16 21:58:03 +0200512 kref_get(&orb->kref); /* transaction callback reference */
513 kref_get(&orb->kref); /* orb callback reference */
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400514
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500515 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200516 node_id, generation, device->max_speed, offset,
Stefan Richtere847cc832010-06-12 20:29:07 +0200517 &orb->pointer, 8, complete_transaction, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500518}
519
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200520static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500521{
Stefan Richtere5110d02009-06-06 18:35:27 +0200522 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500523 struct sbp2_orb *orb, *next;
524 struct list_head list;
525 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500526 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500527
528 INIT_LIST_HEAD(&list);
529 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200530 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500531 spin_unlock_irqrestore(&device->card->lock, flags);
532
533 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500534 retval = 0;
Stefan Richtera481e972010-08-16 22:13:34 +0200535 fw_cancel_transaction(device->card, &orb->t);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500536
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500537 orb->rcode = RCODE_CANCELLED;
538 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200539 kref_put(&orb->kref, free_orb); /* orb callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500540 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500541
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500542 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500543}
544
Stefan Richter53dca512008-12-14 21:47:04 +0100545static void complete_management_orb(struct sbp2_orb *base_orb,
546 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500547{
548 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400549 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500550
551 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400552 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500553 complete(&orb->done);
554}
555
Stefan Richter53dca512008-12-14 21:47:04 +0100556static int sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
557 int generation, int function,
558 int lun_or_login_id, void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500559{
Stefan Richtere5110d02009-06-06 18:35:27 +0200560 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500561 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100562 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500563 int retval = -ENOMEM;
564
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100565 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
566 return 0;
567
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400568 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500569 if (orb == NULL)
570 return -ENOMEM;
571
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400572 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500573 orb->response_bus =
574 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400575 sizeof(orb->response), DMA_FROM_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700576 if (dma_mapping_error(device->card->device, orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200577 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500578
Stefan Richter71ee9f02008-02-28 20:51:11 +0100579 orb->request.response.high = 0;
580 orb->request.response.low = cpu_to_be32(orb->response_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500581
Stefan Richter71ee9f02008-02-28 20:51:11 +0100582 orb->request.misc = cpu_to_be32(
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400583 MANAGEMENT_ORB_NOTIFY |
584 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100585 MANAGEMENT_ORB_LUN(lun_or_login_id));
586 orb->request.length = cpu_to_be32(
587 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500588
Stefan Richter71ee9f02008-02-28 20:51:11 +0100589 orb->request.status_fifo.high =
590 cpu_to_be32(lu->address_handler.offset >> 32);
591 orb->request.status_fifo.low =
592 cpu_to_be32(lu->address_handler.offset);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500593
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500594 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100595 /* Ask for 2^2 == 4 seconds reconnect grace period */
Stefan Richter71ee9f02008-02-28 20:51:11 +0100596 orb->request.misc |= cpu_to_be32(
Stefan Richter14dc9922008-01-20 01:25:31 +0100597 MANAGEMENT_ORB_RECONNECT(2) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100598 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
Jarod Wilson384170d2008-01-25 23:31:12 -0500599 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100600 } else {
601 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500602 }
603
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500604 init_completion(&orb->done);
605 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500606
Stefan Richter7aa48482007-07-02 21:04:44 +0200607 orb->base.request_bus =
608 dma_map_single(device->card->device, &orb->request,
609 sizeof(orb->request), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700610 if (dma_mapping_error(device->card->device, orb->base.request_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200611 goto fail_mapping_request;
612
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200613 sbp2_send_orb(&orb->base, lu, node_id, generation,
614 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500615
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100616 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500617
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500618 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200619 if (sbp2_cancel_orbs(lu) == 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100620 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
621 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500622 goto out;
623 }
624
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500625 if (orb->base.rcode != RCODE_COMPLETE) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100626 fw_error("%s: management write failed, rcode 0x%02x\n",
627 lu->tgt->bus_id, orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500628 goto out;
629 }
630
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400631 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
632 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Stefan Richter48f18c72008-02-03 23:09:50 +0100633 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400634 STATUS_GET_RESPONSE(orb->status),
635 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500636 goto out;
637 }
638
639 retval = 0;
640 out:
641 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400642 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200643 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500644 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400645 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200646 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500647 if (response)
Stefan Richter71ee9f02008-02-28 20:51:11 +0100648 memcpy(response, orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400649 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500650
651 return retval;
652}
653
Stefan Richtere0e60212008-02-03 23:08:58 +0100654static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
655{
Stefan Richtere5110d02009-06-06 18:35:27 +0200656 struct fw_device *device = target_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200657 __be32 d = 0;
Stefan Richtere0e60212008-02-03 23:08:58 +0100658
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200659 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
660 lu->tgt->node_id, lu->generation, device->max_speed,
661 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc832010-06-12 20:29:07 +0200662 &d, 4);
Stefan Richtere0e60212008-02-03 23:08:58 +0100663}
664
Stefan Richter53dca512008-12-14 21:47:04 +0100665static void complete_agent_reset_write_no_wait(struct fw_card *card,
666 int rcode, void *payload, size_t length, void *data)
Stefan Richtere0e60212008-02-03 23:08:58 +0100667{
668 kfree(data);
669}
670
671static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500672{
Stefan Richtere5110d02009-06-06 18:35:27 +0200673 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500674 struct fw_transaction *t;
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200675 static __be32 d;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500676
Stefan Richtere0e60212008-02-03 23:08:58 +0100677 t = kmalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500678 if (t == NULL)
Stefan Richtere0e60212008-02-03 23:08:58 +0100679 return;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500680
681 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200682 lu->tgt->node_id, lu->generation, device->max_speed,
683 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc832010-06-12 20:29:07 +0200684 &d, 4, complete_agent_reset_write_no_wait, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500685}
686
Stefan Richter2e2705b2008-02-16 16:37:28 +0100687static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
688{
689 /*
690 * We may access dont_block without taking card->lock here:
691 * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
692 * are currently serialized against each other.
693 * And a wrong result in sbp2_conditionally_block()'s access of
694 * dont_block is rather harmless, it simply misses its first chance.
695 */
696 --lu->tgt->dont_block;
697}
698
699/*
700 * Blocks lu->tgt if all of the following conditions are met:
701 * - Login, INQUIRY, and high-level SCSI setup of all of the target's
702 * logical units have been finished (indicated by dont_block == 0).
703 * - lu->generation is stale.
704 *
705 * Note, scsi_block_requests() must be called while holding card->lock,
706 * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
707 * unblock the target.
708 */
709static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
710{
711 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200712 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100713 struct Scsi_Host *shost =
714 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
715 unsigned long flags;
716
717 spin_lock_irqsave(&card->lock, flags);
718 if (!tgt->dont_block && !lu->blocked &&
719 lu->generation != card->generation) {
720 lu->blocked = true;
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100721 if (++tgt->blocked == 1)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100722 scsi_block_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100723 }
724 spin_unlock_irqrestore(&card->lock, flags);
725}
726
727/*
728 * Unblocks lu->tgt as soon as all its logical units can be unblocked.
729 * Note, it is harmless to run scsi_unblock_requests() outside the
730 * card->lock protected section. On the other hand, running it inside
731 * the section might clash with shost->host_lock.
732 */
733static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
734{
735 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200736 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100737 struct Scsi_Host *shost =
738 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
739 unsigned long flags;
740 bool unblock = false;
741
742 spin_lock_irqsave(&card->lock, flags);
743 if (lu->blocked && lu->generation == card->generation) {
744 lu->blocked = false;
745 unblock = --tgt->blocked == 0;
746 }
747 spin_unlock_irqrestore(&card->lock, flags);
748
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100749 if (unblock)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100750 scsi_unblock_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100751}
752
753/*
754 * Prevents future blocking of tgt and unblocks it.
755 * Note, it is harmless to run scsi_unblock_requests() outside the
756 * card->lock protected section. On the other hand, running it inside
757 * the section might clash with shost->host_lock.
758 */
759static void sbp2_unblock(struct sbp2_target *tgt)
760{
Stefan Richtere5110d02009-06-06 18:35:27 +0200761 struct fw_card *card = target_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100762 struct Scsi_Host *shost =
763 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
764 unsigned long flags;
765
766 spin_lock_irqsave(&card->lock, flags);
767 ++tgt->dont_block;
768 spin_unlock_irqrestore(&card->lock, flags);
769
770 scsi_unblock_requests(shost);
771}
772
Stefan Richterf8436152008-02-26 23:30:02 +0100773static int sbp2_lun2int(u16 lun)
774{
775 struct scsi_lun eight_bytes_lun;
776
777 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
778 eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
779 eight_bytes_lun.scsi_lun[1] = lun & 0xff;
780
781 return scsilun_to_int(&eight_bytes_lun);
782}
783
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200784static void sbp2_release_target(struct kref *kref)
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400785{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200786 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
787 struct sbp2_logical_unit *lu, *next;
788 struct Scsi_Host *shost =
789 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richterf8436152008-02-26 23:30:02 +0100790 struct scsi_device *sdev;
Stefan Richtere5110d02009-06-06 18:35:27 +0200791 struct fw_device *device = target_device(tgt);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400792
Stefan Richter2e2705b2008-02-16 16:37:28 +0100793 /* prevent deadlocks */
794 sbp2_unblock(tgt);
795
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200796 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
Stefan Richterf8436152008-02-26 23:30:02 +0100797 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
798 if (sdev) {
799 scsi_remove_device(sdev);
800 scsi_device_put(sdev);
Stefan Richter33f1c6c32008-02-19 09:05:49 +0100801 }
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400802 if (lu->login_id != INVALID_LOGIN_ID) {
803 int generation, node_id;
804 /*
805 * tgt->node_id may be obsolete here if we failed
806 * during initial login or after a bus reset where
807 * the topology changed.
808 */
809 generation = device->generation;
810 smp_rmb(); /* node_id vs. generation */
811 node_id = device->node_id;
812 sbp2_send_management_orb(lu, node_id, generation,
813 SBP2_LOGOUT_REQUEST,
814 lu->login_id, NULL);
815 }
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200816 fw_core_remove_address_handler(&lu->address_handler);
817 list_del(&lu->link);
818 kfree(lu);
819 }
820 scsi_remove_host(shost);
Stefan Richterf32ddad2008-04-24 23:17:47 +0200821 fw_notify("released %s, target %d:0:0\n", tgt->bus_id, shost->host_no);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200822
Stefan Richter1dc3bea2008-02-24 19:01:21 +0100823 fw_unit_put(tgt->unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200824 scsi_host_put(shost);
Stefan Richter855c6032008-02-27 22:14:27 +0100825 fw_device_put(device);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400826}
827
Stefan Richter9fb551b2009-10-08 00:41:10 +0200828static void sbp2_target_get(struct sbp2_target *tgt)
829{
830 kref_get(&tgt->kref);
831}
Stefan Richterdf8ec242007-08-12 12:51:18 +0200832
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400833static void sbp2_target_put(struct sbp2_target *tgt)
834{
835 kref_put(&tgt->kref, sbp2_release_target);
836}
837
Stefan Richter9fb551b2009-10-08 00:41:10 +0200838static struct workqueue_struct *sbp2_wq;
839
Stefan Richter285838e2007-11-07 01:12:51 +0100840/*
841 * Always get the target's kref when scheduling work on one its units.
842 * Each workqueue job is responsible to call sbp2_target_put() upon return.
843 */
844static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
845{
Stefan Richter9fb551b2009-10-08 00:41:10 +0200846 sbp2_target_get(lu->tgt);
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400847 if (!queue_delayed_work(sbp2_wq, &lu->work, delay))
848 sbp2_target_put(lu->tgt);
Stefan Richter285838e2007-11-07 01:12:51 +0100849}
850
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500851/*
852 * Write retransmit retry values into the BUSY_TIMEOUT register.
853 * - The single-phase retry protocol is supported by all SBP-2 devices, but the
854 * default retry_limit value is 0 (i.e. never retry transmission). We write a
855 * saner value after logging into the device.
856 * - The dual-phase retry protocol is optional to implement, and if not
857 * supported, writes to the dual-phase portion of the register will be
858 * ignored. We try to write the original 1394-1995 default here.
859 * - In the case of devices that are also SBP-3-compliant, all writes are
860 * ignored, as the register is read-only, but contains single-phase retry of
861 * 15, which is what we're trying to set for all SBP-2 device anyway, so this
862 * write attempt is safe and yields more consistent behavior for all devices.
863 *
864 * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
865 * and section 6.4 of the SBP-3 spec for further details.
866 */
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500867static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
868{
Stefan Richtere5110d02009-06-06 18:35:27 +0200869 struct fw_device *device = target_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200870 __be32 d = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500871
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200872 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
873 lu->tgt->node_id, lu->generation, device->max_speed,
Stefan Richtere847cc832010-06-12 20:29:07 +0200874 CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT, &d, 4);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500875}
876
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200877static void sbp2_reconnect(struct work_struct *work);
878
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500879static void sbp2_login(struct work_struct *work)
880{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200881 struct sbp2_logical_unit *lu =
882 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +0100883 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +0200884 struct fw_device *device = target_device(tgt);
Stefan Richter48f18c72008-02-03 23:09:50 +0100885 struct Scsi_Host *shost;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200886 struct scsi_device *sdev;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500887 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200888 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500889
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100890 if (fw_device_is_shutdown(device))
891 goto out;
892
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100893 generation = device->generation;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100894 smp_rmb(); /* node IDs must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100895 node_id = device->node_id;
896 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500897
Stefan Richterce896d92008-02-03 23:11:39 +0100898 /* If this is a re-login attempt, log out, or we might be rejected. */
Stefan Richterf8436152008-02-26 23:30:02 +0100899 if (lu->has_sdev)
Stefan Richterce896d92008-02-03 23:11:39 +0100900 sbp2_send_management_orb(lu, device->node_id, generation,
901 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
902
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200903 if (sbp2_send_management_orb(lu, node_id, generation,
904 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter2e2705b2008-02-16 16:37:28 +0100905 if (lu->retries++ < 5) {
Stefan Richter285838e2007-11-07 01:12:51 +0100906 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Stefan Richter2e2705b2008-02-16 16:37:28 +0100907 } else {
Stefan Richter48f18c72008-02-03 23:09:50 +0100908 fw_error("%s: failed to login to LUN %04x\n",
909 tgt->bus_id, lu->lun);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100910 /* Let any waiting I/O fail from now on. */
911 sbp2_unblock(lu->tgt);
912 }
Stefan Richter285838e2007-11-07 01:12:51 +0100913 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500914 }
915
Stefan Richter48f18c72008-02-03 23:09:50 +0100916 tgt->node_id = node_id;
917 tgt->address_high = local_node_id << 16;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100918 smp_wmb(); /* node IDs must not be older than generation */
919 lu->generation = generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500920
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200921 lu->command_block_agent_address =
Stefan Richter71ee9f02008-02-28 20:51:11 +0100922 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
923 << 32) | be32_to_cpu(response.command_block_agent.low);
924 lu->login_id = be32_to_cpu(response.misc) & 0xffff;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500925
Stefan Richter48f18c72008-02-03 23:09:50 +0100926 fw_notify("%s: logged in to LUN %04x (%d retries)\n",
927 tgt->bus_id, lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500928
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500929 /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
930 sbp2_set_busy_timeout(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500931
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200932 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
933 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500934
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100935 /* This was a re-login. */
Stefan Richterf8436152008-02-26 23:30:02 +0100936 if (lu->has_sdev) {
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100937 sbp2_cancel_orbs(lu);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100938 sbp2_conditionally_unblock(lu);
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100939 goto out;
940 }
941
Stefan Richter9220f192008-02-03 23:04:38 +0100942 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
943 ssleep(SBP2_INQUIRY_DELAY);
944
Stefan Richter48f18c72008-02-03 23:09:50 +0100945 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richterf8436152008-02-26 23:30:02 +0100946 sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
Stefan Richtere80de372008-02-15 21:29:02 +0100947 /*
948 * FIXME: We are unable to perform reconnects while in sbp2_login().
949 * Therefore __scsi_add_device() will get into trouble if a bus reset
950 * happens in parallel. It will either fail or leave us with an
951 * unusable sdev. As a workaround we check for this and retry the
952 * whole login and SCSI probing.
953 */
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100954
Stefan Richtere80de372008-02-15 21:29:02 +0100955 /* Reported error during __scsi_add_device() */
956 if (IS_ERR(sdev))
957 goto out_logout_login;
958
Stefan Richtere80de372008-02-15 21:29:02 +0100959 /* Unreported error during __scsi_add_device() */
960 smp_rmb(); /* get current card generation */
961 if (generation != device->card->generation) {
962 scsi_remove_device(sdev);
Stefan Richter33f1c6c32008-02-19 09:05:49 +0100963 scsi_device_put(sdev);
Stefan Richtere80de372008-02-15 21:29:02 +0100964 goto out_logout_login;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500965 }
Stefan Richtere80de372008-02-15 21:29:02 +0100966
967 /* No error during __scsi_add_device() */
Stefan Richterf8436152008-02-26 23:30:02 +0100968 lu->has_sdev = true;
969 scsi_device_put(sdev);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100970 sbp2_allow_block(lu);
Stefan Richtere80de372008-02-15 21:29:02 +0100971 goto out;
972
973 out_logout_login:
974 smp_rmb(); /* generation may have changed */
975 generation = device->generation;
976 smp_rmb(); /* node_id must not be older than generation */
977
978 sbp2_send_management_orb(lu, device->node_id, generation,
979 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
980 /*
981 * If a bus reset happened, sbp2_update will have requeued
982 * lu->work already. Reset the work from reconnect to login.
983 */
984 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Stefan Richter285838e2007-11-07 01:12:51 +0100985 out:
Stefan Richter48f18c72008-02-03 23:09:50 +0100986 sbp2_target_put(tgt);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500987}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500988
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200989static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
990{
991 struct sbp2_logical_unit *lu;
992
993 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
994 if (!lu)
995 return -ENOMEM;
996
997 lu->address_handler.length = 0x100;
998 lu->address_handler.address_callback = sbp2_status_write;
999 lu->address_handler.callback_data = lu;
1000
1001 if (fw_core_add_address_handler(&lu->address_handler,
1002 &fw_high_memory_region) < 0) {
1003 kfree(lu);
1004 return -ENOMEM;
1005 }
1006
Stefan Richterf8436152008-02-26 23:30:02 +01001007 lu->tgt = tgt;
1008 lu->lun = lun_entry & 0xffff;
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -04001009 lu->login_id = INVALID_LOGIN_ID;
Stefan Richterf8436152008-02-26 23:30:02 +01001010 lu->retries = 0;
1011 lu->has_sdev = false;
1012 lu->blocked = false;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001013 ++tgt->dont_block;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001014 INIT_LIST_HEAD(&lu->orb_list);
1015 INIT_DELAYED_WORK(&lu->work, sbp2_login);
1016
1017 list_add_tail(&lu->link, &tgt->lu_list);
1018 return 0;
1019}
1020
Stefan Richter13b302d2009-12-26 01:44:10 +01001021static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt,
1022 const u32 *directory)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001023{
1024 struct fw_csr_iterator ci;
1025 int key, value;
1026
1027 fw_csr_iterator_init(&ci, directory);
1028 while (fw_csr_iterator_next(&ci, &key, &value))
1029 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
1030 sbp2_add_logical_unit(tgt, value) < 0)
1031 return -ENOMEM;
1032 return 0;
1033}
1034
Stefan Richter13b302d2009-12-26 01:44:10 +01001035static int sbp2_scan_unit_dir(struct sbp2_target *tgt, const u32 *directory,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001036 u32 *model, u32 *firmware_revision)
1037{
1038 struct fw_csr_iterator ci;
1039 int key, value;
1040
1041 fw_csr_iterator_init(&ci, directory);
1042 while (fw_csr_iterator_next(&ci, &key, &value)) {
1043 switch (key) {
1044
1045 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1046 tgt->management_agent_address =
1047 CSR_REGISTER_BASE + 4 * value;
1048 break;
1049
1050 case CSR_DIRECTORY_ID:
1051 tgt->directory_id = value;
1052 break;
1053
1054 case CSR_MODEL:
1055 *model = value;
1056 break;
1057
1058 case SBP2_CSR_FIRMWARE_REVISION:
1059 *firmware_revision = value;
1060 break;
1061
Jarod Wilson384170d2008-01-25 23:31:12 -05001062 case SBP2_CSR_UNIT_CHARACTERISTICS:
1063 /* the timeout value is stored in 500ms units */
Stefan Richtereaf76e02009-10-08 00:39:31 +02001064 tgt->mgt_orb_timeout = (value >> 8 & 0xff) * 500;
Jarod Wilson384170d2008-01-25 23:31:12 -05001065 break;
1066
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001067 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1068 if (sbp2_add_logical_unit(tgt, value) < 0)
1069 return -ENOMEM;
1070 break;
1071
1072 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
Richard Sharpe0e3e2ea2008-06-24 19:11:13 -07001073 /* Adjust for the increment in the iterator */
1074 if (sbp2_scan_logical_unit_dir(tgt, ci.p - 1 + value) < 0)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001075 return -ENOMEM;
1076 break;
1077 }
1078 }
1079 return 0;
1080}
1081
Stefan Richtereaf76e02009-10-08 00:39:31 +02001082/*
1083 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
1084 * provided in the config rom. Most devices do provide a value, which
1085 * we'll use for login management orbs, but with some sane limits.
1086 */
1087static void sbp2_clamp_management_orb_timeout(struct sbp2_target *tgt)
1088{
1089 unsigned int timeout = tgt->mgt_orb_timeout;
1090
1091 if (timeout > 40000)
1092 fw_notify("%s: %ds mgt_ORB_timeout limited to 40s\n",
1093 tgt->bus_id, timeout / 1000);
1094
1095 tgt->mgt_orb_timeout = clamp_val(timeout, 5000, 40000);
1096}
1097
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001098static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1099 u32 firmware_revision)
1100{
1101 int i;
Stefan Richter05cca7382008-01-26 17:42:45 +01001102 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001103
Stefan Richter2df222b2007-08-13 17:48:25 +02001104 if (w)
1105 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
1106 "if you need the workarounds parameter for %s\n",
Stefan Richter48f18c72008-02-03 23:09:50 +01001107 tgt->bus_id);
Stefan Richter2df222b2007-08-13 17:48:25 +02001108
1109 if (w & SBP2_WORKAROUND_OVERRIDE)
1110 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001111
1112 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1113
1114 if (sbp2_workarounds_table[i].firmware_revision !=
1115 (firmware_revision & 0xffffff00))
1116 continue;
1117
1118 if (sbp2_workarounds_table[i].model != model &&
Stefan Richterf7460722009-01-24 19:41:46 +01001119 sbp2_workarounds_table[i].model != SBP2_ROM_VALUE_WILDCARD)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001120 continue;
1121
Stefan Richter2df222b2007-08-13 17:48:25 +02001122 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001123 break;
1124 }
Stefan Richter2df222b2007-08-13 17:48:25 +02001125 out:
1126 if (w)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001127 fw_notify("Workarounds for %s: 0x%x "
1128 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
Stefan Richter48f18c72008-02-03 23:09:50 +01001129 tgt->bus_id, w, firmware_revision, model);
Stefan Richter2df222b2007-08-13 17:48:25 +02001130 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001131}
1132
1133static struct scsi_host_template scsi_driver_template;
1134
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001135static int sbp2_probe(struct device *dev)
1136{
1137 struct fw_unit *unit = fw_unit(dev);
Stefan Richtere5110d02009-06-06 18:35:27 +02001138 struct fw_device *device = fw_parent_device(unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001139 struct sbp2_target *tgt;
1140 struct sbp2_logical_unit *lu;
1141 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001142 u32 model, firmware_revision;
1143
Stefan Richter09b12dd2008-08-14 21:47:21 +02001144 if (dma_get_max_seg_size(device->card->device) > SBP2_MAX_SEG_SIZE)
1145 BUG_ON(dma_set_max_seg_size(device->card->device,
1146 SBP2_MAX_SEG_SIZE));
1147
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001148 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1149 if (shost == NULL)
1150 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001151
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001152 tgt = (struct sbp2_target *)shost->hostdata;
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001153 dev_set_drvdata(&unit->device, tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001154 tgt->unit = unit;
1155 kref_init(&tgt->kref);
1156 INIT_LIST_HEAD(&tgt->lu_list);
Kay Sieversa1f64812008-10-30 01:41:56 +01001157 tgt->bus_id = dev_name(&unit->device);
Stefan Richterc9755e12008-03-24 20:54:28 +01001158 tgt->guid = (u64)device->config_rom[3] << 32 | device->config_rom[4];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001159
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001160 if (fw_device_enable_phys_dma(device) < 0)
1161 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001162
Stefan Richteraf271942009-06-30 20:27:59 +02001163 shost->max_cmd_len = SBP2_MAX_CDB_SIZE;
1164
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001165 if (scsi_add_host(shost, &unit->device) < 0)
1166 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001167
Stefan Richter855c6032008-02-27 22:14:27 +01001168 fw_device_get(device);
Stefan Richter1dc3bea2008-02-24 19:01:21 +01001169 fw_unit_get(unit);
Stefan Richter855c6032008-02-27 22:14:27 +01001170
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001171 /* implicit directory ID */
1172 tgt->directory_id = ((unit->directory - device->config_rom) * 4
1173 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001174
Stefan Richterf7460722009-01-24 19:41:46 +01001175 firmware_revision = SBP2_ROM_VALUE_MISSING;
1176 model = SBP2_ROM_VALUE_MISSING;
1177
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001178 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1179 &firmware_revision) < 0)
1180 goto fail_tgt_put;
1181
Stefan Richtereaf76e02009-10-08 00:39:31 +02001182 sbp2_clamp_management_orb_timeout(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001183 sbp2_init_workarounds(tgt, model, firmware_revision);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001184
Stefan Richtera08e1002009-01-24 19:41:46 +01001185 /*
1186 * At S100 we can do 512 bytes per packet, at S200 1024 bytes,
1187 * and so on up to 4096 bytes. The SBP-2 max_payload field
1188 * specifies the max payload size as 2 ^ (max_payload + 2), so
1189 * if we set this to max_speed + 7, we get the right value.
1190 */
1191 tgt->max_payload = min(device->max_speed + 7, 10U);
1192 tgt->max_payload = min(tgt->max_payload, device->card->max_receive - 1);
1193
Stefan Richter285838e2007-11-07 01:12:51 +01001194 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001195 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter0dcfeb72008-10-22 00:28:36 +02001196 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001197 return 0;
Kristian Høgsbergad852742007-05-09 19:23:07 -04001198
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001199 fail_tgt_put:
Stefan Richter285838e2007-11-07 01:12:51 +01001200 sbp2_target_put(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001201 return -ENOMEM;
1202
1203 fail_shost_put:
1204 scsi_host_put(shost);
1205 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001206}
1207
1208static int sbp2_remove(struct device *dev)
1209{
1210 struct fw_unit *unit = fw_unit(dev);
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001211 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001212
Stefan Richter285838e2007-11-07 01:12:51 +01001213 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001214 return 0;
1215}
1216
1217static void sbp2_reconnect(struct work_struct *work)
1218{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001219 struct sbp2_logical_unit *lu =
1220 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +01001221 struct sbp2_target *tgt = lu->tgt;
Stefan Richtere5110d02009-06-06 18:35:27 +02001222 struct fw_device *device = target_device(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001223 int generation, node_id, local_node_id;
1224
Stefan Richterbe6f48b2008-01-27 19:14:44 +01001225 if (fw_device_is_shutdown(device))
1226 goto out;
1227
Stefan Richter5a8a1bc2008-01-24 01:53:19 +01001228 generation = device->generation;
Stefan Richter621f6dd2008-10-26 11:04:20 +01001229 smp_rmb(); /* node IDs must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +01001230 node_id = device->node_id;
1231 local_node_id = device->card->node_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001232
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001233 if (sbp2_send_management_orb(lu, node_id, generation,
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001234 SBP2_RECONNECT_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001235 lu->login_id, NULL) < 0) {
Stefan Richterce896d92008-02-03 23:11:39 +01001236 /*
1237 * If reconnect was impossible even though we are in the
1238 * current generation, fall back and try to log in again.
1239 *
1240 * We could check for "Function rejected" status, but
1241 * looking at the bus generation as simpler and more general.
1242 */
1243 smp_rmb(); /* get current card generation */
1244 if (generation == device->card->generation ||
1245 lu->retries++ >= 5) {
Stefan Richter48f18c72008-02-03 23:09:50 +01001246 fw_error("%s: failed to reconnect\n", tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001247 lu->retries = 0;
1248 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001249 }
Stefan Richter285838e2007-11-07 01:12:51 +01001250 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1251 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001252 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001253
Stefan Richter48f18c72008-02-03 23:09:50 +01001254 tgt->node_id = node_id;
1255 tgt->address_high = local_node_id << 16;
Stefan Richter621f6dd2008-10-26 11:04:20 +01001256 smp_wmb(); /* node IDs must not be older than generation */
1257 lu->generation = generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001258
Stefan Richter48f18c72008-02-03 23:09:50 +01001259 fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1260 tgt->bus_id, lu->lun, lu->retries);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001261
1262 sbp2_agent_reset(lu);
1263 sbp2_cancel_orbs(lu);
Stefan Richter2e2705b2008-02-16 16:37:28 +01001264 sbp2_conditionally_unblock(lu);
Stefan Richter285838e2007-11-07 01:12:51 +01001265 out:
Stefan Richter48f18c72008-02-03 23:09:50 +01001266 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001267}
1268
1269static void sbp2_update(struct fw_unit *unit)
1270{
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001271 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001272 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001273
Stefan Richtere5110d02009-06-06 18:35:27 +02001274 fw_device_enable_phys_dma(fw_parent_device(unit));
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001275
1276 /*
1277 * Fw-core serializes sbp2_update() against sbp2_remove().
1278 * Iteration over tgt->lu_list is therefore safe here.
1279 */
1280 list_for_each_entry(lu, &tgt->lu_list, link) {
Stefan Richter2e2705b2008-02-16 16:37:28 +01001281 sbp2_conditionally_block(lu);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001282 lu->retries = 0;
Stefan Richter285838e2007-11-07 01:12:51 +01001283 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001284 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001285}
1286
1287#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1288#define SBP2_SW_VERSION_ENTRY 0x00010483
1289
Stefan Richterb3b29882009-02-15 23:12:34 +01001290static const struct ieee1394_device_id sbp2_id_table[] = {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001291 {
Stefan Richterb3b29882009-02-15 23:12:34 +01001292 .match_flags = IEEE1394_MATCH_SPECIFIER_ID |
1293 IEEE1394_MATCH_VERSION,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001294 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
Stefan Richter5af4e5e2007-01-21 20:45:32 +01001295 .version = SBP2_SW_VERSION_ENTRY,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001296 },
1297 { }
1298};
1299
1300static struct fw_driver sbp2_driver = {
1301 .driver = {
1302 .owner = THIS_MODULE,
1303 .name = sbp2_driver_name,
1304 .bus = &fw_bus_type,
1305 .probe = sbp2_probe,
1306 .remove = sbp2_remove,
1307 },
1308 .update = sbp2_update,
1309 .id_table = sbp2_id_table,
1310};
1311
Stefan Richter5e212562009-01-28 01:03:34 +01001312static void sbp2_unmap_scatterlist(struct device *card_device,
1313 struct sbp2_command_orb *orb)
1314{
1315 if (scsi_sg_count(orb->cmd))
1316 dma_unmap_sg(card_device, scsi_sglist(orb->cmd),
1317 scsi_sg_count(orb->cmd),
1318 orb->cmd->sc_data_direction);
1319
1320 if (orb->request.misc & cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT))
1321 dma_unmap_single(card_device, orb->page_table_bus,
1322 sizeof(orb->page_table), DMA_TO_DEVICE);
1323}
1324
Stefan Richter53dca512008-12-14 21:47:04 +01001325static unsigned int sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001326{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001327 int sam_status;
1328
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001329 sense_data[0] = 0x70;
1330 sense_data[1] = 0x0;
1331 sense_data[2] = sbp2_status[1];
1332 sense_data[3] = sbp2_status[4];
1333 sense_data[4] = sbp2_status[5];
1334 sense_data[5] = sbp2_status[6];
1335 sense_data[6] = sbp2_status[7];
1336 sense_data[7] = 10;
1337 sense_data[8] = sbp2_status[8];
1338 sense_data[9] = sbp2_status[9];
1339 sense_data[10] = sbp2_status[10];
1340 sense_data[11] = sbp2_status[11];
1341 sense_data[12] = sbp2_status[2];
1342 sense_data[13] = sbp2_status[3];
1343 sense_data[14] = sbp2_status[12];
1344 sense_data[15] = sbp2_status[13];
1345
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001346 sam_status = sbp2_status[0] & 0x3f;
1347
1348 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001349 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001350 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001351 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001352 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001353 case SAM_STAT_RESERVATION_CONFLICT:
1354 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001355 return DID_OK << 16 | sam_status;
1356
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001357 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001358 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001359 }
1360}
1361
Stefan Richter53dca512008-12-14 21:47:04 +01001362static void complete_command_orb(struct sbp2_orb *base_orb,
1363 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001364{
Jay Fenlason6f061482007-06-27 16:04:33 -04001365 struct sbp2_command_orb *orb =
1366 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richtere5110d02009-06-06 18:35:27 +02001367 struct fw_device *device = target_device(orb->lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001368 int result;
1369
1370 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001371 if (STATUS_GET_DEAD(*status))
Stefan Richtere0e60212008-02-03 23:08:58 +01001372 sbp2_agent_reset_no_wait(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001373
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001374 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001375 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001376 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001377 break;
1378 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001379 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001380 break;
1381 case SBP2_STATUS_ILLEGAL_REQUEST:
1382 case SBP2_STATUS_VENDOR_DEPENDENT:
1383 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001384 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001385 break;
1386 }
1387
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001388 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1389 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001390 orb->cmd->sense_buffer);
1391 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001392 /*
1393 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001394 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001395 * or when sending the write (less likely).
1396 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001397 result = DID_BUS_BUSY << 16;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001398 sbp2_conditionally_block(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001399 }
1400
1401 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001402 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001403 sbp2_unmap_scatterlist(device->card->device, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001404
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001405 orb->cmd->result = result;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001406 orb->done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001407}
1408
Stefan Richter53dca512008-12-14 21:47:04 +01001409static int sbp2_map_scatterlist(struct sbp2_command_orb *orb,
1410 struct fw_device *device, struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001411{
Stefan Richter09b12dd2008-08-14 21:47:21 +02001412 struct scatterlist *sg = scsi_sglist(orb->cmd);
1413 int i, n;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001414
Stefan Richter09b12dd2008-08-14 21:47:21 +02001415 n = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1416 orb->cmd->sc_data_direction);
1417 if (n == 0)
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001418 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001419
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001420 /*
1421 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001422 * the scatter list by converting it to an immediate block
1423 * request. This is also a workaround for broken devices such
1424 * as the second generation iPod which doesn't support page
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001425 * tables.
1426 */
Stefan Richter09b12dd2008-08-14 21:47:21 +02001427 if (n == 1) {
Stefan Richter71ee9f02008-02-28 20:51:11 +01001428 orb->request.data_descriptor.high =
1429 cpu_to_be32(lu->tgt->address_high);
1430 orb->request.data_descriptor.low =
1431 cpu_to_be32(sg_dma_address(sg));
1432 orb->request.misc |=
1433 cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001434 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001435 }
1436
Stefan Richter09b12dd2008-08-14 21:47:21 +02001437 for_each_sg(sg, sg, n, i) {
1438 orb->page_table[i].high = cpu_to_be32(sg_dma_len(sg) << 16);
1439 orb->page_table[i].low = cpu_to_be32(sg_dma_address(sg));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001440 }
1441
Stefan Richterb4be0162007-07-02 22:07:34 +02001442 orb->page_table_bus =
1443 dma_map_single(device->card->device, orb->page_table,
1444 sizeof(orb->page_table), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -07001445 if (dma_mapping_error(device->card->device, orb->page_table_bus))
Stefan Richterb4be0162007-07-02 22:07:34 +02001446 goto fail_page_table;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001447
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001448 /*
1449 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001450 * to fill in the node ID part of the address. All other
1451 * pointers assume that the data referenced reside on the
1452 * initiator (i.e. us), but data_descriptor can refer to data
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001453 * on other nodes so we need to put our ID in descriptor.high.
1454 */
Stefan Richter71ee9f02008-02-28 20:51:11 +01001455 orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1456 orb->request.data_descriptor.low = cpu_to_be32(orb->page_table_bus);
1457 orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
Stefan Richter09b12dd2008-08-14 21:47:21 +02001458 COMMAND_ORB_DATA_SIZE(n));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001459
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001460 return 0;
1461
1462 fail_page_table:
Stefan Richter09b12dd2008-08-14 21:47:21 +02001463 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1464 scsi_sg_count(orb->cmd), orb->cmd->sc_data_direction);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001465 fail:
1466 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001467}
1468
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001469/* SCSI stack integration */
1470
1471static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1472{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001473 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Stefan Richtere5110d02009-06-06 18:35:27 +02001474 struct fw_device *device = target_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001475 struct sbp2_command_orb *orb;
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001476 int generation, retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001477
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001478 /*
1479 * Bidirectional commands are not yet implemented, and unknown
1480 * transfer direction not handled.
1481 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001482 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richter8a8cea22007-06-09 19:26:22 +02001483 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001484 cmd->result = DID_ERROR << 16;
1485 done(cmd);
1486 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001487 }
1488
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001489 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001490 if (orb == NULL) {
1491 fw_notify("failed to alloc orb\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001492 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001493 }
1494
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001495 /* Initialize rcode to something not RCODE_COMPLETE. */
1496 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001497 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001498
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001499 orb->lu = lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001500 orb->done = done;
1501 orb->cmd = cmd;
1502
Stefan Richtera08e1002009-01-24 19:41:46 +01001503 orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
Stefan Richter71ee9f02008-02-28 20:51:11 +01001504 orb->request.misc = cpu_to_be32(
Stefan Richtera08e1002009-01-24 19:41:46 +01001505 COMMAND_ORB_MAX_PAYLOAD(lu->tgt->max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001506 COMMAND_ORB_SPEED(device->max_speed) |
Stefan Richter71ee9f02008-02-28 20:51:11 +01001507 COMMAND_ORB_NOTIFY);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001508
1509 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +01001510 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001511
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001512 generation = device->generation;
1513 smp_rmb(); /* sbp2_map_scatterlist looks at tgt->address_high */
1514
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001515 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1516 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001517
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001518 memcpy(orb->request.command_block, cmd->cmnd, cmd->cmd_len);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001519
1520 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001521 orb->base.request_bus =
1522 dma_map_single(device->card->device, &orb->request,
1523 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001524 if (dma_mapping_error(device->card->device, orb->base.request_bus)) {
1525 sbp2_unmap_scatterlist(device->card->device, orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001526 goto out;
Stefan Richter5e212562009-01-28 01:03:34 +01001527 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001528
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001529 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, generation,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001530 lu->command_block_agent_address + SBP2_ORB_POINTER);
1531 retval = 0;
1532 out:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001533 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001534 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001535}
1536
Stefan Richtercfb01382007-01-23 21:20:08 +01001537static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1538{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001539 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001540
Stefan Richter5513c5f2008-02-17 14:56:19 +01001541 /* (Re-)Adding logical units via the SCSI stack is not supported. */
1542 if (!lu)
1543 return -ENOSYS;
1544
Stefan Richtercfb01382007-01-23 21:20:08 +01001545 sdev->allow_restart = 1;
1546
Stefan Richter8ac3a472008-01-27 22:31:27 +01001547 /* SBP-2 requires quadlet alignment of the data buffers. */
1548 blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
James Bottomley465ff312008-01-01 10:00:10 -06001549
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001550 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001551 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001552
Stefan Richtercfb01382007-01-23 21:20:08 +01001553 return 0;
1554}
1555
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001556static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1557{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001558 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001559
Stefan Richtercfb01382007-01-23 21:20:08 +01001560 sdev->use_10_for_rw = 1;
1561
Stefan Richter2635f962008-05-11 00:36:47 +02001562 if (sbp2_param_exclusive_login)
1563 sdev->manage_start_stop = 1;
1564
Stefan Richtercfb01382007-01-23 21:20:08 +01001565 if (sdev->type == TYPE_ROM)
1566 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001567
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001568 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001569 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001570 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001571
1572 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001573 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001574
Stefan Richterffcaade2008-05-11 00:35:04 +02001575 if (lu->tgt->workarounds & SBP2_WORKAROUND_POWER_CONDITION)
1576 sdev->start_stop_pwr_cond = 1;
1577
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001578 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001579 blk_queue_max_hw_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001580
Stefan Richter09b12dd2008-08-14 21:47:21 +02001581 blk_queue_max_segment_size(sdev->request_queue, SBP2_MAX_SEG_SIZE);
1582
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001583 return 0;
1584}
1585
1586/*
1587 * Called by scsi stack when something has really gone wrong. Usually
1588 * called when a command has timed-out for some reason.
1589 */
1590static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1591{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001592 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001593
Stefan Richter48f18c72008-02-03 23:09:50 +01001594 fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001595 sbp2_agent_reset(lu);
1596 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001597
1598 return SUCCESS;
1599}
1600
Stefan Richter14e21982007-05-27 13:18:27 +02001601/*
1602 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1603 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1604 *
1605 * This is the concatenation of target port identifier and logical unit
1606 * identifier as per SAM-2...SAM-4 annex A.
1607 */
Stefan Richter53dca512008-12-14 21:47:04 +01001608static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
1609 struct device_attribute *attr, char *buf)
Stefan Richter14e21982007-05-27 13:18:27 +02001610{
1611 struct scsi_device *sdev = to_scsi_device(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001612 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001613
1614 if (!sdev)
1615 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001616
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001617 lu = sdev->hostdata;
Stefan Richter14e21982007-05-27 13:18:27 +02001618
Stefan Richterc9755e12008-03-24 20:54:28 +01001619 return sprintf(buf, "%016llx:%06x:%04x\n",
1620 (unsigned long long)lu->tgt->guid,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001621 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001622}
1623
1624static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1625
1626static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1627 &dev_attr_ieee1394_id,
1628 NULL
1629};
1630
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001631static struct scsi_host_template scsi_driver_template = {
1632 .module = THIS_MODULE,
1633 .name = "SBP-2 IEEE-1394",
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -04001634 .proc_name = sbp2_driver_name,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001635 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001636 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001637 .slave_configure = sbp2_scsi_slave_configure,
1638 .eh_abort_handler = sbp2_scsi_abort,
1639 .this_id = -1,
1640 .sg_tablesize = SG_ALL,
1641 .use_clustering = ENABLE_CLUSTERING,
Stefan Richter02af8e72007-01-21 20:50:11 +01001642 .cmd_per_lun = 1,
1643 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001644 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001645};
1646
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001647MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1648MODULE_DESCRIPTION("SCSI over IEEE1394");
1649MODULE_LICENSE("GPL");
1650MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1651
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001652/* Provide a module alias so root-on-sbp2 initrds don't break. */
1653#ifndef CONFIG_IEEE1394_SBP2_MODULE
1654MODULE_ALIAS("sbp2");
1655#endif
1656
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001657static int __init sbp2_init(void)
1658{
Stefan Richterdf8ec242007-08-12 12:51:18 +02001659 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1660 if (!sbp2_wq)
1661 return -ENOMEM;
1662
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001663 return driver_register(&sbp2_driver.driver);
1664}
1665
1666static void __exit sbp2_cleanup(void)
1667{
1668 driver_unregister(&sbp2_driver.driver);
Stefan Richterdf8ec242007-08-12 12:51:18 +02001669 destroy_workqueue(sbp2_wq);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001670}
1671
1672module_init(sbp2_init);
1673module_exit(sbp2_cleanup);