54cad3a5dfb8bc620191e300247155f1da8d6a36
[linux-2.6.git] / drivers / firewire / fw-sbp2.c
1 /*                                              -*- c-basic-offset: 8 -*-
2  * fw-sbp2.c -- SBP2 driver (SCSI over IEEE1394)
3  *
4  * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/mod_devicetable.h>
24 #include <linux/device.h>
25 #include <linux/scatterlist.h>
26 #include <linux/dma-mapping.h>
27
28 #include <scsi/scsi.h>
29 #include <scsi/scsi_cmnd.h>
30 #include <scsi/scsi_dbg.h>
31 #include <scsi/scsi_device.h>
32 #include <scsi/scsi_host.h>
33
34 #include "fw-transaction.h"
35 #include "fw-topology.h"
36 #include "fw-device.h"
37
38 /* I don't know why the SCSI stack doesn't define something like this... */
39 typedef void (*scsi_done_fn_t) (struct scsi_cmnd *);
40
41 static const char sbp2_driver_name[] = "sbp2";
42
43 struct sbp2_device {
44         struct fw_unit *unit;
45         struct fw_address_handler address_handler;
46         struct list_head orb_list;
47         u64 management_agent_address;
48         u64 command_block_agent_address;
49         u32 workarounds;
50         int login_id;
51
52         /* We cache these addresses and only update them once we've
53          * logged in or reconnected to the sbp2 device.  That way, any
54          * IO to the device will automatically fail and get retried if
55          * it happens in a window where the device is not ready to
56          * handle it (e.g. after a bus reset but before we reconnect). */
57         int node_id;
58         int address_high;
59         int generation;
60
61         struct work_struct work;
62         struct Scsi_Host *scsi_host;
63 };
64
65 #define SBP2_MAX_SG_ELEMENT_LENGTH      0xf000
66 #define SBP2_MAX_SECTORS                255     /* Max sectors supported */
67
68 #define SBP2_ORB_NULL                   0x80000000
69
70 #define SBP2_DIRECTION_TO_MEDIA         0x0
71 #define SBP2_DIRECTION_FROM_MEDIA       0x1
72
73 /* Unit directory keys */
74 #define SBP2_COMMAND_SET_SPECIFIER      0x38
75 #define SBP2_COMMAND_SET                0x39
76 #define SBP2_COMMAND_SET_REVISION       0x3b
77 #define SBP2_FIRMWARE_REVISION          0x3c
78
79 /* Flags for detected oddities and brokeness */
80 #define SBP2_WORKAROUND_128K_MAX_TRANS  0x1
81 #define SBP2_WORKAROUND_INQUIRY_36      0x2
82 #define SBP2_WORKAROUND_MODE_SENSE_8    0x4
83 #define SBP2_WORKAROUND_FIX_CAPACITY    0x8
84 #define SBP2_WORKAROUND_OVERRIDE        0x100
85
86 /* Management orb opcodes */
87 #define SBP2_LOGIN_REQUEST              0x0
88 #define SBP2_QUERY_LOGINS_REQUEST       0x1
89 #define SBP2_RECONNECT_REQUEST          0x3
90 #define SBP2_SET_PASSWORD_REQUEST       0x4
91 #define SBP2_LOGOUT_REQUEST             0x7
92 #define SBP2_ABORT_TASK_REQUEST         0xb
93 #define SBP2_ABORT_TASK_SET             0xc
94 #define SBP2_LOGICAL_UNIT_RESET         0xe
95 #define SBP2_TARGET_RESET_REQUEST       0xf
96
97 /* Offsets for command block agent registers */
98 #define SBP2_AGENT_STATE                0x00
99 #define SBP2_AGENT_RESET                0x04
100 #define SBP2_ORB_POINTER                0x08
101 #define SBP2_DOORBELL                   0x10
102 #define SBP2_UNSOLICITED_STATUS_ENABLE  0x14
103
104 /* Status write response codes */
105 #define SBP2_STATUS_REQUEST_COMPLETE    0x0
106 #define SBP2_STATUS_TRANSPORT_FAILURE   0x1
107 #define SBP2_STATUS_ILLEGAL_REQUEST     0x2
108 #define SBP2_STATUS_VENDOR_DEPENDENT    0x3
109
110 #define status_get_orb_high(v)          ((v).status & 0xffff)
111 #define status_get_sbp_status(v)        (((v).status >> 16) & 0xff)
112 #define status_get_len(v)               (((v).status >> 24) & 0x07)
113 #define status_get_dead(v)              (((v).status >> 27) & 0x01)
114 #define status_get_response(v)          (((v).status >> 28) & 0x03)
115 #define status_get_source(v)            (((v).status >> 30) & 0x03)
116 #define status_get_orb_low(v)           ((v).orb_low)
117 #define status_get_data(v)              ((v).data)
118
119 struct sbp2_status {
120         u32 status;
121         u32 orb_low;
122         u8 data[24];
123 };
124
125 struct sbp2_pointer {
126         u32 high;
127         u32 low;
128 };
129
130 struct sbp2_orb {
131         struct fw_transaction t;
132         dma_addr_t request_bus;
133         int rcode;
134         struct sbp2_pointer pointer;
135         void (*callback) (struct sbp2_orb * orb, struct sbp2_status * status);
136         struct list_head link;
137 };
138
139 #define management_orb_lun(v)                   ((v))
140 #define management_orb_function(v)              ((v) << 16)
141 #define management_orb_reconnect(v)             ((v) << 20)
142 #define management_orb_exclusive                ((1) << 28)
143 #define management_orb_request_format(v)        ((v) << 29)
144 #define management_orb_notify                   ((1) << 31)
145
146 #define management_orb_response_length(v)       ((v))
147 #define management_orb_password_length(v)       ((v) << 16)
148
149 struct sbp2_management_orb {
150         struct sbp2_orb base;
151         struct {
152                 struct sbp2_pointer password;
153                 struct sbp2_pointer response;
154                 u32 misc;
155                 u32 length;
156                 struct sbp2_pointer status_fifo;
157         } request;
158         __be32 response[4];
159         dma_addr_t response_bus;
160         struct completion done;
161         struct sbp2_status status;
162 };
163
164 #define login_response_get_login_id(v)  ((v).misc & 0xffff)
165 #define login_response_get_length(v)    (((v).misc >> 16) & 0xffff)
166
167 struct sbp2_login_response {
168         u32 misc;
169         struct sbp2_pointer command_block_agent;
170         u32 reconnect_hold;
171 };
172
173 #define command_orb_data_size(v)        ((v))
174 #define command_orb_page_size(v)        ((v) << 16)
175 #define command_orb_page_table_present  ((1) << 19)
176 #define command_orb_max_payload(v)      ((v) << 20)
177 #define command_orb_speed(v)            ((v) << 24)
178 #define command_orb_direction(v)        ((v) << 27)
179 #define command_orb_request_format(v)   ((v) << 29)
180 #define command_orb_notify              ((1) << 31)
181
182 struct sbp2_command_orb {
183         struct sbp2_orb base;
184         struct {
185                 struct sbp2_pointer next;
186                 struct sbp2_pointer data_descriptor;
187                 u32 misc;
188                 u8 command_block[12];
189         } request;
190         struct scsi_cmnd *cmd;
191         scsi_done_fn_t done;
192         struct fw_unit *unit;
193
194         struct sbp2_pointer page_table[SG_ALL];
195         dma_addr_t page_table_bus;
196         dma_addr_t request_buffer_bus;
197 };
198
199 /*
200  * List of devices with known bugs.
201  *
202  * The firmware_revision field, masked with 0xffff00, is the best
203  * indicator for the type of bridge chip of a device.  It yields a few
204  * false positives but this did not break correctly behaving devices
205  * so far.  We use ~0 as a wildcard, since the 24 bit values we get
206  * from the config rom can never match that.
207  */
208 static const struct {
209         u32 firmware_revision;
210         u32 model;
211         unsigned workarounds;
212 } sbp2_workarounds_table[] = {
213         /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
214                 .firmware_revision      = 0x002800,
215                 .model                  = 0x001010,
216                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36 |
217                                           SBP2_WORKAROUND_MODE_SENSE_8,
218         },
219         /* Initio bridges, actually only needed for some older ones */ {
220                 .firmware_revision      = 0x000200,
221                 .model                  = ~0,
222                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36,
223         },
224         /* Symbios bridge */ {
225                 .firmware_revision      = 0xa0b800,
226                 .model                  = ~0,
227                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS,
228         },
229         /* There are iPods (2nd gen, 3rd gen) with model_id == 0, but
230          * these iPods do not feature the read_capacity bug according
231          * to one report.  Read_capacity behaviour as well as model_id
232          * could change due to Apple-supplied firmware updates though. */
233         /* iPod 4th generation. */ {
234                 .firmware_revision      = 0x0a2700,
235                 .model                  = 0x000021,
236                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
237         },
238         /* iPod mini */ {
239                 .firmware_revision      = 0x0a2700,
240                 .model                  = 0x000023,
241                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
242         },
243         /* iPod Photo */ {
244                 .firmware_revision      = 0x0a2700,
245                 .model                  = 0x00007e,
246                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
247         }
248 };
249
250 static void
251 sbp2_status_write(struct fw_card *card, struct fw_request *request,
252                   int tcode, int destination, int source,
253                   int generation, int speed,
254                   unsigned long long offset,
255                   void *payload, size_t length, void *callback_data)
256 {
257         struct sbp2_device *sd = callback_data;
258         struct sbp2_orb *orb;
259         struct sbp2_status status;
260         size_t header_size;
261         unsigned long flags;
262
263         if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
264             length == 0 || length > sizeof status) {
265                 fw_send_response(card, request, RCODE_TYPE_ERROR);
266                 return;
267         }
268
269         header_size = min(length, 2 * sizeof(u32));
270         fw_memcpy_from_be32(&status, payload, header_size);
271         if (length > header_size)
272                 memcpy(status.data, payload + 8, length - header_size);
273         if (status_get_source(status) == 2 || status_get_source(status) == 3) {
274                 fw_notify("non-orb related status write, not handled\n");
275                 fw_send_response(card, request, RCODE_COMPLETE);
276                 return;
277         }
278
279         /* Lookup the orb corresponding to this status write. */
280         spin_lock_irqsave(&card->lock, flags);
281         list_for_each_entry(orb, &sd->orb_list, link) {
282                 if (status_get_orb_high(status) == 0 &&
283                     status_get_orb_low(status) == orb->request_bus) {
284                         list_del(&orb->link);
285                         break;
286                 }
287         }
288         spin_unlock_irqrestore(&card->lock, flags);
289
290         if (&orb->link != &sd->orb_list)
291                 orb->callback(orb, &status);
292         else
293                 fw_error("status write for unknown orb\n");
294
295         fw_send_response(card, request, RCODE_COMPLETE);
296 }
297
298 static void
299 complete_transaction(struct fw_card *card, int rcode,
300                      void *payload, size_t length, void *data)
301 {
302         struct sbp2_orb *orb = data;
303         unsigned long flags;
304
305         orb->rcode = rcode;
306         if (rcode != RCODE_COMPLETE) {
307                 spin_lock_irqsave(&card->lock, flags);
308                 list_del(&orb->link);
309                 spin_unlock_irqrestore(&card->lock, flags);
310                 orb->callback(orb, NULL);
311         }
312 }
313
314 static void
315 sbp2_send_orb(struct sbp2_orb *orb, struct fw_unit *unit,
316               int node_id, int generation, u64 offset)
317 {
318         struct fw_device *device = fw_device(unit->device.parent);
319         struct sbp2_device *sd = unit->device.driver_data;
320         unsigned long flags;
321
322         orb->pointer.high = 0;
323         orb->pointer.low = orb->request_bus;
324         fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof orb->pointer);
325
326         spin_lock_irqsave(&device->card->lock, flags);
327         list_add_tail(&orb->link, &sd->orb_list);
328         spin_unlock_irqrestore(&device->card->lock, flags);
329
330         fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
331                         node_id, generation,
332                         device->node->max_speed, offset,
333                         &orb->pointer, sizeof orb->pointer,
334                         complete_transaction, orb);
335 }
336
337 static void sbp2_cancel_orbs(struct fw_unit *unit)
338 {
339         struct fw_device *device = fw_device(unit->device.parent);
340         struct sbp2_device *sd = unit->device.driver_data;
341         struct sbp2_orb *orb, *next;
342         struct list_head list;
343         unsigned long flags;
344
345         INIT_LIST_HEAD(&list);
346         spin_lock_irqsave(&device->card->lock, flags);
347         list_splice_init(&sd->orb_list, &list);
348         spin_unlock_irqrestore(&device->card->lock, flags);
349
350         list_for_each_entry_safe(orb, next, &list, link) {
351                 orb->rcode = RCODE_CANCELLED;
352                 orb->callback(orb, NULL);
353         }
354 }
355
356 static void
357 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
358 {
359         struct sbp2_management_orb *orb =
360             (struct sbp2_management_orb *)base_orb;
361
362         if (status)
363                 memcpy(&orb->status, status, sizeof *status);
364         complete(&orb->done);
365 }
366
367 static int
368 sbp2_send_management_orb(struct fw_unit *unit, int node_id, int generation,
369                          int function, int lun, void *response)
370 {
371         struct fw_device *device = fw_device(unit->device.parent);
372         struct sbp2_device *sd = unit->device.driver_data;
373         struct sbp2_management_orb *orb;
374         unsigned long timeout;
375         int retval = -ENOMEM;
376
377         orb = kzalloc(sizeof *orb, GFP_ATOMIC);
378         if (orb == NULL)
379                 return -ENOMEM;
380
381         /* The sbp2 device is going to send a block read request to
382          * read out the request from host memory, so map it for
383          * dma. */
384         orb->base.request_bus =
385                 dma_map_single(device->card->device, &orb->request,
386                                sizeof orb->request, DMA_TO_DEVICE);
387         if (orb->base.request_bus == 0)
388                 goto out;
389
390         orb->response_bus =
391                 dma_map_single(device->card->device, &orb->response,
392                                sizeof orb->response, DMA_FROM_DEVICE);
393         if (orb->response_bus == 0)
394                 goto out;
395
396         orb->request.response.high    = 0;
397         orb->request.response.low     = orb->response_bus;
398
399         orb->request.misc =
400                 management_orb_notify |
401                 management_orb_function(function) |
402                 management_orb_lun(lun);
403         orb->request.length =
404                 management_orb_response_length(sizeof orb->response);
405
406         orb->request.status_fifo.high = sd->address_handler.offset >> 32;
407         orb->request.status_fifo.low  = sd->address_handler.offset;
408
409         /* FIXME: Yeah, ok this isn't elegant, we hardwire exclusive
410          * login and 1 second reconnect time.  The reconnect setting
411          * is probably fine, but the exclusive login should be an
412          * option. */
413         if (function == SBP2_LOGIN_REQUEST) {
414                 orb->request.misc |=
415                         management_orb_exclusive |
416                         management_orb_reconnect(0);
417         }
418
419         fw_memcpy_to_be32(&orb->request, &orb->request, sizeof orb->request);
420
421         init_completion(&orb->done);
422         orb->base.callback = complete_management_orb;
423         sbp2_send_orb(&orb->base, unit,
424                       node_id, generation, sd->management_agent_address);
425
426         timeout = wait_for_completion_timeout(&orb->done, 10 * HZ);
427
428         /* FIXME: Handle bus reset race here. */
429
430         retval = -EIO;
431         if (orb->base.rcode != RCODE_COMPLETE) {
432                 fw_error("management write failed, rcode 0x%02x\n",
433                          orb->base.rcode);
434                 goto out;
435         }
436
437         if (timeout == 0) {
438                 fw_error("orb reply timed out, rcode=0x%02x\n",
439                          orb->base.rcode);
440                 goto out;
441         }
442
443         if (status_get_response(orb->status) != 0 ||
444             status_get_sbp_status(orb->status) != 0) {
445                 fw_error("error status: %d:%d\n",
446                          status_get_response(orb->status),
447                          status_get_sbp_status(orb->status));
448                 goto out;
449         }
450
451         retval = 0;
452  out:
453         dma_unmap_single(device->card->device, orb->base.request_bus,
454                          sizeof orb->request, DMA_TO_DEVICE);
455         dma_unmap_single(device->card->device, orb->response_bus,
456                          sizeof orb->response, DMA_FROM_DEVICE);
457
458         if (response)
459                 fw_memcpy_from_be32(response,
460                                     orb->response, sizeof orb->response);
461         kfree(orb);
462
463         return retval;
464 }
465
466 static void
467 complete_agent_reset_write(struct fw_card *card, int rcode,
468                            void *payload, size_t length, void *data)
469 {
470         struct fw_transaction *t = data;
471
472         fw_notify("agent reset write rcode=%d\n", rcode);
473         kfree(t);
474 }
475
476 static int sbp2_agent_reset(struct fw_unit *unit)
477 {
478         struct fw_device *device = fw_device(unit->device.parent);
479         struct sbp2_device *sd = unit->device.driver_data;
480         struct fw_transaction *t;
481         static u32 zero;
482
483         t = kzalloc(sizeof *t, GFP_ATOMIC);
484         if (t == NULL)
485                 return -ENOMEM;
486
487         fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
488                         sd->node_id, sd->generation, SCODE_400,
489                         sd->command_block_agent_address + SBP2_AGENT_RESET,
490                         &zero, sizeof zero, complete_agent_reset_write, t);
491
492         return 0;
493 }
494
495 static int add_scsi_devices(struct fw_unit *unit);
496 static void remove_scsi_devices(struct fw_unit *unit);
497
498 static int sbp2_probe(struct device *dev)
499 {
500         struct fw_unit *unit = fw_unit(dev);
501         struct fw_device *device = fw_device(unit->device.parent);
502         struct sbp2_device *sd;
503         struct fw_csr_iterator ci;
504         int i, key, value, lun, retval;
505         int node_id, generation, local_node_id;
506         struct sbp2_login_response response;
507         u32 model, firmware_revision;
508
509         sd = kzalloc(sizeof *sd, GFP_KERNEL);
510         if (sd == NULL)
511                 return -ENOMEM;
512
513         unit->device.driver_data = sd;
514         sd->unit = unit;
515         INIT_LIST_HEAD(&sd->orb_list);
516
517         sd->address_handler.length = 0x100;
518         sd->address_handler.address_callback = sbp2_status_write;
519         sd->address_handler.callback_data = sd;
520
521         if (fw_core_add_address_handler(&sd->address_handler,
522                                         &fw_high_memory_region) < 0) {
523                 kfree(sd);
524                 return -EBUSY;
525         }
526
527         if (fw_device_enable_phys_dma(device) < 0) {
528                 fw_core_remove_address_handler(&sd->address_handler);
529                 kfree(sd);
530                 return -EBUSY;
531         }
532
533         /* Scan unit directory to get management agent address,
534          * firmware revison and model.  Initialize firmware_revision
535          * and model to values that wont match anything in our table. */
536         firmware_revision = 0xff000000;
537         model = 0xff000000;
538         fw_csr_iterator_init(&ci, unit->directory);
539         while (fw_csr_iterator_next(&ci, &key, &value)) {
540                 switch (key) {
541                 case CSR_DEPENDENT_INFO | CSR_OFFSET:
542                         sd->management_agent_address =
543                                 0xfffff0000000ULL + 4 * value;
544                         break;
545                 case SBP2_FIRMWARE_REVISION:
546                         firmware_revision = value;
547                         break;
548                 case CSR_MODEL:
549                         model = value;
550                         break;
551                 }
552         }
553
554         for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
555                 if (sbp2_workarounds_table[i].firmware_revision !=
556                     (firmware_revision & 0xffffff00))
557                         continue;
558                 if (sbp2_workarounds_table[i].model != model &&
559                     sbp2_workarounds_table[i].model != ~0)
560                         continue;
561                 sd->workarounds |= sbp2_workarounds_table[i].workarounds;
562                 break;
563         }
564
565         if (sd->workarounds)
566                 fw_notify("Workarounds for node %s: 0x%x "
567                           "(firmware_revision 0x%06x, model_id 0x%06x)\n",
568                           unit->device.bus_id,
569                           sd->workarounds, firmware_revision, model);
570
571         /* FIXME: Make this work for multi-lun devices. */
572         lun = 0;
573
574         generation    = device->card->generation;
575         node_id       = device->node->node_id;
576         local_node_id = device->card->local_node->node_id;
577
578         /* FIXME: We should probably do this from a keventd callback
579          * and handle retries by rescheduling the work. */
580         if (sbp2_send_management_orb(unit, node_id, generation,
581                                      SBP2_LOGIN_REQUEST, lun, &response) < 0) {
582                 fw_core_remove_address_handler(&sd->address_handler);
583                 kfree(sd);
584                 return -EBUSY;
585         }
586
587         sd->generation   = generation;
588         sd->node_id      = node_id;
589         sd->address_high = local_node_id << 16;
590
591         /* Get command block agent offset and login id. */
592         sd->command_block_agent_address =
593                 ((u64) response.command_block_agent.high << 32) |
594                 response.command_block_agent.low;
595         sd->login_id = login_response_get_login_id(response);
596
597         fw_notify("logged in to sbp2 unit %s\n", unit->device.bus_id);
598         fw_notify(" - management_agent_address: 0x%012llx\n",
599                   (unsigned long long) sd->management_agent_address);
600         fw_notify(" - command_block_agent_address: 0x%012llx\n",
601                   (unsigned long long) sd->command_block_agent_address);
602         fw_notify(" - status write address: 0x%012llx\n",
603                   (unsigned long long) sd->address_handler.offset);
604
605 #if 0
606         /* FIXME: The linux1394 sbp2 does this last step. */
607         sbp2_set_busy_timeout(scsi_id);
608 #endif
609
610         sbp2_agent_reset(unit);
611
612         retval = add_scsi_devices(unit);
613         if (retval < 0) {
614                 sbp2_send_management_orb(unit, sd->node_id, sd->generation,
615                                          SBP2_LOGOUT_REQUEST, sd->login_id,
616                                          NULL);
617                 fw_core_remove_address_handler(&sd->address_handler);
618                 kfree(sd);
619                 return retval;
620         }
621
622         return 0;
623 }
624
625 static int sbp2_remove(struct device *dev)
626 {
627         struct fw_unit *unit = fw_unit(dev);
628         struct sbp2_device *sd = unit->device.driver_data;
629
630         sbp2_send_management_orb(unit, sd->node_id, sd->generation,
631                                  SBP2_LOGOUT_REQUEST, sd->login_id, NULL);
632
633         remove_scsi_devices(unit);
634
635         fw_core_remove_address_handler(&sd->address_handler);
636         kfree(sd);
637
638         fw_notify("removed sbp2 unit %s\n", dev->bus_id);
639
640         return 0;
641 }
642
643 static void sbp2_reconnect(struct work_struct *work)
644 {
645         struct sbp2_device *sd = container_of(work, struct sbp2_device, work);
646         struct fw_unit *unit = sd->unit;
647         struct fw_device *device = fw_device(unit->device.parent);
648         int generation, node_id, local_node_id;
649
650         fw_notify("in sbp2_reconnect, reconnecting to unit %s\n",
651                   unit->device.bus_id);
652
653         generation    = device->card->generation;
654         node_id       = device->node->node_id;
655         local_node_id = device->card->local_node->node_id;
656
657         sbp2_send_management_orb(unit, node_id, generation,
658                                  SBP2_RECONNECT_REQUEST, sd->login_id, NULL);
659
660         /* FIXME: handle reconnect failures. */
661
662         sbp2_cancel_orbs(unit);
663
664         sd->generation   = generation;
665         sd->node_id      = node_id;
666         sd->address_high = local_node_id << 16;
667 }
668
669 static void sbp2_update(struct fw_unit *unit)
670 {
671         struct fw_device *device = fw_device(unit->device.parent);
672         struct sbp2_device *sd = unit->device.driver_data;
673
674         fw_device_enable_phys_dma(device);
675
676         INIT_WORK(&sd->work, sbp2_reconnect);
677         schedule_work(&sd->work);
678 }
679
680 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
681 #define SBP2_SW_VERSION_ENTRY   0x00010483
682
683 static const struct fw_device_id sbp2_id_table[] = {
684         {
685                 .match_flags  = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
686                 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
687                 .version      = SBP2_SW_VERSION_ENTRY,
688         },
689         { }
690 };
691
692 static struct fw_driver sbp2_driver = {
693         .driver   = {
694                 .owner  = THIS_MODULE,
695                 .name   = sbp2_driver_name,
696                 .bus    = &fw_bus_type,
697                 .probe  = sbp2_probe,
698                 .remove = sbp2_remove,
699         },
700         .update   = sbp2_update,
701         .id_table = sbp2_id_table,
702 };
703
704 static unsigned int sbp2_status_to_sense_data(u8 * sbp2_status, u8 * sense_data)
705 {
706         sense_data[0] = 0x70;
707         sense_data[1] = 0x0;
708         sense_data[2] = sbp2_status[1];
709         sense_data[3] = sbp2_status[4];
710         sense_data[4] = sbp2_status[5];
711         sense_data[5] = sbp2_status[6];
712         sense_data[6] = sbp2_status[7];
713         sense_data[7] = 10;
714         sense_data[8] = sbp2_status[8];
715         sense_data[9] = sbp2_status[9];
716         sense_data[10] = sbp2_status[10];
717         sense_data[11] = sbp2_status[11];
718         sense_data[12] = sbp2_status[2];
719         sense_data[13] = sbp2_status[3];
720         sense_data[14] = sbp2_status[12];
721         sense_data[15] = sbp2_status[13];
722
723         switch (sbp2_status[0] & 0x3f) {
724         case SAM_STAT_GOOD:
725                 return DID_OK;
726
727         case SAM_STAT_CHECK_CONDITION:
728                 /* return CHECK_CONDITION << 1 | DID_OK << 16; */
729                 return DID_OK;
730
731         case SAM_STAT_BUSY:
732                 return DID_BUS_BUSY;
733
734         case SAM_STAT_CONDITION_MET:
735         case SAM_STAT_RESERVATION_CONFLICT:
736         case SAM_STAT_COMMAND_TERMINATED:
737         default:
738                 return DID_ERROR;
739         }
740 }
741
742 static void
743 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
744 {
745         struct sbp2_command_orb *orb = (struct sbp2_command_orb *)base_orb;
746         struct fw_unit *unit = orb->unit;
747         struct fw_device *device = fw_device(unit->device.parent);
748         struct scatterlist *sg;
749         int result;
750
751         if (status != NULL) {
752                 if (status_get_dead(*status)) {
753                         fw_notify("agent died, issuing agent reset\n");
754                         sbp2_agent_reset(unit);
755                 }
756
757                 switch (status_get_response(*status)) {
758                 case SBP2_STATUS_REQUEST_COMPLETE:
759                         result = DID_OK;
760                         break;
761                 case SBP2_STATUS_TRANSPORT_FAILURE:
762                         result = DID_BUS_BUSY;
763                         break;
764                 case SBP2_STATUS_ILLEGAL_REQUEST:
765                 case SBP2_STATUS_VENDOR_DEPENDENT:
766                 default:
767                         result = DID_ERROR;
768                         break;
769                 }
770
771                 if (result == DID_OK && status_get_len(*status) > 1)
772                         result = sbp2_status_to_sense_data(status_get_data(*status),
773                                                            orb->cmd->sense_buffer);
774         } else {
775                 /* If the orb completes with status == NULL, something
776                  * went wrong, typically a bus reset happened mid-orb
777                  * or when sending the write (less likely). */
778                 fw_notify("no command orb status, rcode=%d\n",
779                           orb->base.rcode);
780                 result = DID_ERROR;
781         }
782
783         dma_unmap_single(device->card->device, orb->base.request_bus,
784                          sizeof orb->request, DMA_TO_DEVICE);
785
786         if (orb->cmd->use_sg > 0) {
787                 sg = (struct scatterlist *)orb->cmd->request_buffer;
788                 dma_unmap_sg(device->card->device, sg, orb->cmd->use_sg,
789                              orb->cmd->sc_data_direction);
790         }
791
792         if (orb->page_table_bus != 0)
793                 dma_unmap_single(device->card->device, orb->page_table_bus,
794                                  sizeof orb->page_table_bus, DMA_TO_DEVICE);
795
796         if (orb->request_buffer_bus != 0)
797                 dma_unmap_single(device->card->device, orb->request_buffer_bus,
798                                  sizeof orb->request_buffer_bus,
799                                  DMA_FROM_DEVICE);
800
801         orb->cmd->result = result << 16;
802         orb->done(orb->cmd);
803
804         kfree(orb);
805 }
806
807 static void sbp2_command_orb_map_scatterlist(struct sbp2_command_orb *orb)
808 {
809         struct fw_unit *unit =
810                 (struct fw_unit *)orb->cmd->device->host->hostdata[0];
811         struct fw_device *device = fw_device(unit->device.parent);
812         struct sbp2_device *sd = unit->device.driver_data;
813         struct scatterlist *sg;
814         int sg_len, l, i, j, count;
815         size_t size;
816         dma_addr_t sg_addr;
817
818         sg = (struct scatterlist *)orb->cmd->request_buffer;
819         count = dma_map_sg(device->card->device, sg, orb->cmd->use_sg,
820                            orb->cmd->sc_data_direction);
821
822         /* Handle the special case where there is only one element in
823          * the scatter list by converting it to an immediate block
824          * request. This is also a workaround for broken devices such
825          * as the second generation iPod which doesn't support page
826          * tables. */
827         if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
828                 orb->request.data_descriptor.high = sd->address_high;
829                 orb->request.data_descriptor.low  = sg_dma_address(sg);
830                 orb->request.misc |=
831                         command_orb_data_size(sg_dma_len(sg));
832                 return;
833         }
834
835         /* Convert the scatterlist to an sbp2 page table.  If any
836          * scatterlist entries are too big for sbp2 we split the as we go. */
837         for (i = 0, j = 0; i < count; i++) {
838                 sg_len = sg_dma_len(sg + i);
839                 sg_addr = sg_dma_address(sg + i);
840                 while (sg_len) {
841                         l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
842                         orb->page_table[j].low = sg_addr;
843                         orb->page_table[j].high = (l << 16);
844                         sg_addr += l;
845                         sg_len -= l;
846                         j++;
847                 }
848         }
849
850         size = sizeof orb->page_table[0] * j;
851
852         /* The data_descriptor pointer is the one case where we need
853          * to fill in the node ID part of the address.  All other
854          * pointers assume that the data referenced reside on the
855          * initiator (i.e. us), but data_descriptor can refer to data
856          * on other nodes so we need to put our ID in descriptor.high. */
857
858         orb->page_table_bus =
859                 dma_map_single(device->card->device, orb->page_table,
860                                size, DMA_TO_DEVICE);
861         orb->request.data_descriptor.high = sd->address_high;
862         orb->request.data_descriptor.low  = orb->page_table_bus;
863         orb->request.misc |=
864                 command_orb_page_table_present |
865                 command_orb_data_size(j);
866
867         fw_memcpy_to_be32(orb->page_table, orb->page_table, size);
868 }
869
870 static void sbp2_command_orb_map_buffer(struct sbp2_command_orb *orb)
871 {
872         struct fw_unit *unit =
873                 (struct fw_unit *)orb->cmd->device->host->hostdata[0];
874         struct fw_device *device = fw_device(unit->device.parent);
875         struct sbp2_device *sd = unit->device.driver_data;
876
877         /* As for map_scatterlist, we need to fill in the high bits of
878          * the data_descriptor pointer. */
879
880         orb->request_buffer_bus =
881                 dma_map_single(device->card->device,
882                                orb->cmd->request_buffer,
883                                orb->cmd->request_bufflen,
884                                orb->cmd->sc_data_direction);
885         orb->request.data_descriptor.high = sd->address_high;
886         orb->request.data_descriptor.low  = orb->request_buffer_bus;
887         orb->request.misc |=
888                 command_orb_data_size(orb->cmd->request_bufflen);
889 }
890
891 /* SCSI stack integration */
892
893 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
894 {
895         struct fw_unit *unit = (struct fw_unit *)cmd->device->host->hostdata[0];
896         struct fw_device *device = fw_device(unit->device.parent);
897         struct sbp2_device *sd = unit->device.driver_data;
898         struct sbp2_command_orb *orb;
899
900         /* Bidirectional commands are not yet implemented, and unknown
901          * transfer direction not handled. */
902         if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
903                 fw_error("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
904                 cmd->result = DID_ERROR << 16;
905                 done(cmd);
906                 return 0;
907         }
908
909         orb = kzalloc(sizeof *orb, GFP_ATOMIC);
910         if (orb == NULL) {
911                 fw_notify("failed to alloc orb\n");
912                 cmd->result = DID_NO_CONNECT << 16;
913                 done(cmd);
914                 return 0;
915         }
916
917         orb->base.request_bus =
918                 dma_map_single(device->card->device, &orb->request,
919                                sizeof orb->request, DMA_TO_DEVICE);
920
921         orb->unit = unit;
922         orb->done = done;
923         orb->cmd  = cmd;
924
925         orb->request.next.high   = SBP2_ORB_NULL;
926         orb->request.next.low    = 0x0;
927         /* At speed 100 we can do 512 bytes per packet, at speed 200,
928          * 1024 bytes per packet etc.  The SBP-2 max_payload field
929          * specifies the max payload size as 2 ^ (max_payload + 2), so
930          * if we set this to max_speed + 7, we get the right value. */
931         orb->request.misc =
932                 command_orb_max_payload(device->node->max_speed + 7) |
933                 command_orb_speed(device->node->max_speed) |
934                 command_orb_notify;
935
936         if (cmd->sc_data_direction == DMA_FROM_DEVICE)
937                 orb->request.misc |=
938                         command_orb_direction(SBP2_DIRECTION_FROM_MEDIA);
939         else if (cmd->sc_data_direction == DMA_TO_DEVICE)
940                 orb->request.misc |=
941                         command_orb_direction(SBP2_DIRECTION_TO_MEDIA);
942
943         if (cmd->use_sg) {
944                 sbp2_command_orb_map_scatterlist(orb);
945         } else if (cmd->request_bufflen > SBP2_MAX_SG_ELEMENT_LENGTH) {
946                 /* FIXME: Need to split this into a sg list... but
947                  * could we get the scsi or blk layer to do that by
948                  * reporting our max supported block size? */
949                 fw_error("command > 64k\n");
950                 cmd->result = DID_ERROR << 16;
951                 done(cmd);
952                 return 0;
953         } else if (cmd->request_bufflen > 0) {
954                 sbp2_command_orb_map_buffer(orb);
955         }
956
957         fw_memcpy_to_be32(&orb->request, &orb->request, sizeof orb->request);
958
959         memset(orb->request.command_block,
960                0, sizeof orb->request.command_block);
961         memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
962
963         orb->base.callback = complete_command_orb;
964
965         sbp2_send_orb(&orb->base, unit, sd->node_id, sd->generation,
966                       sd->command_block_agent_address + SBP2_ORB_POINTER);
967
968         return 0;
969 }
970
971 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
972 {
973         struct fw_unit *unit = (struct fw_unit *)sdev->host->hostdata[0];
974         struct sbp2_device *sd = unit->device.driver_data;
975
976         sdev->allow_restart = 1;
977
978         if (sd->workarounds & SBP2_WORKAROUND_INQUIRY_36)
979                 sdev->inquiry_len = 36;
980         return 0;
981 }
982
983 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
984 {
985         struct fw_unit *unit = (struct fw_unit *)sdev->host->hostdata[0];
986         struct sbp2_device *sd = unit->device.driver_data;
987
988         sdev->use_10_for_rw = 1;
989
990         if (sdev->type == TYPE_ROM)
991                 sdev->use_10_for_ms = 1;
992         if (sdev->type == TYPE_DISK &&
993             sd->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
994                 sdev->skip_ms_page_8 = 1;
995         if (sd->workarounds & SBP2_WORKAROUND_FIX_CAPACITY) {
996                 fw_notify("setting fix_capacity for %s\n", unit->device.bus_id);
997                 sdev->fix_capacity = 1;
998         }
999
1000         return 0;
1001 }
1002
1003 /*
1004  * Called by scsi stack when something has really gone wrong.  Usually
1005  * called when a command has timed-out for some reason.
1006  */
1007 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1008 {
1009         struct fw_unit *unit = (struct fw_unit *)cmd->device->host->hostdata[0];
1010
1011         fw_notify("sbp2_scsi_abort\n");
1012
1013         sbp2_cancel_orbs(unit);
1014
1015         return SUCCESS;
1016 }
1017
1018 static struct scsi_host_template scsi_driver_template = {
1019         .module                 = THIS_MODULE,
1020         .name                   = "SBP-2 IEEE-1394",
1021         .proc_name              = (char *)sbp2_driver_name,
1022         .queuecommand           = sbp2_scsi_queuecommand,
1023         .slave_alloc            = sbp2_scsi_slave_alloc,
1024         .slave_configure        = sbp2_scsi_slave_configure,
1025         .eh_abort_handler       = sbp2_scsi_abort,
1026         .this_id                = -1,
1027         .sg_tablesize           = SG_ALL,
1028         .use_clustering         = ENABLE_CLUSTERING,
1029         .cmd_per_lun            = 1,
1030         .can_queue              = 1,
1031 };
1032
1033 static int add_scsi_devices(struct fw_unit *unit)
1034 {
1035         struct sbp2_device *sd = unit->device.driver_data;
1036         int retval, lun;
1037
1038         sd->scsi_host = scsi_host_alloc(&scsi_driver_template,
1039                                         sizeof(unsigned long));
1040         if (sd->scsi_host == NULL) {
1041                 fw_error("failed to register scsi host\n");
1042                 return -1;
1043         }
1044
1045         sd->scsi_host->hostdata[0] = (unsigned long)unit;
1046         retval = scsi_add_host(sd->scsi_host, &unit->device);
1047         if (retval < 0) {
1048                 fw_error("failed to add scsi host\n");
1049                 scsi_host_put(sd->scsi_host);
1050                 return retval;
1051         }
1052
1053         /* FIXME: Loop over luns here. */
1054         lun = 0;
1055         retval = scsi_add_device(sd->scsi_host, 0, 0, lun);
1056         if (retval < 0) {
1057                 fw_error("failed to add scsi device\n");
1058                 scsi_remove_host(sd->scsi_host);
1059                 scsi_host_put(sd->scsi_host);
1060                 return retval;
1061         }
1062
1063         return 0;
1064 }
1065
1066 static void remove_scsi_devices(struct fw_unit *unit)
1067 {
1068         struct sbp2_device *sd = unit->device.driver_data;
1069
1070         scsi_remove_host(sd->scsi_host);
1071         scsi_host_put(sd->scsi_host);
1072 }
1073
1074 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1075 MODULE_DESCRIPTION("SCSI over IEEE1394");
1076 MODULE_LICENSE("GPL");
1077 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1078
1079 static int __init sbp2_init(void)
1080 {
1081         return driver_register(&sbp2_driver.driver);
1082 }
1083
1084 static void __exit sbp2_cleanup(void)
1085 {
1086         driver_unregister(&sbp2_driver.driver);
1087 }
1088
1089 module_init(sbp2_init);
1090 module_exit(sbp2_cleanup);