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
41 #include <linux/config.h>
42 #include <linux/kernel.h>
43 #include <linux/list.h>
44 #include <linux/string.h>
45 #include <linux/stringify.h>
46 #include <linux/slab.h>
47 #include <linux/interrupt.h>
48 #include <linux/fs.h>
49 #include <linux/poll.h>
50 #include <linux/module.h>
51 #include <linux/moduleparam.h>
52 #include <linux/types.h>
53 #include <linux/delay.h>
54 #include <linux/sched.h>
55 #include <linux/blkdev.h>
56 #include <linux/smp_lock.h>
57 #include <linux/init.h>
58 #include <linux/pci.h>
59
60 #include <asm/current.h>
61 #include <asm/uaccess.h>
62 #include <asm/io.h>
63 #include <asm/byteorder.h>
64 #include <asm/atomic.h>
65 #include <asm/system.h>
66 #include <asm/scatterlist.h>
67
68 #include <scsi/scsi.h>
69 #include <scsi/scsi_cmnd.h>
70 #include <scsi/scsi_dbg.h>
71 #include <scsi/scsi_device.h>
72 #include <scsi/scsi_host.h>
73
74 #include "csr1212.h"
75 #include "ieee1394.h"
76 #include "ieee1394_types.h"
77 #include "ieee1394_core.h"
78 #include "nodemgr.h"
79 #include "hosts.h"
80 #include "highlevel.h"
81 #include "ieee1394_transactions.h"
82 #include "sbp2.h"
83
84 /*
85 * Module load parameter definitions
86 */
87
88 /*
89 * Change max_speed on module load if you have a bad IEEE-1394
90 * controller that has trouble running 2KB packets at 400mb.
91 *
92 * NOTE: On certain OHCI parts I have seen short packets on async transmit
93 * (probably due to PCI latency/throughput issues with the part). You can
94 * bump down the speed if you are running into problems.
95 */
96 static int max_speed = IEEE1394_SPEED_MAX;
97 module_param(max_speed, int, 0644);
98 MODULE_PARM_DESC(max_speed, "Force max speed (3 = 800mb, 2 = 400mb, 1 = 200mb, 0 = 100mb)");
99
100 /*
101 * Set serialize_io to 1 if you'd like only one scsi command sent
102 * down to us at a time (debugging). This might be necessary for very
103 * badly behaved sbp2 devices.
104 *
105 * TODO: Make this configurable per device.
106 */
107 static int serialize_io = 1;
108 module_param(serialize_io, int, 0444);
109 MODULE_PARM_DESC(serialize_io, "Serialize I/O coming from scsi drivers (default = 1, faster = 0)");
110
111 /*
112 * Bump up max_sectors if you'd like to support very large sized
113 * transfers. Please note that some older sbp2 bridge chips are broken for
114 * transfers greater or equal to 128KB. Default is a value of 255
115 * sectors, or just under 128KB (at 512 byte sector size). I can note that
116 * the Oxsemi sbp2 chipsets have no problems supporting very large
117 * transfer sizes.
118 */
119 static int max_sectors = SBP2_MAX_SECTORS;
120 module_param(max_sectors, int, 0444);
121 MODULE_PARM_DESC(max_sectors, "Change max sectors per I/O supported (default = "
122 __stringify(SBP2_MAX_SECTORS) ")");
123
124 /*
125 * Exclusive login to sbp2 device? In most cases, the sbp2 driver should
126 * do an exclusive login, as it's generally unsafe to have two hosts
127 * talking to a single sbp2 device at the same time (filesystem coherency,
128 * etc.). If you're running an sbp2 device that supports multiple logins,
129 * and you're either running read-only filesystems or some sort of special
130 * filesystem supporting multiple hosts (one such filesystem is OpenGFS,
131 * see opengfs.sourceforge.net for more info), then set exclusive_login
132 * to zero. Note: The Oxsemi OXFW911 sbp2 chipset supports up to four
133 * concurrent logins.
134 */
135 static int exclusive_login = 1;
136 module_param(exclusive_login, int, 0644);
137 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device (default = 1)");
138
139 /*
140 * If any of the following workarounds is required for your device to work,
141 * please submit the kernel messages logged by sbp2 to the linux1394-devel
142 * mailing list.
143 *
144 * - 128kB max transfer
145 * Limit transfer size. Necessary for some old bridges.
146 *
147 * - 36 byte inquiry
148 * When scsi_mod probes the device, let the inquiry command look like that
149 * from MS Windows.
150 *
151 * - skip mode page 8
152 * Suppress sending of mode_sense for mode page 8 if the device pretends to
153 * support the SCSI Primary Block commands instead of Reduced Block Commands.
154 *
155 * - fix capacity
156 * Tell sd_mod to correct the last sector number reported by read_capacity.
157 * Avoids access beyond actual disk limits on devices with an off-by-one bug.
158 * Don't use this with devices which don't have this bug.
159 *
160 * - override internal blacklist
161 * Instead of adding to the built-in blacklist, use only the workarounds
162 * specified in the module load parameter.
163 * Useful if a blacklist entry interfered with a non-broken device.
164 */
165 static int sbp2_default_workarounds;
166 module_param_named(workarounds, sbp2_default_workarounds, int, 0644);
167 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
168 ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
169 ", 36 byte inquiry = " __stringify(SBP2_WORKAROUND_INQUIRY_36)
170 ", skip mode page 8 = " __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
171 ", fix capacity = " __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
172 ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
173 ", or a combination)");
174
175 /* legacy parameter */
176 static int force_inquiry_hack;
177 module_param(force_inquiry_hack, int, 0644);
178 MODULE_PARM_DESC(force_inquiry_hack, "Deprecated, use 'workarounds'");
179
180 /*
181 * Export information about protocols/devices supported by this driver.
182 */
183 static struct ieee1394_device_id sbp2_id_table[] = {
184 {
185 .match_flags = IEEE1394_MATCH_SPECIFIER_ID | IEEE1394_MATCH_VERSION,
186 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY & 0xffffff,
187 .version = SBP2_SW_VERSION_ENTRY & 0xffffff},
188 {}
189 };
190
191 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
192
193 /*
194 * Debug levels, configured via kernel config, or enable here.
195 */
196
197 #define CONFIG_IEEE1394_SBP2_DEBUG 0
198 /* #define CONFIG_IEEE1394_SBP2_DEBUG_ORBS */
199 /* #define CONFIG_IEEE1394_SBP2_DEBUG_DMA */
200 /* #define CONFIG_IEEE1394_SBP2_DEBUG 1 */
201 /* #define CONFIG_IEEE1394_SBP2_DEBUG 2 */
202 /* #define CONFIG_IEEE1394_SBP2_PACKET_DUMP */
203
204 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_ORBS
205 #define SBP2_ORB_DEBUG(fmt, args...) HPSB_ERR("sbp2(%s): "fmt, __FUNCTION__, ## args)
206 static u32 global_outstanding_command_orbs = 0;
207 #define outstanding_orb_incr global_outstanding_command_orbs++
208 #define outstanding_orb_decr global_outstanding_command_orbs--
209 #else
210 #define SBP2_ORB_DEBUG(fmt, args...)
211 #define outstanding_orb_incr
212 #define outstanding_orb_decr
213 #endif
214
215 #ifdef CONFIG_IEEE1394_SBP2_DEBUG_DMA
216 #define SBP2_DMA_ALLOC(fmt, args...) \
217 HPSB_ERR("sbp2(%s)alloc(%d): "fmt, __FUNCTION__, \
218 ++global_outstanding_dmas, ## args)
219 #define SBP2_DMA_FREE(fmt, args...) \
220 HPSB_ERR("sbp2(%s)free(%d): "fmt, __FUNCTION__, \
221 --global_outstanding_dmas, ## args)
222 static u32 global_outstanding_dmas = 0;
223 #else
224 #define SBP2_DMA_ALLOC(fmt, args...)
225 #define SBP2_DMA_FREE(fmt, args...)
226 #endif
227
228 #if CONFIG_IEEE1394_SBP2_DEBUG >= 2
229 #define SBP2_DEBUG(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
230 #define SBP2_INFO(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
231 #define SBP2_NOTICE(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
232 #define SBP2_WARN(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
233 #elif CONFIG_IEEE1394_SBP2_DEBUG == 1
234 #define SBP2_DEBUG(fmt, args...) HPSB_DEBUG("sbp2: "fmt, ## args)
235 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
236 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
237 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
238 #else
239 #define SBP2_DEBUG(fmt, args...)
240 #define SBP2_INFO(fmt, args...) HPSB_INFO("sbp2: "fmt, ## args)
241 #define SBP2_NOTICE(fmt, args...) HPSB_NOTICE("sbp2: "fmt, ## args)
242 #define SBP2_WARN(fmt, args...) HPSB_WARN("sbp2: "fmt, ## args)
243 #endif
244
245 #define SBP2_ERR(fmt, args...) HPSB_ERR("sbp2: "fmt, ## args)
246 #define SBP2_DEBUG_ENTER() SBP2_DEBUG("%s", __FUNCTION__)
247
248 /*
249 * Globals
250 */
251
252 static void sbp2scsi_complete_all_commands(struct scsi_id_instance_data *scsi_id,
253 u32 status);
254
255 static void sbp2scsi_complete_command(struct scsi_id_instance_data *scsi_id,
256 u32 scsi_status, struct scsi_cmnd *SCpnt,
257 void (*done)(struct scsi_cmnd *));
258
259 static struct scsi_host_template scsi_driver_template;
260
261 static const u8 sbp2_speedto_max_payload[] = { 0x7, 0x8, 0x9, 0xA, 0xB, 0xC };
262
263 static void sbp2_host_reset(struct hpsb_host *host);
264
265 static int sbp2_probe(struct device *dev);
266 static int sbp2_remove(struct device *dev);
267 static int sbp2_update(struct unit_directory *ud);
268
269 static struct hpsb_highlevel sbp2_highlevel = {
270 .name = SBP2_DEVICE_NAME,
271 .host_reset = sbp2_host_reset,
272 };
273
274 static struct hpsb_address_ops sbp2_ops = {
275 .write = sbp2_handle_status_write
276 };
277
278 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
279 static struct hpsb_address_ops sbp2_physdma_ops = {
280 .read = sbp2_handle_physdma_read,
281 .write = sbp2_handle_physdma_write,
282 };
283 #endif
284
285 static struct hpsb_protocol_driver sbp2_driver = {
286 .name = "SBP2 Driver",
287 .id_table = sbp2_id_table,
288 .update = sbp2_update,
289 .driver = {
290 .name = SBP2_DEVICE_NAME,
291 .bus = &ieee1394_bus_type,
292 .probe = sbp2_probe,
293 .remove = sbp2_remove,
294 },
295 };
296
297 /*
298 * List of devices with known bugs.
299 *
300 * The firmware_revision field, masked with 0xffff00, is the best indicator
301 * for the type of bridge chip of a device. It yields a few false positives
302 * but this did not break correctly behaving devices so far.
303 */
304 static const struct {
305 u32 firmware_revision;
306 u32 model_id;
307 unsigned workarounds;
308 } sbp2_workarounds_table[] = {
309 /* TSB42AA9 */ {
310 .firmware_revision = 0x002800,
311 .workarounds = SBP2_WORKAROUND_INQUIRY_36 |
312 SBP2_WORKAROUND_MODE_SENSE_8,
313 },
314 /* Initio bridges, actually only needed for some older ones */ {
315 .firmware_revision = 0x000200,
316 .workarounds = SBP2_WORKAROUND_INQUIRY_36,
317 },
318 /* Symbios bridge */ {
319 .firmware_revision = 0xa0b800,
320 .workarounds = SBP2_WORKAROUND_128K_MAX_TRANS,
321 },
322 /*
323 * Note about the following Apple iPod blacklist entries:
324 *
325 * There are iPods (2nd gen, 3rd gen) with model_id==0. Since our
326 * matching logic treats 0 as a wildcard, we cannot match this ID
327 * without rewriting the matching routine. Fortunately these iPods
328 * do not feature the read_capacity bug according to one report.
329 * Read_capacity behaviour as well as model_id could change due to
330 * Apple-supplied firmware updates though.
331 */
332 /* iPod 4th generation */ {
333 .firmware_revision = 0x0a2700,
334 .model_id = 0x000021,
335 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
336 },
337 /* iPod mini */ {
338 .firmware_revision = 0x0a2700,
339 .model_id = 0x000023,
340 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
341 },
342 /* iPod Photo */ {
343 .firmware_revision = 0x0a2700,
344 .model_id = 0x00007e,
345 .workarounds = SBP2_WORKAROUND_FIX_CAPACITY,
346 }
347 };
348
349 /**************************************
350 * General utility functions
351 **************************************/
352
353 #ifndef __BIG_ENDIAN
354 /*
355 * Converts a buffer from be32 to cpu byte ordering. Length is in bytes.
356 */
357 static __inline__ void sbp2util_be32_to_cpu_buffer(void *buffer, int length)
358 {
359 u32 *temp = buffer;
360
361 for (length = (length >> 2); length--; )
362 temp[length] = be32_to_cpu(temp[length]);
363
364 return;
365 }
366
367 /*
368 * Converts a buffer from cpu to be32 byte ordering. Length is in bytes.
369 */
370 static __inline__ void sbp2util_cpu_to_be32_buffer(void *buffer, int length)
371 {
372 u32 *temp = buffer;
373
374 for (length = (length >> 2); length--; )
375 temp[length] = cpu_to_be32(temp[length]);
376
377 return;
378 }
379 #else /* BIG_ENDIAN */
380 /* Why waste the cpu cycles? */
381 #define sbp2util_be32_to_cpu_buffer(x,y)
382 #define sbp2util_cpu_to_be32_buffer(x,y)
383 #endif
384
385 #ifdef CONFIG_IEEE1394_SBP2_PACKET_DUMP
386 /*
387 * Debug packet dump routine. Length is in bytes.
388 */
389 static void sbp2util_packet_dump(void *buffer, int length, char *dump_name,
390 u32 dump_phys_addr)
391 {
392 int i;
393 unsigned char *dump = buffer;
394
395 if (!dump || !length || !dump_name)
396 return;
397
398 if (dump_phys_addr)
399 printk("[%s, 0x%x]", dump_name, dump_phys_addr);
400 else
401 printk("[%s]", dump_name);
402 for (i = 0; i < length; i++) {
403 if (i > 0x3f) {
404 printk("\n ...");
405 break;
406 }
407 if ((i & 0x3) == 0)
408 printk(" ");
409 if ((i & 0xf) == 0)
410 printk("\n ");
411 printk("%02x ", (int)dump[i]);
412 }
413 printk("\n");
414
415 return;
416 }
417 #else
418 #define sbp2util_packet_dump(w,x,y,z)
419 #endif
420
421 /*
422 * Goofy routine that basically does a down_timeout function.
423 */
424 static int sbp2util_down_timeout(atomic_t *done, int timeout)
425 {
426 int i;
427
428 for (i = timeout; (i > 0 && atomic_read(done) == 0); i-= HZ/10) {
429 if (msleep_interruptible(100)) /* 100ms */
430 return 1;
431 }
432 return (i > 0) ? 0 : 1;
433 }
434
435 /* Free's an allocated packet */
436 static void sbp2_free_packet(struct hpsb_packet *packet)
437 {
438 hpsb_free_tlabel(packet);
439 hpsb_free_packet(packet);
440 }
441
442 /* This is much like hpsb_node_write(), except it ignores the response
443 * subaction and returns immediately. Can be used from interrupts.
444 */
445 static int sbp2util_node_write_no_wait(struct node_entry *ne, u64 addr,
446 quadlet_t *buffer, size_t length)
447 {
448 struct hpsb_packet *packet;
449
450 packet = hpsb_make_writepacket(ne->host, ne->nodeid,
451 addr, buffer, length);
452 if (!packet)
453 return -ENOMEM;
454
455 hpsb_set_packet_complete_task(packet,
456 (void (*)(void *))sbp2_free_packet,
457 packet);
458
459 hpsb_node_fill_packet(ne, packet);
460
461 if (hpsb_send_packet(packet) < 0) {
462 sbp2_free_packet(packet);
463 return -EIO;
464 }
465
466 return 0;
467 }
468
469 /*
470 * This function is called to create a pool of command orbs used for
471 * command processing. It is called when a new sbp2 device is detected.
472 */
473 static int sbp2util_create_command_orb_pool(struct scsi_id_instance_data *scsi_id)
474 {
475 struct sbp2scsi_host_info *hi = scsi_id->hi;
476 int i;
477 unsigned long flags, orbs;
478 struct sbp2_command_info *command;
479
480 orbs = serialize_io ? 2 : SBP2_MAX_CMDS;
481
482 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
483 for (i = 0; i < orbs; i++) {
484 command = kzalloc(sizeof(*command), GFP_ATOMIC);
485 if (!command) {
486 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock,
487 flags);
488 return -ENOMEM;
489 }
490 command->command_orb_dma =
491 pci_map_single(hi->host->pdev, &command->command_orb,
492 sizeof(struct sbp2_command_orb),
493 PCI_DMA_BIDIRECTIONAL);
494 SBP2_DMA_ALLOC("single command orb DMA");
495 command->sge_dma =
496 pci_map_single(hi->host->pdev,
497 &command->scatter_gather_element,
498 sizeof(command->scatter_gather_element),
499 PCI_DMA_BIDIRECTIONAL);
500 SBP2_DMA_ALLOC("scatter_gather_element");
501 INIT_LIST_HEAD(&command->list);
502 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
503 }
504 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
505 return 0;
506 }
507
508 /*
509 * This function is called to delete a pool of command orbs.
510 */
511 static void sbp2util_remove_command_orb_pool(struct scsi_id_instance_data *scsi_id)
512 {
513 struct hpsb_host *host = scsi_id->hi->host;
514 struct list_head *lh, *next;
515 struct sbp2_command_info *command;
516 unsigned long flags;
517
518 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
519 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
520 list_for_each_safe(lh, next, &scsi_id->sbp2_command_orb_completed) {
521 command = list_entry(lh, struct sbp2_command_info, list);
522
523 /* Release our generic DMA's */
524 pci_unmap_single(host->pdev, command->command_orb_dma,
525 sizeof(struct sbp2_command_orb),
526 PCI_DMA_BIDIRECTIONAL);
527 SBP2_DMA_FREE("single command orb DMA");
528 pci_unmap_single(host->pdev, command->sge_dma,
529 sizeof(command->scatter_gather_element),
530 PCI_DMA_BIDIRECTIONAL);
531 SBP2_DMA_FREE("scatter_gather_element");
532
533 kfree(command);
534 }
535 }
536 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
537 return;
538 }
539
540 /*
541 * This function finds the sbp2_command for a given outstanding command
542 * orb.Only looks at the inuse list.
543 */
544 static struct sbp2_command_info *sbp2util_find_command_for_orb(
545 struct scsi_id_instance_data *scsi_id, dma_addr_t orb)
546 {
547 struct sbp2_command_info *command;
548 unsigned long flags;
549
550 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
551 if (!list_empty(&scsi_id->sbp2_command_orb_inuse)) {
552 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list) {
553 if (command->command_orb_dma == orb) {
554 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
555 return command;
556 }
557 }
558 }
559 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
560
561 SBP2_ORB_DEBUG("could not match command orb %x", (unsigned int)orb);
562
563 return NULL;
564 }
565
566 /*
567 * This function finds the sbp2_command for a given outstanding SCpnt.
568 * Only looks at the inuse list.
569 * Must be called with scsi_id->sbp2_command_orb_lock held.
570 */
571 static struct sbp2_command_info *sbp2util_find_command_for_SCpnt(
572 struct scsi_id_instance_data *scsi_id, void *SCpnt)
573 {
574 struct sbp2_command_info *command;
575
576 if (!list_empty(&scsi_id->sbp2_command_orb_inuse))
577 list_for_each_entry(command, &scsi_id->sbp2_command_orb_inuse, list)
578 if (command->Current_SCpnt == SCpnt)
579 return command;
580 return NULL;
581 }
582
583 /*
584 * This function allocates a command orb used to send a scsi command.
585 */
586 static struct sbp2_command_info *sbp2util_allocate_command_orb(
587 struct scsi_id_instance_data *scsi_id,
588 struct scsi_cmnd *Current_SCpnt,
589 void (*Current_done)(struct scsi_cmnd *))
590 {
591 struct list_head *lh;
592 struct sbp2_command_info *command = NULL;
593 unsigned long flags;
594
595 spin_lock_irqsave(&scsi_id->sbp2_command_orb_lock, flags);
596 if (!list_empty(&scsi_id->sbp2_command_orb_completed)) {
597 lh = scsi_id->sbp2_command_orb_completed.next;
598 list_del(lh);
599 command = list_entry(lh, struct sbp2_command_info, list);
600 command->Current_done = Current_done;
601 command->Current_SCpnt = Current_SCpnt;
602 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_inuse);
603 } else {
604 SBP2_ERR("%s: no orbs available", __FUNCTION__);
605 }
606 spin_unlock_irqrestore(&scsi_id->sbp2_command_orb_lock, flags);
607 return command;
608 }
609
610 /* Free our DMA's */
611 static void sbp2util_free_command_dma(struct sbp2_command_info *command)
612 {
613 struct scsi_id_instance_data *scsi_id =
614 (struct scsi_id_instance_data *)command->Current_SCpnt->device->host->hostdata[0];
615 struct hpsb_host *host;
616
617 if (!scsi_id) {
618 SBP2_ERR("%s: scsi_id == NULL", __FUNCTION__);
619 return;
620 }
621
622 host = scsi_id->ud->ne->host;
623
624 if (command->cmd_dma) {
625 if (command->dma_type == CMD_DMA_SINGLE) {
626 pci_unmap_single(host->pdev, command->cmd_dma,
627 command->dma_size, command->dma_dir);
628 SBP2_DMA_FREE("single bulk");
629 } else if (command->dma_type == CMD_DMA_PAGE) {
630 pci_unmap_page(host->pdev, command->cmd_dma,
631 command->dma_size, command->dma_dir);
632 SBP2_DMA_FREE("single page");
633 } /* XXX: Check for CMD_DMA_NONE bug */
634 command->dma_type = CMD_DMA_NONE;
635 command->cmd_dma = 0;
636 }
637
638 if (command->sge_buffer) {
639 pci_unmap_sg(host->pdev, command->sge_buffer,
640 command->dma_size, command->dma_dir);
641 SBP2_DMA_FREE("scatter list");
642 command->sge_buffer = NULL;
643 }
644 }
645
646 /*
647 * This function moves a command to the completed orb list.
648 * Must be called with scsi_id->sbp2_command_orb_lock held.
649 */
650 static void sbp2util_mark_command_completed(
651 struct scsi_id_instance_data *scsi_id,
652 struct sbp2_command_info *command)
653 {
654 list_del(&command->list);
655 sbp2util_free_command_dma(command);
656 list_add_tail(&command->list, &scsi_id->sbp2_command_orb_completed);
657 }
658
659 /*
660 * Is scsi_id valid? Is the 1394 node still present?
661 */
662 static inline int sbp2util_node_is_available(struct scsi_id_instance_data *scsi_id)
663 {
664 return scsi_id && scsi_id->ne && !scsi_id->ne->in_limbo;
665 }
666
667 /*********************************************
668 * IEEE-1394 core driver stack related section
669 *********************************************/
670 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud);
671
672 static int sbp2_probe(struct device *dev)
673 {
674 struct unit_directory *ud;
675 struct scsi_id_instance_data *scsi_id;
676
677 SBP2_DEBUG_ENTER();
678
679 ud = container_of(dev, struct unit_directory, device);
680
681 /* Don't probe UD's that have the LUN flag. We'll probe the LUN(s)
682 * instead. */
683 if (ud->flags & UNIT_DIRECTORY_HAS_LUN_DIRECTORY)
684 return -ENODEV;
685
686 scsi_id = sbp2_alloc_device(ud);
687
688 if (!scsi_id)
689 return -ENOMEM;
690
691 sbp2_parse_unit_directory(scsi_id, ud);
692
693 return sbp2_start_device(scsi_id);
694 }
695
696 static int sbp2_remove(struct device *dev)
697 {
698 struct unit_directory *ud;
699 struct scsi_id_instance_data *scsi_id;
700 struct scsi_device *sdev;
701
702 SBP2_DEBUG_ENTER();
703
704 ud = container_of(dev, struct unit_directory, device);
705 scsi_id = ud->device.driver_data;
706 if (!scsi_id)
707 return 0;
708
709 if (scsi_id->scsi_host) {
710 /* Get rid of enqueued commands if there is no chance to
711 * send them. */
712 if (!sbp2util_node_is_available(scsi_id))
713 sbp2scsi_complete_all_commands(scsi_id, DID_NO_CONNECT);
714 /* scsi_remove_device() will trigger shutdown functions of SCSI
715 * highlevel drivers which would deadlock if blocked. */
716 scsi_unblock_requests(scsi_id->scsi_host);
717 }
718 sdev = scsi_id->sdev;
719 if (sdev) {
720 scsi_id->sdev = NULL;
721 scsi_remove_device(sdev);
722 }
723
724 sbp2_logout_device(scsi_id);
725 sbp2_remove_device(scsi_id);
726
727 return 0;
728 }
729
730 static int sbp2_update(struct unit_directory *ud)
731 {
732 struct scsi_id_instance_data *scsi_id = ud->device.driver_data;
733
734 SBP2_DEBUG_ENTER();
735
736 if (sbp2_reconnect_device(scsi_id)) {
737
738 /*
739 * Ok, reconnect has failed. Perhaps we didn't
740 * reconnect fast enough. Try doing a regular login, but
741 * first do a logout just in case of any weirdness.
742 */
743 sbp2_logout_device(scsi_id);
744
745 if (sbp2_login_device(scsi_id)) {
746 /* Login failed too, just fail, and the backend
747 * will call our sbp2_remove for us */
748 SBP2_ERR("Failed to reconnect to sbp2 device!");
749 return -EBUSY;
750 }
751 }
752
753 /* Set max retries to something large on the device. */
754 sbp2_set_busy_timeout(scsi_id);
755
756 /* Do a SBP-2 fetch agent reset. */
757 sbp2_agent_reset(scsi_id, 1);
758
759 /* Get the max speed and packet size that we can use. */
760 sbp2_max_speed_and_size(scsi_id);
761
762 /* Complete any pending commands with busy (so they get
763 * retried) and remove them from our queue
764 */
765 sbp2scsi_complete_all_commands(scsi_id, DID_BUS_BUSY);
766
767 /* Make sure we unblock requests (since this is likely after a bus
768 * reset). */
769 scsi_unblock_requests(scsi_id->scsi_host);
770
771 return 0;
772 }
773
774 /* This functions is called by the sbp2_probe, for each new device. We now
775 * allocate one scsi host for each scsi_id (unit directory). */
776 static struct scsi_id_instance_data *sbp2_alloc_device(struct unit_directory *ud)
777 {
778 struct sbp2scsi_host_info *hi;
779 struct Scsi_Host *scsi_host = NULL;
780 struct scsi_id_instance_data *scsi_id = NULL;
781
782 SBP2_DEBUG_ENTER();
783
784 scsi_id = kzalloc(sizeof(*scsi_id), GFP_KERNEL);
785 if (!scsi_id) {
786 SBP2_ERR("failed to create scsi_id");
787 goto failed_alloc;
788 }
789
790 scsi_id->ne = ud->ne;
791 scsi_id->ud = ud;
792 scsi_id->speed_code = IEEE1394_SPEED_100;
793 scsi_id->max_payload_size = sbp2_speedto_max_payload[IEEE1394_SPEED_100];
794 atomic_set(&scsi_id->sbp2_login_complete, 0);
795 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_inuse);
796 INIT_LIST_HEAD(&scsi_id->sbp2_command_orb_completed);
797 INIT_LIST_HEAD(&scsi_id->scsi_list);
798 spin_lock_init(&scsi_id->sbp2_command_orb_lock);
799 scsi_id->sbp2_lun = 0;
800
801 ud->device.driver_data = scsi_id;
802
803 hi = hpsb_get_hostinfo(&sbp2_highlevel, ud->ne->host);
804 if (!hi) {
805 hi = hpsb_create_hostinfo(&sbp2_highlevel, ud->ne->host, sizeof(*hi));
806 if (!hi) {
807 SBP2_ERR("failed to allocate hostinfo");
808 goto failed_alloc;
809 }
810 SBP2_DEBUG("sbp2_alloc_device: allocated hostinfo");
811 hi->host = ud->ne->host;
812 INIT_LIST_HEAD(&hi->scsi_ids);
813
814 #ifdef CONFIG_IEEE1394_SBP2_PHYS_DMA
815 /* Handle data movement if physical dma is not
816 * enabled or not supported on host controller */
817 if (!hpsb_register_addrspace(&sbp2_highlevel, ud->ne->host,
818 &sbp2_physdma_ops,
819 0x0ULL, 0xfffffffcULL)) {
820 SBP2_ERR("failed to register lower 4GB address range");
821 goto failed_alloc;
822 }
823 #endif
824 }
825
826 /* Prevent unloading of the 1394 host */
827 if (!try_module_get(hi->host->driver->owner)) {
828 SBP2_ERR("failed to get a reference on 1394 host driver");
829 goto failed_alloc;
830 }
831
832 scsi_id->hi = hi;
833
834 list_add_tail(&scsi_id->scsi_list, &hi->scsi_ids);
835
836 /* Register the status FIFO address range. We could use the same FIFO
837 * for targets at different nodes. However we need different FIFOs per
838 * target in order to support multi-unit devices.
839 * The FIFO is located out of the local host controller's physical range
840 * but, if possible, within the posted write area. Status writes will
841 * then be performed as unified transactions. This slightly reduces
842 * bandwidth usage, and some Prolific based devices seem to require it.
843 */
844 scsi_id->status_fifo_addr = hpsb_allocate_and_register_addrspace(
845 &sbp2_highlevel, ud->ne->host, &sbp2_ops,
846 sizeof(struct sbp2_status_block), sizeof(quadlet_t),
847 0x010000000000ULL, CSR1212_ALL_SPACE_END);
848 if (scsi_id->status_fifo_addr == ~0ULL) {
849 SBP2_ERR("failed to allocate status FIFO address range");
850 goto failed_alloc;
851 }
852
853 /* Register our host with the SCSI stack. */
854 scsi_host = scsi_host_alloc(&scsi_driver_template,
855 sizeof(unsigned long));
856 if (!scsi_host) {
857 SBP2_ERR("failed to register scsi host");
858 goto failed_alloc;
859 }
860
861 scsi_host->hostdata[0] = (unsigned long)scsi_id;
862
863 if (!scsi_add_host(scsi_host, &ud->device)) {
864 scsi_id->scsi_host = scsi_host;
865 return scsi_id;
866 }
867
868 SBP2_ERR("failed to add scsi host");
869 scsi_host_put(scsi_host);
870
871 failed_alloc:
872 sbp2_remove_device(scsi_id);
873 return NULL;
874 }
875
876 static void sbp2_host_reset(struct hpsb_host *host)
877 {
878 struct sbp2scsi_host_info *hi;
879 struct scsi_id_instance_data *scsi_id;
880
881 hi = hpsb_get_hostinfo(&sbp2_highlevel, host);
882
883 if (hi) {
884 list_for_each_entry(scsi_id, &hi->scsi_ids, scsi_list)
885 scsi_block_requests(scsi_id->scsi_host);
886 }
887 }
888
889 /*
890 * This function is where we first pull the node unique ids, and then
891 * allocate memory and register a SBP-2 device.
892 */
893 static int sbp2_start_device(struct scsi_id_instance_data *scsi_id)
894 {
895 struct sbp2scsi_host_info *hi = scsi_id->hi;
896 int error;
897
898 SBP2_DEBUG_ENTER();
899
900 /* Login FIFO DMA */
901 scsi_id->login_response =
902 pci_alloc_consistent(hi->host->pdev,
903 sizeof(struct sbp2_login_response),
904 &scsi_id->login_response_dma);
905 if (!scsi_id->login_response)
906 goto alloc_fail;
907 SBP2_DMA_ALLOC("consistent DMA region for login FIFO");
908
909 /* Query logins ORB DMA */
910 scsi_id->query_logins_orb =
911 pci_alloc_consistent(hi->host->pdev,
912 sizeof(struct sbp2_query_logins_orb),
913 &scsi_id->query_logins_orb_dma);
914 if (!scsi_id->query_logins_orb)
915 goto alloc_fail;
916 SBP2_DMA_ALLOC("consistent DMA region for query logins ORB");
917
918 /* Query logins response DMA */
919 scsi_id->query_logins_response =
920 pci_alloc_consistent(hi->host->pdev,
921 sizeof(struct sbp2_query_logins_response),
922 &scsi_id->query_logins_response_dma);
923 if (!scsi_id->query_logins_response)
924 goto alloc_fail;
925 SBP2_DMA_ALLOC("consistent DMA region for query logins response");
926
927 /* Reconnect ORB DMA */
928 scsi_id->reconnect_orb =
929 pci_alloc_consistent(hi->host->pdev,
930 sizeof(struct sbp2_reconnect_orb),
931 &scsi_id->reconnect_orb_dma);
932 if (!scsi_id->reconnect_orb)
933 goto alloc_fail;
934 SBP2_DMA_ALLOC("consistent DMA region for reconnect ORB");
935
936 /* Logout ORB DMA */
937 scsi_id->logout_orb =
938 pci_alloc_consistent(hi->host->pdev,
939 sizeof(struct sbp2_logout_orb),
940 &scsi_id->logout_orb_dma);
941 if (!scsi_id->logout_orb)
942 goto alloc_fail;
943 SBP2_DMA_ALLOC("consistent DMA region for logout ORB");
944
945 /* Login ORB DMA */
946 scsi_id->login_orb =
947 pci_alloc_consistent(hi->host->pdev,
948 sizeof(struct sbp2_login_orb),
949 &scsi_id->login_orb_dma);
950 if (!scsi_id->login_orb)
951 goto alloc_fail;
952 SBP2_DMA_ALLOC("consistent DMA region for login ORB");
953
954