SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/firewire/fw-sbp2.c

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