blob: 7aef911fdc716d4874b7152b3c0d6e27bc8c1642 [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>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050055
56#include <scsi/scsi.h>
57#include <scsi/scsi_cmnd.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050058#include <scsi/scsi_device.h>
59#include <scsi/scsi_host.h>
60
Stefan Richter5cd54c92007-06-17 23:55:41 +020061/*
62 * So far only bridges from Oxford Semiconductor are known to support
63 * concurrent logins. Depending on firmware, four or two concurrent logins
64 * are possible on OXFW911 and newer Oxsemi bridges.
65 *
66 * Concurrent logins are useful together with cluster filesystems.
67 */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103068static bool sbp2_param_exclusive_login = 1;
Stefan Richter5cd54c92007-06-17 23:55:41 +020069module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
70MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
71 "(default = Y, use N for concurrent initiators)");
72
Stefan Richter2df222b2007-08-13 17:48:25 +020073/*
74 * Flags for firmware oddities
75 *
76 * - 128kB max transfer
77 * Limit transfer size. Necessary for some old bridges.
78 *
79 * - 36 byte inquiry
80 * When scsi_mod probes the device, let the inquiry command look like that
81 * from MS Windows.
82 *
83 * - skip mode page 8
84 * Suppress sending of mode_sense for mode page 8 if the device pretends to
85 * support the SCSI Primary Block commands instead of Reduced Block Commands.
86 *
87 * - fix capacity
88 * Tell sd_mod to correct the last sector number reported by read_capacity.
89 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
90 * Don't use this with devices which don't have this bug.
91 *
Stefan Richter9220f192008-02-03 23:04:38 +010092 * - delay inquiry
93 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
94 *
Stefan Richterffcaade2008-05-11 00:35:04 +020095 * - power condition
96 * Set the power condition field in the START STOP UNIT commands sent by
97 * sd_mod on suspend, resume, and shutdown (if manage_start_stop is on).
98 * Some disks need this to spin down or to resume properly.
99 *
Stefan Richter2df222b2007-08-13 17:48:25 +0200100 * - override internal blacklist
101 * Instead of adding to the built-in blacklist, use only the workarounds
102 * specified in the module load parameter.
103 * Useful if a blacklist entry interfered with a non-broken device.
104 */
105#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
106#define SBP2_WORKAROUND_INQUIRY_36 0x2
107#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
108#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
Stefan Richter9220f192008-02-03 23:04:38 +0100109#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
110#define SBP2_INQUIRY_DELAY 12
Stefan Richterffcaade2008-05-11 00:35:04 +0200111#define SBP2_WORKAROUND_POWER_CONDITION 0x20
Stefan Richter2df222b2007-08-13 17:48:25 +0200112#define SBP2_WORKAROUND_OVERRIDE 0x100
113
114static int sbp2_param_workarounds;
115module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
116MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
117 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
118 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
119 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
120 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
Stefan Richter9220f192008-02-03 23:04:38 +0100121 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
Stefan Richterffcaade2008-05-11 00:35:04 +0200122 ", set power condition in start stop unit = "
123 __stringify(SBP2_WORKAROUND_POWER_CONDITION)
Stefan Richter2df222b2007-08-13 17:48:25 +0200124 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
125 ", or a combination)");
126
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200127/*
128 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
129 * and one struct scsi_device per sbp2_logical_unit.
130 */
131struct sbp2_logical_unit {
132 struct sbp2_target *tgt;
133 struct list_head link;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500134 struct fw_address_handler address_handler;
135 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200136
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500137 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200138 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500139 int login_id;
140
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400141 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200142 * The generation is updated once we've logged in or reconnected
143 * to the logical unit. Thus, I/O to the device will automatically
144 * fail and get retried if it happens in a window where the device
145 * is not ready, e.g. after a bus reset but before we reconnect.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400146 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500147 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500148 int retries;
Tejun Heo70044d72014-03-07 10:19:57 -0500149 work_func_t workfn;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500150 struct delayed_work work;
Stefan Richterf8436152008-02-26 23:30:02 +0100151 bool has_sdev;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100152 bool blocked;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500153};
154
Stefan Richterb2af07b2011-08-27 15:34:32 +0200155static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
156{
157 queue_delayed_work(fw_workqueue, &lu->work, delay);
158}
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 {
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200165 struct fw_unit *unit;
Stefan Richter05cca7382008-01-26 17:42:45 +0100166 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200167
168 u64 management_agent_address;
Stefan Richterc9755e12008-03-24 20:54:28 +0100169 u64 guid;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200170 int directory_id;
171 int node_id;
172 int address_high;
Stefan Richter05cca7382008-01-26 17:42:45 +0100173 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500174 unsigned int mgt_orb_timeout;
Stefan Richtera08e1002009-01-24 19:41:46 +0100175 unsigned int max_payload;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100176
177 int dont_block; /* counter for each logical unit */
178 int blocked; /* ditto */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200179};
180
Stefan Richtereba9eba2011-12-20 21:34:12 +0100181static struct fw_device *target_parent_device(struct sbp2_target *tgt)
Stefan Richtere5110d02009-06-06 18:35:27 +0200182{
183 return fw_parent_device(tgt->unit);
184}
185
Stefan Richtereba9eba2011-12-20 21:34:12 +0100186static const struct device *tgt_dev(const struct sbp2_target *tgt)
187{
188 return &tgt->unit->device;
189}
190
191static const struct device *lu_dev(const struct sbp2_logical_unit *lu)
192{
193 return &lu->tgt->unit->device;
194}
195
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -0400196/* Impossible login_id, to detect logout attempt before successful login */
197#define INVALID_LOGIN_ID 0x10000
198
Stefan Richtereaf76e02009-10-08 00:39:31 +0200199#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500200#define SBP2_ORB_NULL 0x80000000
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500201#define SBP2_RETRY_LIMIT 0xf /* 15 retries */
202#define SBP2_CYCLE_LIMIT (0xc8 << 12) /* 200 125us cycles */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500203
Stefan Richter09b12dd2008-08-14 21:47:21 +0200204/*
Stefan Richteraf271942009-06-30 20:27:59 +0200205 * There is no transport protocol limit to the CDB length, but we implement
206 * a fixed length only. 16 bytes is enough for disks larger than 2 TB.
207 */
208#define SBP2_MAX_CDB_SIZE 16
209
210/*
Clemens Ladisch26c72e22012-05-18 22:26:21 +0200211 * The maximum SBP-2 data buffer size is 0xffff. We quadlet-align this
212 * for compatibility with earlier versions of this driver.
Stefan Richter09b12dd2008-08-14 21:47:21 +0200213 */
214#define SBP2_MAX_SEG_SIZE 0xfffc
215
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500216/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500217#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200218#define SBP2_CSR_FIRMWARE_REVISION 0x3c
219#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
Chris Boot8ff6a752012-02-15 14:59:08 +0000220#define SBP2_CSR_UNIT_UNIQUE_ID 0x8d
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200221#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500222
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500223/* Management orb opcodes */
224#define SBP2_LOGIN_REQUEST 0x0
225#define SBP2_QUERY_LOGINS_REQUEST 0x1
226#define SBP2_RECONNECT_REQUEST 0x3
227#define SBP2_SET_PASSWORD_REQUEST 0x4
228#define SBP2_LOGOUT_REQUEST 0x7
229#define SBP2_ABORT_TASK_REQUEST 0xb
230#define SBP2_ABORT_TASK_SET 0xc
231#define SBP2_LOGICAL_UNIT_RESET 0xe
232#define SBP2_TARGET_RESET_REQUEST 0xf
233
234/* Offsets for command block agent registers */
235#define SBP2_AGENT_STATE 0x00
236#define SBP2_AGENT_RESET 0x04
237#define SBP2_ORB_POINTER 0x08
238#define SBP2_DOORBELL 0x10
239#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
240
241/* Status write response codes */
242#define SBP2_STATUS_REQUEST_COMPLETE 0x0
243#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
244#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
245#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
246
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400247#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
248#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
249#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
250#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
251#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
252#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
253#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
254#define STATUS_GET_DATA(v) ((v).data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500255
256struct sbp2_status {
257 u32 status;
258 u32 orb_low;
259 u8 data[24];
260};
261
262struct sbp2_pointer {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100263 __be32 high;
264 __be32 low;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500265};
266
267struct sbp2_orb {
268 struct fw_transaction t;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400269 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500270 dma_addr_t request_bus;
271 int rcode;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400272 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500273 struct list_head link;
274};
275
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400276#define MANAGEMENT_ORB_LUN(v) ((v))
277#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
278#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200279#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400280#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
281#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500282
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400283#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
284#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500285
286struct sbp2_management_orb {
287 struct sbp2_orb base;
288 struct {
289 struct sbp2_pointer password;
290 struct sbp2_pointer response;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100291 __be32 misc;
292 __be32 length;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500293 struct sbp2_pointer status_fifo;
294 } request;
295 __be32 response[4];
296 dma_addr_t response_bus;
297 struct completion done;
298 struct sbp2_status status;
299};
300
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500301struct sbp2_login_response {
Stefan Richter71ee9f02008-02-28 20:51:11 +0100302 __be32 misc;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500303 struct sbp2_pointer command_block_agent;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100304 __be32 reconnect_hold;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500305};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400306#define COMMAND_ORB_DATA_SIZE(v) ((v))
307#define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
308#define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
309#define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
310#define COMMAND_ORB_SPEED(v) ((v) << 24)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +0100311#define COMMAND_ORB_DIRECTION ((1) << 27)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400312#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
313#define COMMAND_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500314
315struct sbp2_command_orb {
316 struct sbp2_orb base;
317 struct {
318 struct sbp2_pointer next;
319 struct sbp2_pointer data_descriptor;
Stefan Richter71ee9f02008-02-28 20:51:11 +0100320 __be32 misc;
Stefan Richteraf271942009-06-30 20:27:59 +0200321 u8 command_block[SBP2_MAX_CDB_SIZE];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500322 } request;
323 struct scsi_cmnd *cmd;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200324 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500325
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200326 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500327 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500328};
329
Stefan Richterf7460722009-01-24 19:41:46 +0100330#define SBP2_ROM_VALUE_WILDCARD ~0 /* match all */
331#define SBP2_ROM_VALUE_MISSING 0xff000000 /* not present in the unit dir. */
332
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500333/*
334 * List of devices with known bugs.
335 *
336 * The firmware_revision field, masked with 0xffff00, is the best
337 * indicator for the type of bridge chip of a device. It yields a few
338 * false positives but this did not break correctly behaving devices
Stefan Richterf7460722009-01-24 19:41:46 +0100339 * so far.
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500340 */
341static const struct {
342 u32 firmware_revision;
343 u32 model;
Stefan Richter05cca7382008-01-26 17:42:45 +0100344 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500345} sbp2_workarounds_table[] = {
346 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
347 .firmware_revision = 0x002800,
348 .model = 0x001010,
349 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
Stefan Richterffcaade2008-05-11 00:35:04 +0200350 SBP2_WORKAROUND_MODE_SENSE_8 |
351 SBP2_WORKAROUND_POWER_CONDITION,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500352 },
Stefan Richter9220f192008-02-03 23:04:38 +0100353 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
354 .firmware_revision = 0x002800,
355 .model = 0x000000,
Stefan Richter3c5f8032009-09-06 19:33:50 +0200356 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
Stefan Richter9220f192008-02-03 23:04:38 +0100357 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500358 /* Initio bridges, actually only needed for some older ones */ {
359 .firmware_revision = 0x000200,
Stefan Richterf7460722009-01-24 19:41:46 +0100360 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500361 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
362 },
Stefan Richterffcaade2008-05-11 00:35:04 +0200363 /* PL-3507 bridge with Prolific firmware */ {
364 .firmware_revision = 0x012800,
Stefan Richterf7460722009-01-24 19:41:46 +0100365 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richterffcaade2008-05-11 00:35:04 +0200366 .workarounds = SBP2_WORKAROUND_POWER_CONDITION,
367 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500368 /* Symbios bridge */ {
369 .firmware_revision = 0xa0b800,
Stefan Richterf7460722009-01-24 19:41:46 +0100370 .model = SBP2_ROM_VALUE_WILDCARD,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500371 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
372 },
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100373 /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
374 .firmware_revision = 0x002600,
Stefan Richterf7460722009-01-24 19:41:46 +0100375 .model = SBP2_ROM_VALUE_WILDCARD,
Stefan Richter2aa9ff72008-03-11 22:32:03 +0100376 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
377 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400378 /*
Stefan Richterc8c47072009-01-29 00:11:59 +0100379 * iPod 2nd generation: needs 128k max transfer size workaround
380 * iPod 3rd generation: needs fix capacity workaround
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400381 */
Stefan Richterc8c47072009-01-29 00:11:59 +0100382 {
383 .firmware_revision = 0x0a2700,
384 .model = 0x000000,
385 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS |
386 SBP2_WORKAROUND_FIX_CAPACITY,
387 },
388 /* iPod 4th generation */ {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500389 .firmware_revision = 0x0a2700,
390 .model = 0x000021,
391 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
392 },
393 /* iPod mini */ {
394 .firmware_revision = 0x0a2700,
Stefan Richter031bb272008-11-22 12:38:58 +0100395 .model = 0x000022,
396 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
397 },
398 /* iPod mini */ {
399 .firmware_revision = 0x0a2700,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500400 .model = 0x000023,
401 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
402 },
403 /* iPod Photo */ {
404 .firmware_revision = 0x0a2700,
405 .model = 0x00007e,
406 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
407 }
408};
409
Stefan Richter53dca512008-12-14 21:47:04 +0100410static void free_orb(struct kref *kref)
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400411{
412 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
413
414 kfree(orb);
415}
416
Stefan Richter53dca512008-12-14 21:47:04 +0100417static void sbp2_status_write(struct fw_card *card, struct fw_request *request,
418 int tcode, int destination, int source,
Stefan Richter33e553f2010-06-20 22:50:35 +0200419 int generation, unsigned long long offset,
Stefan Richter53dca512008-12-14 21:47:04 +0100420 void *payload, size_t length, void *callback_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500421{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200422 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500423 struct sbp2_orb *orb;
424 struct sbp2_status status;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500425 unsigned long flags;
426
427 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
Stefan Richter094614f2009-09-06 18:51:27 +0200428 length < 8 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500429 fw_send_response(card, request, RCODE_TYPE_ERROR);
430 return;
431 }
432
Stefan Richter094614f2009-09-06 18:51:27 +0200433 status.status = be32_to_cpup(payload);
434 status.orb_low = be32_to_cpup(payload + 4);
435 memset(status.data, 0, sizeof(status.data));
436 if (length > 8)
437 memcpy(status.data, payload + 8, length - 8);
438
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400439 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100440 dev_notice(lu_dev(lu),
441 "non-ORB related status write, not handled\n");
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500442 fw_send_response(card, request, RCODE_COMPLETE);
443 return;
444 }
445
446 /* Lookup the orb corresponding to this status write. */
447 spin_lock_irqsave(&card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200448 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400449 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400450 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
451 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500452 list_del(&orb->link);
453 break;
454 }
455 }
456 spin_unlock_irqrestore(&card->lock, flags);
457
Stefan Richterbaed6b82009-09-03 23:07:35 +0200458 if (&orb->link != &lu->orb_list) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500459 orb->callback(orb, &status);
Stefan Richter6c743402010-08-16 21:58:03 +0200460 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richterbaed6b82009-09-03 23:07:35 +0200461 } else {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100462 dev_err(lu_dev(lu), "status write for unknown ORB\n");
Stefan Richterbaed6b82009-09-03 23:07:35 +0200463 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400464
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500465 fw_send_response(card, request, RCODE_COMPLETE);
466}
467
Stefan Richter53dca512008-12-14 21:47:04 +0100468static void complete_transaction(struct fw_card *card, int rcode,
469 void *payload, size_t length, void *data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500470{
471 struct sbp2_orb *orb = data;
472 unsigned long flags;
473
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400474 /*
475 * This is a little tricky. We can get the status write for
476 * the orb before we get this callback. The status write
477 * handler above will assume the orb pointer transaction was
478 * successful and set the rcode to RCODE_COMPLETE for the orb.
479 * So this callback only sets the rcode if it hasn't already
480 * been set and only does the cleanup if the transaction
481 * failed and we didn't already get a status write.
482 */
483 spin_lock_irqsave(&card->lock, flags);
484
485 if (orb->rcode == -1)
486 orb->rcode = rcode;
Stefan Richter7a4e1e92011-03-15 00:04:42 +0100487 if (orb->rcode != RCODE_COMPLETE) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500488 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200489 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter6c743402010-08-16 21:58:03 +0200490
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500491 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200492 kref_put(&orb->kref, free_orb); /* orb callback reference */
Stefan Richter1b34e972007-08-25 10:40:42 +0200493 } else {
494 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500495 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400496
Stefan Richter6c743402010-08-16 21:58:03 +0200497 kref_put(&orb->kref, free_orb); /* transaction callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500498}
499
Stefan Richter53dca512008-12-14 21:47:04 +0100500static void sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
501 int node_id, int generation, u64 offset)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500502{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100503 struct fw_device *device = target_parent_device(lu->tgt);
Stefan Richter81bf52d2011-05-01 21:06:42 +0200504 struct sbp2_pointer orb_pointer;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500505 unsigned long flags;
506
Stefan Richter81bf52d2011-05-01 21:06:42 +0200507 orb_pointer.high = 0;
508 orb_pointer.low = cpu_to_be32(orb->request_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500509
510 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200511 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500512 spin_unlock_irqrestore(&device->card->lock, flags);
513
Stefan Richter6c743402010-08-16 21:58:03 +0200514 kref_get(&orb->kref); /* transaction callback reference */
515 kref_get(&orb->kref); /* orb callback reference */
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400516
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500517 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200518 node_id, generation, device->max_speed, offset,
Stefan Richter81bf52d2011-05-01 21:06:42 +0200519 &orb_pointer, 8, complete_transaction, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500520}
521
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200522static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500523{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100524 struct fw_device *device = target_parent_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500525 struct sbp2_orb *orb, *next;
526 struct list_head list;
527 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500528 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500529
530 INIT_LIST_HEAD(&list);
531 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200532 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500533 spin_unlock_irqrestore(&device->card->lock, flags);
534
535 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500536 retval = 0;
Stefan Richter7a4e1e92011-03-15 00:04:42 +0100537 if (fw_cancel_transaction(device->card, &orb->t) == 0)
538 continue;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500539
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500540 orb->rcode = RCODE_CANCELLED;
541 orb->callback(orb, NULL);
Stefan Richter6c743402010-08-16 21:58:03 +0200542 kref_put(&orb->kref, free_orb); /* orb callback reference */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500543 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500544
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500545 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500546}
547
Stefan Richter53dca512008-12-14 21:47:04 +0100548static void complete_management_orb(struct sbp2_orb *base_orb,
549 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500550{
551 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400552 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500553
554 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400555 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500556 complete(&orb->done);
557}
558
Stefan Richter53dca512008-12-14 21:47:04 +0100559static int sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
560 int generation, int function,
561 int lun_or_login_id, void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500562{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100563 struct fw_device *device = target_parent_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500564 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100565 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500566 int retval = -ENOMEM;
567
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100568 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
569 return 0;
570
Stefan Richterc13ccfc2012-03-04 14:23:00 +0100571 orb = kzalloc(sizeof(*orb), GFP_NOIO);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500572 if (orb == NULL)
573 return -ENOMEM;
574
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400575 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500576 orb->response_bus =
577 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400578 sizeof(orb->response), DMA_FROM_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700579 if (dma_mapping_error(device->card->device, orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200580 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500581
Stefan Richter71ee9f02008-02-28 20:51:11 +0100582 orb->request.response.high = 0;
583 orb->request.response.low = cpu_to_be32(orb->response_bus);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500584
Stefan Richter71ee9f02008-02-28 20:51:11 +0100585 orb->request.misc = cpu_to_be32(
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400586 MANAGEMENT_ORB_NOTIFY |
587 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100588 MANAGEMENT_ORB_LUN(lun_or_login_id));
589 orb->request.length = cpu_to_be32(
590 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500591
Stefan Richter71ee9f02008-02-28 20:51:11 +0100592 orb->request.status_fifo.high =
593 cpu_to_be32(lu->address_handler.offset >> 32);
594 orb->request.status_fifo.low =
595 cpu_to_be32(lu->address_handler.offset);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500596
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500597 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100598 /* Ask for 2^2 == 4 seconds reconnect grace period */
Stefan Richter71ee9f02008-02-28 20:51:11 +0100599 orb->request.misc |= cpu_to_be32(
Stefan Richter14dc9922008-01-20 01:25:31 +0100600 MANAGEMENT_ORB_RECONNECT(2) |
Stefan Richter71ee9f02008-02-28 20:51:11 +0100601 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
Jarod Wilson384170d2008-01-25 23:31:12 -0500602 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100603 } else {
604 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500605 }
606
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500607 init_completion(&orb->done);
608 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500609
Stefan Richter7aa48482007-07-02 21:04:44 +0200610 orb->base.request_bus =
611 dma_map_single(device->card->device, &orb->request,
612 sizeof(orb->request), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -0700613 if (dma_mapping_error(device->card->device, orb->base.request_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200614 goto fail_mapping_request;
615
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200616 sbp2_send_orb(&orb->base, lu, node_id, generation,
617 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500618
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100619 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500620
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500621 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200622 if (sbp2_cancel_orbs(lu) == 0) {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100623 dev_err(lu_dev(lu), "ORB reply timed out, rcode 0x%02x\n",
624 orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500625 goto out;
626 }
627
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500628 if (orb->base.rcode != RCODE_COMPLETE) {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100629 dev_err(lu_dev(lu), "management write failed, rcode 0x%02x\n",
630 orb->base.rcode);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500631 goto out;
632 }
633
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400634 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
635 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100636 dev_err(lu_dev(lu), "error status: %d:%d\n",
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400637 STATUS_GET_RESPONSE(orb->status),
638 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500639 goto out;
640 }
641
642 retval = 0;
643 out:
644 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400645 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200646 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500647 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400648 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200649 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500650 if (response)
Stefan Richter71ee9f02008-02-28 20:51:11 +0100651 memcpy(response, orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400652 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500653
654 return retval;
655}
656
Stefan Richtere0e60212008-02-03 23:08:58 +0100657static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
658{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100659 struct fw_device *device = target_parent_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200660 __be32 d = 0;
Stefan Richtere0e60212008-02-03 23:08:58 +0100661
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200662 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
663 lu->tgt->node_id, lu->generation, device->max_speed,
664 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc832010-06-12 20:29:07 +0200665 &d, 4);
Stefan Richtere0e60212008-02-03 23:08:58 +0100666}
667
Stefan Richter53dca512008-12-14 21:47:04 +0100668static void complete_agent_reset_write_no_wait(struct fw_card *card,
669 int rcode, void *payload, size_t length, void *data)
Stefan Richtere0e60212008-02-03 23:08:58 +0100670{
671 kfree(data);
672}
673
674static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500675{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100676 struct fw_device *device = target_parent_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500677 struct fw_transaction *t;
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200678 static __be32 d;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500679
Stefan Richtere0e60212008-02-03 23:08:58 +0100680 t = kmalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500681 if (t == NULL)
Stefan Richtere0e60212008-02-03 23:08:58 +0100682 return;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500683
684 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200685 lu->tgt->node_id, lu->generation, device->max_speed,
686 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere847cc832010-06-12 20:29:07 +0200687 &d, 4, complete_agent_reset_write_no_wait, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500688}
689
Stefan Richter2e2705b2008-02-16 16:37:28 +0100690static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
691{
692 /*
693 * We may access dont_block without taking card->lock here:
694 * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
695 * are currently serialized against each other.
696 * And a wrong result in sbp2_conditionally_block()'s access of
697 * dont_block is rather harmless, it simply misses its first chance.
698 */
699 --lu->tgt->dont_block;
700}
701
702/*
703 * Blocks lu->tgt if all of the following conditions are met:
704 * - Login, INQUIRY, and high-level SCSI setup of all of the target's
705 * logical units have been finished (indicated by dont_block == 0).
706 * - lu->generation is stale.
707 *
708 * Note, scsi_block_requests() must be called while holding card->lock,
709 * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
710 * unblock the target.
711 */
712static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
713{
714 struct sbp2_target *tgt = lu->tgt;
Stefan Richtereba9eba2011-12-20 21:34:12 +0100715 struct fw_card *card = target_parent_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100716 struct Scsi_Host *shost =
717 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
718 unsigned long flags;
719
720 spin_lock_irqsave(&card->lock, flags);
721 if (!tgt->dont_block && !lu->blocked &&
722 lu->generation != card->generation) {
723 lu->blocked = true;
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100724 if (++tgt->blocked == 1)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100725 scsi_block_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100726 }
727 spin_unlock_irqrestore(&card->lock, flags);
728}
729
730/*
731 * Unblocks lu->tgt as soon as all its logical units can be unblocked.
732 * Note, it is harmless to run scsi_unblock_requests() outside the
733 * card->lock protected section. On the other hand, running it inside
734 * the section might clash with shost->host_lock.
735 */
736static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
737{
738 struct sbp2_target *tgt = lu->tgt;
Stefan Richtereba9eba2011-12-20 21:34:12 +0100739 struct fw_card *card = target_parent_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100740 struct Scsi_Host *shost =
741 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
742 unsigned long flags;
743 bool unblock = false;
744
745 spin_lock_irqsave(&card->lock, flags);
746 if (lu->blocked && lu->generation == card->generation) {
747 lu->blocked = false;
748 unblock = --tgt->blocked == 0;
749 }
750 spin_unlock_irqrestore(&card->lock, flags);
751
Stefan Richtera5fd9ec2008-02-28 20:53:45 +0100752 if (unblock)
Stefan Richter2e2705b2008-02-16 16:37:28 +0100753 scsi_unblock_requests(shost);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100754}
755
756/*
757 * Prevents future blocking of tgt and unblocks it.
758 * Note, it is harmless to run scsi_unblock_requests() outside the
759 * card->lock protected section. On the other hand, running it inside
760 * the section might clash with shost->host_lock.
761 */
762static void sbp2_unblock(struct sbp2_target *tgt)
763{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100764 struct fw_card *card = target_parent_device(tgt)->card;
Stefan Richter2e2705b2008-02-16 16:37:28 +0100765 struct Scsi_Host *shost =
766 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
767 unsigned long flags;
768
769 spin_lock_irqsave(&card->lock, flags);
770 ++tgt->dont_block;
771 spin_unlock_irqrestore(&card->lock, flags);
772
773 scsi_unblock_requests(shost);
774}
775
Stefan Richterf8436152008-02-26 23:30:02 +0100776static int sbp2_lun2int(u16 lun)
777{
778 struct scsi_lun eight_bytes_lun;
779
780 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
781 eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
782 eight_bytes_lun.scsi_lun[1] = lun & 0xff;
783
784 return scsilun_to_int(&eight_bytes_lun);
785}
786
Jarod Wilson17cff9f2008-03-07 01:43:31 -0500787/*
788 * Write retransmit retry values into the BUSY_TIMEOUT register.
789 * - The single-phase retry protocol is supported by all SBP-2 devices, but the
790 * default retry_limit value is 0 (i.e. never retry transmission). We write a
791 * saner value after logging into the device.
792 * - The dual-phase retry protocol is optional to implement, and if not
793 * supported, writes to the dual-phase portion of the register will be
794 * ignored. We try to write the original 1394-1995 default here.
795 * - In the case of devices that are also SBP-3-compliant, all writes are
796 * ignored, as the register is read-only, but contains single-phase retry of
797 * 15, which is what we're trying to set for all SBP-2 device anyway, so this
798 * write attempt is safe and yields more consistent behavior for all devices.
799 *
800 * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
801 * and section 6.4 of the SBP-3 spec for further details.
802 */
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500803static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
804{
Stefan Richtereba9eba2011-12-20 21:34:12 +0100805 struct fw_device *device = target_parent_device(lu->tgt);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200806 __be32 d = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500807
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200808 fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
809 lu->tgt->node_id, lu->generation, device->max_speed,
Stefan Richtere847cc832010-06-12 20:29:07 +0200810 CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT, &d, 4);
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500811}
812
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200813static void sbp2_reconnect(struct work_struct *work);
814
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500815static void sbp2_login(struct work_struct *work)
816{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200817 struct sbp2_logical_unit *lu =
818 container_of(work, struct sbp2_logical_unit, work.work);
Stefan Richter48f18c72008-02-03 23:09:50 +0100819 struct sbp2_target *tgt = lu->tgt;
Stefan Richtereba9eba2011-12-20 21:34:12 +0100820 struct fw_device *device = target_parent_device(tgt);
Stefan Richter48f18c72008-02-03 23:09:50 +0100821 struct Scsi_Host *shost;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200822 struct scsi_device *sdev;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500823 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200824 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500825
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100826 if (fw_device_is_shutdown(device))
Stefan Richter6ff81472011-08-27 15:33:34 +0200827 return;
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100828
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100829 generation = device->generation;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100830 smp_rmb(); /* node IDs must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100831 node_id = device->node_id;
832 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500833
Stefan Richterce896d92008-02-03 23:11:39 +0100834 /* If this is a re-login attempt, log out, or we might be rejected. */
Stefan Richterf8436152008-02-26 23:30:02 +0100835 if (lu->has_sdev)
Stefan Richterce896d92008-02-03 23:11:39 +0100836 sbp2_send_management_orb(lu, device->node_id, generation,
837 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
838
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200839 if (sbp2_send_management_orb(lu, node_id, generation,
840 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter2e2705b2008-02-16 16:37:28 +0100841 if (lu->retries++ < 5) {
Stefan Richter285838e2007-11-07 01:12:51 +0100842 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Stefan Richter2e2705b2008-02-16 16:37:28 +0100843 } else {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100844 dev_err(tgt_dev(tgt), "failed to login to LUN %04x\n",
845 lu->lun);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100846 /* Let any waiting I/O fail from now on. */
847 sbp2_unblock(lu->tgt);
848 }
Stefan Richter6ff81472011-08-27 15:33:34 +0200849 return;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500850 }
851
Stefan Richter48f18c72008-02-03 23:09:50 +0100852 tgt->node_id = node_id;
853 tgt->address_high = local_node_id << 16;
Stefan Richter621f6dd2008-10-26 11:04:20 +0100854 smp_wmb(); /* node IDs must not be older than generation */
855 lu->generation = generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500856
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200857 lu->command_block_agent_address =
Stefan Richter71ee9f02008-02-28 20:51:11 +0100858 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
859 << 32) | be32_to_cpu(response.command_block_agent.low);
860 lu->login_id = be32_to_cpu(response.misc) & 0xffff;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500861
Stefan Richtereba9eba2011-12-20 21:34:12 +0100862 dev_notice(tgt_dev(tgt), "logged in to LUN %04x (%d retries)\n",
863 lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500864
Jarod Wilson51f9dbe2008-03-07 01:43:01 -0500865 /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
866 sbp2_set_busy_timeout(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500867
Tejun Heo70044d72014-03-07 10:19:57 -0500868 lu->workfn = sbp2_reconnect;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200869 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500870
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100871 /* This was a re-login. */
Stefan Richterf8436152008-02-26 23:30:02 +0100872 if (lu->has_sdev) {
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100873 sbp2_cancel_orbs(lu);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100874 sbp2_conditionally_unblock(lu);
Stefan Richter6ff81472011-08-27 15:33:34 +0200875
876 return;
Stefan Richter0fa6dfd2008-02-03 23:10:47 +0100877 }
878
Stefan Richter9220f192008-02-03 23:04:38 +0100879 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
880 ssleep(SBP2_INQUIRY_DELAY);
881
Stefan Richter48f18c72008-02-03 23:09:50 +0100882 shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Stefan Richterf8436152008-02-26 23:30:02 +0100883 sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
Stefan Richtere80de372008-02-15 21:29:02 +0100884 /*
885 * FIXME: We are unable to perform reconnects while in sbp2_login().
886 * Therefore __scsi_add_device() will get into trouble if a bus reset
887 * happens in parallel. It will either fail or leave us with an
888 * unusable sdev. As a workaround we check for this and retry the
889 * whole login and SCSI probing.
890 */
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100891
Stefan Richtere80de372008-02-15 21:29:02 +0100892 /* Reported error during __scsi_add_device() */
893 if (IS_ERR(sdev))
894 goto out_logout_login;
895
Stefan Richtere80de372008-02-15 21:29:02 +0100896 /* Unreported error during __scsi_add_device() */
897 smp_rmb(); /* get current card generation */
898 if (generation != device->card->generation) {
899 scsi_remove_device(sdev);
Stefan Richter33f1c6c32008-02-19 09:05:49 +0100900 scsi_device_put(sdev);
Stefan Richtere80de372008-02-15 21:29:02 +0100901 goto out_logout_login;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500902 }
Stefan Richtere80de372008-02-15 21:29:02 +0100903
904 /* No error during __scsi_add_device() */
Stefan Richterf8436152008-02-26 23:30:02 +0100905 lu->has_sdev = true;
906 scsi_device_put(sdev);
Stefan Richter2e2705b2008-02-16 16:37:28 +0100907 sbp2_allow_block(lu);
Stefan Richter6ff81472011-08-27 15:33:34 +0200908
909 return;
Stefan Richtere80de372008-02-15 21:29:02 +0100910
911 out_logout_login:
912 smp_rmb(); /* generation may have changed */
913 generation = device->generation;
914 smp_rmb(); /* node_id must not be older than generation */
915
916 sbp2_send_management_orb(lu, device->node_id, generation,
917 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
918 /*
919 * If a bus reset happened, sbp2_update will have requeued
920 * lu->work already. Reset the work from reconnect to login.
921 */
Tejun Heo70044d72014-03-07 10:19:57 -0500922 lu->workfn = sbp2_login;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500923}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500924
Stefan Richterb2af07b2011-08-27 15:34:32 +0200925static void sbp2_reconnect(struct work_struct *work)
926{
927 struct sbp2_logical_unit *lu =
928 container_of(work, struct sbp2_logical_unit, work.work);
929 struct sbp2_target *tgt = lu->tgt;
Stefan Richtereba9eba2011-12-20 21:34:12 +0100930 struct fw_device *device = target_parent_device(tgt);
Stefan Richterb2af07b2011-08-27 15:34:32 +0200931 int generation, node_id, local_node_id;
932
933 if (fw_device_is_shutdown(device))
934 return;
935
936 generation = device->generation;
937 smp_rmb(); /* node IDs must not be older than generation */
938 node_id = device->node_id;
939 local_node_id = device->card->node_id;
940
941 if (sbp2_send_management_orb(lu, node_id, generation,
942 SBP2_RECONNECT_REQUEST,
943 lu->login_id, NULL) < 0) {
944 /*
945 * If reconnect was impossible even though we are in the
946 * current generation, fall back and try to log in again.
947 *
948 * We could check for "Function rejected" status, but
949 * looking at the bus generation as simpler and more general.
950 */
951 smp_rmb(); /* get current card generation */
952 if (generation == device->card->generation ||
953 lu->retries++ >= 5) {
Stefan Richtereba9eba2011-12-20 21:34:12 +0100954 dev_err(tgt_dev(tgt), "failed to reconnect\n");
Stefan Richterb2af07b2011-08-27 15:34:32 +0200955 lu->retries = 0;
Tejun Heo70044d72014-03-07 10:19:57 -0500956 lu->workfn = sbp2_login;
Stefan Richterb2af07b2011-08-27 15:34:32 +0200957 }
958 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
959
960 return;
961 }
962
963 tgt->node_id = node_id;
964 tgt->address_high = local_node_id << 16;
965 smp_wmb(); /* node IDs must not be older than generation */
966 lu->generation = generation;
967
Stefan Richtereba9eba2011-12-20 21:34:12 +0100968 dev_notice(tgt_dev(tgt), "reconnected to LUN %04x (%d retries)\n",
969 lu->lun, lu->retries);
Stefan Richterb2af07b2011-08-27 15:34:32 +0200970
971 sbp2_agent_reset(lu);
972 sbp2_cancel_orbs(lu);
973 sbp2_conditionally_unblock(lu);
974}
975
Tejun Heo70044d72014-03-07 10:19:57 -0500976static void sbp2_lu_workfn(struct work_struct *work)
977{
978 struct sbp2_logical_unit *lu = container_of(to_delayed_work(work),
979 struct sbp2_logical_unit, work);
980 lu->workfn(work);
981}
982
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200983static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
984{
985 struct sbp2_logical_unit *lu;
986
987 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
988 if (!lu)
989 return -ENOMEM;
990
991 lu->address_handler.length = 0x100;
992 lu->address_handler.address_callback = sbp2_status_write;
993 lu->address_handler.callback_data = lu;
994
995 if (fw_core_add_address_handler(&lu->address_handler,
996 &fw_high_memory_region) < 0) {
997 kfree(lu);
998 return -ENOMEM;
999 }
1000
Stefan Richterf8436152008-02-26 23:30:02 +01001001 lu->tgt = tgt;
1002 lu->lun = lun_entry & 0xffff;
Jay Fenlasoncd1f70fd2008-10-24 15:26:20 -04001003 lu->login_id = INVALID_LOGIN_ID;
Stefan Richterf8436152008-02-26 23:30:02 +01001004 lu->retries = 0;
1005 lu->has_sdev = false;
1006 lu->blocked = false;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001007 ++tgt->dont_block;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001008 INIT_LIST_HEAD(&lu->orb_list);
Tejun Heo70044d72014-03-07 10:19:57 -05001009 lu->workfn = sbp2_login;
1010 INIT_DELAYED_WORK(&lu->work, sbp2_lu_workfn);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001011
1012 list_add_tail(&lu->link, &tgt->lu_list);
1013 return 0;
1014}
1015
Chris Boot8ff6a752012-02-15 14:59:08 +00001016static void sbp2_get_unit_unique_id(struct sbp2_target *tgt,
1017 const u32 *leaf)
1018{
1019 if ((leaf[0] & 0xffff0000) == 0x00020000)
1020 tgt->guid = (u64)leaf[1] << 32 | leaf[2];
1021}
1022
Stefan Richter13b302d2009-12-26 01:44:10 +01001023static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt,
1024 const u32 *directory)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001025{
1026 struct fw_csr_iterator ci;
1027 int key, value;
1028
1029 fw_csr_iterator_init(&ci, directory);
1030 while (fw_csr_iterator_next(&ci, &key, &value))
1031 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
1032 sbp2_add_logical_unit(tgt, value) < 0)
1033 return -ENOMEM;
1034 return 0;
1035}
1036
Stefan Richter13b302d2009-12-26 01:44:10 +01001037static int sbp2_scan_unit_dir(struct sbp2_target *tgt, const u32 *directory,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001038 u32 *model, u32 *firmware_revision)
1039{
1040 struct fw_csr_iterator ci;
1041 int key, value;
1042
1043 fw_csr_iterator_init(&ci, directory);
1044 while (fw_csr_iterator_next(&ci, &key, &value)) {
1045 switch (key) {
1046
1047 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1048 tgt->management_agent_address =
1049 CSR_REGISTER_BASE + 4 * value;
1050 break;
1051
1052 case CSR_DIRECTORY_ID:
1053 tgt->directory_id = value;
1054 break;
1055
1056 case CSR_MODEL:
1057 *model = value;
1058 break;
1059
1060 case SBP2_CSR_FIRMWARE_REVISION:
1061 *firmware_revision = value;
1062 break;
1063
Jarod Wilson384170d2008-01-25 23:31:12 -05001064 case SBP2_CSR_UNIT_CHARACTERISTICS:
1065 /* the timeout value is stored in 500ms units */
Stefan Richtereaf76e02009-10-08 00:39:31 +02001066 tgt->mgt_orb_timeout = (value >> 8 & 0xff) * 500;
Jarod Wilson384170d2008-01-25 23:31:12 -05001067 break;
1068
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001069 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1070 if (sbp2_add_logical_unit(tgt, value) < 0)
1071 return -ENOMEM;
1072 break;
1073
Chris Boot8ff6a752012-02-15 14:59:08 +00001074 case SBP2_CSR_UNIT_UNIQUE_ID:
1075 sbp2_get_unit_unique_id(tgt, ci.p - 1 + value);
1076 break;
1077
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001078 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
Richard Sharpe0e3e2ea2008-06-24 19:11:13 -07001079 /* Adjust for the increment in the iterator */
1080 if (sbp2_scan_logical_unit_dir(tgt, ci.p - 1 + value) < 0)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001081 return -ENOMEM;
1082 break;
1083 }
1084 }
1085 return 0;
1086}
1087
Stefan Richtereaf76e02009-10-08 00:39:31 +02001088/*
1089 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
1090 * provided in the config rom. Most devices do provide a value, which
1091 * we'll use for login management orbs, but with some sane limits.
1092 */
1093static void sbp2_clamp_management_orb_timeout(struct sbp2_target *tgt)
1094{
1095 unsigned int timeout = tgt->mgt_orb_timeout;
1096
1097 if (timeout > 40000)
Stefan Richtereba9eba2011-12-20 21:34:12 +01001098 dev_notice(tgt_dev(tgt), "%ds mgt_ORB_timeout limited to 40s\n",
1099 timeout / 1000);
Stefan Richtereaf76e02009-10-08 00:39:31 +02001100
1101 tgt->mgt_orb_timeout = clamp_val(timeout, 5000, 40000);
1102}
1103
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001104static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1105 u32 firmware_revision)
1106{
1107 int i;
Stefan Richter05cca7382008-01-26 17:42:45 +01001108 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001109
Stefan Richter2df222b2007-08-13 17:48:25 +02001110 if (w)
Stefan Richtereba9eba2011-12-20 21:34:12 +01001111 dev_notice(tgt_dev(tgt),
1112 "Please notify linux1394-devel@lists.sf.net "
1113 "if you need the workarounds parameter\n");
Stefan Richter2df222b2007-08-13 17:48:25 +02001114
1115 if (w & SBP2_WORKAROUND_OVERRIDE)
1116 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001117
1118 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1119
1120 if (sbp2_workarounds_table[i].firmware_revision !=
1121 (firmware_revision & 0xffffff00))
1122 continue;
1123
1124 if (sbp2_workarounds_table[i].model != model &&
Stefan Richterf7460722009-01-24 19:41:46 +01001125 sbp2_workarounds_table[i].model != SBP2_ROM_VALUE_WILDCARD)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001126 continue;
1127
Stefan Richter2df222b2007-08-13 17:48:25 +02001128 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001129 break;
1130 }
Stefan Richter2df222b2007-08-13 17:48:25 +02001131 out:
1132 if (w)
Stefan Richtereba9eba2011-12-20 21:34:12 +01001133 dev_notice(tgt_dev(tgt), "workarounds 0x%x "
1134 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
1135 w, firmware_revision, model);
Stefan Richter2df222b2007-08-13 17:48:25 +02001136 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001137}
1138
1139static struct scsi_host_template scsi_driver_template;
Stefan Richter94a87152013-06-09 18:15:00 +02001140static void sbp2_remove(struct fw_unit *unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001141
Stefan Richter94a87152013-06-09 18:15:00 +02001142static int sbp2_probe(struct fw_unit *unit, const struct ieee1394_device_id *id)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001143{
Stefan Richtere5110d02009-06-06 18:35:27 +02001144 struct fw_device *device = fw_parent_device(unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001145 struct sbp2_target *tgt;
1146 struct sbp2_logical_unit *lu;
1147 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001148 u32 model, firmware_revision;
1149
Chris Boot74044562012-02-15 14:59:09 +00001150 /* cannot (or should not) handle targets on the local node */
1151 if (device->is_local)
1152 return -ENODEV;
1153
Stefan Richter09b12dd2008-08-14 21:47:21 +02001154 if (dma_get_max_seg_size(device->card->device) > SBP2_MAX_SEG_SIZE)
Stefan Richterd6c8cef2013-03-24 17:31:38 +01001155 WARN_ON(dma_set_max_seg_size(device->card->device,
1156 SBP2_MAX_SEG_SIZE));
Stefan Richter09b12dd2008-08-14 21:47:21 +02001157
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001158 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1159 if (shost == NULL)
1160 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001161
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001162 tgt = (struct sbp2_target *)shost->hostdata;
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001163 dev_set_drvdata(&unit->device, tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001164 tgt->unit = unit;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001165 INIT_LIST_HEAD(&tgt->lu_list);
Stefan Richterc9755e12008-03-24 20:54:28 +01001166 tgt->guid = (u64)device->config_rom[3] << 32 | device->config_rom[4];
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001167
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001168 if (fw_device_enable_phys_dma(device) < 0)
1169 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001170
Stefan Richteraf271942009-06-30 20:27:59 +02001171 shost->max_cmd_len = SBP2_MAX_CDB_SIZE;
1172
Clemens Ladisch473ffe62012-05-18 18:39:39 +02001173 if (scsi_add_host_with_dma(shost, &unit->device,
1174 device->card->device) < 0)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001175 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001176
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001177 /* implicit directory ID */
1178 tgt->directory_id = ((unit->directory - device->config_rom) * 4
1179 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001180
Stefan Richterf7460722009-01-24 19:41:46 +01001181 firmware_revision = SBP2_ROM_VALUE_MISSING;
1182 model = SBP2_ROM_VALUE_MISSING;
1183
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001184 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1185 &firmware_revision) < 0)
Stefan Richter32ce38f2011-08-27 15:35:23 +02001186 goto fail_remove;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001187
Stefan Richtereaf76e02009-10-08 00:39:31 +02001188 sbp2_clamp_management_orb_timeout(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001189 sbp2_init_workarounds(tgt, model, firmware_revision);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001190
Stefan Richtera08e1002009-01-24 19:41:46 +01001191 /*
1192 * At S100 we can do 512 bytes per packet, at S200 1024 bytes,
1193 * and so on up to 4096 bytes. The SBP-2 max_payload field
1194 * specifies the max payload size as 2 ^ (max_payload + 2), so
1195 * if we set this to max_speed + 7, we get the right value.
1196 */
Stefan Richter4ec4a672011-09-19 00:20:48 +02001197 tgt->max_payload = min3(device->max_speed + 7, 10U,
1198 device->card->max_receive - 1);
Stefan Richtera08e1002009-01-24 19:41:46 +01001199
Stefan Richter285838e2007-11-07 01:12:51 +01001200 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001201 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter0dcfeb72008-10-22 00:28:36 +02001202 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
Stefan Richter6ff81472011-08-27 15:33:34 +02001203
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001204 return 0;
Kristian Høgsbergad852742007-05-09 19:23:07 -04001205
Stefan Richter32ce38f2011-08-27 15:35:23 +02001206 fail_remove:
Stefan Richter94a87152013-06-09 18:15:00 +02001207 sbp2_remove(unit);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001208 return -ENOMEM;
1209
1210 fail_shost_put:
1211 scsi_host_put(shost);
1212 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001213}
1214
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001215static void sbp2_update(struct fw_unit *unit)
1216{
Greg Kroah-Hartmand9614502009-04-30 14:43:31 -07001217 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001218 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001219
Stefan Richtere5110d02009-06-06 18:35:27 +02001220 fw_device_enable_phys_dma(fw_parent_device(unit));
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001221
1222 /*
1223 * Fw-core serializes sbp2_update() against sbp2_remove().
1224 * Iteration over tgt->lu_list is therefore safe here.
1225 */
1226 list_for_each_entry(lu, &tgt->lu_list, link) {
Stefan Richter2e2705b2008-02-16 16:37:28 +01001227 sbp2_conditionally_block(lu);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001228 lu->retries = 0;
Stefan Richter285838e2007-11-07 01:12:51 +01001229 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001230 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001231}
1232
Stefan Richter94a87152013-06-09 18:15:00 +02001233static void sbp2_remove(struct fw_unit *unit)
Stefan Richterb2af07b2011-08-27 15:34:32 +02001234{
Stefan Richter32ce38f2011-08-27 15:35:23 +02001235 struct fw_device *device = fw_parent_device(unit);
1236 struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
Stefan Richterb2af07b2011-08-27 15:34:32 +02001237 struct sbp2_logical_unit *lu, *next;
1238 struct Scsi_Host *shost =
1239 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
1240 struct scsi_device *sdev;
Stefan Richterb2af07b2011-08-27 15:34:32 +02001241
1242 /* prevent deadlocks */
1243 sbp2_unblock(tgt);
1244
1245 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
Stefan Richter32ce38f2011-08-27 15:35:23 +02001246 cancel_delayed_work_sync(&lu->work);
Stefan Richterb2af07b2011-08-27 15:34:32 +02001247 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
1248 if (sdev) {
1249 scsi_remove_device(sdev);
1250 scsi_device_put(sdev);
1251 }
1252 if (lu->login_id != INVALID_LOGIN_ID) {
1253 int generation, node_id;
1254 /*
1255 * tgt->node_id may be obsolete here if we failed
1256 * during initial login or after a bus reset where
1257 * the topology changed.
1258 */
1259 generation = device->generation;
1260 smp_rmb(); /* node_id vs. generation */
1261 node_id = device->node_id;
1262 sbp2_send_management_orb(lu, node_id, generation,
1263 SBP2_LOGOUT_REQUEST,
1264 lu->login_id, NULL);
1265 }
1266 fw_core_remove_address_handler(&lu->address_handler);
1267 list_del(&lu->link);
1268 kfree(lu);
1269 }
1270 scsi_remove_host(shost);
Stefan Richter94a87152013-06-09 18:15:00 +02001271 dev_notice(&unit->device, "released target %d:0:0\n", shost->host_no);
Stefan Richterb2af07b2011-08-27 15:34:32 +02001272
1273 scsi_host_put(shost);
Stefan Richterb2af07b2011-08-27 15:34:32 +02001274}
1275
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001276#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,
Stefan Richter0c22ecd2012-02-18 22:01:14 +01001292 .name = KBUILD_MODNAME,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001293 .bus = &fw_bus_type,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001294 },
Stefan Richter94a87152013-06-09 18:15:00 +02001295 .probe = sbp2_probe,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001296 .update = sbp2_update,
Stefan Richter94a87152013-06-09 18:15:00 +02001297 .remove = sbp2_remove,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001298 .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{
Clemens Ladischf2030222012-05-18 18:40:19 +02001304 scsi_dma_unmap(orb->cmd);
Stefan Richter5e212562009-01-28 01:03:34 +01001305
1306 if (orb->request.misc & cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT))
1307 dma_unmap_single(card_device, orb->page_table_bus,
1308 sizeof(orb->page_table), DMA_TO_DEVICE);
1309}
1310
Stefan Richter53dca512008-12-14 21:47:04 +01001311static unsigned int sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001312{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001313 int sam_status;
Chris Boot6503de62012-02-15 14:59:10 +00001314 int sfmt = (sbp2_status[0] >> 6) & 0x03;
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001315
Chris Boot6503de62012-02-15 14:59:10 +00001316 if (sfmt == 2 || sfmt == 3) {
1317 /*
1318 * Reserved for future standardization (2) or
1319 * Status block format vendor-dependent (3)
1320 */
1321 return DID_ERROR << 16;
1322 }
1323
1324 sense_data[0] = 0x70 | sfmt | (sbp2_status[1] & 0x80);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001325 sense_data[1] = 0x0;
Chris Boot6503de62012-02-15 14:59:10 +00001326 sense_data[2] = ((sbp2_status[1] << 1) & 0xe0) | (sbp2_status[1] & 0x0f);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001327 sense_data[3] = sbp2_status[4];
1328 sense_data[4] = sbp2_status[5];
1329 sense_data[5] = sbp2_status[6];
1330 sense_data[6] = sbp2_status[7];
1331 sense_data[7] = 10;
1332 sense_data[8] = sbp2_status[8];
1333 sense_data[9] = sbp2_status[9];
1334 sense_data[10] = sbp2_status[10];
1335 sense_data[11] = sbp2_status[11];
1336 sense_data[12] = sbp2_status[2];
1337 sense_data[13] = sbp2_status[3];
1338 sense_data[14] = sbp2_status[12];
1339 sense_data[15] = sbp2_status[13];
1340
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001341 sam_status = sbp2_status[0] & 0x3f;
1342
1343 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001344 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001345 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001346 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001347 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001348 case SAM_STAT_RESERVATION_CONFLICT:
1349 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001350 return DID_OK << 16 | sam_status;
1351
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001352 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001353 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001354 }
1355}
1356
Stefan Richter53dca512008-12-14 21:47:04 +01001357static void complete_command_orb(struct sbp2_orb *base_orb,
1358 struct sbp2_status *status)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001359{
Jay Fenlason6f061482007-06-27 16:04:33 -04001360 struct sbp2_command_orb *orb =
1361 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richtereba9eba2011-12-20 21:34:12 +01001362 struct fw_device *device = target_parent_device(orb->lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001363 int result;
1364
1365 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001366 if (STATUS_GET_DEAD(*status))
Stefan Richtere0e60212008-02-03 23:08:58 +01001367 sbp2_agent_reset_no_wait(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001368
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001369 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001370 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001371 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001372 break;
1373 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001374 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001375 break;
1376 case SBP2_STATUS_ILLEGAL_REQUEST:
1377 case SBP2_STATUS_VENDOR_DEPENDENT:
1378 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001379 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001380 break;
1381 }
1382
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001383 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1384 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001385 orb->cmd->sense_buffer);
1386 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001387 /*
1388 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001389 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001390 * or when sending the write (less likely).
1391 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001392 result = DID_BUS_BUSY << 16;
Stefan Richter2e2705b2008-02-16 16:37:28 +01001393 sbp2_conditionally_block(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001394 }
1395
1396 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001397 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001398 sbp2_unmap_scatterlist(device->card->device, orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001399
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001400 orb->cmd->result = result;
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001401 orb->cmd->scsi_done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001402}
1403
Stefan Richter53dca512008-12-14 21:47:04 +01001404static int sbp2_map_scatterlist(struct sbp2_command_orb *orb,
1405 struct fw_device *device, struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001406{
Stefan Richter09b12dd2008-08-14 21:47:21 +02001407 struct scatterlist *sg = scsi_sglist(orb->cmd);
1408 int i, n;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001409
Clemens Ladischf2030222012-05-18 18:40:19 +02001410 n = scsi_dma_map(orb->cmd);
1411 if (n <= 0)
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001412 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001413
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001414 /*
1415 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001416 * the scatter list by converting it to an immediate block
1417 * request. This is also a workaround for broken devices such
1418 * as the second generation iPod which doesn't support page
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001419 * tables.
1420 */
Stefan Richter09b12dd2008-08-14 21:47:21 +02001421 if (n == 1) {
Stefan Richter71ee9f02008-02-28 20:51:11 +01001422 orb->request.data_descriptor.high =
1423 cpu_to_be32(lu->tgt->address_high);
1424 orb->request.data_descriptor.low =
1425 cpu_to_be32(sg_dma_address(sg));
1426 orb->request.misc |=
1427 cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001428 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001429 }
1430
Stefan Richter09b12dd2008-08-14 21:47:21 +02001431 for_each_sg(sg, sg, n, i) {
1432 orb->page_table[i].high = cpu_to_be32(sg_dma_len(sg) << 16);
1433 orb->page_table[i].low = cpu_to_be32(sg_dma_address(sg));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001434 }
1435
Stefan Richterb4be0162007-07-02 22:07:34 +02001436 orb->page_table_bus =
1437 dma_map_single(device->card->device, orb->page_table,
1438 sizeof(orb->page_table), DMA_TO_DEVICE);
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -07001439 if (dma_mapping_error(device->card->device, orb->page_table_bus))
Stefan Richterb4be0162007-07-02 22:07:34 +02001440 goto fail_page_table;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001441
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001442 /*
1443 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001444 * to fill in the node ID part of the address. All other
1445 * pointers assume that the data referenced reside on the
1446 * initiator (i.e. us), but data_descriptor can refer to data
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001447 * on other nodes so we need to put our ID in descriptor.high.
1448 */
Stefan Richter71ee9f02008-02-28 20:51:11 +01001449 orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1450 orb->request.data_descriptor.low = cpu_to_be32(orb->page_table_bus);
1451 orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
Stefan Richter09b12dd2008-08-14 21:47:21 +02001452 COMMAND_ORB_DATA_SIZE(n));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001453
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001454 return 0;
1455
1456 fail_page_table:
Clemens Ladischf2030222012-05-18 18:40:19 +02001457 scsi_dma_unmap(orb->cmd);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001458 fail:
1459 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001460}
1461
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001462/* SCSI stack integration */
1463
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001464static int sbp2_scsi_queuecommand(struct Scsi_Host *shost,
1465 struct scsi_cmnd *cmd)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001466{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001467 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Stefan Richtereba9eba2011-12-20 21:34:12 +01001468 struct fw_device *device = target_parent_device(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001469 struct sbp2_command_orb *orb;
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001470 int generation, retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001471
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001472 /*
1473 * Bidirectional commands are not yet implemented, and unknown
1474 * transfer direction not handled.
1475 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001476 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richtereba9eba2011-12-20 21:34:12 +01001477 dev_err(lu_dev(lu), "cannot handle bidirectional command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001478 cmd->result = DID_ERROR << 16;
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001479 cmd->scsi_done(cmd);
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001480 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001481 }
1482
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001483 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Stefan Richtercfb0c9d2013-03-24 17:32:00 +01001484 if (orb == NULL)
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001485 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001486
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001487 /* Initialize rcode to something not RCODE_COMPLETE. */
1488 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001489 kref_init(&orb->base.kref);
Stefan Richterb75ca5e2011-04-22 12:21:44 +02001490 orb->lu = lu;
1491 orb->cmd = cmd;
Stefan Richtera08e1002009-01-24 19:41:46 +01001492 orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
Stefan Richter71ee9f02008-02-28 20:51:11 +01001493 orb->request.misc = cpu_to_be32(
Stefan Richtera08e1002009-01-24 19:41:46 +01001494 COMMAND_ORB_MAX_PAYLOAD(lu->tgt->max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001495 COMMAND_ORB_SPEED(device->max_speed) |
Stefan Richter71ee9f02008-02-28 20:51:11 +01001496 COMMAND_ORB_NOTIFY);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001497
1498 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
Stefan Richter0d7dcbf2008-02-28 20:52:02 +01001499 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001500
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001501 generation = device->generation;
1502 smp_rmb(); /* sbp2_map_scatterlist looks at tgt->address_high */
1503
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001504 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1505 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001506
Boaz Harrosh64a87b22008-04-30 11:19:47 +03001507 memcpy(orb->request.command_block, cmd->cmnd, cmd->cmd_len);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001508
1509 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001510 orb->base.request_bus =
1511 dma_map_single(device->card->device, &orb->request,
1512 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter5e212562009-01-28 01:03:34 +01001513 if (dma_mapping_error(device->card->device, orb->base.request_bus)) {
1514 sbp2_unmap_scatterlist(device->card->device, orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001515 goto out;
Stefan Richter5e212562009-01-28 01:03:34 +01001516 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001517
Stefan Richter4bbc1bd2008-08-09 20:22:17 +02001518 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, generation,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001519 lu->command_block_agent_address + SBP2_ORB_POINTER);
1520 retval = 0;
1521 out:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001522 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001523 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001524}
1525
Stefan Richtercfb01382007-01-23 21:20:08 +01001526static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1527{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001528 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001529
Stefan Richter5513c5f2008-02-17 14:56:19 +01001530 /* (Re-)Adding logical units via the SCSI stack is not supported. */
1531 if (!lu)
1532 return -ENOSYS;
1533
Stefan Richtercfb01382007-01-23 21:20:08 +01001534 sdev->allow_restart = 1;
1535
Clemens Ladisch26c72e22012-05-18 22:26:21 +02001536 /*
1537 * SBP-2 does not require any alignment, but we set it anyway
1538 * for compatibility with earlier versions of this driver.
1539 */
Stefan Richter8ac3a472008-01-27 22:31:27 +01001540 blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
James Bottomley465ff312008-01-01 10:00:10 -06001541
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001542 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001543 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001544
Stefan Richtercfb01382007-01-23 21:20:08 +01001545 return 0;
1546}
1547
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001548static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1549{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001550 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001551
Stefan Richtercfb01382007-01-23 21:20:08 +01001552 sdev->use_10_for_rw = 1;
1553
Stefan Richter2635f962008-05-11 00:36:47 +02001554 if (sbp2_param_exclusive_login)
1555 sdev->manage_start_stop = 1;
1556
Stefan Richtercfb01382007-01-23 21:20:08 +01001557 if (sdev->type == TYPE_ROM)
1558 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001559
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001560 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001561 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001562 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001563
1564 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001565 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001566
Stefan Richterffcaade2008-05-11 00:35:04 +02001567 if (lu->tgt->workarounds & SBP2_WORKAROUND_POWER_CONDITION)
1568 sdev->start_stop_pwr_cond = 1;
1569
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001570 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Martin K. Petersen086fa5f2010-02-26 00:20:38 -05001571 blk_queue_max_hw_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001572
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001573 return 0;
1574}
1575
1576/*
1577 * Called by scsi stack when something has really gone wrong. Usually
1578 * called when a command has timed-out for some reason.
1579 */
1580static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1581{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001582 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001583
Stefan Richtereba9eba2011-12-20 21:34:12 +01001584 dev_notice(lu_dev(lu), "sbp2_scsi_abort\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001585 sbp2_agent_reset(lu);
1586 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001587
1588 return SUCCESS;
1589}
1590
Stefan Richter14e21982007-05-27 13:18:27 +02001591/*
1592 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1593 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1594 *
1595 * This is the concatenation of target port identifier and logical unit
1596 * identifier as per SAM-2...SAM-4 annex A.
1597 */
Stefan Richter53dca512008-12-14 21:47:04 +01001598static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
1599 struct device_attribute *attr, char *buf)
Stefan Richter14e21982007-05-27 13:18:27 +02001600{
1601 struct scsi_device *sdev = to_scsi_device(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001602 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001603
1604 if (!sdev)
1605 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001606
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001607 lu = sdev->hostdata;
Stefan Richter14e21982007-05-27 13:18:27 +02001608
Stefan Richterc9755e12008-03-24 20:54:28 +01001609 return sprintf(buf, "%016llx:%06x:%04x\n",
1610 (unsigned long long)lu->tgt->guid,
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001611 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001612}
1613
1614static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1615
1616static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1617 &dev_attr_ieee1394_id,
1618 NULL
1619};
1620
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001621static struct scsi_host_template scsi_driver_template = {
1622 .module = THIS_MODULE,
1623 .name = "SBP-2 IEEE-1394",
Stefan Richter0c22ecd2012-02-18 22:01:14 +01001624 .proc_name = "sbp2",
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001625 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001626 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001627 .slave_configure = sbp2_scsi_slave_configure,
1628 .eh_abort_handler = sbp2_scsi_abort,
1629 .this_id = -1,
1630 .sg_tablesize = SG_ALL,
1631 .use_clustering = ENABLE_CLUSTERING,
Stefan Richter02af8e72007-01-21 20:50:11 +01001632 .cmd_per_lun = 1,
1633 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001634 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001635};
1636
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001637MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1638MODULE_DESCRIPTION("SCSI over IEEE1394");
1639MODULE_LICENSE("GPL");
1640MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1641
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001642/* Provide a module alias so root-on-sbp2 initrds don't break. */
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001643MODULE_ALIAS("sbp2");
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001644
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001645static int __init sbp2_init(void)
1646{
1647 return driver_register(&sbp2_driver.driver);
1648}
1649
1650static void __exit sbp2_cleanup(void)
1651{
1652 driver_unregister(&sbp2_driver.driver);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001653}
1654
1655module_init(sbp2_init);
1656module_exit(sbp2_cleanup);