ieee1394: sbp2: safer initialization of status fifo
[linux-2.6-block.git] / drivers / ieee1394 / sbp2.c
CommitLineData
1da177e4
LT
1/*
2 * sbp2.c - SBP-2 protocol driver for IEEE-1394
3 *
4 * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
5 * jamesg@filanet.com (JSG)
6 *
7 * Copyright (C) 2003 Ben Collins <bcollins@debian.org>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 */
23
24/*
25 * Brief Description:
26 *
27 * This driver implements the Serial Bus Protocol 2 (SBP-2) over IEEE-1394
28 * under Linux. The SBP-2 driver is implemented as an IEEE-1394 high-level
29 * driver. It also registers as a SCSI lower-level driver in order to accept
30 * SCSI commands for transport using SBP-2.
31 *
32 * You may access any attached SBP-2 storage devices as if they were SCSI
33 * devices (e.g. mount /dev/sda1, fdisk, mkfs, etc.).
34 *
35 * Current Issues:
36 *
37 * - Error Handling: SCSI aborts and bus reset requests are handled somewhat
38 * but the code needs additional debugging.
39 */
40
1da177e4
LT
41#include <linux/kernel.h>
42#include <linux/list.h>
43#include <linux/string.h>
24d3bf88 44#include <linux/stringify.h>
1da177e4
LT
45#include <linux/slab.h>
46#include <linux/interrupt.h>
47#include <linux/fs.h>
48#include <linux/poll.h>
49#include <linux/module.h>
50#include <linux/moduleparam.h>
51#include <linux/types.h>
52#include <linux/delay.h>
53#include <linux/sched.h>
54#include <linux/blkdev.h>
55#include <linux/smp_lock.h>
56#include <linux/init.h>
57#include <linux/pci.h>
58
59#include <asm/current.h>
60#include <asm/uaccess.h>
61#include <asm/io.h>
62#include <asm/byteorder.h>
63#include <asm/atomic.h>
64#include <asm/system.h>
65#include <asm/scatterlist.h>
66
67#include <scsi/scsi.h>
68#include <scsi/scsi_cmnd.h>
69#include <scsi/scsi_dbg.h>
70#include <scsi/scsi_device.h>
71#include <scsi/scsi_host.h>
72
73#include "csr1212.h"
74#include "ieee1394.h"
75#include "ieee1394_types.h"
76#include "ieee1394_core.h"
77#include "nodemgr.h"
78#include "hosts.h"
79#include "highlevel.h"
80#include "ieee1394_transactions.h"
81#include "sbp2.h"
82
1da177e4
LT
83/*
84 * Module load parameter definitions
85 */
86
87/*
88 * Change max_speed on module load if you have a bad IEEE-1394
89 * controller that has trouble running 2KB packets at 400mb.
90 *
91 * NOTE: On certain OHCI parts I have seen short packets on async transmit
92 * (probably due to PCI latency/throughput issues with the part). You can
93 * bump down the speed if you are running into problems.
94 */
95static int max_speed = IEEE1394_SPEED_MAX;
96module_param(max_speed, int, 0644);
2bab359a 97MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
1da177e4
LT
98
99/*
100 * Set serialize_io to 1 if you'd like only one scsi command sent
101 * down to us at a time (debugging). This might be necessary for very
102 * badly behaved sbp2 devices.
2bab359a
JM
103 *
104 * TODO: Make this configurable per device.
1da177e4 105 */
2bab359a 106static int serialize_io = 1;
1da177e4 107module_param(serialize_io, int, 0444);
2bab359a 108MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
1da177e4
LT
109
110/*
111 * Bump up max_sectors if you'd like to support very large sized
112 * transfers. Please note that some older sbp2 bridge chips are broken for
113 * transfers greater or equal to 128KB. Default is a value of 255
114 * sectors, or just under 128KB (at 512 byte sector size). I can note that
115 * the Oxsemi sbp2 chipsets have no problems supporting very large
116 * transfer sizes.
117 */
118static int max_sectors = SBP2_MAX_SECTORS;
119module_param(max_sectors, int, 0444);
24d3bf88
SR
120MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
121 __stringify(SBP2_MAX_SECTORS) ")");
1da177e4
LT
122
123/*
124 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
125 * do an exclusive login, as it's generally unsafe to have two hosts
126 * talking to a single sbp2 device at the same time (filesystem coherency,
127 * etc.). If you're running an sbp2 device that supports multiple logins,
128 * and you're either running read-only filesystems or some sort of special
20f45781
BC
129 * filesystem supporting multiple hosts, e.g. OpenGFS, Oracle Cluster
130 * File System, or Lustre, then set exclusive_login to zero.
131 *
132 * So far only bridges from Oxford Semiconductor are known to support
133 * concurrent logins. Depending on firmware, four or two concurrent logins
134 * are possible on OXFW911 and newer Oxsemi bridges.
1da177e4
LT
135 */
136static int exclusive_login = 1;
137module_param(exclusive_login, int, 0644);
138MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
139
140/*
24d3bf88
SR
141 * If any of the following workarounds is required for your device to work,
142 * please submit the kernel messages logged by sbp2 to the linux1394-devel
143 * mailing list.
1da177e4 144 *
24d3bf88
SR
145 * - 128kB max transfer
146 * Limit transfer size. Necessary for some old bridges.
147 *
148 * - 36 byte inquiry
149 * When scsi_mod probes the device, let the inquiry command look like that
150 * from MS Windows.
151 *
152 * - skip mode page 8
153 * Suppress sending of mode_sense for mode page 8 if the device pretends to
154 * support the SCSI Primary Block commands instead of Reduced Block Commands.
e9a1c52c
SR
155 *
156 * - fix capacity
157 * Tell sd_mod to correct the last sector number reported by read_capacity.
158 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
159 * Don't use this with devices which don't have this bug.
679c0cd2
SR
160 *
161 * - override internal blacklist
162 * Instead of adding to the built-in blacklist, use only the workarounds
163 * specified in the module load parameter.
164 * Useful if a blacklist entry interfered with a non-broken device.
1da177e4 165 */
24d3bf88
SR
166static int sbp2_default_workarounds;
167module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
168MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
169 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
170 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
171 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
e9a1c52c 172 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
679c0cd2 173 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
24d3bf88
SR
174 ", or a combination)");
175
176/* legacy parameter */
1934b8b6 177static int force_inquiry_hack;
a80614d1 178module_param(force_inquiry_hack, int, 0644);
24d3bf88 179MODULE_PARM_DESC(force_inquiry_hack, "Deprecated, use 'workarounds'");
1da177e4 180
1da177e4
LT
181/*
182 * Export information about protocols/devices supported by this driver.
183 */
184static struct ieee1394_device_id sbp2_id_table[] = {
185 {
a237f35f
SR
186 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
187 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
188 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
189 {}
1da177e4
LT
190};
191
192MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
193
194/*
195 * Debug levels, configured via kernel config, or enable here.
196 */
197
44456d37 198#define CONFIG_IEEE1394_SBP2_DEBUG 0
1da177e4
LT
199/* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
200/* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
201/* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
202/* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
203/* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
204
205#ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
206#define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
207static u32 global_outstanding_command_orbs = 0;
208#define outstanding_orb_incr global_outstanding_command_orbs++
209#define outstanding_orb_decr global_outstanding_command_orbs--
210#else
211#define SBP2_ORB_DEBUG(fmt, args...)
212#define outstanding_orb_incr
213#define outstanding_orb_decr
214#endif
215
216#ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
217#define SBP2_DMA_ALLOC(fmt, args...) \
218 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
219 ++global_outstanding_dmas, ## args)
220#define SBP2_DMA_FREE(fmt, args...) \
221 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
222 --global_outstanding_dmas, ## args)
223static u32 global_outstanding_dmas = 0;
224#else
225#define SBP2_DMA_ALLOC(fmt, args...)
226#define SBP2_DMA_FREE(fmt, args...)
227#endif
228
229#if CONFIG_IEEE1394_SBP2_DEBUG >= 2
230#define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
231#define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
232#define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
233#define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
234#elif CONFIG_IEEE1394_SBP2_DEBUG == 1
235#define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
236#define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
237#define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
238#define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
239#else
240#define SBP2_DEBUG(fmt, args...)
241#define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
242#define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
243#define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
244#endif
245
246#define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
d024ebc6 247#define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
1da177e4 248
1da177e4
LT
249/*
250 * Globals
251 */
252
253static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
254 u32 status);
255
256static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
257 u32 scsi_status, struct scsi_cmnd *SCpnt,
258 void (*done)(struct scsi_cmnd *));
259
260static struct scsi_host_template scsi_driver_template;
261
262static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
263
264static void sbp2_host_reset(struct hpsb_host *host);
265
266static int sbp2_probe(struct device *dev);
267static int sbp2_remove(struct device *dev);
268static int sbp2_update(struct unit_directory *ud);
269
270static struct hpsb_highlevel sbp2_highlevel = {
271 .name = SBP2_DEVICE_NAME,
272 .host_reset = sbp2_host_reset,
273};
274
275static struct hpsb_address_ops sbp2_ops = {
276 .write = sbp2_handle_status_write
277};
278
279#ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
280static struct hpsb_address_ops sbp2_physdma_ops = {
a237f35f
SR
281 .read = sbp2_handle_physdma_read,
282 .write = sbp2_handle_physdma_write,
1da177e4
LT
283};
284#endif
285
286static struct hpsb_protocol_driver sbp2_driver = {
287 .name = "SBP2 Driver",
288 .id_table = sbp2_id_table,
289 .update = sbp2_update,
290 .driver = {
291 .name = SBP2_DEVICE_NAME,
292 .bus = &ieee1394_bus_type,
293 .probe = sbp2_probe,
294 .remove = sbp2_remove,
295 },
296};
297
a80614d1 298/*
24d3bf88
SR
299 * List of devices with known bugs.
300 *
301 * The firmware_revision field, masked with 0xffff00, is the best indicator
302 * for the type of bridge chip of a device. It yields a few false positives
303 * but this did not break correctly behaving devices so far.
a80614d1 304 */
24d3bf88
SR
305static const struct {
306 u32 firmware_revision;
e9a1c52c 307 u32 model_id;
24d3bf88
SR
308 unsigned workarounds;
309} sbp2_workarounds_table[] = {
4b9a3347 310 /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
24d3bf88 311 .firmware_revision = 0x002800,
4b9a3347 312 .model_id = 0x001010,
24d3bf88
SR
313 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
314 SBP2_WORKAROUND_MODE_SENSE_8,
315 },
316 /* Initio bridges, actually only needed for some older ones */ {
317 .firmware_revision = 0x000200,
318 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
319 },
320 /* Symbios bridge */ {
321 .firmware_revision = 0xa0b800,
322 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
e9a1c52c
SR
323 },
324 /*
325 * Note about the following Apple iPod blacklist entries:
326 *
327 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
328 * matching logic treats 0 as a wildcard, we cannot match this ID
329 * without rewriting the matching routine. Fortunately these iPods
330 * do not feature the read_capacity bug according to one report.
331 * Read_capacity behaviour as well as model_id could change due to
332 * Apple-supplied firmware updates though.
333 */
334 /* iPod 4th generation */ {
335 .firmware_revision = 0x0a2700,
336 .model_id = 0x000021,
337 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
338 },
339 /* iPod mini */ {
340 .firmware_revision = 0x0a2700,
341 .model_id = 0x000023,
342 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
343 },
344 /* iPod Photo */ {
345 .firmware_revision = 0x0a2700,
346 .model_id = 0x00007e,
347 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
24d3bf88 348 }
1da177e4
LT
349};
350
1da177e4
LT
351/**************************************
352 * General utility functions
353 **************************************/
354
1da177e4
LT
355#ifndef __BIG_ENDIAN
356/*
357 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
358 */
2b01b80b 359static inline void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
1da177e4
LT
360{
361 u32 *temp = buffer;
362
363 for (length = (length >> 2); length--; )
364 temp[length] = be32_to_cpu(temp[length]);
365
366 return;
367}
368
369/*
370 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
371 */
2b01b80b 372static inline void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
1da177e4
LT
373{
374 u32 *temp = buffer;
375
376 for (length = (length >> 2); length--; )
377 temp[length] = cpu_to_be32(temp[length]);
378
379 return;
380}
381#else /* BIG_ENDIAN */
382/* Why waste the cpu cycles? */
383#define sbp2util_be32_to_cpu_buffer(x,y)
384#define sbp2util_cpu_to_be32_buffer(x,y)
385#endif
386
387#ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
388/*
389 * Debug packet dump routine. Length is in bytes.
390 */
a237f35f
SR
391static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
392 u32 dump_phys_addr)
1da177e4
LT
393{
394 int i;
395 unsigned char *dump = buffer;
396
397 if (!dump || !length || !dump_name)
398 return;
399
400 if (dump_phys_addr)
401 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
402 else
403 printk("[%s]", dump_name);
404 for (i = 0; i < length; i++) {
405 if (i > 0x3f) {
406 printk("\n ...");
407 break;
408 }
409 if ((i & 0x3) == 0)
410 printk(" ");
411 if ((i & 0xf) == 0)
412 printk("\n ");
a237f35f 413 printk("%02x ", (int)dump[i]);
1da177e4
LT
414 }
415 printk("\n");
416
417 return;
418}
419#else
420#define sbp2util_packet_dump(w,x,y,z)
421#endif
422
423/*
424 * Goofy routine that basically does a down_timeout function.
425 */
426static int sbp2util_down_timeout(atomic_t *done, int timeout)
427{
428 int i;
429
430 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
431 if (msleep_interruptible(100)) /* 100ms */
a237f35f 432 return 1;
1da177e4 433 }
a237f35f 434 return (i > 0) ? 0 : 1;
1da177e4
LT
435}
436
437/* Free's an allocated packet */
438static void sbp2_free_packet(struct hpsb_packet *packet)
439{
440 hpsb_free_tlabel(packet);
441 hpsb_free_packet(packet);
442}
443
444/* This is much like hpsb_node_write(), except it ignores the response
445 * subaction and returns immediately. Can be used from interrupts.
446 */
447static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
a237f35f 448 quadlet_t *buffer, size_t length)
1da177e4
LT
449{
450 struct hpsb_packet *packet;
451
452 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
453 addr, buffer, length);
a237f35f
SR
454 if (!packet)
455 return -ENOMEM;
1da177e4 456
a237f35f
SR
457 hpsb_set_packet_complete_task(packet,
458 (void (*)(void *))sbp2_free_packet,
1da177e4
LT
459 packet);
460
461 hpsb_node_fill_packet(ne, packet);
462
a237f35f 463 if (hpsb_send_packet(packet) < 0) {
1da177e4
LT
464 sbp2_free_packet(packet);
465 return -EIO;
466 }
467
468 return 0;
469}
470
471/*
472 * This function is called to create a pool of command orbs used for
473 * command processing. It is called when a new sbp2 device is detected.
474 */
475static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
476{
477 struct sbp2scsi_host_info *hi = scsi_id->hi;
478 int i;
479 unsigned long flags, orbs;
480 struct sbp2_command_info *command;
481
482 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
483
484 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
485 for (i = 0; i < orbs; i++) {
8551158a 486 command = kzalloc(sizeof(*command), GFP_ATOMIC);
1da177e4 487 if (!command) {
a237f35f
SR
488 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
489 flags);
490 return -ENOMEM;
1da177e4 491 }
1da177e4 492 command->command_orb_dma =
a237f35f
SR
493 pci_map_single(hi->host->pdev, &command->command_orb,
494 sizeof(struct sbp2_command_orb),
d4018d7f 495 PCI_DMA_TODEVICE);
1da177e4
LT
496 SBP2_DMA_ALLOC("single command orb DMA");
497 command->sge_dma =
a237f35f
SR
498 pci_map_single(hi->host->pdev,
499 &command->scatter_gather_element,
500 sizeof(command->scatter_gather_element),
501 PCI_DMA_BIDIRECTIONAL);
1da177e4
LT
502 SBP2_DMA_ALLOC("scatter_gather_element");
503 INIT_LIST_HEAD(&command->list);
504 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
505 }
506 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
507 return 0;
508}
509
510/*
511 * This function is called to delete a pool of command orbs.
512 */
513static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
514{
515 struct hpsb_host *host = scsi_id->hi->host;
516 struct list_head *lh, *next;
517 struct sbp2_command_info *command;
518 unsigned long flags;
519
520 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
521 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
522 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
523 command = list_entry(lh, struct sbp2_command_info, list);
524
525 /* Release our generic DMA's */
526 pci_unmap_single(host->pdev, command->command_orb_dma,
527 sizeof(struct sbp2_command_orb),
d4018d7f 528 PCI_DMA_TODEVICE);
1da177e4
LT
529 SBP2_DMA_FREE("single command orb DMA");
530 pci_unmap_single(host->pdev, command->sge_dma,
531 sizeof(command->scatter_gather_element),
532 PCI_DMA_BIDIRECTIONAL);
533 SBP2_DMA_FREE("scatter_gather_element");
534
535 kfree(command);
536 }
537 }
538 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
539 return;
540}
541
542/*
543 * This function finds the sbp2_command for a given outstanding command
544 * orb.Only looks at the inuse list.
545 */
546static struct sbp2_command_info *sbp2util_find_command_for_orb(
547 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
548{
549 struct sbp2_command_info *command;
550 unsigned long flags;
551
552 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
553 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
554 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
555 if (command->command_orb_dma == orb) {
556 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
a237f35f 557 return command;
1da177e4
LT
558 }
559 }
560 }
561 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
562
563 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
564
a237f35f 565 return NULL;
1da177e4
LT
566}
567
568/*
569 * This function finds the sbp2_command for a given outstanding SCpnt.
570 * Only looks at the inuse list.
24c7cd06 571 * Must be called with scsi_id->sbp2_command_orb_lock held.
1da177e4 572 */
24c7cd06
SR
573static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
574 struct scsi_id_instance_data *scsi_id, void *SCpnt)
1da177e4
LT
575{
576 struct sbp2_command_info *command;
1da177e4 577
24c7cd06
SR
578 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
579 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
580 if (command->Current_SCpnt == SCpnt)
a237f35f 581 return command;
a237f35f 582 return NULL;
1da177e4
LT
583}
584
585/*
586 * This function allocates a command orb used to send a scsi command.
587 */
588static struct sbp2_command_info *sbp2util_allocate_command_orb(
589 struct scsi_id_instance_data *scsi_id,
590 struct scsi_cmnd *Current_SCpnt,
591 void (*Current_done)(struct scsi_cmnd *))
592{
593 struct list_head *lh;
594 struct sbp2_command_info *command = NULL;
595 unsigned long flags;
596
597 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
598 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
599 lh = scsi_id->sbp2_command_orb_completed.next;
600 list_del(lh);
601 command = list_entry(lh, struct sbp2_command_info, list);
602 command->Current_done = Current_done;
603 command->Current_SCpnt = Current_SCpnt;
604 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
605 } else {
d024ebc6 606 SBP2_ERR("%s: no orbs available", __FUNCTION__);
1da177e4
LT
607 }
608 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
a237f35f 609 return command;
1da177e4
LT
610}
611
612/* Free our DMA's */
613static void sbp2util_free_command_dma(struct sbp2_command_info *command)
614{
615 struct scsi_id_instance_data *scsi_id =
616 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
617 struct hpsb_host *host;
618
619 if (!scsi_id) {
d024ebc6 620 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
1da177e4
LT
621 return;
622 }
623
624 host = scsi_id->ud->ne->host;
625
626 if (command->cmd_dma) {
627 if (command->dma_type == CMD_DMA_SINGLE) {
628 pci_unmap_single(host->pdev, command->cmd_dma,
629 command->dma_size, command->dma_dir);
630 SBP2_DMA_FREE("single bulk");
631 } else if (command->dma_type == CMD_DMA_PAGE) {
632 pci_unmap_page(host->pdev, command->cmd_dma,
633 command->dma_size, command->dma_dir);
634 SBP2_DMA_FREE("single page");
635 } /* XXX: Check for CMD_DMA_NONE bug */
636 command->dma_type = CMD_DMA_NONE;
637 command->cmd_dma = 0;
638 }
639
640 if (command->sge_buffer) {
641 pci_unmap_sg(host->pdev, command->sge_buffer,
642 command->dma_size, command->dma_dir);
643 SBP2_DMA_FREE("scatter list");
644 command->sge_buffer = NULL;
645 }
646}
647
648/*
649 * This function moves a command to the completed orb list.
24c7cd06 650 * Must be called with scsi_id->sbp2_command_orb_lock held.
1da177e4 651 */
24c7cd06
SR
652static void sbp2util_mark_command_completed(
653 struct scsi_id_instance_data *scsi_id,
654 struct sbp2_command_info *command)
1da177e4 655{
1da177e4
LT
656 list_del(&command->list);
657 sbp2util_free_command_dma(command);
658 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
1da177e4
LT
659}
660
abd559b1
JM
661/*
662 * Is scsi_id valid? Is the 1394 node still present?
663 */
664static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
665{
666 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
667}
668
1da177e4
LT
669/*********************************************
670 * IEEE-1394 core driver stack related section
671 *********************************************/
672static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
673
674static int sbp2_probe(struct device *dev)
675{
676 struct unit_directory *ud;
677 struct scsi_id_instance_data *scsi_id;
678
d024ebc6 679 SBP2_DEBUG_ENTER();
1da177e4
LT
680
681 ud = container_of(dev, struct unit_directory, device);
682
683 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
684 * instead. */
685 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
686 return -ENODEV;
687
a237f35f 688 scsi_id = sbp2_alloc_device(ud);
1da177e4 689
a237f35f
SR
690 if (!scsi_id)
691 return -ENOMEM;
1da177e4 692
a237f35f 693 sbp2_parse_unit_directory(scsi_id, ud);
1da177e4 694
a237f35f 695 return sbp2_start_device(scsi_id);
1da177e4
LT
696}
697
698static int sbp2_remove(struct device *dev)
699{
700 struct unit_directory *ud;
701 struct scsi_id_instance_data *scsi_id;
abd559b1 702 struct scsi_device *sdev;
1da177e4 703
d024ebc6 704 SBP2_DEBUG_ENTER();
1da177e4
LT
705
706 ud = container_of(dev, struct unit_directory, device);
707 scsi_id = ud->device.driver_data;
abd559b1
JM
708 if (!scsi_id)
709 return 0;
710
bf637ec3
SR
711 if (scsi_id->scsi_host) {
712 /* Get rid of enqueued commands if there is no chance to
713 * send them. */
714 if (!sbp2util_node_is_available(scsi_id))
715 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
716 /* scsi_remove_device() will trigger shutdown functions of SCSI
717 * highlevel drivers which would deadlock if blocked. */
abd559b1 718 scsi_unblock_requests(scsi_id->scsi_host);
bf637ec3 719 }
abd559b1
JM
720 sdev = scsi_id->sdev;
721 if (sdev) {
722 scsi_id->sdev = NULL;
723 scsi_remove_device(sdev);
724 }
1da177e4
LT
725
726 sbp2_logout_device(scsi_id);
727 sbp2_remove_device(scsi_id);
728
729 return 0;
730}
731
732static int sbp2_update(struct unit_directory *ud)
733{
734 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
735
d024ebc6 736 SBP2_DEBUG_ENTER();
1da177e4
LT
737
738 if (sbp2_reconnect_device(scsi_id)) {
739
740 /*
741 * Ok, reconnect has failed. Perhaps we didn't
742 * reconnect fast enough. Try doing a regular login, but
743 * first do a logout just in case of any weirdness.
744 */
745 sbp2_logout_device(scsi_id);
746
747 if (sbp2_login_device(scsi_id)) {
748 /* Login failed too, just fail, and the backend
749 * will call our sbp2_remove for us */
750 SBP2_ERR("Failed to reconnect to sbp2 device!");
751 return -EBUSY;
752 }
753 }
754
755 /* Set max retries to something large on the device. */
756 sbp2_set_busy_timeout(scsi_id);
757
758 /* Do a SBP-2 fetch agent reset. */
759 sbp2_agent_reset(scsi_id, 1);
760
761 /* Get the max speed and packet size that we can use. */
762 sbp2_max_speed_and_size(scsi_id);
763
764 /* Complete any pending commands with busy (so they get
765 * retried) and remove them from our queue
766 */
767 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
768
769 /* Make sure we unblock requests (since this is likely after a bus
770 * reset). */
771 scsi_unblock_requests(scsi_id->scsi_host);
772
773 return 0;
774}
775
776/* This functions is called by the sbp2_probe, for each new device. We now
777 * allocate one scsi host for each scsi_id (unit directory). */
778static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
779{
780 struct sbp2scsi_host_info *hi;
781 struct Scsi_Host *scsi_host = NULL;
782 struct scsi_id_instance_data *scsi_id = NULL;
783
d024ebc6 784 SBP2_DEBUG_ENTER();
1da177e4 785
8551158a 786 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
1da177e4
LT
787 if (!scsi_id) {
788 SBP2_ERR("failed to create scsi_id");
789 goto failed_alloc;
790 }
1da177e4
LT
791
792 scsi_id->ne = ud->ne;
793 scsi_id->ud = ud;
794 scsi_id->speed_code = IEEE1394_SPEED_100;
795 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
6737231e 796 scsi_id->status_fifo_addr = CSR1212_INVALID_ADDR_SPACE;
1da177e4
LT
797 atomic_set(&scsi_id->sbp2_login_complete, 0);
798 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
799 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
800 INIT_LIST_HEAD(&scsi_id->scsi_list);
801 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
1da177e4
LT
802
803 ud->device.driver_data = scsi_id;
804
805 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
806 if (!hi) {
807 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
808 if (!hi) {
809 SBP2_ERR("failed to allocate hostinfo");
810 goto failed_alloc;
811 }
812 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
813 hi->host = ud->ne->host;
814 INIT_LIST_HEAD(&hi->scsi_ids);
815
1da177e4
LT
816#ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
817 /* Handle data movement if physical dma is not
55664051
SR
818 * enabled or not supported on host controller */
819 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
820 &sbp2_physdma_ops,
821 0x0ULL, 0xfffffffcULL)) {
822 SBP2_ERR("failed to register lower 4GB address range");
823 goto failed_alloc;
824 }
1da177e4
LT
825#endif
826 }
827
147830f2
SR
828 /* Prevent unloading of the 1394 host */
829 if (!try_module_get(hi->host->driver->owner)) {
830 SBP2_ERR("failed to get a reference on 1394 host driver");
831 goto failed_alloc;
832 }
833
1da177e4
LT
834 scsi_id->hi = hi;
835
836 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
837
35bdddb8
SR
838 /* Register the status FIFO address range. We could use the same FIFO
839 * for targets at different nodes. However we need different FIFOs per
a54c9d30
SR
840 * target in order to support multi-unit devices.
841 * The FIFO is located out of the local host controller's physical range
842 * but, if possible, within the posted write area. Status writes will
843 * then be performed as unified transactions. This slightly reduces
844 * bandwidth usage, and some Prolific based devices seem to require it.
845 */
35bdddb8
SR
846 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
847 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
848 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
40ae6c5e 849 ud->ne->host->low_addr_space, CSR1212_ALL_SPACE_END);
6737231e 850 if (scsi_id->status_fifo_addr == CSR1212_INVALID_ADDR_SPACE) {
35bdddb8
SR
851 SBP2_ERR("failed to allocate status FIFO address range");
852 goto failed_alloc;
853 }
854
1da177e4 855 /* Register our host with the SCSI stack. */
a2ef79e1 856 scsi_host = scsi_host_alloc(&scsi_driver_template,
a237f35f 857 sizeof(unsigned long));
1da177e4
LT
858 if (!scsi_host) {
859 SBP2_ERR("failed to register scsi host");
860 goto failed_alloc;
861 }
862
863 scsi_host->hostdata[0] = (unsigned long)scsi_id;
864
865 if (!scsi_add_host(scsi_host, &ud->device)) {
866 scsi_id->scsi_host = scsi_host;
867 return scsi_id;
868 }
869
870 SBP2_ERR("failed to add scsi host");
871 scsi_host_put(scsi_host);
872
873failed_alloc:
874 sbp2_remove_device(scsi_id);
875 return NULL;
876}
877
1da177e4
LT
878static void sbp2_host_reset(struct hpsb_host *host)
879{
880 struct sbp2scsi_host_info *hi;
881 struct scsi_id_instance_data *scsi_id;
882
883 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
884
885 if (hi) {
886 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
887 scsi_block_requests(scsi_id->scsi_host);
888 }
889}
890
1da177e4
LT
891/*
892 * This function is where we first pull the node unique ids, and then
893 * allocate memory and register a SBP-2 device.
894 */
895static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
896{
897 struct sbp2scsi_host_info *hi = scsi_id->hi;
146f7262 898 int error;
1da177e4 899
d024ebc6 900 SBP2_DEBUG_ENTER();
1da177e4
LT
901
902 /* Login FIFO DMA */
903 scsi_id->login_response =
a237f35f
SR
904 pci_alloc_consistent(hi->host->pdev,
905 sizeof(struct sbp2_login_response),
1da177e4
LT
906 &scsi_id->login_response_dma);
907 if (!scsi_id->login_response)
908 goto alloc_fail;
909 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
910
911 /* Query logins ORB DMA */
912 scsi_id->query_logins_orb =
a237f35f
SR
913 pci_alloc_consistent(hi->host->pdev,
914 sizeof(struct sbp2_query_logins_orb),
1da177e4
LT
915 &scsi_id->query_logins_orb_dma);
916 if (!scsi_id->query_logins_orb)
917 goto alloc_fail;
918 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
919
920 /* Query logins response DMA */
921 scsi_id->query_logins_response =
a237f35f
SR
922 pci_alloc_consistent(hi->host->pdev,
923 sizeof(struct sbp2_query_logins_response),
1da177e4
LT
924 &scsi_id->query_logins_response_dma);
925 if (!scsi_id->query_logins_response)
926 goto alloc_fail;
927 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
928
929 /* Reconnect ORB DMA */
930 scsi_id->reconnect_orb =
a237f35f
SR
931 pci_alloc_consistent(hi->host->pdev,
932 sizeof(struct sbp2_reconnect_orb),
1da177e4
LT
933 &scsi_id->reconnect_orb_dma);
934 if (!scsi_id->reconnect_orb)
935 goto alloc_fail;
936 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
937
938 /* Logout ORB DMA */
939 scsi_id->logout_orb =
a237f35f
SR
940 pci_alloc_consistent(hi->host->pdev,
941 sizeof(struct sbp2_logout_orb),
1da177e4
LT
942 &scsi_id->logout_orb_dma);
943 if (!scsi_id->logout_orb)
944 goto alloc_fail;
945 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
946
947 /* Login ORB DMA */
948 scsi_id->login_orb =
a237f35f
SR
949 pci_alloc_consistent(hi->host->pdev,
950 sizeof(struct sbp2_login_orb),
1da177e4 951 &scsi_id->login_orb_dma);
eaceec7f
SR
952 if (!scsi_id->login_orb)
953 goto alloc_fail;
1da177e4
LT
954 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
955
956 SBP2_DEBUG("New SBP-2 device inserted, SCSI ID = %x", scsi_id->ud->id);
957
958 /*
959 * Create our command orb pool
960 */
961 if (sbp2util_create_command_orb_pool(scsi_id)) {
962 SBP2_ERR("sbp2util_create_command_orb_pool failed!");
963 sbp2_remove_device(scsi_id);
964 return -ENOMEM;
965 }
966
967 /* Schedule a timeout here. The reason is that we may be so close
968 * to a bus reset, that the device is not available for logins.
969 * This can happen when the bus reset is caused by the host
970 * connected to the sbp2 device being removed. That host would
971 * have a certain amount of time to relogin before the sbp2 device
972 * allows someone else to login instead. One second makes sense. */
973 msleep_interruptible(1000);
974 if (signal_pending(current)) {
1da177e4
LT
975 sbp2_remove_device(scsi_id);
976 return -EINTR;
977 }
a237f35f 978
1da177e4
LT
979 /*
980 * Login to the sbp-2 device
981 */
982 if (sbp2_login_device(scsi_id)) {
983 /* Login failed, just remove the device. */
984 sbp2_remove_device(scsi_id);
985 return -EBUSY;
986 }
987
988 /*
989 * Set max retries to something large on the device
990 */
991 sbp2_set_busy_timeout(scsi_id);
992
993 /*
994 * Do a SBP-2 fetch agent reset
995 */
996 sbp2_agent_reset(scsi_id, 1);
997
998 /*
999 * Get the max speed and packet size that we can use
1000 */
1001 sbp2_max_speed_and_size(scsi_id);
1002
1003 /* Add this device to the scsi layer now */
146f7262
JB
1004 error = scsi_add_device(scsi_id->scsi_host, 0, scsi_id->ud->id, 0);
1005 if (error) {
1da177e4 1006 SBP2_ERR("scsi_add_device failed");
dc3edd54
SR
1007 sbp2_logout_device(scsi_id);
1008 sbp2_remove_device(scsi_id);
146f7262 1009 return error;
1da177e4
LT
1010 }
1011
1012 return 0;
eaceec7f
SR
1013
1014alloc_fail:
1015 SBP2_ERR("Could not allocate memory for scsi_id");
1016 sbp2_remove_device(scsi_id);
1017 return -ENOMEM;
1da177e4
LT
1018}
1019
1020/*
1021 * This function removes an sbp2 device from the sbp2scsi_host_info struct.
1022 */
1023static void sbp2_remove_device(struct scsi_id_instance_data *scsi_id)
1024{
1025 struct sbp2scsi_host_info *hi;
1026
d024ebc6 1027 SBP2_DEBUG_ENTER();
1da177e4
LT
1028
1029 if (!scsi_id)
1030 return;
1031
1032 hi = scsi_id->hi;
1033
1034 /* This will remove our scsi device aswell */
1035 if (scsi_id->scsi_host) {
1036 scsi_remove_host(scsi_id->scsi_host);
1037 scsi_host_put(scsi_id->scsi_host);
1038 }
1039
1040 sbp2util_remove_command_orb_pool(scsi_id);
1041
1042 list_del(&scsi_id->scsi_list);
1043
1044 if (scsi_id->login_response) {
1045 pci_free_consistent(hi->host->pdev,
1046 sizeof(struct sbp2_login_response),
1047 scsi_id->login_response,
1048 scsi_id->login_response_dma);
1049 SBP2_DMA_FREE("single login FIFO");
1050 }
1051
1052 if (scsi_id->login_orb) {
1053 pci_free_consistent(hi->host->pdev,
1054 sizeof(struct sbp2_login_orb),
1055 scsi_id->login_orb,
1056 scsi_id->login_orb_dma);
1057 SBP2_DMA_FREE("single login ORB");
1058 }
1059
1060 if (scsi_id->reconnect_orb) {
1061 pci_free_consistent(hi->host->pdev,
1062 sizeof(struct sbp2_reconnect_orb),
1063 scsi_id->reconnect_orb,
1064 scsi_id->reconnect_orb_dma);
1065 SBP2_DMA_FREE("single reconnect orb");
1066 }
1067
1068 if (scsi_id->logout_orb) {
1069 pci_free_consistent(hi->host->pdev,
1070 sizeof(struct sbp2_logout_orb),
1071 scsi_id->logout_orb,
1072 scsi_id->logout_orb_dma);
1073 SBP2_DMA_FREE("single logout orb");
1074 }
1075
1076 if (scsi_id->query_logins_orb) {
1077 pci_free_consistent(hi->host->pdev,
1078 sizeof(struct sbp2_query_logins_orb),
1079 scsi_id->query_logins_orb,
1080 scsi_id->query_logins_orb_dma);
1081 SBP2_DMA_FREE("single query logins orb");
1082 }
1083
1084 if (scsi_id->query_logins_response) {
1085 pci_free_consistent(hi->host->pdev,
1086 sizeof(struct sbp2_query_logins_response),
1087 scsi_id->query_logins_response,
1088 scsi_id->query_logins_response_dma);
1089 SBP2_DMA_FREE("single query logins data");
1090 }
1091
6737231e 1092 if (scsi_id->status_fifo_addr != CSR1212_INVALID_ADDR_SPACE)
35bdddb8 1093 hpsb_unregister_addrspace(&sbp2_highlevel, hi->host,
6737231e 1094 scsi_id->status_fifo_addr);
35bdddb8 1095
1da177e4
LT
1096 scsi_id->ud->device.driver_data = NULL;
1097
147830f2
SR
1098 if (hi)
1099 module_put(hi->host->driver->owner);
1100
1da177e4
LT
1101 SBP2_DEBUG("SBP-2 device removed, SCSI ID = %d", scsi_id->ud->id);
1102
1103 kfree(scsi_id);
1104}
1105
1106#ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
1107/*
1108 * This function deals with physical dma write requests (for adapters that do not support
1109 * physical dma in hardware). Mostly just here for debugging...
1110 */
a237f35f
SR
1111static int sbp2_handle_physdma_write(struct hpsb_host *host, int nodeid,
1112 int destid, quadlet_t *data, u64 addr,
1113 size_t length, u16 flags)
1da177e4
LT
1114{
1115
a237f35f
SR
1116 /*
1117 * Manually put the data in the right place.
1118 */
1119 memcpy(bus_to_virt((u32) addr), data, length);
1120 sbp2util_packet_dump(data, length, "sbp2 phys dma write by device",
1121 (u32) addr);
1122 return RCODE_COMPLETE;
1da177e4
LT
1123}
1124
1125/*
1126 * This function deals with physical dma read requests (for adapters that do not support
1127 * physical dma in hardware). Mostly just here for debugging...
1128 */
a237f35f
SR
1129static int sbp2_handle_physdma_read(struct hpsb_host *host, int nodeid,
1130 quadlet_t *data, u64 addr, size_t length,
1131 u16 flags)
1da177e4
LT
1132{
1133
a237f35f
SR
1134 /*
1135 * Grab data from memory and send a read response.
1136 */
1137 memcpy(data, bus_to_virt((u32) addr), length);
1138 sbp2util_packet_dump(data, length, "sbp2 phys dma read by device",
1139 (u32) addr);
1140 return RCODE_COMPLETE;
1da177e4
LT
1141}
1142#endif
1143
1da177e4
LT
1144/**************************************
1145 * SBP-2 protocol related section
1146 **************************************/
1147
1da177e4
LT
1148/*
1149 * This function queries the device for the maximum concurrent logins it
1150 * supports.
1151 */
1152static int sbp2_query_logins(struct scsi_id_instance_data *scsi_id)
1153{
1154 struct sbp2scsi_host_info *hi = scsi_id->hi;
1155 quadlet_t data[2];
1156 int max_logins;
1157 int active_logins;
1158
d024ebc6 1159 SBP2_DEBUG_ENTER();
1da177e4
LT
1160
1161 scsi_id->query_logins_orb->reserved1 = 0x0;
1162 scsi_id->query_logins_orb->reserved2 = 0x0;
1163
1164 scsi_id->query_logins_orb->query_response_lo = scsi_id->query_logins_response_dma;
1165 scsi_id->query_logins_orb->query_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1da177e4
LT
1166
1167 scsi_id->query_logins_orb->lun_misc = ORB_SET_FUNCTION(SBP2_QUERY_LOGINS_REQUEST);
1168 scsi_id->query_logins_orb->lun_misc |= ORB_SET_NOTIFY(1);
e309fc6d 1169 scsi_id->query_logins_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1da177e4
LT
1170
1171 scsi_id->query_logins_orb->reserved_resp_length =
1172 ORB_SET_QUERY_LOGINS_RESP_LENGTH(sizeof(struct sbp2_query_logins_response));
1da177e4 1173
35bdddb8
SR
1174 scsi_id->query_logins_orb->status_fifo_hi =
1175 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1176 scsi_id->query_logins_orb->status_fifo_lo =
1177 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1da177e4
LT
1178
1179 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb));
1180
1da177e4
LT
1181 sbp2util_packet_dump(scsi_id->query_logins_orb, sizeof(struct sbp2_query_logins_orb),
1182 "sbp2 query logins orb", scsi_id->query_logins_orb_dma);
1183
1184 memset(scsi_id->query_logins_response, 0, sizeof(struct sbp2_query_logins_response));
1da177e4 1185
1da177e4
LT
1186 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1187 data[1] = scsi_id->query_logins_orb_dma;
1188 sbp2util_cpu_to_be32_buffer(data, 8);
1189
1190 atomic_set(&scsi_id->sbp2_login_complete, 0);
1191
1da177e4 1192 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1da177e4
LT
1193
1194 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 2*HZ)) {
1195 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
a237f35f 1196 return -EIO;
1da177e4
LT
1197 }
1198
1199 if (scsi_id->status_block.ORB_offset_lo != scsi_id->query_logins_orb_dma) {
1200 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
a237f35f 1201 return -EIO;
1da177e4
LT
1202 }
1203
1204 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1205 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1206 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1207
1208 SBP2_INFO("Error querying logins to SBP-2 device - timed out");
a237f35f 1209 return -EIO;
1da177e4
LT
1210 }
1211
1212 sbp2util_cpu_to_be32_buffer(scsi_id->query_logins_response, sizeof(struct sbp2_query_logins_response));
1213
1214 SBP2_DEBUG("length_max_logins = %x",
1215 (unsigned int)scsi_id->query_logins_response->length_max_logins);
1216
1da177e4 1217 max_logins = RESPONSE_GET_MAX_LOGINS(scsi_id->query_logins_response->length_max_logins);
20f45781 1218 SBP2_INFO("Maximum concurrent logins supported: %d", max_logins);
1da177e4
LT
1219
1220 active_logins = RESPONSE_GET_ACTIVE_LOGINS(scsi_id->query_logins_response->length_max_logins);
20f45781 1221 SBP2_INFO("Number of active logins: %d", active_logins);
1da177e4
LT
1222
1223 if (active_logins >= max_logins) {
a237f35f 1224 return -EIO;
1da177e4
LT
1225 }
1226
1227 return 0;
1228}
1229
1230/*
1231 * This function is called in order to login to a particular SBP-2 device,
1232 * after a bus reset.
1233 */
1234static int sbp2_login_device(struct scsi_id_instance_data *scsi_id)
1235{
1236 struct sbp2scsi_host_info *hi = scsi_id->hi;
1237 quadlet_t data[2];
1238
d024ebc6 1239 SBP2_DEBUG_ENTER();
1da177e4
LT
1240
1241 if (!scsi_id->login_orb) {
d024ebc6 1242 SBP2_DEBUG("%s: login_orb not alloc'd!", __FUNCTION__);
a237f35f 1243 return -EIO;
1da177e4
LT
1244 }
1245
1246 if (!exclusive_login) {
1247 if (sbp2_query_logins(scsi_id)) {
1248 SBP2_INFO("Device does not support any more concurrent logins");
a237f35f 1249 return -EIO;
1da177e4
LT
1250 }
1251 }
1252
1253 /* Set-up login ORB, assume no password */
1254 scsi_id->login_orb->password_hi = 0;
1255 scsi_id->login_orb->password_lo = 0;
1da177e4
LT
1256
1257 scsi_id->login_orb->login_response_lo = scsi_id->login_response_dma;
1258 scsi_id->login_orb->login_response_hi = ORB_SET_NODE_ID(hi->host->node_id);
1da177e4
LT
1259
1260 scsi_id->login_orb->lun_misc = ORB_SET_FUNCTION(SBP2_LOGIN_REQUEST);
1261 scsi_id->login_orb->lun_misc |= ORB_SET_RECONNECT(0); /* One second reconnect time */
1262 scsi_id->login_orb->lun_misc |= ORB_SET_EXCLUSIVE(exclusive_login); /* Exclusive access to device */
1263 scsi_id->login_orb->lun_misc |= ORB_SET_NOTIFY(1); /* Notify us of login complete */
e309fc6d 1264 scsi_id->login_orb->lun_misc |= ORB_SET_LUN(scsi_id->sbp2_lun);
1da177e4
LT
1265
1266 scsi_id->login_orb->passwd_resp_lengths =
1267 ORB_SET_LOGIN_RESP_LENGTH(sizeof(struct sbp2_login_response));
1da177e4 1268
35bdddb8
SR
1269 scsi_id->login_orb->status_fifo_hi =
1270 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1271 scsi_id->login_orb->status_fifo_lo =
1272 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1da177e4 1273
1da177e4
LT
1274 sbp2util_cpu_to_be32_buffer(scsi_id->login_orb, sizeof(struct sbp2_login_orb));
1275
1da177e4
LT
1276 sbp2util_packet_dump(scsi_id->login_orb, sizeof(struct sbp2_login_orb),
1277 "sbp2 login orb", scsi_id->login_orb_dma);
1278
1da177e4 1279 memset(scsi_id->login_response, 0, sizeof(struct sbp2_login_response));
1da177e4 1280
1da177e4
LT
1281 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1282 data[1] = scsi_id->login_orb_dma;
1283 sbp2util_cpu_to_be32_buffer(data, 8);
1284
1285 atomic_set(&scsi_id->sbp2_login_complete, 0);
1286
1da177e4 1287 hpsb_node_write(scsi_id->ne, scsi_id->sbp2_management_agent_addr, data, 8);
1da177e4
LT
1288
1289 /*
1290 * Wait for login status (up to 20 seconds)...
1291 */
1292 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, 20*HZ)) {
1293 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
a237f35f 1294 return -EIO;
1da177e4
LT
1295 }
1296
1297 /*
1298 * Sanity. Make sure status returned matches login orb.
1299 */
1300 if (scsi_id->status_block.ORB_offset_lo != scsi_id->login_orb_dma) {
1301 SBP2_ERR("Error logging into SBP-2 device - login timed-out");
a237f35f 1302 return -EIO;
1da177e4
LT
1303 }
1304
1305 /*
1306 * Check status
1307 */
1308 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1309 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1310 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1311
1312 SBP2_ERR("Error logging into SBP-2 device - login failed");
a237f35f 1313 return -EIO;
1da177e4
LT
1314 }
1315
1316 /*
1317 * Byte swap the login response, for use when reconnecting or
1318 * logging out.
1319 */
1320 sbp2util_cpu_to_be32_buffer(scsi_id->login_response, sizeof(struct sbp2_login_response));
1321
1322 /*
1323 * Grab our command block agent address from the login response.
1324 */
1325 SBP2_DEBUG("command_block_agent_hi = %x",
1326 (unsigned int)scsi_id->login_response->command_block_agent_hi);
1327 SBP2_DEBUG("command_block_agent_lo = %x",
1328 (unsigned int)scsi_id->login_response->command_block_agent_lo);
1329
1330 scsi_id->sbp2_command_block_agent_addr =
1331 ((u64)scsi_id->login_response->command_block_agent_hi) << 32;
1332 scsi_id->sbp2_command_block_agent_addr |= ((u64)scsi_id->login_response->command_block_agent_lo);
1333 scsi_id->sbp2_command_block_agent_addr &= 0x0000ffffffffffffULL;
1334
1335 SBP2_INFO("Logged into SBP-2 device");
1336
a237f35f 1337 return 0;
1da177e4
LT
1338
1339}
1340
1341/*
1342 * This function is called in order to logout from a particular SBP-2
1343 * device, usually called during driver unload.
1344 */
1345static int sbp2_logout_device(struct scsi_id_instance_data *scsi_id)
1346{
1347 struct sbp2scsi_host_info *hi = scsi_id->hi;
1348 quadlet_t data[2];
1349 int error;
1350
d024ebc6 1351 SBP2_DEBUG_ENTER();
1da177e4
LT
1352
1353 /*
1354 * Set-up logout ORB
1355 */
1356 scsi_id->logout_orb->reserved1 = 0x0;
1357 scsi_id->logout_orb->reserved2 = 0x0;
1358 scsi_id->logout_orb->reserved3 = 0x0;
1359 scsi_id->logout_orb->reserved4 = 0x0;
1360
1361 scsi_id->logout_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_LOGOUT_REQUEST);
1362 scsi_id->logout_orb->login_ID_misc |= ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1363
1364 /* Notify us when complete */
1365 scsi_id->logout_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1366
1367 scsi_id->logout_orb->reserved5 = 0x0;
35bdddb8
SR
1368 scsi_id->logout_orb->status_fifo_hi =
1369 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1370 scsi_id->logout_orb->status_fifo_lo =
1371 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1da177e4
LT
1372
1373 /*
1374 * Byte swap ORB if necessary
1375 */
1376 sbp2util_cpu_to_be32_buffer(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb));
1377
1378 sbp2util_packet_dump(scsi_id->logout_orb, sizeof(struct sbp2_logout_orb),
1379 "sbp2 logout orb", scsi_id->logout_orb_dma);
1380
1381 /*
1382 * Ok, let's write to the target's management agent register
1383 */
1384 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1385 data[1] = scsi_id->logout_orb_dma;
1386 sbp2util_cpu_to_be32_buffer(data, 8);
1387
1388 atomic_set(&scsi_id->sbp2_login_complete, 0);
1389
1390 error = hpsb_node_write(scsi_id->ne,
a237f35f 1391 scsi_id->sbp2_management_agent_addr, data, 8);
1da177e4
LT
1392 if (error)
1393 return error;
1394
1395 /* Wait for device to logout...1 second. */
1396 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ))
1397 return -EIO;
1398
1399 SBP2_INFO("Logged out of SBP-2 device");
1400
a237f35f 1401 return 0;
1da177e4
LT
1402
1403}
1404
1405/*
1406 * This function is called in order to reconnect to a particular SBP-2
1407 * device, after a bus reset.
1408 */
1409static int sbp2_reconnect_device(struct scsi_id_instance_data *scsi_id)
1410{
1411 struct sbp2scsi_host_info *hi = scsi_id->hi;
1412 quadlet_t data[2];
1413 int error;
1414
d024ebc6 1415 SBP2_DEBUG_ENTER();
1da177e4
LT
1416
1417 /*
1418 * Set-up reconnect ORB
1419 */
1420 scsi_id->reconnect_orb->reserved1 = 0x0;
1421 scsi_id->reconnect_orb->reserved2 = 0x0;
1422 scsi_id->reconnect_orb->reserved3 = 0x0;
1423 scsi_id->reconnect_orb->reserved4 = 0x0;
1424
1425 scsi_id->reconnect_orb->login_ID_misc = ORB_SET_FUNCTION(SBP2_RECONNECT_REQUEST);
1426 scsi_id->reconnect_orb->login_ID_misc |=
1427 ORB_SET_LOGIN_ID(scsi_id->login_response->length_login_ID);
1428
1429 /* Notify us when complete */
1430 scsi_id->reconnect_orb->login_ID_misc |= ORB_SET_NOTIFY(1);
1431
1432 scsi_id->reconnect_orb->reserved5 = 0x0;
35bdddb8
SR
1433 scsi_id->reconnect_orb->status_fifo_hi =
1434 ORB_SET_STATUS_FIFO_HI(scsi_id->status_fifo_addr, hi->host->node_id);
1435 scsi_id->reconnect_orb->status_fifo_lo =
1436 ORB_SET_STATUS_FIFO_LO(scsi_id->status_fifo_addr);
1da177e4
LT
1437
1438 /*
1439 * Byte swap ORB if necessary
1440 */
1441 sbp2util_cpu_to_be32_buffer(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb));
1442
1443 sbp2util_packet_dump(scsi_id->reconnect_orb, sizeof(struct sbp2_reconnect_orb),
1444 "sbp2 reconnect orb", scsi_id->reconnect_orb_dma);
1445
1da177e4
LT
1446 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1447 data[1] = scsi_id->reconnect_orb_dma;
1448 sbp2util_cpu_to_be32_buffer(data, 8);
1449
1450 atomic_set(&scsi_id->sbp2_login_complete, 0);
1451
1452 error = hpsb_node_write(scsi_id->ne,
a237f35f 1453 scsi_id->sbp2_management_agent_addr, data, 8);
1da177e4
LT
1454 if (error)
1455 return error;
1456
1457 /*
1458 * Wait for reconnect status (up to 1 second)...
1459 */
1460 if (sbp2util_down_timeout(&scsi_id->sbp2_login_complete, HZ)) {
1461 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
a237f35f 1462 return -EIO;
1da177e4
LT
1463 }
1464
1465 /*
1466 * Sanity. Make sure status returned matches reconnect orb.
1467 */
1468 if (scsi_id->status_block.ORB_offset_lo != scsi_id->reconnect_orb_dma) {
1469 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect timed-out");
a237f35f 1470 return -EIO;
1da177e4
LT
1471 }
1472
1473 /*
1474 * Check status
1475 */
1476 if (STATUS_GET_RESP(scsi_id->status_block.ORB_offset_hi_misc) ||
1477 STATUS_GET_DEAD_BIT(scsi_id->status_block.ORB_offset_hi_misc) ||
1478 STATUS_GET_SBP_STATUS(scsi_id->status_block.ORB_offset_hi_misc)) {
1479
1480 SBP2_ERR("Error reconnecting to SBP-2 device - reconnect failed");
a237f35f 1481 return -EIO;
1da177e4
LT
1482 }
1483
1484 HPSB_DEBUG("Reconnected to SBP-2 device");
1485
a237f35f 1486 return 0;
1da177e4
LT
1487
1488}
1489
1490/*
1491 * This function is called in order to set the busy timeout (number of
1492 * retries to attempt) on the sbp2 device.
1493 */
1494static int sbp2_set_busy_timeout(struct scsi_id_instance_data *scsi_id)
1495{
1496 quadlet_t data;
1497
d024ebc6 1498 SBP2_DEBUG_ENTER();
1da177e4 1499
1da177e4 1500 data = cpu_to_be32(SBP2_BUSY_TIMEOUT_VALUE);
d024ebc6
SR
1501 if (hpsb_node_write(scsi_id->ne, SBP2_BUSY_TIMEOUT_ADDRESS, &data, 4))
1502 SBP2_ERR("%s error", __FUNCTION__);
a237f35f 1503 return 0;
1da177e4
LT
1504}
1505
1da177e4
LT
1506/*
1507 * This function is called to parse sbp2 device's config rom unit
1508 * directory. Used to determine things like sbp2 management agent offset,
1509 * and command set used (SCSI or RBC).
1510 */
1511static void sbp2_parse_unit_directory(struct scsi_id_instance_data *scsi_id,
1512 struct unit_directory *ud)
1513{
1514 struct csr1212_keyval *kv;
1515 struct csr1212_dentry *dentry;
1516 u64 management_agent_addr;
1517 u32 command_set_spec_id, command_set, unit_characteristics,
24d3bf88
SR
1518 firmware_revision;
1519 unsigned workarounds;
1da177e4
LT
1520 int i;
1521
d024ebc6 1522 SBP2_DEBUG_ENTER();
1da177e4
LT
1523
1524 management_agent_addr = 0x0;
1525 command_set_spec_id = 0x0;
1526 command_set = 0x0;
1527 unit_characteristics = 0x0;
1528 firmware_revision = 0x0;
1529
1530 /* Handle different fields in the unit directory, based on keys */
1531 csr1212_for_each_dir_entry(ud->ne->csr, kv, ud->ud_kv, dentry) {
1532 switch (kv->key.id) {
1533 case CSR1212_KV_ID_DEPENDENT_INFO:
1534 if (kv->key.type == CSR1212_KV_TYPE_CSR_OFFSET) {
1535 /* Save off the management agent address */
1536 management_agent_addr =
a237f35f
SR
1537 CSR1212_REGISTER_SPACE_BASE +
1538 (kv->value.csr_offset << 2);
1da177e4
LT
1539
1540 SBP2_DEBUG("sbp2_management_agent_addr = %x",
a237f35f 1541 (unsigned int)management_agent_addr);
1da177e4 1542 } else if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
a237f35f
SR
1543 scsi_id->sbp2_lun =
1544 ORB_SET_LUN(kv->value.immediate);
1da177e4
LT
1545 }
1546 break;
1547
1548 case SBP2_COMMAND_SET_SPEC_ID_KEY:
1549 /* Command spec organization */
1550 command_set_spec_id = kv->value.immediate;
1551 SBP2_DEBUG("sbp2_command_set_spec_id = %x",
a237f35f 1552 (unsigned int)command_set_spec_id);
1da177e4
LT
1553 break;
1554
1555 case SBP2_COMMAND_SET_KEY:
1556 /* Command set used by sbp2 device */
1557 command_set = kv->value.immediate;
1558 SBP2_DEBUG("sbp2_command_set = %x",
a237f35f 1559 (unsigned int)command_set);
1da177e4
LT
1560 break;
1561
1562 case SBP2_UNIT_CHARACTERISTICS_KEY:
1563 /*
1564 * Unit characterisitcs (orb related stuff
1565 * that I'm not yet paying attention to)
1566 */
1567 unit_characteristics = kv->value.immediate;
1568 SBP2_DEBUG("sbp2_unit_characteristics = %x",
a237f35f 1569 (unsigned int)unit_characteristics);
1da177e4
LT
1570 break;
1571
1572 case SBP2_FIRMWARE_REVISION_KEY:
1573 /* Firmware revision */
1574 firmware_revision = kv->value.immediate;
24d3bf88
SR
1575 SBP2_DEBUG("sbp2_firmware_revision = %x",
1576 (unsigned int)firmware_revision);
1da177e4
LT
1577 break;
1578
1579 default:
1580 break;
1581 }
1582 }
1583
24d3bf88
SR
1584 workarounds = sbp2_default_workarounds;
1585 if (force_inquiry_hack) {
1586 SBP2_WARN("force_inquiry_hack is deprecated. "
1587 "Use parameter 'workarounds' instead.");
1588 workarounds |= SBP2_WORKAROUND_INQUIRY_36;
1589 }
1da177e4 1590
679c0cd2
SR
1591 if (!(workarounds & SBP2_WORKAROUND_OVERRIDE))
1592 for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1593 if (sbp2_workarounds_table[i].firmware_revision &&
1594 sbp2_workarounds_table[i].firmware_revision !=
1595 (firmware_revision & 0xffff00))
1596 continue;
1597 if (sbp2_workarounds_table[i].model_id &&
1598 sbp2_workarounds_table[i].model_id != ud->model_id)
1599 continue;
1600 workarounds |= sbp2_workarounds_table[i].workarounds;
1601 break;
1602 }
1da177e4 1603
24d3bf88 1604 if (workarounds)
e9a1c52c
SR
1605 SBP2_INFO("Workarounds for node " NODE_BUS_FMT ": 0x%x "
1606 "(firmware_revision 0x%06x, vendor_id 0x%06x,"
1607 " model_id 0x%06x)",
24d3bf88 1608 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
e9a1c52c
SR
1609 workarounds, firmware_revision,
1610 ud->vendor_id ? ud->vendor_id : ud->ne->vendor_id,
1611 ud->model_id);
24d3bf88
SR
1612
1613 /* We would need one SCSI host template for each target to adjust
1614 * max_sectors on the fly, therefore warn only. */
1615 if (workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
1616 (max_sectors * 512) > (128 * 1024))
1617 SBP2_WARN("Node " NODE_BUS_FMT ": Bridge only supports 128KB "
1618 "max transfer size. WARNING: Current max_sectors "
1619 "setting is larger than 128KB (%d sectors)",
1620 NODE_BUS_ARGS(ud->ne->host, ud->ne->nodeid),
1621 max_sectors);
1622
1da177e4
LT
1623 /* If this is a logical unit directory entry, process the parent
1624 * to get the values. */
1625 if (ud->flags & UNIT_DIRECTORY_LUN_DIRECTORY) {
1626 struct unit_directory *parent_ud =
1627 container_of(ud->device.parent, struct unit_directory, device);
1628 sbp2_parse_unit_directory(scsi_id, parent_ud);
1629 } else {
1630 scsi_id->sbp2_management_agent_addr = management_agent_addr;
1631 scsi_id->sbp2_command_set_spec_id = command_set_spec_id;
1632 scsi_id->sbp2_command_set = command_set;
1633 scsi_id->sbp2_unit_characteristics = unit_characteristics;
1634 scsi_id->sbp2_firmware_revision = firmware_revision;
1635 scsi_id->workarounds = workarounds;
1636 if (ud->flags & UNIT_DIRECTORY_HAS_LUN)
e309fc6d 1637 scsi_id->sbp2_lun = ORB_SET_LUN(ud->lun);
1da177e4
LT
1638 }
1639}
1640
fd23ade8
BC
1641#define SBP2_PAYLOAD_TO_BYTES(p) (1 << ((p) + 2))
1642
1da177e4
LT
1643/*
1644 * This function is called in order to determine the max speed and packet
1645 * size we can use in our ORBs. Note, that we (the driver and host) only
1646 * initiate the transaction. The SBP-2 device actually transfers the data
1647 * (by reading from the DMA area we tell it). This means that the SBP-2
1648 * device decides the actual maximum data it can transfer. We just tell it
1649 * the speed that it needs to use, and the max_rec the host supports, and
1650 * it takes care of the rest.
1651 */
1652static int sbp2_max_speed_and_size(struct scsi_id_instance_data *scsi_id)
1653{
1654 struct sbp2scsi_host_info *hi = scsi_id->hi;
fd23ade8 1655 u8 payload;
1da177e4 1656
d024ebc6 1657 SBP2_DEBUG_ENTER();
1da177e4 1658
a237f35f 1659 scsi_id->speed_code =
647dcb5f 1660 hi->host->speed[NODEID_TO_NODE(scsi_id->ne->nodeid)];
1da177e4
LT
1661
1662 /* Bump down our speed if the user requested it */
1663 if (scsi_id->speed_code > max_speed) {
1664 scsi_id->speed_code = max_speed;
1665 SBP2_ERR("Forcing SBP-2 max speed down to %s",
1666 hpsb_speedto_str[scsi_id->speed_code]);
1667 }
1668
1669 /* Payload size is the lesser of what our speed supports and what
1670 * our host supports. */
fd23ade8
BC
1671 payload = min(sbp2_speedto_max_payload[scsi_id->speed_code],
1672 (u8) (hi->host->csr.max_rec - 1));
1673
1674 /* If physical DMA is off, work around limitation in ohci1394:
1675 * packet size must not exceed PAGE_SIZE */
1676 if (scsi_id->ne->host->low_addr_space < (1ULL << 32))
1677 while (SBP2_PAYLOAD_TO_BYTES(payload) + 24 > PAGE_SIZE &&
1678 payload)
1679 payload--;
1da177e4
LT
1680
1681 HPSB_DEBUG("Node " NODE_BUS_FMT ": Max speed [%s] - Max payload [%u]",
1682 NODE_BUS_ARGS(hi->host, scsi_id->ne->nodeid),
1683 hpsb_speedto_str[scsi_id->speed_code],
fd23ade8 1684 SBP2_PAYLOAD_TO_BYTES(payload));
1da177e4 1685
fd23ade8 1686 scsi_id->max_payload_size = payload;
a237f35f 1687 return 0;
1da177e4
LT
1688}
1689
1690/*
1691 * This function is called in order to perform a SBP-2 agent reset.
1692 */
1693static int sbp2_agent_reset(struct scsi_id_instance_data *scsi_id, int wait)
1694{
1695 quadlet_t data;
1696 u64 addr;
1697 int retval;
cc078189 1698 unsigned long flags;
1da177e4 1699
d024ebc6 1700 SBP2_DEBUG_ENTER();
1da177e4 1701
1da177e4
LT
1702 data = ntohl(SBP2_AGENT_RESET_DATA);
1703 addr = scsi_id->sbp2_command_block_agent_addr + SBP2_AGENT_RESET_OFFSET;
1704
1705 if (wait)
1706 retval = hpsb_node_write(scsi_id->ne, addr, &data, 4);
1707 else
1708 retval = sbp2util_node_write_no_wait(scsi_id->ne, addr, &data, 4);
1709
1710 if (retval < 0) {
1711 SBP2_ERR("hpsb_node_write failed.\n");
1712 return -EIO;
1713 }
1714
1715 /*
1716 * Need to make sure orb pointer is written on next command
1717 */
cc078189 1718 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4 1719 scsi_id->last_orb = NULL;
cc078189 1720 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4 1721
a237f35f 1722 return 0;
1da177e4
LT
1723}
1724
cf8d2c09
SR
1725static void sbp2_prep_command_orb_sg(struct sbp2_command_orb *orb,
1726 struct sbp2scsi_host_info *hi,
1727 struct sbp2_command_info *command,
1728 unsigned int scsi_use_sg,
1729 struct scatterlist *sgpnt,
1730 u32 orb_direction,
1731 enum dma_data_direction dma_dir)
1732{
1733 command->dma_dir = dma_dir;
1734 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1735 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1736
1737 /* Special case if only one element (and less than 64KB in size) */
1738 if ((scsi_use_sg == 1) &&
1739 (sgpnt[0].length <= SBP2_MAX_SG_ELEMENT_LENGTH)) {
1740
1741 SBP2_DEBUG("Only one s/g element");
1742 command->dma_size = sgpnt[0].length;
1743 command->dma_type = CMD_DMA_PAGE;
1744 command->cmd_dma = pci_map_page(hi->host->pdev,
1745 sgpnt[0].page,
1746 sgpnt[0].offset,
1747 command->dma_size,
1748 command->dma_dir);
1749 SBP2_DMA_ALLOC("single page scatter element");
1750
1751 orb->data_descriptor_lo = command->cmd_dma;
1752 orb->misc |= ORB_SET_DATA_SIZE(command->dma_size);
1753
1754 } else {
1755 struct sbp2_unrestricted_page_table *sg_element =
1756 &command->scatter_gather_element[0];
1757 u32 sg_count, sg_len;
1758 dma_addr_t sg_addr;
1759 int i, count = pci_map_sg(hi->host->pdev, sgpnt, scsi_use_sg,
1760 dma_dir);
1761
1762 SBP2_DMA_ALLOC("scatter list");
1763
1764 command->dma_size = scsi_use_sg;
1765 command->sge_buffer = sgpnt;
1766
1767 /* use page tables (s/g) */
1768 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1769 orb->data_descriptor_lo = command->sge_dma;
1770
1771 /*
1772 * Loop through and fill out our sbp-2 page tables
1773 * (and split up anything too large)
1774 */
1775 for (i = 0, sg_count = 0 ; i < count; i++, sgpnt++) {
1776 sg_len = sg_dma_len(sgpnt);
1777 sg_addr = sg_dma_address(sgpnt);
1778 while (sg_len) {
1779 sg_element[sg_count].segment_base_lo = sg_addr;
1780 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1781 sg_element[sg_count].length_segment_base_hi =
1782 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1783 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1784 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1785 } else {
1786 sg_element[sg_count].length_segment_base_hi =
1787 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1788 sg_len = 0;
1789 }
1790 sg_count++;
1791 }
1792 }
1793
1794 /* Number of page table (s/g) elements */
1795 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1796
1797 sbp2util_packet_dump(sg_element,
1798 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1799 "sbp2 s/g list", command->sge_dma);
1800
1801 /* Byte swap page tables if necessary */
1802 sbp2util_cpu_to_be32_buffer(sg_element,
1803 (sizeof(struct sbp2_unrestricted_page_table)) *
1804 sg_count);
1805 }
1806}
1807
1808static void sbp2_prep_command_orb_no_sg(struct sbp2_command_orb *orb,
1809 struct sbp2scsi_host_info *hi,
1810 struct sbp2_command_info *command,
1811 struct scatterlist *sgpnt,
1812 u32 orb_direction,
1813 unsigned int scsi_request_bufflen,
1814 void *scsi_request_buffer,
1815 enum dma_data_direction dma_dir)
1816{
1817 command->dma_dir = dma_dir;
1818 command->dma_size = scsi_request_bufflen;
1819 command->dma_type = CMD_DMA_SINGLE;
1820 command->cmd_dma = pci_map_single(hi->host->pdev, scsi_request_buffer,
1821 command->dma_size, command->dma_dir);
1822 orb->data_descriptor_hi = ORB_SET_NODE_ID(hi->host->node_id);
1823 orb->misc |= ORB_SET_DIRECTION(orb_direction);
1824
1825 SBP2_DMA_ALLOC("single bulk");
1826
1827 /*
1828 * Handle case where we get a command w/o s/g enabled (but
1829 * check for transfers larger than 64K)
1830 */
1831 if (scsi_request_bufflen <= SBP2_MAX_SG_ELEMENT_LENGTH) {
1832
1833 orb->data_descriptor_lo = command->cmd_dma;
1834 orb->misc |= ORB_SET_DATA_SIZE(scsi_request_bufflen);
1835
1836 } else {
1837 struct sbp2_unrestricted_page_table *sg_element =
1838 &command->scatter_gather_element[0];
1839 u32 sg_count, sg_len;
1840 dma_addr_t sg_addr;
1841
1842 /*
1843 * Need to turn this into page tables, since the
1844 * buffer is too large.
1845 */
1846 orb->data_descriptor_lo = command->sge_dma;
1847
1848 /* Use page tables (s/g) */
1849 orb->misc |= ORB_SET_PAGE_TABLE_PRESENT(0x1);
1850
1851 /*
1852 * fill out our sbp-2 page tables (and split up
1853 * the large buffer)
1854 */
1855 sg_count = 0;
1856 sg_len = scsi_request_bufflen;
1857 sg_addr = command->cmd_dma;
1858 while (sg_len) {
1859 sg_element[sg_count].segment_base_lo = sg_addr;
1860 if (sg_len > SBP2_MAX_SG_ELEMENT_LENGTH) {
1861 sg_element[sg_count].length_segment_base_hi =
1862 PAGE_TABLE_SET_SEGMENT_LENGTH(SBP2_MAX_SG_ELEMENT_LENGTH);
1863 sg_addr += SBP2_MAX_SG_ELEMENT_LENGTH;
1864 sg_len -= SBP2_MAX_SG_ELEMENT_LENGTH;
1865 } else {
1866 sg_element[sg_count].length_segment_base_hi =
1867 PAGE_TABLE_SET_SEGMENT_LENGTH(sg_len);
1868 sg_len = 0;
1869 }
1870 sg_count++;
1871 }
1872
1873 /* Number of page table (s/g) elements */
1874 orb->misc |= ORB_SET_DATA_SIZE(sg_count);
1875
1876 sbp2util_packet_dump(sg_element,
1877 (sizeof(struct sbp2_unrestricted_page_table)) * sg_count,
1878 "sbp2 s/g list", command->sge_dma);
1879
1880 /* Byte swap page tables if necessary */
1881 sbp2util_cpu_to_be32_buffer(sg_element,
1882 (sizeof(struct sbp2_unrestricted_page_table)) *
1883 sg_count);
1884 }
1885}
1886
1da177e4
LT
1887/*
1888 * This function is called to create the actual command orb and s/g list
1889 * out of the scsi command itself.
1890 */
cf8d2c09
SR
1891static void sbp2_create_command_orb(struct scsi_id_instance_data *scsi_id,
1892 struct sbp2_command_info *command,
1893 unchar *scsi_cmd,
1894 unsigned int scsi_use_sg,
1895 unsigned int scsi_request_bufflen,
1896 void *scsi_request_buffer,
1897 enum dma_data_direction dma_dir)
1da177e4
LT
1898{
1899 struct sbp2scsi_host_info *hi = scsi_id->hi;
a237f35f 1900 struct scatterlist *sgpnt = (struct scatterlist *)scsi_request_buffer;
1da177e4 1901 struct sbp2_command_orb *command_orb = &command->command_orb;
cf8d2c09 1902 u32 orb_direction;
1da177e4
LT
1903
1904 /*
1905 * Set-up our command ORB..
1906 *
1907 * NOTE: We're doing unrestricted page tables (s/g), as this is
1908 * best performance (at least with the devices I have). This means
1909 * that data_size becomes the number of s/g elements, and
1910 * page_size should be zero (for unrestricted).
1911 */
1912 command_orb->next_ORB_hi = ORB_SET_NULL_PTR(1);
1913 command_orb->next_ORB_lo = 0x0;
1914 command_orb->misc = ORB_SET_MAX_PAYLOAD(scsi_id->max_payload_size);
1915 command_orb->misc |= ORB_SET_SPEED(scsi_id->speed_code);
a237f35f 1916 command_orb->misc |= ORB_SET_NOTIFY(1); /* Notify us when complete */
1da177e4 1917
43863eba 1918 if (dma_dir == DMA_NONE)
a237f35f 1919 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
43863eba 1920 else if (dma_dir == DMA_TO_DEVICE && scsi_request_bufflen)
a237f35f 1921 orb_direction = ORB_DIRECTION_WRITE_TO_MEDIA;
43863eba 1922 else if (dma_dir == DMA_FROM_DEVICE && scsi_request_bufflen)
a237f35f 1923 orb_direction = ORB_DIRECTION_READ_FROM_MEDIA;
43863eba
SR
1924 else {
1925 SBP2_WARN("Falling back to DMA_NONE");
1926 orb_direction = ORB_DIRECTION_NO_DATA_TRANSFER;
1da177e4
LT
1927 }
1928
cf8d2c09 1929 /* Set-up our pagetable stuff */
1da177e4 1930 if (orb_direction == ORB_DIRECTION_NO_DATA_TRANSFER) {
1da177e4 1931 SBP2_DEBUG("No data transfer");
1da177e4
LT
1932 command_orb->data_descriptor_hi = 0x0;
1933 command_orb->data_descriptor_lo = 0x0;
1934 command_orb->misc |= ORB_SET_DIRECTION(1);
1da177e4 1935 } else if (scsi_use_sg) {
1da177e4 1936 SBP2_DEBUG("Use scatter/gather");
cf8d2c09
SR
1937 sbp2_prep_command_orb_sg(command_orb, hi, command, scsi_use_sg,
1938 sgpnt, orb_direction, dma_dir);
1da177e4 1939 } else {
1da177e4 1940 SBP2_DEBUG("No scatter/gather");
cf8d2c09
SR
1941 sbp2_prep_command_orb_no_sg(command_orb, hi, command, sgpnt,
1942 orb_direction, scsi_request_bufflen,
1943 scsi_request_buffer, dma_dir);
1da177e4
LT
1944 }
1945
cf8d2c09 1946 /* Byte swap command ORB if necessary */
1da177e4
LT
1947 sbp2util_cpu_to_be32_buffer(command_orb, sizeof(struct sbp2_command_orb));
1948
cf8d2c09 1949 /* Put our scsi command in the command ORB */
1da177e4
LT
1950 memset(command_orb->cdb, 0, 12);
1951 memcpy(command_orb->cdb, scsi_cmd, COMMAND_SIZE(*scsi_cmd));
1da177e4
LT
1952}
1953
1954/*
1955 * This function is called in order to begin a regular SBP-2 command.
1956 */
28212767 1957static void sbp2_link_orb_command(struct scsi_id_instance_data *scsi_id,
1da177e4
LT
1958 struct sbp2_command_info *command)
1959{
1960 struct sbp2scsi_host_info *hi = scsi_id->hi;
1961 struct sbp2_command_orb *command_orb = &command->command_orb;
cc078189
SR
1962 struct sbp2_command_orb *last_orb;
1963 dma_addr_t last_orb_dma;
1964 u64 addr = scsi_id->sbp2_command_block_agent_addr;
1965 quadlet_t data[2];
1966 size_t length;
1967 unsigned long flags;
1da177e4
LT
1968
1969 outstanding_orb_incr;
1970 SBP2_ORB_DEBUG("sending command orb %p, total orbs = %x",
a237f35f 1971 command_orb, global_outstanding_command_orbs);
1da177e4
LT
1972
1973 pci_dma_sync_single_for_device(hi->host->pdev, command->command_orb_dma,
1974 sizeof(struct sbp2_command_orb),
d4018d7f 1975 PCI_DMA_TODEVICE);
1da177e4
LT
1976 pci_dma_sync_single_for_device(hi->host->pdev, command->sge_dma,
1977 sizeof(command->scatter_gather_element),
1978 PCI_DMA_BIDIRECTIONAL);
1979 /*
1980 * Check to see if there are any previous orbs to use
1981 */
cc078189
SR
1982 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1983 last_orb = scsi_id->last_orb;
1984 last_orb_dma = scsi_id->last_orb_dma;
1985 if (!last_orb) {
1da177e4 1986 /*
cc078189
SR
1987 * last_orb == NULL means: We know that the target's fetch agent
1988 * is not active right now.
1da177e4 1989 */
cc078189 1990 addr += SBP2_ORB_POINTER_OFFSET;
1da177e4
LT
1991 data[0] = ORB_SET_NODE_ID(hi->host->node_id);
1992 data[1] = command->command_orb_dma;
1993 sbp2util_cpu_to_be32_buffer(data, 8);
cc078189 1994 length = 8;
1da177e4 1995 } else {
1da177e4 1996 /*
cc078189
SR
1997 * last_orb != NULL means: We know that the target's fetch agent
1998 * is (very probably) not dead or in reset state right now.
1999 * We have an ORB already sent that we can append a new one to.
2000 * The target's fetch agent may or may not have read this
2001 * previous ORB yet.
1da177e4 2002 */
cc078189
SR
2003 pci_dma_sync_single_for_cpu(hi->host->pdev, last_orb_dma,
2004 sizeof(struct sbp2_command_orb),
d4018d7f 2005 PCI_DMA_TODEVICE);
cc078189
SR
2006 last_orb->next_ORB_lo = cpu_to_be32(command->command_orb_dma);
2007 wmb();
1da177e4 2008 /* Tells hardware that this pointer is valid */
cc078189
SR
2009 last_orb->next_ORB_hi = 0;
2010 pci_dma_sync_single_for_device(hi->host->pdev, last_orb_dma,
1da177e4 2011 sizeof(struct sbp2_command_orb),
d4018d7f 2012 PCI_DMA_TODEVICE);
cc078189
SR
2013 addr += SBP2_DOORBELL_OFFSET;
2014 data[0] = 0;
2015 length = 4;
2016 }
2017 scsi_id->last_orb = command_orb;
2018 scsi_id->last_orb_dma = command->command_orb_dma;
2019 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4 2020
cc078189
SR
2021 SBP2_ORB_DEBUG("write to %s register, command orb %p",
2022 last_orb ? "DOORBELL" : "ORB_POINTER", command_orb);
28212767 2023 if (sbp2util_node_write_no_wait(scsi_id->ne, addr, data, length))
cc078189 2024 SBP2_ERR("sbp2util_node_write_no_wait failed.\n");
28212767 2025 /* We rely on SCSI EH to deal with _node_write_ failures. */
1da177e4
LT
2026}
2027
2028/*
2029 * This function is called in order to begin a regular SBP-2 command.
2030 */
2031static int sbp2_send_command(struct scsi_id_instance_data *scsi_id,
2032 struct scsi_cmnd *SCpnt,
2033 void (*done)(struct scsi_cmnd *))
2034{
2035 unchar *cmd = (unchar *) SCpnt->cmnd;
2036 unsigned int request_bufflen = SCpnt->request_bufflen;
2037 struct sbp2_command_info *command;
2038
d024ebc6 2039 SBP2_DEBUG_ENTER();
1da177e4
LT
2040 SBP2_DEBUG("SCSI transfer size = %x", request_bufflen);
2041 SBP2_DEBUG("SCSI s/g elements = %x", (unsigned int)SCpnt->use_sg);
2042
2043 /*
2044 * Allocate a command orb and s/g structure
2045 */
2046 command = sbp2util_allocate_command_orb(scsi_id, SCpnt, done);
2047 if (!command) {
a237f35f 2048 return -EIO;
1da177e4
LT
2049 }
2050
1da177e4
LT
2051 /*
2052 * Now actually fill in the comamnd orb and sbp2 s/g list
2053 */
2054 sbp2_create_command_orb(scsi_id, command, cmd, SCpnt->use_sg,
2055 request_bufflen, SCpnt->request_buffer,
2056 SCpnt->sc_data_direction);
1da177e4
LT
2057
2058 sbp2util_packet_dump(&command->command_orb, sizeof(struct sbp2_command_orb),
2059 "sbp2 command orb", command->command_orb_dma);
2060
1da177e4
LT
2061 /*
2062 * Link up the orb, and ring the doorbell if needed
2063 */
2064 sbp2_link_orb_command(scsi_id, command);
2065
a237f35f 2066 return 0;
1da177e4
LT
2067}
2068
1da177e4
LT
2069/*
2070 * Translates SBP-2 status into SCSI sense data for check conditions
2071 */
2072static unsigned int sbp2_status_to_sense_data(unchar *sbp2_status, unchar *sense_data)
2073{
d024ebc6 2074 SBP2_DEBUG_ENTER();
1da177e4
LT
2075
2076 /*
2077 * Ok, it's pretty ugly... ;-)
2078 */
2079 sense_data[0] = 0x70;
2080 sense_data[1] = 0x0;
2081 sense_data[2] = sbp2_status[9];
2082 sense_data[3] = sbp2_status[12];
2083 sense_data[4] = sbp2_status[13];
2084 sense_data[5] = sbp2_status[14];
2085 sense_data[6] = sbp2_status[15];
2086 sense_data[7] = 10;
2087 sense_data[8] = sbp2_status[16];
2088 sense_data[9] = sbp2_status[17];
2089 sense_data[10] = sbp2_status[18];
2090 sense_data[11] = sbp2_status[19];
2091 sense_data[12] = sbp2_status[10];
2092 sense_data[13] = sbp2_status[11];
2093 sense_data[14] = sbp2_status[20];
2094 sense_data[15] = sbp2_status[21];
2095
a237f35f 2096 return sbp2_status[8] & 0x3f; /* return scsi status */
1da177e4
LT
2097}
2098
1da177e4
LT
2099/*
2100 * This function deals with status writes from the SBP-2 device
2101 */
3e98eab4
SR
2102static int sbp2_handle_status_write(struct hpsb_host *host, int nodeid,
2103 int destid, quadlet_t *data, u64 addr,
2104 size_t length, u16 fl)
1da177e4
LT
2105{
2106 struct sbp2scsi_host_info *hi;
2107 struct scsi_id_instance_data *scsi_id = NULL, *scsi_id_tmp;
1da177e4 2108 struct scsi_cmnd *SCpnt = NULL;
3e98eab4 2109 struct sbp2_status_block *sb;
1da177e4
LT
2110 u32 scsi_status = SBP2_SCSI_STATUS_GOOD;
2111 struct sbp2_command_info *command;
79456197 2112 unsigned long flags;
1da177e4 2113
d024ebc6 2114 SBP2_DEBUG_ENTER();
1da177e4
LT
2115
2116 sbp2util_packet_dump(data, length, "sbp2 status write by device", (u32)addr);
2117
2118 if (!host) {
2119 SBP2_ERR("host is NULL - this is bad!");
a237f35f 2120 return RCODE_ADDRESS_ERROR;
1da177e4
LT
2121 }
2122
2123 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
2124
2125 if (!hi) {
2126 SBP2_ERR("host info is NULL - this is bad!");
a237f35f 2127 return RCODE_ADDRESS_ERROR;
1da177e4
LT
2128 }
2129
2130 /*
35bdddb8
SR
2131 * Find our scsi_id structure by looking at the status fifo address
2132 * written to by the sbp2 device.
1da177e4 2133 */
1da177e4 2134 list_for_each_entry(scsi_id_tmp, &hi->scsi_ids, scsi_list) {
35bdddb8
SR
2135 if (scsi_id_tmp->ne->nodeid == nodeid &&
2136 scsi_id_tmp->status_fifo_addr == addr) {
1da177e4
LT
2137 scsi_id = scsi_id_tmp;
2138 break;
2139 }
2140 }
2141
2142 if (!scsi_id) {
2143 SBP2_ERR("scsi_id is NULL - device is gone?");
a237f35f 2144 return RCODE_ADDRESS_ERROR;
1da177e4
LT
2145 }
2146
2147 /*
3e98eab4
SR
2148 * Put response into scsi_id status fifo buffer. The first two bytes
2149 * come in big endian bit order. Often the target writes only a
2150 * truncated status block, minimally the first two quadlets. The rest
2151 * is implied to be zeros.
1da177e4 2152 */
3e98eab4
SR
2153 sb = &scsi_id->status_block;
2154 memset(sb->command_set_dependent, 0, sizeof(sb->command_set_dependent));
2155 memcpy(sb, data, length);
2156 sbp2util_be32_to_cpu_buffer(sb, 8);
1da177e4
LT
2157
2158 /*
3e98eab4
SR
2159 * Handle command ORB status here if necessary. First, need to match
2160 * status with command.
1da177e4 2161 */
3e98eab4 2162 command = sbp2util_find_command_for_orb(scsi_id, sb->ORB_offset_lo);
1da177e4
LT
2163 if (command) {
2164
2165 SBP2_DEBUG("Found status for command ORB");
2166 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2167 sizeof(struct sbp2_command_orb),
d4018d7f 2168 PCI_DMA_TODEVICE);
1da177e4
LT
2169 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2170 sizeof(command->scatter_gather_element),
2171 PCI_DMA_BIDIRECTIONAL);
2172
2173 SBP2_ORB_DEBUG("matched command orb %p", &command->command_orb);
2174 outstanding_orb_decr;
2175
2176 /*
3e98eab4
SR
2177 * Matched status with command, now grab scsi command pointers
2178 * and check status.
1da177e4
LT
2179 */
2180 SCpnt = command->Current_SCpnt;
24c7cd06 2181 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4 2182 sbp2util_mark_command_completed(scsi_id, command);
24c7cd06 2183 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2184
2185 if (SCpnt) {
1da177e4 2186 /*
3e98eab4 2187 * See if the target stored any scsi status information.
1da177e4 2188 */
3e98eab4 2189 if (STATUS_GET_LENGTH(sb->ORB_offset_hi_misc) > 1) {
1da177e4 2190 SBP2_DEBUG("CHECK CONDITION");
3e98eab4
SR
2191 scsi_status = sbp2_status_to_sense_data(
2192 (unchar *)sb, SCpnt->sense_buffer);
1da177e4
LT
2193 }
2194
2195 /*
3e98eab4
SR
2196 * Check to see if the dead bit is set. If so, we'll
2197 * have to initiate a fetch agent reset.
1da177e4 2198 */
3e98eab4
SR
2199 if (STATUS_GET_DEAD_BIT(sb->ORB_offset_hi_misc)) {
2200 SBP2_DEBUG("Dead bit set - "
2201 "initiating fetch agent reset");
1da177e4
LT
2202 sbp2_agent_reset(scsi_id, 0);
2203 }
2204
2205 SBP2_ORB_DEBUG("completing command orb %p", &command->command_orb);
2206 }
2207
2208 /*
cc078189
SR
2209 * Check here to see if there are no commands in-use. If there
2210 * are none, we know that the fetch agent left the active state
2211 * _and_ that we did not reactivate it yet. Therefore clear
2212 * last_orb so that next time we write directly to the
2213 * ORB_POINTER register. That way the fetch agent does not need
2214 * to refetch the next_ORB.
1da177e4 2215 */
79456197 2216 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
cc078189 2217 if (list_empty(&scsi_id->sbp2_command_orb_inuse))
1da177e4 2218 scsi_id->last_orb = NULL;
79456197 2219 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2220
2221 } else {
1da177e4
LT
2222 /*
2223 * It's probably a login/logout/reconnect status.
2224 */
3e98eab4
SR
2225 if ((sb->ORB_offset_lo == scsi_id->reconnect_orb_dma) ||
2226 (sb->ORB_offset_lo == scsi_id->login_orb_dma) ||
2227 (sb->ORB_offset_lo == scsi_id->query_logins_orb_dma) ||
2228 (sb->ORB_offset_lo == scsi_id->logout_orb_dma))
1da177e4 2229 atomic_set(&scsi_id->sbp2_login_complete, 1);
1da177e4
LT
2230 }
2231
2232 if (SCpnt) {
1da177e4
LT
2233 SBP2_DEBUG("Completing SCSI command");
2234 sbp2scsi_complete_command(scsi_id, scsi_status, SCpnt,
2235 command->Current_done);
2236 SBP2_ORB_DEBUG("command orb completed");
2237 }
2238
a237f35f 2239 return RCODE_COMPLETE;
1da177e4
LT
2240}
2241
1da177e4
LT
2242/**************************************
2243 * SCSI interface related section
2244 **************************************/
2245
2246/*
2247 * This routine is the main request entry routine for doing I/O. It is
2248 * called from the scsi stack directly.
2249 */
2250static int sbp2scsi_queuecommand(struct scsi_cmnd *SCpnt,
2251 void (*done)(struct scsi_cmnd *))
2252{
2253 struct scsi_id_instance_data *scsi_id =
2254 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2255 struct sbp2scsi_host_info *hi;
abd559b1 2256 int result = DID_NO_CONNECT << 16;
1da177e4 2257
d024ebc6
SR
2258 SBP2_DEBUG_ENTER();
2259#if (CONFIG_IEEE1394_SBP2_DEBUG >= 2) || defined(CONFIG_IEEE1394_SBP2_PACKET_DUMP)
2260 scsi_print_command(SCpnt);
2261#endif
1da177e4 2262
abd559b1
JM
2263 if (!sbp2util_node_is_available(scsi_id))
2264 goto done;
1da177e4
LT
2265
2266 hi = scsi_id->hi;
2267
2268 if (!hi) {
2269 SBP2_ERR("sbp2scsi_host_info is NULL - this is bad!");
abd559b1 2270 goto done;
1da177e4
LT
2271 }
2272
2273 /*
2274 * Until we handle multiple luns, just return selection time-out
2275 * to any IO directed at non-zero LUNs
2276 */
abd559b1
JM
2277 if (SCpnt->device->lun)
2278 goto done;
1da177e4
LT
2279
2280 /*
2281 * Check for request sense command, and handle it here
2282 * (autorequest sense)
2283 */
2284 if (SCpnt->cmnd[0] == REQUEST_SENSE) {
2285 SBP2_DEBUG("REQUEST_SENSE");
2286 memcpy(SCpnt->request_buffer, SCpnt->sense_buffer, SCpnt->request_bufflen);
2287 memset(SCpnt->sense_buffer, 0, sizeof(SCpnt->sense_buffer));
2288 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_GOOD, SCpnt, done);
abd559b1 2289 return 0;
1da177e4
LT
2290 }
2291
2292 /*
2293 * Check to see if we are in the middle of a bus reset.
2294 */
2295 if (!hpsb_node_entry_valid(scsi_id->ne)) {
2296 SBP2_ERR("Bus reset in progress - rejecting command");
abd559b1
JM
2297 result = DID_BUS_BUSY << 16;
2298 goto done;
1da177e4
LT
2299 }
2300
43863eba
SR
2301 /*
2302 * Bidirectional commands are not yet implemented,
2303 * and unknown transfer direction not handled.
2304 */
2305 if (SCpnt->sc_data_direction == DMA_BIDIRECTIONAL) {
2306 SBP2_ERR("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
2307 result = DID_ERROR << 16;
2308 goto done;
2309 }
2310
1da177e4
LT
2311 /*
2312 * Try and send our SCSI command
2313 */
2314 if (sbp2_send_command(scsi_id, SCpnt, done)) {
2315 SBP2_ERR("Error sending SCSI command");
2316 sbp2scsi_complete_command(scsi_id, SBP2_SCSI_STATUS_SELECTION_TIMEOUT,
2317 SCpnt, done);
2318 }
abd559b1 2319 return 0;
1da177e4 2320
abd559b1
JM
2321done:
2322 SCpnt->result = result;
2323 done(SCpnt);
2324 return 0;
1da177e4
LT
2325}
2326
2327/*
2328 * This function is called in order to complete all outstanding SBP-2
2329 * commands (in case of resets, etc.).
2330 */
2331static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
2332 u32 status)
2333{
2334 struct sbp2scsi_host_info *hi = scsi_id->hi;
2335 struct list_head *lh;
2336 struct sbp2_command_info *command;
79456197 2337 unsigned long flags;
1da177e4 2338
d024ebc6 2339 SBP2_DEBUG_ENTER();
1da177e4 2340
79456197 2341 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2342 while (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
2343 SBP2_DEBUG("Found pending command to complete");
2344 lh = scsi_id->sbp2_command_orb_inuse.next;
2345 command = list_entry(lh, struct sbp2_command_info, list);
2346 pci_dma_sync_single_for_cpu(hi->host->pdev, command->command_orb_dma,
2347 sizeof(struct sbp2_command_orb),
d4018d7f 2348 PCI_DMA_TODEVICE);
1da177e4
LT
2349 pci_dma_sync_single_for_cpu(hi->host->pdev, command->sge_dma,
2350 sizeof(command->scatter_gather_element),
2351 PCI_DMA_BIDIRECTIONAL);
2352 sbp2util_mark_command_completed(scsi_id, command);
2353 if (command->Current_SCpnt) {
2354 command->Current_SCpnt->result = status << 16;
2355 command->Current_done(command->Current_SCpnt);
2356 }
2357 }
79456197 2358 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2359
2360 return;
2361}
2362
2363/*
2364 * This function is called in order to complete a regular SBP-2 command.
2365 *
2366 * This can be called in interrupt context.
2367 */
2368static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
2369 u32 scsi_status, struct scsi_cmnd *SCpnt,
2370 void (*done)(struct scsi_cmnd *))
2371{
d024ebc6 2372 SBP2_DEBUG_ENTER();
1da177e4
LT
2373
2374 /*
2375 * Sanity
2376 */
2377 if (!SCpnt) {
2378 SBP2_ERR("SCpnt is NULL");
2379 return;
2380 }
2381
2382 /*
2383 * If a bus reset is in progress and there was an error, don't
2384 * complete the command, just let it get retried at the end of the
2385 * bus reset.
2386 */
a237f35f
SR
2387 if (!hpsb_node_entry_valid(scsi_id->ne)
2388 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
1da177e4
LT
2389 SBP2_ERR("Bus reset in progress - retry command later");
2390 return;
2391 }
a237f35f 2392
1da177e4
LT
2393 /*
2394 * Switch on scsi status
2395 */
2396 switch (scsi_status) {
a237f35f 2397 case SBP2_SCSI_STATUS_GOOD:
8f0525ff 2398 SCpnt->result = DID_OK << 16;
a237f35f 2399 break;
1da177e4 2400
a237f35f
SR
2401 case SBP2_SCSI_STATUS_BUSY:
2402 SBP2_ERR("SBP2_SCSI_STATUS_BUSY");
2403 SCpnt->result = DID_BUS_BUSY << 16;
2404 break;
1da177e4 2405
a237f35f
SR
2406 case SBP2_SCSI_STATUS_CHECK_CONDITION:
2407 SBP2_DEBUG("SBP2_SCSI_STATUS_CHECK_CONDITION");
8f0525ff 2408 SCpnt->result = CHECK_CONDITION << 1 | DID_OK << 16;
1da177e4 2409#if CONFIG_IEEE1394_SBP2_DEBUG >= 1
a237f35f 2410 scsi_print_command(SCpnt);
d024ebc6 2411 scsi_print_sense(SBP2_DEVICE_NAME, SCpnt);
1da177e4 2412#endif
a237f35f 2413 break;
1da177e4 2414
a237f35f
SR
2415 case SBP2_SCSI_STATUS_SELECTION_TIMEOUT:
2416 SBP2_ERR("SBP2_SCSI_STATUS_SELECTION_TIMEOUT");
2417 SCpnt->result = DID_NO_CONNECT << 16;
2418 scsi_print_command(SCpnt);
2419 break;
1da177e4 2420
a237f35f
SR
2421 case SBP2_SCSI_STATUS_CONDITION_MET:
2422 case SBP2_SCSI_STATUS_RESERVATION_CONFLICT:
2423 case SBP2_SCSI_STATUS_COMMAND_TERMINATED:
2424 SBP2_ERR("Bad SCSI status = %x", scsi_status);
2425 SCpnt->result = DID_ERROR << 16;
2426 scsi_print_command(SCpnt);
2427 break;
1da177e4 2428
a237f35f
SR
2429 default:
2430 SBP2_ERR("Unsupported SCSI status = %x", scsi_status);
2431 SCpnt->result = DID_ERROR << 16;
1da177e4
LT
2432 }
2433
1da177e4
LT
2434 /*
2435 * If a bus reset is in progress and there was an error, complete
2436 * the command as busy so that it will get retried.
2437 */
a237f35f
SR
2438 if (!hpsb_node_entry_valid(scsi_id->ne)
2439 && (scsi_status != SBP2_SCSI_STATUS_GOOD)) {
1da177e4
LT
2440 SBP2_ERR("Completing command with busy (bus reset)");
2441 SCpnt->result = DID_BUS_BUSY << 16;
2442 }
2443
2444 /*
2445 * If a unit attention occurs, return busy status so it gets
2446 * retried... it could have happened because of a 1394 bus reset
2447 * or hot-plug...
8f0525ff
SR
2448 * XXX DID_BUS_BUSY is actually a bad idea because it will defy
2449 * the scsi layer's retry logic.
1da177e4
LT
2450 */
2451#if 0
2452 if ((scsi_status == SBP2_SCSI_STATUS_CHECK_CONDITION) &&
2453 (SCpnt->sense_buffer[2] == UNIT_ATTENTION)) {
2454 SBP2_DEBUG("UNIT ATTENTION - return busy");
2455 SCpnt->result = DID_BUS_BUSY << 16;
2456 }
2457#endif
2458
2459 /*
2460 * Tell scsi stack that we're done with this command
2461 */
a237f35f 2462 done(SCpnt);
1da177e4
LT
2463}
2464
abd559b1 2465static int sbp2scsi_slave_alloc(struct scsi_device *sdev)
1da177e4 2466{
a80614d1
SR
2467 struct scsi_id_instance_data *scsi_id =
2468 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2469
2470 scsi_id->sdev = sdev;
2471
24d3bf88 2472 if (scsi_id->workarounds & SBP2_WORKAROUND_INQUIRY_36)
a80614d1 2473 sdev->inquiry_len = 36;
abd559b1
JM
2474 return 0;
2475}
2476
abd559b1
JM
2477static int sbp2scsi_slave_configure(struct scsi_device *sdev)
2478{
24d3bf88
SR
2479 struct scsi_id_instance_data *scsi_id =
2480 (struct scsi_id_instance_data *)sdev->host->hostdata[0];
2481
abd559b1 2482 blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
365c786f
BC
2483 sdev->use_10_for_rw = 1;
2484 sdev->use_10_for_ms = 1;
24d3bf88
SR
2485
2486 if (sdev->type == TYPE_DISK &&
2487 scsi_id->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
2488 sdev->skip_ms_page_8 = 1;
e9a1c52c
SR
2489 if (scsi_id->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
2490 sdev->fix_capacity = 1;
31a379e1
SR
2491 if (scsi_id->ne->guid_vendor_id == 0x0010b9 && /* Maxtor's OUI */
2492 (sdev->type == TYPE_DISK || sdev->type == TYPE_RBC))
2493 sdev->allow_restart = 1;
1da177e4
LT
2494 return 0;
2495}
2496
abd559b1
JM
2497static void sbp2scsi_slave_destroy(struct scsi_device *sdev)
2498{
2499 ((struct scsi_id_instance_data *)sdev->host->hostdata[0])->sdev = NULL;
2500 return;
2501}
2502
1da177e4
LT
2503/*
2504 * Called by scsi stack when something has really gone wrong. Usually
2505 * called when a command has timed-out for some reason.
2506 */
2507static int sbp2scsi_abort(struct scsi_cmnd *SCpnt)
2508{
2509 struct scsi_id_instance_data *scsi_id =
2510 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2511 struct sbp2scsi_host_info *hi = scsi_id->hi;
2512 struct sbp2_command_info *command;
24c7cd06 2513 unsigned long flags;
1da177e4
LT
2514
2515 SBP2_ERR("aborting sbp2 command");
2516 scsi_print_command(SCpnt);
2517
abd559b1 2518 if (sbp2util_node_is_available(scsi_id)) {
1da177e4
LT
2519
2520 /*
2521 * Right now, just return any matching command structures
2522 * to the free pool.
2523 */
24c7cd06 2524 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2525 command = sbp2util_find_command_for_SCpnt(scsi_id, SCpnt);
2526 if (command) {
2527 SBP2_DEBUG("Found command to abort");
2528 pci_dma_sync_single_for_cpu(hi->host->pdev,
2529 command->command_orb_dma,
2530 sizeof(struct sbp2_command_orb),
d4018d7f 2531 PCI_DMA_TODEVICE);
1da177e4
LT
2532 pci_dma_sync_single_for_cpu(hi->host->pdev,
2533 command->sge_dma,
2534 sizeof(command->scatter_gather_element),
2535 PCI_DMA_BIDIRECTIONAL);
2536 sbp2util_mark_command_completed(scsi_id, command);
2537 if (command->Current_SCpnt) {
2538 command->Current_SCpnt->result = DID_ABORT << 16;
2539 command->Current_done(command->Current_SCpnt);
2540 }
2541 }
24c7cd06 2542 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
1da177e4
LT
2543
2544 /*
2545 * Initiate a fetch agent reset.
2546 */
2547 sbp2_agent_reset(scsi_id, 0);
2548 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
2549 }
2550
a237f35f 2551 return SUCCESS;
1da177e4
LT
2552}
2553
2554/*
2555 * Called by scsi stack when something has really gone wrong.
2556 */
abd559b1 2557static int sbp2scsi_reset(struct scsi_cmnd *SCpnt)
1da177e4
LT
2558{
2559 struct scsi_id_instance_data *scsi_id =
2560 (struct scsi_id_instance_data *)SCpnt->device->host->hostdata[0];
2561
2562 SBP2_ERR("reset requested");
2563
abd559b1 2564 if (sbp2util_node_is_available(scsi_id)) {
1da177e4
LT
2565 SBP2_ERR("Generating sbp2 fetch agent reset");
2566 sbp2_agent_reset(scsi_id, 0);
2567 }
2568
abd559b1 2569 return SUCCESS;
94d0e7b8
JG
2570}
2571
a237f35f
SR
2572static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
2573 struct device_attribute *attr,
2574 char *buf)
1da177e4
LT
2575{
2576 struct scsi_device *sdev;
2577 struct scsi_id_instance_data *scsi_id;
2578 int lun;
2579
2580 if (!(sdev = to_scsi_device(dev)))
2581 return 0;
2582
2583 if (!(scsi_id = (struct scsi_id_instance_data *)sdev->host->hostdata[0]))
2584 return 0;
2585
e309fc6d 2586 lun = ORB_SET_LUN(scsi_id->sbp2_lun);
1da177e4
LT
2587
2588 return sprintf(buf, "%016Lx:%d:%d\n", (unsigned long long)scsi_id->ne->guid,
2589 scsi_id->ud->id, lun);
2590}
2591static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
2592
2593static struct device_attribute *sbp2_sysfs_sdev_attrs[] = {
2594 &dev_attr_ieee1394_id,
2595 NULL
2596};
2597
2598MODULE_AUTHOR("Ben Collins <bcollins@debian.org>");
2599MODULE_DESCRIPTION("IEEE-1394 SBP-2 protocol driver");
2600MODULE_SUPPORTED_DEVICE(SBP2_DEVICE_NAME);
2601MODULE_LICENSE("GPL");
2602
2603/* SCSI host template */
2604static struct scsi_host_template scsi_driver_template = {
2605 .module = THIS_MODULE,
2606 .name = "SBP-2 IEEE-1394",
2607 .proc_name = SBP2_DEVICE_NAME,
1da177e4
LT
2608 .queuecommand = sbp2scsi_queuecommand,
2609 .eh_abort_handler = sbp2scsi_abort,
2610 .eh_device_reset_handler = sbp2scsi_reset,
abd559b1 2611 .slave_alloc = sbp2scsi_slave_alloc,
1da177e4 2612 .slave_configure = sbp2scsi_slave_configure,
abd559b1 2613 .slave_destroy = sbp2scsi_slave_destroy,
1da177e4
LT
2614 .this_id = -1,
2615 .sg_tablesize = SG_ALL,
2616 .use_clustering = ENABLE_CLUSTERING,
2617 .cmd_per_lun = SBP2_MAX_CMDS,
2618 .can_queue = SBP2_MAX_CMDS,
2619 .emulated = 1,
2620 .sdev_attrs = sbp2_sysfs_sdev_attrs,
2621};
2622
2623static int sbp2_module_init(void)
2624{
2625 int ret;
2626
d024ebc6 2627 SBP2_DEBUG_ENTER();
1da177e4 2628
1da177e4
LT
2629 /* Module load debug option to force one command at a time (serializing I/O) */
2630 if (serialize_io) {
2bab359a
JM
2631 SBP2_INFO("Driver forced to serialize I/O (serialize_io=1)");
2632 SBP2_INFO("Try serialize_io=0 for better performance");
1da177e4
LT
2633 scsi_driver_template.can_queue = 1;
2634 scsi_driver_template.cmd_per_lun = 1;
2635 }
2636
24d3bf88
SR
2637 if (sbp2_default_workarounds & SBP2_WORKAROUND_128K_MAX_TRANS &&
2638 (max_sectors * 512) > (128 * 1024))
2639 max_sectors = 128 * 1024 / 512;
1da177e4
LT
2640 scsi_driver_template.max_sectors = max_sectors;
2641
1da177e4
LT
2642 /* Register our high level driver with 1394 stack */
2643 hpsb_register_highlevel(&sbp2_highlevel);
2644
2645 ret = hpsb_register_protocol(&sbp2_driver);
2646 if (ret) {
2647 SBP2_ERR("Failed to register protocol");
2648 hpsb_unregister_highlevel(&sbp2_highlevel);
2649 return ret;
2650 }
2651
2652 return 0;
2653}
2654
2655static void __exit sbp2_module_exit(void)
2656{
d024ebc6 2657 SBP2_DEBUG_ENTER();
1da177e4
LT
2658
2659 hpsb_unregister_protocol(&sbp2_driver);
2660
2661 hpsb_unregister_highlevel(&sbp2_highlevel);
2662}
2663
2664module_init(sbp2_module_init);
2665module_exit(sbp2_module_exit);