blob: 32b50f13e7a879a428d3b0f292a571c6769245bb [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * SBP2 driver (SCSI over IEEE1394)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05003 *
Kristian Høgsberg27a15e52007-02-06 14:49:39 -05004 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
Kristian Høgsbergc781c062007-05-07 20:33:32 -040021/*
22 * The basic structure of this driver is based on the old storage driver,
Kristian Høgsberg27a15e52007-02-06 14:49:39 -050023 * drivers/ieee1394/sbp2.c, originally written by
24 * James Goodwin <jamesg@filanet.com>
25 * with later contributions and ongoing maintenance from
26 * Ben Collins <bcollins@debian.org>,
27 * Stefan Richter <stefanr@s5r6.in-berlin.de>
28 * and many others.
29 */
30
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050031#include <linux/kernel.h>
32#include <linux/module.h>
Stefan Richter5cd54c92007-06-17 23:55:41 +020033#include <linux/moduleparam.h>
Stefan Richterfe69ca32006-12-28 12:46:54 +010034#include <linux/mod_devicetable.h>
Stefan Richter9220f192008-02-03 23:04:38 +010035#include <linux/delay.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050036#include <linux/device.h>
Andrew Morton0b5b2902006-12-27 14:49:23 -080037#include <linux/scatterlist.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050038#include <linux/dma-mapping.h>
Stefan Richtercf47c7a2007-06-17 23:52:08 +020039#include <linux/blkdev.h>
Stefan Richtere7cdf232007-07-01 13:54:57 +020040#include <linux/string.h>
Stefan Richter2df222b2007-08-13 17:48:25 +020041#include <linux/stringify.h>
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -050042#include <linux/timer.h>
Stefan Richterdf8ec242007-08-12 12:51:18 +020043#include <linux/workqueue.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010044#include <asm/system.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050045
46#include <scsi/scsi.h>
47#include <scsi/scsi_cmnd.h>
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -050048#include <scsi/scsi_device.h>
49#include <scsi/scsi_host.h>
50
51#include "fw-transaction.h"
52#include "fw-topology.h"
53#include "fw-device.h"
54
Stefan Richter5cd54c92007-06-17 23:55:41 +020055/*
56 * So far only bridges from Oxford Semiconductor are known to support
57 * concurrent logins. Depending on firmware, four or two concurrent logins
58 * are possible on OXFW911 and newer Oxsemi bridges.
59 *
60 * Concurrent logins are useful together with cluster filesystems.
61 */
62static int sbp2_param_exclusive_login = 1;
63module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
64MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
65 "(default = Y, use N for concurrent initiators)");
66
Stefan Richter2df222b2007-08-13 17:48:25 +020067/*
68 * Flags for firmware oddities
69 *
70 * - 128kB max transfer
71 * Limit transfer size. Necessary for some old bridges.
72 *
73 * - 36 byte inquiry
74 * When scsi_mod probes the device, let the inquiry command look like that
75 * from MS Windows.
76 *
77 * - skip mode page 8
78 * Suppress sending of mode_sense for mode page 8 if the device pretends to
79 * support the SCSI Primary Block commands instead of Reduced Block Commands.
80 *
81 * - fix capacity
82 * Tell sd_mod to correct the last sector number reported by read_capacity.
83 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
84 * Don't use this with devices which don't have this bug.
85 *
Stefan Richter9220f192008-02-03 23:04:38 +010086 * - delay inquiry
87 * Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
88 *
Stefan Richter2df222b2007-08-13 17:48:25 +020089 * - override internal blacklist
90 * Instead of adding to the built-in blacklist, use only the workarounds
91 * specified in the module load parameter.
92 * Useful if a blacklist entry interfered with a non-broken device.
93 */
94#define SBP2_WORKAROUND_128K_MAX_TRANS 0x1
95#define SBP2_WORKAROUND_INQUIRY_36 0x2
96#define SBP2_WORKAROUND_MODE_SENSE_8 0x4
97#define SBP2_WORKAROUND_FIX_CAPACITY 0x8
Stefan Richter9220f192008-02-03 23:04:38 +010098#define SBP2_WORKAROUND_DELAY_INQUIRY 0x10
99#define SBP2_INQUIRY_DELAY 12
Stefan Richter2df222b2007-08-13 17:48:25 +0200100#define SBP2_WORKAROUND_OVERRIDE 0x100
101
102static int sbp2_param_workarounds;
103module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
104MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
105 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
106 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
107 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
108 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
Stefan Richter9220f192008-02-03 23:04:38 +0100109 ", delay inquiry = " __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
Stefan Richter2df222b2007-08-13 17:48:25 +0200110 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
111 ", or a combination)");
112
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500113/* I don't know why the SCSI stack doesn't define something like this... */
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400114typedef void (*scsi_done_fn_t)(struct scsi_cmnd *);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500115
116static const char sbp2_driver_name[] = "sbp2";
117
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200118/*
119 * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
120 * and one struct scsi_device per sbp2_logical_unit.
121 */
122struct sbp2_logical_unit {
123 struct sbp2_target *tgt;
124 struct list_head link;
125 struct scsi_device *sdev;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500126 struct fw_address_handler address_handler;
127 struct list_head orb_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200128
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500129 u64 command_block_agent_address;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200130 u16 lun;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500131 int login_id;
132
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400133 /*
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200134 * The generation is updated once we've logged in or reconnected
135 * to the logical unit. Thus, I/O to the device will automatically
136 * fail and get retried if it happens in a window where the device
137 * is not ready, e.g. after a bus reset but before we reconnect.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400138 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500139 int generation;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500140 int retries;
141 struct delayed_work work;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500142};
143
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200144/*
145 * We create one struct sbp2_target per IEEE 1212 Unit Directory
146 * and one struct Scsi_Host per sbp2_target.
147 */
148struct sbp2_target {
149 struct kref kref;
150 struct fw_unit *unit;
Stefan Richter05cca7382008-01-26 17:42:45 +0100151 struct list_head lu_list;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200152
153 u64 management_agent_address;
154 int directory_id;
155 int node_id;
156 int address_high;
Stefan Richter05cca7382008-01-26 17:42:45 +0100157 unsigned int workarounds;
Jarod Wilson384170d2008-01-25 23:31:12 -0500158 unsigned int mgt_orb_timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200159};
160
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100161/*
162 * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
Jarod Wilson384170d2008-01-25 23:31:12 -0500163 * provided in the config rom. Most devices do provide a value, which
164 * we'll use for login management orbs, but with some sane limits.
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100165 */
Jarod Wilson384170d2008-01-25 23:31:12 -0500166#define SBP2_MIN_LOGIN_ORB_TIMEOUT 5000U /* Timeout in ms */
167#define SBP2_MAX_LOGIN_ORB_TIMEOUT 40000U /* Timeout in ms */
Stefan Richter05cca7382008-01-26 17:42:45 +0100168#define SBP2_ORB_TIMEOUT 2000U /* Timeout in ms */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500169#define SBP2_ORB_NULL 0x80000000
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100170#define SBP2_MAX_SG_ELEMENT_LENGTH 0xf000
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500171
172#define SBP2_DIRECTION_TO_MEDIA 0x0
173#define SBP2_DIRECTION_FROM_MEDIA 0x1
174
175/* Unit directory keys */
Jarod Wilson384170d2008-01-25 23:31:12 -0500176#define SBP2_CSR_UNIT_CHARACTERISTICS 0x3a
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200177#define SBP2_CSR_FIRMWARE_REVISION 0x3c
178#define SBP2_CSR_LOGICAL_UNIT_NUMBER 0x14
179#define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500180
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500181/* Management orb opcodes */
182#define SBP2_LOGIN_REQUEST 0x0
183#define SBP2_QUERY_LOGINS_REQUEST 0x1
184#define SBP2_RECONNECT_REQUEST 0x3
185#define SBP2_SET_PASSWORD_REQUEST 0x4
186#define SBP2_LOGOUT_REQUEST 0x7
187#define SBP2_ABORT_TASK_REQUEST 0xb
188#define SBP2_ABORT_TASK_SET 0xc
189#define SBP2_LOGICAL_UNIT_RESET 0xe
190#define SBP2_TARGET_RESET_REQUEST 0xf
191
192/* Offsets for command block agent registers */
193#define SBP2_AGENT_STATE 0x00
194#define SBP2_AGENT_RESET 0x04
195#define SBP2_ORB_POINTER 0x08
196#define SBP2_DOORBELL 0x10
197#define SBP2_UNSOLICITED_STATUS_ENABLE 0x14
198
199/* Status write response codes */
200#define SBP2_STATUS_REQUEST_COMPLETE 0x0
201#define SBP2_STATUS_TRANSPORT_FAILURE 0x1
202#define SBP2_STATUS_ILLEGAL_REQUEST 0x2
203#define SBP2_STATUS_VENDOR_DEPENDENT 0x3
204
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400205#define STATUS_GET_ORB_HIGH(v) ((v).status & 0xffff)
206#define STATUS_GET_SBP_STATUS(v) (((v).status >> 16) & 0xff)
207#define STATUS_GET_LEN(v) (((v).status >> 24) & 0x07)
208#define STATUS_GET_DEAD(v) (((v).status >> 27) & 0x01)
209#define STATUS_GET_RESPONSE(v) (((v).status >> 28) & 0x03)
210#define STATUS_GET_SOURCE(v) (((v).status >> 30) & 0x03)
211#define STATUS_GET_ORB_LOW(v) ((v).orb_low)
212#define STATUS_GET_DATA(v) ((v).data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500213
214struct sbp2_status {
215 u32 status;
216 u32 orb_low;
217 u8 data[24];
218};
219
220struct sbp2_pointer {
221 u32 high;
222 u32 low;
223};
224
225struct sbp2_orb {
226 struct fw_transaction t;
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400227 struct kref kref;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500228 dma_addr_t request_bus;
229 int rcode;
230 struct sbp2_pointer pointer;
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400231 void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500232 struct list_head link;
233};
234
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400235#define MANAGEMENT_ORB_LUN(v) ((v))
236#define MANAGEMENT_ORB_FUNCTION(v) ((v) << 16)
237#define MANAGEMENT_ORB_RECONNECT(v) ((v) << 20)
Stefan Richter5cd54c92007-06-17 23:55:41 +0200238#define MANAGEMENT_ORB_EXCLUSIVE(v) ((v) ? 1 << 28 : 0)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400239#define MANAGEMENT_ORB_REQUEST_FORMAT(v) ((v) << 29)
240#define MANAGEMENT_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500241
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400242#define MANAGEMENT_ORB_RESPONSE_LENGTH(v) ((v))
243#define MANAGEMENT_ORB_PASSWORD_LENGTH(v) ((v) << 16)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500244
245struct sbp2_management_orb {
246 struct sbp2_orb base;
247 struct {
248 struct sbp2_pointer password;
249 struct sbp2_pointer response;
250 u32 misc;
251 u32 length;
252 struct sbp2_pointer status_fifo;
253 } request;
254 __be32 response[4];
255 dma_addr_t response_bus;
256 struct completion done;
257 struct sbp2_status status;
258};
259
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400260#define LOGIN_RESPONSE_GET_LOGIN_ID(v) ((v).misc & 0xffff)
261#define LOGIN_RESPONSE_GET_LENGTH(v) (((v).misc >> 16) & 0xffff)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500262
263struct sbp2_login_response {
264 u32 misc;
265 struct sbp2_pointer command_block_agent;
266 u32 reconnect_hold;
267};
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400268#define COMMAND_ORB_DATA_SIZE(v) ((v))
269#define COMMAND_ORB_PAGE_SIZE(v) ((v) << 16)
270#define COMMAND_ORB_PAGE_TABLE_PRESENT ((1) << 19)
271#define COMMAND_ORB_MAX_PAYLOAD(v) ((v) << 20)
272#define COMMAND_ORB_SPEED(v) ((v) << 24)
273#define COMMAND_ORB_DIRECTION(v) ((v) << 27)
274#define COMMAND_ORB_REQUEST_FORMAT(v) ((v) << 29)
275#define COMMAND_ORB_NOTIFY ((1) << 31)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500276
277struct sbp2_command_orb {
278 struct sbp2_orb base;
279 struct {
280 struct sbp2_pointer next;
281 struct sbp2_pointer data_descriptor;
282 u32 misc;
283 u8 command_block[12];
284 } request;
285 struct scsi_cmnd *cmd;
286 scsi_done_fn_t done;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200287 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500288
Stefan Richter9fb2dd12007-07-01 13:55:31 +0200289 struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500290 dma_addr_t page_table_bus;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500291};
292
293/*
294 * List of devices with known bugs.
295 *
296 * The firmware_revision field, masked with 0xffff00, is the best
297 * indicator for the type of bridge chip of a device. It yields a few
298 * false positives but this did not break correctly behaving devices
299 * so far. We use ~0 as a wildcard, since the 24 bit values we get
300 * from the config rom can never match that.
301 */
302static const struct {
303 u32 firmware_revision;
304 u32 model;
Stefan Richter05cca7382008-01-26 17:42:45 +0100305 unsigned int workarounds;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500306} sbp2_workarounds_table[] = {
307 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
308 .firmware_revision = 0x002800,
309 .model = 0x001010,
310 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
311 SBP2_WORKAROUND_MODE_SENSE_8,
312 },
Stefan Richter9220f192008-02-03 23:04:38 +0100313 /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
314 .firmware_revision = 0x002800,
315 .model = 0x000000,
316 .workarounds = SBP2_WORKAROUND_DELAY_INQUIRY,
317 },
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500318 /* Initio bridges, actually only needed for some older ones */ {
319 .firmware_revision = 0x000200,
320 .model = ~0,
321 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
322 },
323 /* Symbios bridge */ {
324 .firmware_revision = 0xa0b800,
325 .model = ~0,
326 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
327 },
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400328
329 /*
330 * There are iPods (2nd gen, 3rd gen) with model_id == 0, but
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500331 * these iPods do not feature the read_capacity bug according
332 * to one report. Read_capacity behaviour as well as model_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400333 * could change due to Apple-supplied firmware updates though.
334 */
335
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500336 /* iPod 4th generation. */ {
337 .firmware_revision = 0x0a2700,
338 .model = 0x000021,
339 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
340 },
341 /* iPod mini */ {
342 .firmware_revision = 0x0a2700,
343 .model = 0x000023,
344 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
345 },
346 /* iPod Photo */ {
347 .firmware_revision = 0x0a2700,
348 .model = 0x00007e,
349 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
350 }
351};
352
353static void
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400354free_orb(struct kref *kref)
355{
356 struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
357
358 kfree(orb);
359}
360
361static void
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500362sbp2_status_write(struct fw_card *card, struct fw_request *request,
363 int tcode, int destination, int source,
364 int generation, int speed,
365 unsigned long long offset,
366 void *payload, size_t length, void *callback_data)
367{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200368 struct sbp2_logical_unit *lu = callback_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500369 struct sbp2_orb *orb;
370 struct sbp2_status status;
371 size_t header_size;
372 unsigned long flags;
373
374 if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400375 length == 0 || length > sizeof(status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500376 fw_send_response(card, request, RCODE_TYPE_ERROR);
377 return;
378 }
379
380 header_size = min(length, 2 * sizeof(u32));
381 fw_memcpy_from_be32(&status, payload, header_size);
382 if (length > header_size)
383 memcpy(status.data, payload + 8, length - header_size);
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400384 if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500385 fw_notify("non-orb related status write, not handled\n");
386 fw_send_response(card, request, RCODE_COMPLETE);
387 return;
388 }
389
390 /* Lookup the orb corresponding to this status write. */
391 spin_lock_irqsave(&card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200392 list_for_each_entry(orb, &lu->orb_list, link) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400393 if (STATUS_GET_ORB_HIGH(status) == 0 &&
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400394 STATUS_GET_ORB_LOW(status) == orb->request_bus) {
395 orb->rcode = RCODE_COMPLETE;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500396 list_del(&orb->link);
397 break;
398 }
399 }
400 spin_unlock_irqrestore(&card->lock, flags);
401
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200402 if (&orb->link != &lu->orb_list)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500403 orb->callback(orb, &status);
404 else
405 fw_error("status write for unknown orb\n");
406
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400407 kref_put(&orb->kref, free_orb);
408
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500409 fw_send_response(card, request, RCODE_COMPLETE);
410}
411
412static void
413complete_transaction(struct fw_card *card, int rcode,
414 void *payload, size_t length, void *data)
415{
416 struct sbp2_orb *orb = data;
417 unsigned long flags;
418
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400419 /*
420 * This is a little tricky. We can get the status write for
421 * the orb before we get this callback. The status write
422 * handler above will assume the orb pointer transaction was
423 * successful and set the rcode to RCODE_COMPLETE for the orb.
424 * So this callback only sets the rcode if it hasn't already
425 * been set and only does the cleanup if the transaction
426 * failed and we didn't already get a status write.
427 */
428 spin_lock_irqsave(&card->lock, flags);
429
430 if (orb->rcode == -1)
431 orb->rcode = rcode;
432 if (orb->rcode != RCODE_COMPLETE) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500433 list_del(&orb->link);
Stefan Richter1b34e972007-08-25 10:40:42 +0200434 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500435 orb->callback(orb, NULL);
Stefan Richter1b34e972007-08-25 10:40:42 +0200436 } else {
437 spin_unlock_irqrestore(&card->lock, flags);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500438 }
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400439
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400440 kref_put(&orb->kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500441}
442
443static void
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200444sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500445 int node_id, int generation, u64 offset)
446{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200447 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500448 unsigned long flags;
449
450 orb->pointer.high = 0;
451 orb->pointer.low = orb->request_bus;
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400452 fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof(orb->pointer));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500453
454 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200455 list_add_tail(&orb->link, &lu->orb_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500456 spin_unlock_irqrestore(&device->card->lock, flags);
457
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400458 /* Take a ref for the orb list and for the transaction callback. */
459 kref_get(&orb->kref);
460 kref_get(&orb->kref);
461
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500462 fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
Stefan Richterf1397492007-06-10 21:31:36 +0200463 node_id, generation, device->max_speed, offset,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400464 &orb->pointer, sizeof(orb->pointer),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500465 complete_transaction, orb);
466}
467
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200468static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500469{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200470 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500471 struct sbp2_orb *orb, *next;
472 struct list_head list;
473 unsigned long flags;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500474 int retval = -ENOENT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500475
476 INIT_LIST_HEAD(&list);
477 spin_lock_irqsave(&device->card->lock, flags);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200478 list_splice_init(&lu->orb_list, &list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500479 spin_unlock_irqrestore(&device->card->lock, flags);
480
481 list_for_each_entry_safe(orb, next, &list, link) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500482 retval = 0;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500483 if (fw_cancel_transaction(device->card, &orb->t) == 0)
484 continue;
485
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500486 orb->rcode = RCODE_CANCELLED;
487 orb->callback(orb, NULL);
488 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500489
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500490 return retval;
Kristian Høgsberg1d3d52c2007-02-06 14:49:33 -0500491}
492
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500493static void
494complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
495{
496 struct sbp2_management_orb *orb =
Jay Fenlason6f061482007-06-27 16:04:33 -0400497 container_of(base_orb, struct sbp2_management_orb, base);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500498
499 if (status)
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400500 memcpy(&orb->status, status, sizeof(*status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500501 complete(&orb->done);
502}
503
504static int
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200505sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
506 int generation, int function, int lun_or_login_id,
507 void *response)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500508{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200509 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500510 struct sbp2_management_orb *orb;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100511 unsigned int timeout;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500512 int retval = -ENOMEM;
513
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100514 if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
515 return 0;
516
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400517 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500518 if (orb == NULL)
519 return -ENOMEM;
520
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400521 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500522 orb->response_bus =
523 dma_map_single(device->card->device, &orb->response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400524 sizeof(orb->response), DMA_FROM_DEVICE);
Kristian Høgsberg82eff9d2007-02-06 14:49:40 -0500525 if (dma_mapping_error(orb->response_bus))
Stefan Richter7aa48482007-07-02 21:04:44 +0200526 goto fail_mapping_response;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500527
528 orb->request.response.high = 0;
529 orb->request.response.low = orb->response_bus;
530
531 orb->request.misc =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400532 MANAGEMENT_ORB_NOTIFY |
533 MANAGEMENT_ORB_FUNCTION(function) |
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200534 MANAGEMENT_ORB_LUN(lun_or_login_id);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500535 orb->request.length =
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400536 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500537
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200538 orb->request.status_fifo.high = lu->address_handler.offset >> 32;
539 orb->request.status_fifo.low = lu->address_handler.offset;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500540
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500541 if (function == SBP2_LOGIN_REQUEST) {
Stefan Richter14dc9922008-01-20 01:25:31 +0100542 /* Ask for 2^2 == 4 seconds reconnect grace period */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500543 orb->request.misc |=
Stefan Richter14dc9922008-01-20 01:25:31 +0100544 MANAGEMENT_ORB_RECONNECT(2) |
545 MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login);
Jarod Wilson384170d2008-01-25 23:31:12 -0500546 timeout = lu->tgt->mgt_orb_timeout;
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100547 } else {
548 timeout = SBP2_ORB_TIMEOUT;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500549 }
550
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400551 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500552
553 init_completion(&orb->done);
554 orb->base.callback = complete_management_orb;
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500555
Stefan Richter7aa48482007-07-02 21:04:44 +0200556 orb->base.request_bus =
557 dma_map_single(device->card->device, &orb->request,
558 sizeof(orb->request), DMA_TO_DEVICE);
559 if (dma_mapping_error(orb->base.request_bus))
560 goto fail_mapping_request;
561
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200562 sbp2_send_orb(&orb->base, lu, node_id, generation,
563 lu->tgt->management_agent_address);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500564
Jarod Wilsona4c379c2008-01-19 13:15:05 +0100565 wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500566
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500567 retval = -EIO;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200568 if (sbp2_cancel_orbs(lu) == 0) {
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500569 fw_error("orb reply timed out, rcode=0x%02x\n",
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500570 orb->base.rcode);
571 goto out;
572 }
573
Kristian Høgsberg2aaad972007-03-07 12:12:47 -0500574 if (orb->base.rcode != RCODE_COMPLETE) {
575 fw_error("management write failed, rcode 0x%02x\n",
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500576 orb->base.rcode);
577 goto out;
578 }
579
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400580 if (STATUS_GET_RESPONSE(orb->status) != 0 ||
581 STATUS_GET_SBP_STATUS(orb->status) != 0) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500582 fw_error("error status: %d:%d\n",
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400583 STATUS_GET_RESPONSE(orb->status),
584 STATUS_GET_SBP_STATUS(orb->status));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500585 goto out;
586 }
587
588 retval = 0;
589 out:
590 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400591 sizeof(orb->request), DMA_TO_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200592 fail_mapping_request:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500593 dma_unmap_single(device->card->device, orb->response_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400594 sizeof(orb->response), DMA_FROM_DEVICE);
Stefan Richter7aa48482007-07-02 21:04:44 +0200595 fail_mapping_response:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500596 if (response)
597 fw_memcpy_from_be32(response,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400598 orb->response, sizeof(orb->response));
Kristian Høgsberge57d2012007-08-24 18:59:58 -0400599 kref_put(&orb->base.kref, free_orb);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500600
601 return retval;
602}
603
604static void
605complete_agent_reset_write(struct fw_card *card, int rcode,
Stefan Richtere0e60212008-02-03 23:08:58 +0100606 void *payload, size_t length, void *done)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500607{
Stefan Richtere0e60212008-02-03 23:08:58 +0100608 complete(done);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500609}
610
Stefan Richtere0e60212008-02-03 23:08:58 +0100611static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
612{
613 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
614 DECLARE_COMPLETION_ONSTACK(done);
615 struct fw_transaction t;
616 static u32 z;
617
618 fw_send_request(device->card, &t, TCODE_WRITE_QUADLET_REQUEST,
619 lu->tgt->node_id, lu->generation, device->max_speed,
620 lu->command_block_agent_address + SBP2_AGENT_RESET,
621 &z, sizeof(z), complete_agent_reset_write, &done);
622 wait_for_completion(&done);
623}
624
625static void
626complete_agent_reset_write_no_wait(struct fw_card *card, int rcode,
627 void *payload, size_t length, void *data)
628{
629 kfree(data);
630}
631
632static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500633{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200634 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500635 struct fw_transaction *t;
Stefan Richtere0e60212008-02-03 23:08:58 +0100636 static u32 z;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500637
Stefan Richtere0e60212008-02-03 23:08:58 +0100638 t = kmalloc(sizeof(*t), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500639 if (t == NULL)
Stefan Richtere0e60212008-02-03 23:08:58 +0100640 return;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500641
642 fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200643 lu->tgt->node_id, lu->generation, device->max_speed,
644 lu->command_block_agent_address + SBP2_AGENT_RESET,
Stefan Richtere0e60212008-02-03 23:08:58 +0100645 &z, sizeof(z), complete_agent_reset_write_no_wait, t);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500646}
647
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200648static void sbp2_release_target(struct kref *kref)
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400649{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200650 struct sbp2_target *tgt = container_of(kref, struct sbp2_target, kref);
651 struct sbp2_logical_unit *lu, *next;
652 struct Scsi_Host *shost =
653 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400654
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200655 list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
656 if (lu->sdev)
657 scsi_remove_device(lu->sdev);
658
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100659 sbp2_send_management_orb(lu, tgt->node_id, lu->generation,
660 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
Stefan Richter4dccd022008-01-20 01:24:26 +0100661
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200662 fw_core_remove_address_handler(&lu->address_handler);
663 list_del(&lu->link);
664 kfree(lu);
665 }
666 scsi_remove_host(shost);
667 fw_notify("released %s\n", tgt->unit->device.bus_id);
668
669 put_device(&tgt->unit->device);
670 scsi_host_put(shost);
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400671}
672
Stefan Richterdf8ec242007-08-12 12:51:18 +0200673static struct workqueue_struct *sbp2_wq;
674
Stefan Richter285838e2007-11-07 01:12:51 +0100675/*
676 * Always get the target's kref when scheduling work on one its units.
677 * Each workqueue job is responsible to call sbp2_target_put() upon return.
678 */
679static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
680{
681 if (queue_delayed_work(sbp2_wq, &lu->work, delay))
682 kref_get(&lu->tgt->kref);
683}
684
685static void sbp2_target_put(struct sbp2_target *tgt)
686{
687 kref_put(&tgt->kref, sbp2_release_target);
688}
689
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200690static void sbp2_reconnect(struct work_struct *work);
691
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500692static void sbp2_login(struct work_struct *work)
693{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200694 struct sbp2_logical_unit *lu =
695 container_of(work, struct sbp2_logical_unit, work.work);
696 struct Scsi_Host *shost =
697 container_of((void *)lu->tgt, struct Scsi_Host, hostdata[0]);
698 struct scsi_device *sdev;
699 struct scsi_lun eight_bytes_lun;
700 struct fw_unit *unit = lu->tgt->unit;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500701 struct fw_device *device = fw_device(unit->device.parent);
702 struct sbp2_login_response response;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200703 int generation, node_id, local_node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500704
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100705 if (fw_device_is_shutdown(device))
706 goto out;
707
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100708 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100709 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100710 node_id = device->node_id;
711 local_node_id = device->card->node_id;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500712
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200713 if (sbp2_send_management_orb(lu, node_id, generation,
714 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
Stefan Richter285838e2007-11-07 01:12:51 +0100715 if (lu->retries++ < 5)
716 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
717 else
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200718 fw_error("failed to login to %s LUN %04x\n",
719 unit->device.bus_id, lu->lun);
Stefan Richter285838e2007-11-07 01:12:51 +0100720 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500721 }
722
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200723 lu->generation = generation;
724 lu->tgt->node_id = node_id;
725 lu->tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500726
727 /* Get command block agent offset and login id. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200728 lu->command_block_agent_address =
Kristian Høgsberg5c5539d2007-03-07 12:12:45 -0500729 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500730 response.command_block_agent.low;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200731 lu->login_id = LOGIN_RESPONSE_GET_LOGIN_ID(response);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500732
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200733 fw_notify("logged in to %s LUN %04x (%d retries)\n",
734 unit->device.bus_id, lu->lun, lu->retries);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500735
736#if 0
737 /* FIXME: The linux1394 sbp2 does this last step. */
738 sbp2_set_busy_timeout(scsi_id);
739#endif
740
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200741 PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
742 sbp2_agent_reset(lu);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500743
Stefan Richter9220f192008-02-03 23:04:38 +0100744 if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
745 ssleep(SBP2_INQUIRY_DELAY);
746
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200747 memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
748 eight_bytes_lun.scsi_lun[0] = (lu->lun >> 8) & 0xff;
749 eight_bytes_lun.scsi_lun[1] = lu->lun & 0xff;
750
751 sdev = __scsi_add_device(shost, 0, 0,
752 scsilun_to_int(&eight_bytes_lun), lu);
753 if (IS_ERR(sdev)) {
Stefan Richter1b9c12b2008-01-26 17:43:23 +0100754 smp_rmb(); /* generation may have changed */
755 generation = device->generation;
756 smp_rmb(); /* node_id must not be older than generation */
757
758 sbp2_send_management_orb(lu, device->node_id, generation,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200759 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400760 /*
761 * Set this back to sbp2_login so we fall back and
762 * retry login on bus reset.
763 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200764 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
765 } else {
766 lu->sdev = sdev;
767 scsi_device_put(sdev);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500768 }
Stefan Richter285838e2007-11-07 01:12:51 +0100769 out:
770 sbp2_target_put(lu->tgt);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500771}
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500772
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200773static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
774{
775 struct sbp2_logical_unit *lu;
776
777 lu = kmalloc(sizeof(*lu), GFP_KERNEL);
778 if (!lu)
779 return -ENOMEM;
780
781 lu->address_handler.length = 0x100;
782 lu->address_handler.address_callback = sbp2_status_write;
783 lu->address_handler.callback_data = lu;
784
785 if (fw_core_add_address_handler(&lu->address_handler,
786 &fw_high_memory_region) < 0) {
787 kfree(lu);
788 return -ENOMEM;
789 }
790
791 lu->tgt = tgt;
792 lu->sdev = NULL;
793 lu->lun = lun_entry & 0xffff;
794 lu->retries = 0;
795 INIT_LIST_HEAD(&lu->orb_list);
796 INIT_DELAYED_WORK(&lu->work, sbp2_login);
797
798 list_add_tail(&lu->link, &tgt->lu_list);
799 return 0;
800}
801
802static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt, u32 *directory)
803{
804 struct fw_csr_iterator ci;
805 int key, value;
806
807 fw_csr_iterator_init(&ci, directory);
808 while (fw_csr_iterator_next(&ci, &key, &value))
809 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
810 sbp2_add_logical_unit(tgt, value) < 0)
811 return -ENOMEM;
812 return 0;
813}
814
815static int sbp2_scan_unit_dir(struct sbp2_target *tgt, u32 *directory,
816 u32 *model, u32 *firmware_revision)
817{
818 struct fw_csr_iterator ci;
819 int key, value;
Jarod Wilson384170d2008-01-25 23:31:12 -0500820 unsigned int timeout;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200821
822 fw_csr_iterator_init(&ci, directory);
823 while (fw_csr_iterator_next(&ci, &key, &value)) {
824 switch (key) {
825
826 case CSR_DEPENDENT_INFO | CSR_OFFSET:
827 tgt->management_agent_address =
828 CSR_REGISTER_BASE + 4 * value;
829 break;
830
831 case CSR_DIRECTORY_ID:
832 tgt->directory_id = value;
833 break;
834
835 case CSR_MODEL:
836 *model = value;
837 break;
838
839 case SBP2_CSR_FIRMWARE_REVISION:
840 *firmware_revision = value;
841 break;
842
Jarod Wilson384170d2008-01-25 23:31:12 -0500843 case SBP2_CSR_UNIT_CHARACTERISTICS:
844 /* the timeout value is stored in 500ms units */
845 timeout = ((unsigned int) value >> 8 & 0xff) * 500;
846 timeout = max(timeout, SBP2_MIN_LOGIN_ORB_TIMEOUT);
847 tgt->mgt_orb_timeout =
848 min(timeout, SBP2_MAX_LOGIN_ORB_TIMEOUT);
849
850 if (timeout > tgt->mgt_orb_timeout)
851 fw_notify("%s: config rom contains %ds "
852 "management ORB timeout, limiting "
853 "to %ds\n", tgt->unit->device.bus_id,
854 timeout / 1000,
855 tgt->mgt_orb_timeout / 1000);
856 break;
857
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200858 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
859 if (sbp2_add_logical_unit(tgt, value) < 0)
860 return -ENOMEM;
861 break;
862
863 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
864 if (sbp2_scan_logical_unit_dir(tgt, ci.p + value) < 0)
865 return -ENOMEM;
866 break;
867 }
868 }
869 return 0;
870}
871
872static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
873 u32 firmware_revision)
874{
875 int i;
Stefan Richter05cca7382008-01-26 17:42:45 +0100876 unsigned int w = sbp2_param_workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200877
Stefan Richter2df222b2007-08-13 17:48:25 +0200878 if (w)
879 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
880 "if you need the workarounds parameter for %s\n",
881 tgt->unit->device.bus_id);
882
883 if (w & SBP2_WORKAROUND_OVERRIDE)
884 goto out;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200885
886 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
887
888 if (sbp2_workarounds_table[i].firmware_revision !=
889 (firmware_revision & 0xffffff00))
890 continue;
891
892 if (sbp2_workarounds_table[i].model != model &&
893 sbp2_workarounds_table[i].model != ~0)
894 continue;
895
Stefan Richter2df222b2007-08-13 17:48:25 +0200896 w |= sbp2_workarounds_table[i].workarounds;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200897 break;
898 }
Stefan Richter2df222b2007-08-13 17:48:25 +0200899 out:
900 if (w)
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200901 fw_notify("Workarounds for %s: 0x%x "
902 "(firmware_revision 0x%06x, model_id 0x%06x)\n",
903 tgt->unit->device.bus_id,
Stefan Richter2df222b2007-08-13 17:48:25 +0200904 w, firmware_revision, model);
905 tgt->workarounds = w;
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200906}
907
908static struct scsi_host_template scsi_driver_template;
909
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500910static int sbp2_probe(struct device *dev)
911{
912 struct fw_unit *unit = fw_unit(dev);
913 struct fw_device *device = fw_device(unit->device.parent);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200914 struct sbp2_target *tgt;
915 struct sbp2_logical_unit *lu;
916 struct Scsi_Host *shost;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500917 u32 model, firmware_revision;
918
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200919 shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
920 if (shost == NULL)
921 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500922
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200923 tgt = (struct sbp2_target *)shost->hostdata;
924 unit->device.driver_data = tgt;
925 tgt->unit = unit;
926 kref_init(&tgt->kref);
927 INIT_LIST_HEAD(&tgt->lu_list);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500928
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200929 if (fw_device_enable_phys_dma(device) < 0)
930 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500931
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200932 if (scsi_add_host(shost, &unit->device) < 0)
933 goto fail_shost_put;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500934
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200935 /* Initialize to values that won't match anything in our table. */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500936 firmware_revision = 0xff000000;
937 model = 0xff000000;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500938
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200939 /* implicit directory ID */
940 tgt->directory_id = ((unit->directory - device->config_rom) * 4
941 + CSR_CONFIG_ROM) & 0xffffff;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500942
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200943 if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
944 &firmware_revision) < 0)
945 goto fail_tgt_put;
946
947 sbp2_init_workarounds(tgt, model, firmware_revision);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500948
Kristian Høgsbergb3d6e152007-03-14 17:34:58 -0400949 get_device(&unit->device);
950
Stefan Richter285838e2007-11-07 01:12:51 +0100951 /* Do the login in a workqueue so we can easily reschedule retries. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200952 list_for_each_entry(lu, &tgt->lu_list, link)
Stefan Richter285838e2007-11-07 01:12:51 +0100953 sbp2_queue_work(lu, 0);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500954 return 0;
Kristian Høgsbergad852742007-05-09 19:23:07 -0400955
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200956 fail_tgt_put:
Stefan Richter285838e2007-11-07 01:12:51 +0100957 sbp2_target_put(tgt);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200958 return -ENOMEM;
959
960 fail_shost_put:
961 scsi_host_put(shost);
962 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500963}
964
965static int sbp2_remove(struct device *dev)
966{
967 struct fw_unit *unit = fw_unit(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200968 struct sbp2_target *tgt = unit->device.driver_data;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500969
Stefan Richter285838e2007-11-07 01:12:51 +0100970 sbp2_target_put(tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500971 return 0;
972}
973
974static void sbp2_reconnect(struct work_struct *work)
975{
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200976 struct sbp2_logical_unit *lu =
977 container_of(work, struct sbp2_logical_unit, work.work);
978 struct fw_unit *unit = lu->tgt->unit;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500979 struct fw_device *device = fw_device(unit->device.parent);
980 int generation, node_id, local_node_id;
981
Stefan Richterbe6f48b2008-01-27 19:14:44 +0100982 if (fw_device_is_shutdown(device))
983 goto out;
984
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100985 generation = device->generation;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100986 smp_rmb(); /* node_id must not be older than generation */
Stefan Richter5a8a1bc2008-01-24 01:53:19 +0100987 node_id = device->node_id;
988 local_node_id = device->card->node_id;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -0500989
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200990 if (sbp2_send_management_orb(lu, node_id, generation,
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500991 SBP2_RECONNECT_REQUEST,
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200992 lu->login_id, NULL) < 0) {
993 if (lu->retries++ >= 5) {
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500994 fw_error("failed to reconnect to %s\n",
995 unit->device.bus_id);
996 /* Fall back and try to log in again. */
Stefan Richter5a3c2be2007-08-25 14:05:28 +0200997 lu->retries = 0;
998 PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
Kristian Høgsberg7f37c422007-02-06 14:49:34 -0500999 }
Stefan Richter285838e2007-11-07 01:12:51 +01001000 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1001 goto out;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001002 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001003
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001004 lu->generation = generation;
1005 lu->tgt->node_id = node_id;
1006 lu->tgt->address_high = local_node_id << 16;
Kristian Høgsberg7f37c422007-02-06 14:49:34 -05001007
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001008 fw_notify("reconnected to %s LUN %04x (%d retries)\n",
1009 unit->device.bus_id, lu->lun, lu->retries);
1010
1011 sbp2_agent_reset(lu);
1012 sbp2_cancel_orbs(lu);
Stefan Richter285838e2007-11-07 01:12:51 +01001013 out:
1014 sbp2_target_put(lu->tgt);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001015}
1016
1017static void sbp2_update(struct fw_unit *unit)
1018{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001019 struct sbp2_target *tgt = unit->device.driver_data;
1020 struct sbp2_logical_unit *lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001021
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001022 fw_device_enable_phys_dma(fw_device(unit->device.parent));
1023
1024 /*
1025 * Fw-core serializes sbp2_update() against sbp2_remove().
1026 * Iteration over tgt->lu_list is therefore safe here.
1027 */
1028 list_for_each_entry(lu, &tgt->lu_list, link) {
1029 lu->retries = 0;
Stefan Richter285838e2007-11-07 01:12:51 +01001030 sbp2_queue_work(lu, 0);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001031 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001032}
1033
1034#define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1035#define SBP2_SW_VERSION_ENTRY 0x00010483
1036
Stefan Richter21ebcd12007-01-14 15:29:07 +01001037static const struct fw_device_id sbp2_id_table[] = {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001038 {
1039 .match_flags = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
1040 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
Stefan Richter5af4e5e2007-01-21 20:45:32 +01001041 .version = SBP2_SW_VERSION_ENTRY,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001042 },
1043 { }
1044};
1045
1046static struct fw_driver sbp2_driver = {
1047 .driver = {
1048 .owner = THIS_MODULE,
1049 .name = sbp2_driver_name,
1050 .bus = &fw_bus_type,
1051 .probe = sbp2_probe,
1052 .remove = sbp2_remove,
1053 },
1054 .update = sbp2_update,
1055 .id_table = sbp2_id_table,
1056};
1057
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001058static unsigned int
1059sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001060{
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001061 int sam_status;
1062
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001063 sense_data[0] = 0x70;
1064 sense_data[1] = 0x0;
1065 sense_data[2] = sbp2_status[1];
1066 sense_data[3] = sbp2_status[4];
1067 sense_data[4] = sbp2_status[5];
1068 sense_data[5] = sbp2_status[6];
1069 sense_data[6] = sbp2_status[7];
1070 sense_data[7] = 10;
1071 sense_data[8] = sbp2_status[8];
1072 sense_data[9] = sbp2_status[9];
1073 sense_data[10] = sbp2_status[10];
1074 sense_data[11] = sbp2_status[11];
1075 sense_data[12] = sbp2_status[2];
1076 sense_data[13] = sbp2_status[3];
1077 sense_data[14] = sbp2_status[12];
1078 sense_data[15] = sbp2_status[13];
1079
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001080 sam_status = sbp2_status[0] & 0x3f;
1081
1082 switch (sam_status) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001083 case SAM_STAT_GOOD:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001084 case SAM_STAT_CHECK_CONDITION:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001085 case SAM_STAT_CONDITION_MET:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001086 case SAM_STAT_BUSY:
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001087 case SAM_STAT_RESERVATION_CONFLICT:
1088 case SAM_STAT_COMMAND_TERMINATED:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001089 return DID_OK << 16 | sam_status;
1090
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001091 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001092 return DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001093 }
1094}
1095
1096static void
1097complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
1098{
Jay Fenlason6f061482007-06-27 16:04:33 -04001099 struct sbp2_command_orb *orb =
1100 container_of(base_orb, struct sbp2_command_orb, base);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001101 struct fw_device *device = fw_device(orb->lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001102 int result;
1103
1104 if (status != NULL) {
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001105 if (STATUS_GET_DEAD(*status))
Stefan Richtere0e60212008-02-03 23:08:58 +01001106 sbp2_agent_reset_no_wait(orb->lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001107
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001108 switch (STATUS_GET_RESPONSE(*status)) {
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001109 case SBP2_STATUS_REQUEST_COMPLETE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001110 result = DID_OK << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001111 break;
1112 case SBP2_STATUS_TRANSPORT_FAILURE:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001113 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001114 break;
1115 case SBP2_STATUS_ILLEGAL_REQUEST:
1116 case SBP2_STATUS_VENDOR_DEPENDENT:
1117 default:
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001118 result = DID_ERROR << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001119 break;
1120 }
1121
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001122 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1123 result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001124 orb->cmd->sense_buffer);
1125 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001126 /*
1127 * If the orb completes with status == NULL, something
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001128 * went wrong, typically a bus reset happened mid-orb
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001129 * or when sending the write (less likely).
1130 */
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001131 result = DID_BUS_BUSY << 16;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001132 }
1133
1134 dma_unmap_single(device->card->device, orb->base.request_bus,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001135 sizeof(orb->request), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001136
Stefan Richter412edf62007-07-16 21:05:41 +02001137 if (scsi_sg_count(orb->cmd) > 0)
1138 dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1139 scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001140 orb->cmd->sc_data_direction);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001141
1142 if (orb->page_table_bus != 0)
1143 dma_unmap_single(device->card->device, orb->page_table_bus,
Stefan Richterb4be0162007-07-02 22:07:34 +02001144 sizeof(orb->page_table), DMA_TO_DEVICE);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001145
Kristian Høgsbergfbb54232007-04-10 18:11:18 -04001146 orb->cmd->result = result;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001147 orb->done(orb->cmd);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001148}
1149
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001150static int
1151sbp2_map_scatterlist(struct sbp2_command_orb *orb, struct fw_device *device,
1152 struct sbp2_logical_unit *lu)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001153{
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001154 struct scatterlist *sg;
1155 int sg_len, l, i, j, count;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001156 dma_addr_t sg_addr;
1157
Stefan Richter412edf62007-07-16 21:05:41 +02001158 sg = scsi_sglist(orb->cmd);
1159 count = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001160 orb->cmd->sc_data_direction);
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001161 if (count == 0)
1162 goto fail;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001163
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001164 /*
1165 * Handle the special case where there is only one element in
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001166 * the scatter list by converting it to an immediate block
1167 * request. This is also a workaround for broken devices such
1168 * as the second generation iPod which doesn't support page
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001169 * tables.
1170 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001171 if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001172 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001173 orb->request.data_descriptor.low = sg_dma_address(sg);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001174 orb->request.misc |= COMMAND_ORB_DATA_SIZE(sg_dma_len(sg));
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001175 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001176 }
1177
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001178 /*
1179 * Convert the scatterlist to an sbp2 page table. If any
Kristian Høgsberg, Stefan Richter36abb3b2007-05-09 19:23:10 -04001180 * scatterlist entries are too big for sbp2, we split them as we
1181 * go. Even if we ask the block I/O layer to not give us sg
1182 * elements larger than 65535 bytes, some IOMMUs may merge sg elements
1183 * during DMA mapping, and Linux currently doesn't prevent this.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001184 */
Stefan Richterb7811da2008-01-15 21:10:50 +01001185 for (i = 0, j = 0; i < count; i++, sg = sg_next(sg)) {
1186 sg_len = sg_dma_len(sg);
1187 sg_addr = sg_dma_address(sg);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001188 while (sg_len) {
Stefan Richter332ef332007-07-01 13:56:03 +02001189 /* FIXME: This won't get us out of the pinch. */
1190 if (unlikely(j >= ARRAY_SIZE(orb->page_table))) {
1191 fw_error("page table overflow\n");
1192 goto fail_page_table;
1193 }
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001194 l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
1195 orb->page_table[j].low = sg_addr;
1196 orb->page_table[j].high = (l << 16);
1197 sg_addr += l;
1198 sg_len -= l;
1199 j++;
1200 }
1201 }
1202
Stefan Richterb4be0162007-07-02 22:07:34 +02001203 fw_memcpy_to_be32(orb->page_table, orb->page_table,
1204 sizeof(orb->page_table[0]) * j);
1205 orb->page_table_bus =
1206 dma_map_single(device->card->device, orb->page_table,
1207 sizeof(orb->page_table), DMA_TO_DEVICE);
1208 if (dma_mapping_error(orb->page_table_bus))
1209 goto fail_page_table;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001210
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001211 /*
1212 * The data_descriptor pointer is the one case where we need
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001213 * to fill in the node ID part of the address. All other
1214 * pointers assume that the data referenced reside on the
1215 * initiator (i.e. us), but data_descriptor can refer to data
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001216 * on other nodes so we need to put our ID in descriptor.high.
1217 */
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001218 orb->request.data_descriptor.high = lu->tgt->address_high;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001219 orb->request.data_descriptor.low = orb->page_table_bus;
1220 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001221 COMMAND_ORB_PAGE_TABLE_PRESENT |
1222 COMMAND_ORB_DATA_SIZE(j);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001223
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001224 return 0;
1225
1226 fail_page_table:
Stefan Richter412edf62007-07-16 21:05:41 +02001227 dma_unmap_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
Kristian Høgsberg95ffc5e2007-05-09 19:23:08 -04001228 orb->cmd->sc_data_direction);
1229 fail:
1230 return -ENOMEM;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001231}
1232
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001233/* SCSI stack integration */
1234
1235static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
1236{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001237 struct sbp2_logical_unit *lu = cmd->device->hostdata;
1238 struct fw_device *device = fw_device(lu->tgt->unit->device.parent);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001239 struct sbp2_command_orb *orb;
Stefan Richter05cca7382008-01-26 17:42:45 +01001240 unsigned int max_payload;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001241 int retval = SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001242
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001243 /*
1244 * Bidirectional commands are not yet implemented, and unknown
1245 * transfer direction not handled.
1246 */
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001247 if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
Stefan Richter8a8cea22007-06-09 19:26:22 +02001248 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
Kristian Høgsberge1b68c42007-05-09 19:23:09 -04001249 cmd->result = DID_ERROR << 16;
1250 done(cmd);
1251 return 0;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001252 }
1253
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001254 orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001255 if (orb == NULL) {
1256 fw_notify("failed to alloc orb\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001257 return SCSI_MLQUEUE_HOST_BUSY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001258 }
1259
Kristian Høgsberg12f26aa2007-04-10 18:11:20 -04001260 /* Initialize rcode to something not RCODE_COMPLETE. */
1261 orb->base.rcode = -1;
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001262 kref_init(&orb->base.kref);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001263
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001264 orb->lu = lu;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001265 orb->done = done;
1266 orb->cmd = cmd;
1267
1268 orb->request.next.high = SBP2_ORB_NULL;
1269 orb->request.next.low = 0x0;
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001270 /*
1271 * At speed 100 we can do 512 bytes per packet, at speed 200,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001272 * 1024 bytes per packet etc. The SBP-2 max_payload field
1273 * specifies the max payload size as 2 ^ (max_payload + 2), so
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001274 * if we set this to max_speed + 7, we get the right value.
1275 */
Stefan Richter25659f72007-07-21 22:43:05 +02001276 max_payload = min(device->max_speed + 7,
1277 device->card->max_receive - 1);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001278 orb->request.misc =
Stefan Richter25659f72007-07-21 22:43:05 +02001279 COMMAND_ORB_MAX_PAYLOAD(max_payload) |
Stefan Richterf1397492007-06-10 21:31:36 +02001280 COMMAND_ORB_SPEED(device->max_speed) |
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001281 COMMAND_ORB_NOTIFY;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001282
1283 if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1284 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001285 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_FROM_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001286 else if (cmd->sc_data_direction == DMA_TO_DEVICE)
1287 orb->request.misc |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -04001288 COMMAND_ORB_DIRECTION(SBP2_DIRECTION_TO_MEDIA);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001289
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001290 if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1291 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001292
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001293 fw_memcpy_to_be32(&orb->request, &orb->request, sizeof(orb->request));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001294
1295 memset(orb->request.command_block,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -04001296 0, sizeof(orb->request.command_block));
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001297 memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1298
1299 orb->base.callback = complete_command_orb;
Stefan Richter85263922007-07-02 21:04:08 +02001300 orb->base.request_bus =
1301 dma_map_single(device->card->device, &orb->request,
1302 sizeof(orb->request), DMA_TO_DEVICE);
1303 if (dma_mapping_error(orb->base.request_bus))
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001304 goto out;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001305
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001306 sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, lu->generation,
1307 lu->command_block_agent_address + SBP2_ORB_POINTER);
1308 retval = 0;
1309 out:
Kristian Høgsberge57d2012007-08-24 18:59:58 -04001310 kref_put(&orb->base.kref, free_orb);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001311 return retval;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001312}
1313
Stefan Richtercfb01382007-01-23 21:20:08 +01001314static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1315{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001316 struct sbp2_logical_unit *lu = sdev->hostdata;
Stefan Richtercfb01382007-01-23 21:20:08 +01001317
1318 sdev->allow_restart = 1;
1319
James Bottomley465ff312008-01-01 10:00:10 -06001320 /*
1321 * Update the dma alignment (minimum alignment requirements for
1322 * start and end of DMA transfers) to be a sector
1323 */
1324 blk_queue_update_dma_alignment(sdev->request_queue, 511);
1325
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001326 if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
Stefan Richtercfb01382007-01-23 21:20:08 +01001327 sdev->inquiry_len = 36;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001328
Stefan Richtercfb01382007-01-23 21:20:08 +01001329 return 0;
1330}
1331
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001332static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1333{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001334 struct sbp2_logical_unit *lu = sdev->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001335
Stefan Richtercfb01382007-01-23 21:20:08 +01001336 sdev->use_10_for_rw = 1;
1337
1338 if (sdev->type == TYPE_ROM)
1339 sdev->use_10_for_ms = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001340
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001341 if (sdev->type == TYPE_DISK &&
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001342 lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001343 sdev->skip_ms_page_8 = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001344
1345 if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001346 sdev->fix_capacity = 1;
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001347
1348 if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
Stefan Richtercf47c7a2007-06-17 23:52:08 +02001349 blk_queue_max_sectors(sdev->request_queue, 128 * 1024 / 512);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001350
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001351 return 0;
1352}
1353
1354/*
1355 * Called by scsi stack when something has really gone wrong. Usually
1356 * called when a command has timed-out for some reason.
1357 */
1358static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1359{
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001360 struct sbp2_logical_unit *lu = cmd->device->hostdata;
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001361
1362 fw_notify("sbp2_scsi_abort\n");
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001363 sbp2_agent_reset(lu);
1364 sbp2_cancel_orbs(lu);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001365
1366 return SUCCESS;
1367}
1368
Stefan Richter14e21982007-05-27 13:18:27 +02001369/*
1370 * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1371 * u64 EUI-64 : u24 directory_ID : u16 LUN (all printed in hexadecimal)
1372 *
1373 * This is the concatenation of target port identifier and logical unit
1374 * identifier as per SAM-2...SAM-4 annex A.
1375 */
1376static ssize_t
1377sbp2_sysfs_ieee1394_id_show(struct device *dev, struct device_attribute *attr,
1378 char *buf)
1379{
1380 struct scsi_device *sdev = to_scsi_device(dev);
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001381 struct sbp2_logical_unit *lu;
Stefan Richter14e21982007-05-27 13:18:27 +02001382 struct fw_device *device;
Stefan Richter14e21982007-05-27 13:18:27 +02001383
1384 if (!sdev)
1385 return 0;
Stefan Richter14e21982007-05-27 13:18:27 +02001386
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001387 lu = sdev->hostdata;
1388 device = fw_device(lu->tgt->unit->device.parent);
Stefan Richter14e21982007-05-27 13:18:27 +02001389
1390 return sprintf(buf, "%08x%08x:%06x:%04x\n",
1391 device->config_rom[3], device->config_rom[4],
Stefan Richter5a3c2be2007-08-25 14:05:28 +02001392 lu->tgt->directory_id, lu->lun);
Stefan Richter14e21982007-05-27 13:18:27 +02001393}
1394
1395static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1396
1397static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1398 &dev_attr_ieee1394_id,
1399 NULL
1400};
1401
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001402static struct scsi_host_template scsi_driver_template = {
1403 .module = THIS_MODULE,
1404 .name = "SBP-2 IEEE-1394",
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -04001405 .proc_name = sbp2_driver_name,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001406 .queuecommand = sbp2_scsi_queuecommand,
Stefan Richtercfb01382007-01-23 21:20:08 +01001407 .slave_alloc = sbp2_scsi_slave_alloc,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001408 .slave_configure = sbp2_scsi_slave_configure,
1409 .eh_abort_handler = sbp2_scsi_abort,
1410 .this_id = -1,
1411 .sg_tablesize = SG_ALL,
1412 .use_clustering = ENABLE_CLUSTERING,
Stefan Richter02af8e72007-01-21 20:50:11 +01001413 .cmd_per_lun = 1,
1414 .can_queue = 1,
Stefan Richter14e21982007-05-27 13:18:27 +02001415 .sdev_attrs = sbp2_scsi_sysfs_attrs,
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001416};
1417
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001418MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1419MODULE_DESCRIPTION("SCSI over IEEE1394");
1420MODULE_LICENSE("GPL");
1421MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1422
Olaf Hering1e4c7b02007-05-05 23:17:13 +02001423/* Provide a module alias so root-on-sbp2 initrds don't break. */
1424#ifndef CONFIG_IEEE1394_SBP2_MODULE
1425MODULE_ALIAS("sbp2");
1426#endif
1427
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001428static int __init sbp2_init(void)
1429{
Stefan Richterdf8ec242007-08-12 12:51:18 +02001430 sbp2_wq = create_singlethread_workqueue(KBUILD_MODNAME);
1431 if (!sbp2_wq)
1432 return -ENOMEM;
1433
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001434 return driver_register(&sbp2_driver.driver);
1435}
1436
1437static void __exit sbp2_cleanup(void)
1438{
1439 driver_unregister(&sbp2_driver.driver);
Stefan Richterdf8ec242007-08-12 12:51:18 +02001440 destroy_workqueue(sbp2_wq);
Kristian Høgsberg9ba136d2006-12-19 19:58:40 -05001441}
1442
1443module_init(sbp2_init);
1444module_exit(sbp2_cleanup);