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                     orb->rcode == RCODE_COMPLETE) {
 298                         list_del(&orb->link);
 299                         break;
 300                 }
 301         }
 302         spin_unlock_irqrestore(&card->lock, flags);
 303
 304         if (&orb->link != &sd->orb_list)
 305                 orb->callback(orb, &status);
 306         else
 307                 fw_error("status write for unknown orb\n");
 308
 309         fw_send_response(card, request, RCODE_COMPLETE);
 310 }
 311
 312 static void
 313 complete_transaction(struct fw_card *card, int rcode,
 314                      void *payload, size_t length, void *data)
 315 {
 316         struct sbp2_orb *orb = data;
 317         unsigned long flags;
 318
 319         orb->rcode = rcode;
 320         if (rcode != RCODE_COMPLETE) {
 321                 spin_lock_irqsave(&card->lock, flags);
 322                 list_del(&orb->link);
 323                 spin_unlock_irqrestore(&card->lock, flags);
 324                 orb->callback(orb, NULL);
 325         }
 326 }
 327
 328 static void
 329 sbp2_send_orb(struct sbp2_orb *orb, struct fw_unit *unit,
 330               int node_id, int generation, u64 offset)
 331 {
 332         struct fw_device *device = fw_device(unit->device.parent);
 333         struct sbp2_device *sd = unit->device.driver_data;
 334         unsigned long flags;
 335
 336         orb->pointer.high = 0;
 337         orb->pointer.low = orb->request_bus;
 338         fw_memcpy_to_be32(&orb->pointer, &orb->pointer, sizeof orb->pointer);
 339
 340         spin_lock_irqsave(&device->card->lock, flags);
 341         list_add_tail(&orb->link, &sd->orb_list);
 342         spin_unlock_irqrestore(&device->card->lock, flags);
 343
 344         fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
 345                         node_id, generation,
 346                         device->node->max_speed, offset,
 347                         &orb->pointer, sizeof orb->pointer,
 348                         complete_transaction, orb);
 349 }
 350
 351 static int sbp2_cancel_orbs(struct fw_unit *unit)
 352 {
 353         struct fw_device *device = fw_device(unit->device.parent);
 354         struct sbp2_device *sd = unit->device.driver_data;
 355         struct sbp2_orb *orb, *next;
 356         struct list_head list;
 357         unsigned long flags;
 358         int retval = -ENOENT;
 359
 360         INIT_LIST_HEAD(&list);
 361         spin_lock_irqsave(&device->card->lock, flags);
 362         list_splice_init(&sd->orb_list, &list);
 363         spin_unlock_irqrestore(&device->card->lock, flags);
 364
 365         list_for_each_entry_safe(orb, next, &list, link) {
 366                 retval = 0;
 367                 if (fw_cancel_transaction(device->card, &orb->t) == 0)
 368                         continue;
 369
 370                 orb->rcode = RCODE_CANCELLED;
 371                 orb->callback(orb, NULL);
 372         }
 373
 374         return retval;
 375 }
 376
 377 static void
 378 complete_management_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
 379 {
 380         struct sbp2_management_orb *orb =
 381             (struct sbp2_management_orb *)base_orb;
 382
 383         if (status)
 384                 memcpy(&orb->status, status, sizeof *status);
 385         complete(&orb->done);
 386 }
 387
 388 static int
 389 sbp2_send_management_orb(struct fw_unit *unit, int node_id, int generation,
 390                          int function, int lun, void *response)
 391 {
 392         struct fw_device *device = fw_device(unit->device.parent);
 393         struct sbp2_device *sd = unit->device.driver_data;
 394         struct sbp2_management_orb *orb;
 395         int retval = -ENOMEM;
 396
 397         orb = kzalloc(sizeof *orb, GFP_ATOMIC);
 398         if (orb == NULL)
 399                 return -ENOMEM;
 400
 401         /* The sbp2 device is going to send a block read request to
 402          * read out the request from host memory, so map it for
 403          * dma. */
 404         orb->base.request_bus =
 405                 dma_map_single(device->card->device, &orb->request,
 406                                sizeof orb->request, DMA_TO_DEVICE);
 407         if (dma_mapping_error(orb->base.request_bus))
 408                 goto out;
 409
 410         orb->response_bus =
 411                 dma_map_single(device->card->device, &orb->response,
 412                                sizeof orb->response, DMA_FROM_DEVICE);
 413         if (dma_mapping_error(orb->response_bus))
 414                 goto out;
 415
 416         orb->request.response.high    = 0;
 417         orb->request.response.low     = orb->response_bus;
 418
 419         orb->request.misc =
 420                 management_orb_notify |
 421                 management_orb_function(function) |
 422                 management_orb_lun(lun);
 423         orb->request.length =
 424                 management_orb_response_length(sizeof orb->response);
 425
 426         orb->request.status_fifo.high = sd->address_handler.offset >> 32;
 427         orb->request.status_fifo.low  = sd->address_handler.offset;
 428
 429         /* FIXME: Yeah, ok this isn't elegant, we hardwire exclusive
 430          * login and 1 second reconnect time.  The reconnect setting
 431          * is probably fine, but the exclusive login should be an
 432          * option. */
 433         if (function == SBP2_LOGIN_REQUEST) {
 434                 orb->request.misc |=
 435                         management_orb_exclusive |
 436                         management_orb_reconnect(0);
 437         }
 438
 439         fw_memcpy_to_be32(&orb->request, &orb->request, sizeof orb->request);
 440
 441         init_completion(&orb->done);
 442         orb->base.callback = complete_management_orb;
 443
 444         sbp2_send_orb(&orb->base, unit,
 445                       node_id, generation, sd->management_agent_address);
 446
 447         wait_for_completion_timeout(&orb->done,
 448                                     msecs_to_jiffies(SBP2_ORB_TIMEOUT));
 449
 450         retval = -EIO;
 451         if (sbp2_cancel_orbs(unit) == 0) {
 452                 fw_error("orb reply timed out, rcode=0x%02x\n",
 453                          orb->base.rcode);
 454                 goto out;
 455         }
 456
 457         if (orb->base.rcode != RCODE_COMPLETE) {
 458                 fw_error("management write failed, rcode 0x%02x\n",
 459                          orb->base.rcode);
 460                 goto out;
 461         }
 462
 463         if (status_get_response(orb->status) != 0 ||
 464             status_get_sbp_status(orb->status) != 0) {
 465                 fw_error("error status: %d:%d\n",
 466                          status_get_response(orb->status),
 467                          status_get_sbp_status(orb->status));
 468                 goto out;
 469         }
 470
 471         retval = 0;
 472  out:
 473         dma_unmap_single(device->card->device, orb->base.request_bus,
 474                          sizeof orb->request, DMA_TO_DEVICE);
 475         dma_unmap_single(device->card->device, orb->response_bus,
 476                          sizeof orb->response, DMA_FROM_DEVICE);
 477
 478         if (response)
 479                 fw_memcpy_from_be32(response,
 480                                     orb->response, sizeof orb->response);
 481         kfree(orb);
 482
 483         return retval;
 484 }
 485
 486 static void
 487 complete_agent_reset_write(struct fw_card *card, int rcode,
 488                            void *payload, size_t length, void *data)
 489 {
 490         struct fw_transaction *t = data;
 491
 492         kfree(t);
 493 }
 494
 495 static int sbp2_agent_reset(struct fw_unit *unit)
 496 {
 497         struct fw_device *device = fw_device(unit->device.parent);
 498         struct sbp2_device *sd = unit->device.driver_data;
 499         struct fw_transaction *t;
 500         static u32 zero;
 501
 502         t = kzalloc(sizeof *t, GFP_ATOMIC);
 503         if (t == NULL)
 504                 return -ENOMEM;
 505
 506         fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
 507                         sd->node_id, sd->generation, SCODE_400,
 508                         sd->command_block_agent_address + SBP2_AGENT_RESET,
 509                         &zero, sizeof zero, complete_agent_reset_write, t);
 510
 511         return 0;
 512 }
 513
 514 static int add_scsi_devices(struct fw_unit *unit);
 515 static void remove_scsi_devices(struct fw_unit *unit);
 516 static void sbp2_reconnect(struct work_struct *work);
 517
 518 static void
 519 release_sbp2_device(struct kref *kref)
 520 {
 521         struct sbp2_device *sd = container_of(kref, struct sbp2_device, kref);
 522
 523         sbp2_send_management_orb(sd->unit, sd->node_id, sd->generation,
 524                                  SBP2_LOGOUT_REQUEST, sd->login_id, NULL);
 525
 526         remove_scsi_devices(sd->unit);
 527
 528         fw_core_remove_address_handler(&sd->address_handler);
 529         fw_notify("removed sbp2 unit %s\n", sd->unit->device.bus_id);
 530         put_device(&sd->unit->device);
 531         kfree(sd);
 532 }
 533
 534 static void sbp2_login(struct work_struct *work)
 535 {
 536         struct sbp2_device *sd =
 537                 container_of(work, struct sbp2_device, work.work);
 538         struct fw_unit *unit = sd->unit;
 539         struct fw_device *device = fw_device(unit->device.parent);
 540         struct sbp2_login_response response;
 541         int generation, node_id, local_node_id, lun, retval;
 542
 543         /* FIXME: Make this work for multi-lun devices. */
 544         lun = 0;
 545
 546         generation    = device->card->generation;
 547         node_id       = device->node->node_id;
 548         local_node_id = device->card->local_node->node_id;
 549
 550         if (sbp2_send_management_orb(unit, node_id, generation,
 551                                      SBP2_LOGIN_REQUEST, lun, &response) < 0) {
 552                 if (sd->retries++ < 5) {
 553                         schedule_delayed_work(&sd->work, DIV_ROUND_UP(HZ, 5));
 554                 } else {
 555                         fw_error("failed to login to %s\n",
 556                                  unit->device.bus_id);
 557                         remove_scsi_devices(unit);
 558                         kref_put(&sd->kref, release_sbp2_device);
 559                 }
 560                 return;
 561         }
 562
 563         sd->generation   = generation;
 564         sd->node_id      = node_id;
 565         sd->address_high = local_node_id << 16;
 566
 567         /* Get command block agent offset and login id. */
 568         sd->command_block_agent_address =
 569                 ((u64) (response.command_block_agent.high & 0xffff) << 32) |
 570                 response.command_block_agent.low;
 571         sd->login_id = login_response_get_login_id(response);
 572
 573         fw_notify("logged in to sbp2 unit %s (%d retries)\n",
 574                   unit->device.bus_id, sd->retries);
 575         fw_notify(" - management_agent_address:    0x%012llx\n",
 576                   (unsigned long long) sd->management_agent_address);
 577         fw_notify(" - command_block_agent_address: 0x%012llx\n",
 578                   (unsigned long long) sd->command_block_agent_address);
 579         fw_notify(" - status write address:        0x%012llx\n",
 580                   (unsigned long long) sd->address_handler.offset);
 581
 582 #if 0
 583         /* FIXME: The linux1394 sbp2 does this last step. */
 584         sbp2_set_busy_timeout(scsi_id);
 585 #endif
 586
 587         PREPARE_DELAYED_WORK(&sd->work, sbp2_reconnect);
 588         sbp2_agent_reset(unit);
 589
 590         retval = add_scsi_devices(unit);
 591         if (retval < 0) {
 592                 sbp2_send_management_orb(unit, sd->node_id, sd->generation,
 593                                          SBP2_LOGOUT_REQUEST, sd->login_id,
 594                                          NULL);
 595                 /* Set this back to sbp2_login so we fall back and
 596                  * retry login on bus reset. */
 597                 PREPARE_DELAYED_WORK(&sd->work, sbp2_login);
 598         }
 599         kref_put(&sd->kref, release_sbp2_device);
 600 }
 601
 602 static int sbp2_probe(struct device *dev)
 603 {
 604         struct fw_unit *unit = fw_unit(dev);
 605         struct fw_device *device = fw_device(unit->device.parent);
 606         struct sbp2_device *sd;
 607         struct fw_csr_iterator ci;
 608         int i, key, value;
 609         u32 model, firmware_revision;
 610
 611         sd = kzalloc(sizeof *sd, GFP_KERNEL);
 612         if (sd == NULL)
 613                 return -ENOMEM;
 614
 615         unit->device.driver_data = sd;
 616         sd->unit = unit;
 617         INIT_LIST_HEAD(&sd->orb_list);
 618         kref_init(&sd->kref);
 619
 620         sd->address_handler.length = 0x100;
 621         sd->address_handler.address_callback = sbp2_status_write;
 622         sd->address_handler.callback_data = sd;
 623
 624         if (fw_core_add_address_handler(&sd->address_handler,
 625                                         &fw_high_memory_region) < 0) {
 626                 kfree(sd);
 627                 return -EBUSY;
 628         }
 629
 630         if (fw_device_enable_phys_dma(device) < 0) {
 631                 fw_core_remove_address_handler(&sd->address_handler);
 632                 kfree(sd);
 633                 return -EBUSY;
 634         }
 635
 636         /* Scan unit directory to get management agent address,
 637          * firmware revison and model.  Initialize firmware_revision
 638          * and model to values that wont match anything in our table. */
 639         firmware_revision = 0xff000000;
 640         model = 0xff000000;
 641         fw_csr_iterator_init(&ci, unit->directory);
 642         while (fw_csr_iterator_next(&ci, &key, &value)) {
 643                 switch (key) {
 644                 case CSR_DEPENDENT_INFO | CSR_OFFSET:
 645                         sd->management_agent_address =
 646                                 0xfffff0000000ULL + 4 * value;
 647                         break;
 648                 case SBP2_FIRMWARE_REVISION:
 649                         firmware_revision = value;
 650                         break;
 651                 case CSR_MODEL:
 652                         model = value;
 653                         break;
 654                 }
 655         }
 656
 657         for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
 658                 if (sbp2_workarounds_table[i].firmware_revision !=
 659                     (firmware_revision & 0xffffff00))
 660                         continue;
 661                 if (sbp2_workarounds_table[i].model != model &&
 662                     sbp2_workarounds_table[i].model != ~0)
 663                         continue;
 664                 sd->workarounds |= sbp2_workarounds_table[i].workarounds;
 665                 break;
 666         }
 667
 668         if (sd->workarounds)
 669                 fw_notify("Workarounds for node %s: 0x%x "
 670                           "(firmware_revision 0x%06x, model_id 0x%06x)\n",
 671                           unit->device.bus_id,
 672                           sd->workarounds, firmware_revision, model);
 673
 674         get_device(&unit->device);
 675
 676         /* We schedule work to do the login so we can easily
 677          * reschedule retries. Always get the ref before scheduling
 678          * work.*/
 679         INIT_DELAYED_WORK(&sd->work, sbp2_login);
 680         if (schedule_delayed_work(&sd->work, 0))
 681                 kref_get(&sd->kref);
 682
 683         return 0;
 684 }
 685
 686 static int sbp2_remove(struct device *dev)
 687 {
 688         struct fw_unit *unit = fw_unit(dev);
 689         struct sbp2_device *sd = unit->device.driver_data;
 690
 691         kref_put(&sd->kref, release_sbp2_device);
 692
 693         return 0;
 694 }
 695
 696 static void sbp2_reconnect(struct work_struct *work)
 697 {
 698         struct sbp2_device *sd =
 699                 container_of(work, struct sbp2_device, work.work);
 700         struct fw_unit *unit = sd->unit;
 701         struct fw_device *device = fw_device(unit->device.parent);
 702         int generation, node_id, local_node_id;
 703
 704         generation    = device->card->generation;
 705         node_id       = device->node->node_id;
 706         local_node_id = device->card->local_node->node_id;
 707
 708         if (sbp2_send_management_orb(unit, node_id, generation,
 709                                      SBP2_RECONNECT_REQUEST,
 710                                      sd->login_id, NULL) < 0) {
 711                 if (sd->retries++ >= 5) {
 712                         fw_error("failed to reconnect to %s\n",
 713                                  unit->device.bus_id);
 714                         /* Fall back and try to log in again. */
 715                         sd->retries = 0;
 716                         PREPARE_DELAYED_WORK(&sd->work, sbp2_login);
 717                 }
 718                 schedule_delayed_work(&sd->work, DIV_ROUND_UP(HZ, 5));
 719                 return;
 720         }
 721
 722         sd->generation   = generation;
 723         sd->node_id      = node_id;
 724         sd->address_high = local_node_id << 16;
 725
 726         fw_notify("reconnected to unit %s (%d retries)\n",
 727                   unit->device.bus_id, sd->retries);
 728         sbp2_agent_reset(unit);
 729         sbp2_cancel_orbs(unit);
 730         kref_put(&sd->kref, release_sbp2_device);
 731 }
 732
 733 static void sbp2_update(struct fw_unit *unit)
 734 {
 735         struct fw_device *device = fw_device(unit->device.parent);
 736         struct sbp2_device *sd = unit->device.driver_data;
 737
 738         sd->retries = 0;
 739         fw_device_enable_phys_dma(device);
 740         if (schedule_delayed_work(&sd->work, 0))
 741                 kref_get(&sd->kref);
 742 }
 743
 744 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
 745 #define SBP2_SW_VERSION_ENTRY   0x00010483
 746
 747 static const struct fw_device_id sbp2_id_table[] = {
 748         {
 749                 .match_flags  = FW_MATCH_SPECIFIER_ID | FW_MATCH_VERSION,
 750                 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
 751                 .version      = SBP2_SW_VERSION_ENTRY,
 752         },
 753         { }
 754 };
 755
 756 static struct fw_driver sbp2_driver = {
 757         .driver   = {
 758                 .owner  = THIS_MODULE,
 759                 .name   = sbp2_driver_name,
 760                 .bus    = &fw_bus_type,
 761                 .probe  = sbp2_probe,
 762                 .remove = sbp2_remove,
 763         },
 764         .update   = sbp2_update,
 765         .id_table = sbp2_id_table,
 766 };
 767
 768 static unsigned int
 769 sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
 770 {
 771         int sam_status;
 772
 773         sense_data[0] = 0x70;
 774         sense_data[1] = 0x0;
 775         sense_data[2] = sbp2_status[1];
 776         sense_data[3] = sbp2_status[4];
 777         sense_data[4] = sbp2_status[5];
 778         sense_data[5] = sbp2_status[6];
 779         sense_data[6] = sbp2_status[7];
 780         sense_data[7] = 10;
 781         sense_data[8] = sbp2_status[8];
 782         sense_data[9] = sbp2_status[9];
 783         sense_data[10] = sbp2_status[10];
 784         sense_data[11] = sbp2_status[11];
 785         sense_data[12] = sbp2_status[2];
 786         sense_data[13] = sbp2_status[3];
 787         sense_data[14] = sbp2_status[12];
 788         sense_data[15] = sbp2_status[13];
 789
 790         sam_status = sbp2_status[0] & 0x3f;
 791
 792         switch (sam_status) {
 793         case SAM_STAT_GOOD:
 794         case SAM_STAT_CHECK_CONDITION:
 795         case SAM_STAT_CONDITION_MET:
 796         case SAM_STAT_BUSY:
 797         case SAM_STAT_RESERVATION_CONFLICT:
 798         case SAM_STAT_COMMAND_TERMINATED:
 799                 return DID_OK << 16 | sam_status;
 800
 801         default:
 802                 return DID_ERROR << 16;
 803         }
 804 }
 805
 806 static void
 807 complete_command_orb(struct sbp2_orb *base_orb, struct sbp2_status *status)
 808 {
 809         struct sbp2_command_orb *orb = (struct sbp2_command_orb *)base_orb;
 810         struct fw_unit *unit = orb->unit;
 811         struct fw_device *device = fw_device(unit->device.parent);
 812         struct scatterlist *sg;
 813         int result;
 814
 815         if (status != NULL) {
 816                 if (status_get_dead(*status))
 817                         sbp2_agent_reset(unit);
 818
 819                 switch (status_get_response(*status)) {
 820                 case SBP2_STATUS_REQUEST_COMPLETE:
 821                         result = DID_OK << 16;
 822                         break;
 823                 case SBP2_STATUS_TRANSPORT_FAILURE:
 824                         result = DID_BUS_BUSY << 16;
 825                         break;
 826                 case SBP2_STATUS_ILLEGAL_REQUEST:
 827                 case SBP2_STATUS_VENDOR_DEPENDENT:
 828                 default:
 829                         result = DID_ERROR << 16;
 830                         break;
 831                 }
 832
 833                 if (result == DID_OK << 16 && status_get_len(*status) > 1)
 834                         result = sbp2_status_to_sense_data(status_get_data(*status),
 835                                                            orb->cmd->sense_buffer);
 836         } else {
 837                 /* If the orb completes with status == NULL, something
 838                  * went wrong, typically a bus reset happened mid-orb
 839                  * or when sending the write (less likely). */
 840                 result = DID_BUS_BUSY << 16;
 841         }
 842
 843         dma_unmap_single(device->card->device, orb->base.request_bus,
 844                          sizeof orb->request, DMA_TO_DEVICE);
 845
 846         if (orb->cmd->use_sg > 0) {
 847                 sg = (struct scatterlist *)orb->cmd->request_buffer;
 848                 dma_unmap_sg(device->card->device, sg, orb->cmd->use_sg,
 849                              orb->cmd->sc_data_direction);
 850         }
 851
 852         if (orb->page_table_bus != 0)
 853                 dma_unmap_single(device->card->device, orb->page_table_bus,
 854                                  sizeof orb->page_table_bus, DMA_TO_DEVICE);
 855
 856         if (orb->request_buffer_bus != 0)
 857                 dma_unmap_single(device->card->device, orb->request_buffer_bus,
 858                                  sizeof orb->request_buffer_bus,
 859                                  DMA_FROM_DEVICE);
 860
 861         orb->cmd->result = result;
 862         orb->done(orb->cmd);
 863         kfree(orb);
 864 }
 865
 866 static void sbp2_command_orb_map_scatterlist(struct sbp2_command_orb *orb)
 867 {
 868         struct fw_unit *unit =
 869                 (struct fw_unit *)orb->cmd->device->host->hostdata[0];
 870         struct fw_device *device = fw_device(unit->device.parent);
 871         struct sbp2_device *sd = unit->device.driver_data;
 872         struct scatterlist *sg;
 873         int sg_len, l, i, j, count;
 874         size_t size;
 875         dma_addr_t sg_addr;
 876
 877         sg = (struct scatterlist *)orb->cmd->request_buffer;
 878         count = dma_map_sg(device->card->device, sg, orb->cmd->use_sg,
 879                            orb->cmd->sc_data_direction);
 880
 881         /* Handle the special case where there is only one element in
 882          * the scatter list by converting it to an immediate block
 883          * request. This is also a workaround for broken devices such
 884          * as the second generation iPod which doesn't support page
 885          * tables. */
 886         if (count == 1 && sg_dma_len(sg) < SBP2_MAX_SG_ELEMENT_LENGTH) {
 887                 orb->request.data_descriptor.high = sd->address_high;
 888                 orb->request.data_descriptor.low  = sg_dma_address(sg);
 889                 orb->request.misc |=
 890                         command_orb_data_size(sg_dma_len(sg));
 891                 return;
 892         }
 893
 894         /* Convert the scatterlist to an sbp2 page table.  If any
 895          * scatterlist entries are too big for sbp2 we split the as we go. */
 896         for (i = 0, j = 0; i < count; i++) {
 897                 sg_len = sg_dma_len(sg + i);
 898                 sg_addr = sg_dma_address(sg + i);
 899                 while (sg_len) {
 900                         l = min(sg_len, SBP2_MAX_SG_ELEMENT_LENGTH);
 901                         orb->page_table[j].low = sg_addr;
 902                         orb->page_table[j].high = (l << 16);
 903                         sg_addr += l;
 904                         sg_len -= l;
 905                         j++;
 906                 }
 907         }
 908
 909         size = sizeof orb->page_table[0] * j;
 910
 911         /* The data_descriptor pointer is the one case where we need
 912          * to fill in the node ID part of the address.  All other
 913          * pointers assume that the data referenced reside on the
 914          * initiator (i.e. us), but data_descriptor can refer to data
 915          * on other nodes so we need to put our ID in descriptor.high. */
 916
 917         orb->page_table_bus =
 918                 dma_map_single(device->card->device, orb->page_table,
 919                                size, DMA_TO_DEVICE);
 920         orb->request.data_descriptor.high = sd->address_high;
 921         orb->request.data_descriptor.low  = orb->page_table_bus;
 922         orb->request.misc |=
 923                 command_orb_page_table_present |
 924                 command_orb_data_size(j);
 925
 926         fw_memcpy_to_be32(orb->page_table, orb->page_table, size);
 927 }
 928
 929 static void sbp2_command_orb_map_buffer(struct sbp2_command_orb *orb)
 930 {
 931         struct fw_unit *unit =
 932                 (struct fw_unit *)orb->cmd->device->host->hostdata[0];
 933         struct fw_device *device = fw_device(unit->device.parent);
 934         struct sbp2_device *sd = unit->device.driver_data;
 935
 936         /* As for map_scatterlist, we need to fill in the high bits of
 937          * the data_descriptor pointer. */
 938
 939         orb->request_buffer_bus =
 940                 dma_map_single(device->card->device,
 941                                orb->cmd->request_buffer,
 942                                orb->cmd->request_bufflen,
 943                                orb->cmd->sc_data_direction);
 944         orb->request.data_descriptor.high = sd->address_high;
 945         orb->request.data_descriptor.low  = orb->request_buffer_bus;
 946         orb->request.misc |=
 947                 command_orb_data_size(orb->cmd->request_bufflen);
 948 }
 949
 950 /* SCSI stack integration */
 951
 952 static int sbp2_scsi_queuecommand(struct scsi_cmnd *cmd, scsi_done_fn_t done)
 953 {
 954         struct fw_unit *unit = (struct fw_unit *)cmd->device->host->hostdata[0];
 955         struct fw_device *device = fw_device(unit->device.parent);
 956         struct sbp2_device *sd = unit->device.driver_data;
 957         struct sbp2_command_orb *orb;
 958
 959         /* Bidirectional commands are not yet implemented, and unknown
 960          * transfer direction not handled. */
 961         if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
 962                 fw_error("Cannot handle DMA_BIDIRECTIONAL - rejecting command");
 963                 goto fail_alloc;
 964         }
 965
 966         orb = kzalloc(sizeof *orb, GFP_ATOMIC);
 967         if (orb == NULL) {
 968                 fw_notify("failed to alloc orb\n");
 969                 goto fail_alloc;
 970         }
 971
 972         /* Initialize rcode to something not RCODE_COMPLETE. */
 973         orb->base.rcode = -1;
 974         orb->base.request_bus =
 975                 dma_map_single(device->card->device, &orb->request,
 976                                sizeof orb->request, DMA_TO_DEVICE);
 977         if (dma_mapping_error(orb->base.request_bus))
 978                 goto fail_mapping;
 979
 980         orb->unit = unit;
 981         orb->done = done;
 982         orb->cmd  = cmd;
 983
 984         orb->request.next.high   = SBP2_ORB_NULL;
 985         orb->request.next.low    = 0x0;
 986         /* At speed 100 we can do 512 bytes per packet, at speed 200,
 987          * 1024 bytes per packet etc.  The SBP-2 max_payload field
 988          * specifies the max payload size as 2 ^ (max_payload + 2), so
 989          * if we set this to max_speed + 7, we get the right value. */
 990         orb->request.misc =
 991                 command_orb_max_payload(device->node->max_speed + 7) |
 992                 command_orb_speed(device->node->max_speed) |
 993                 command_orb_notify;
 994
 995         if (cmd->sc_data_direction == DMA_FROM_DEVICE)
 996                 orb->request.misc |=
 997                         command_orb_direction(SBP2_DIRECTION_FROM_MEDIA);
 998         else if (cmd->sc_data_direction == DMA_TO_DEVICE)
 999                 orb->request.misc |=
1000                         command_orb_direction(SBP2_DIRECTION_TO_MEDIA);
1001
1002         if (cmd->use_sg) {
1003                 sbp2_command_orb_map_scatterlist(orb);
1004         } else if (cmd->request_bufflen > SBP2_MAX_SG_ELEMENT_LENGTH) {
1005                 /* FIXME: Need to split this into a sg list... but
1006                  * could we get the scsi or blk layer to do that by
1007                  * reporting our max supported block size? */
1008                 fw_error("command > 64k\n");
1009                 goto fail_bufflen;
1010         } else if (cmd->request_bufflen > 0) {
1011                 sbp2_command_orb_map_buffer(orb);
1012         }
1013
1014         fw_memcpy_to_be32(&orb->request, &orb->request, sizeof orb->request);
1015
1016         memset(orb->request.command_block,
1017                0, sizeof orb->request.command_block);
1018         memcpy(orb->request.command_block, cmd->cmnd, COMMAND_SIZE(*cmd->cmnd));
1019
1020         orb->base.callback = complete_command_orb;
1021
1022         sbp2_send_orb(&orb->base, unit, sd->node_id, sd->generation,
1023                       sd->command_block_agent_address + SBP2_ORB_POINTER);
1024
1025         return 0;
1026
1027  fail_bufflen:
1028         dma_unmap_single(device->card->device, orb->base.request_bus,
1029                          sizeof orb->request, DMA_TO_DEVICE);
1030  fail_mapping:
1031         kfree(orb);
1032  fail_alloc:
1033         cmd->result = DID_ERROR << 16;
1034         done(cmd);
1035         return 0;
1036 }
1037
1038 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1039 {
1040         struct fw_unit *unit = (struct fw_unit *)sdev->host->hostdata[0];
1041         struct sbp2_device *sd = unit->device.driver_data;
1042
1043         sdev->allow_restart = 1;
1044
1045         if (sd->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1046                 sdev->inquiry_len = 36;
1047         return 0;
1048 }
1049
1050 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1051 {
1052         struct fw_unit *unit = (struct fw_unit *)sdev->host->hostdata[0];
1053         struct sbp2_device *sd = unit->device.driver_data;
1054
1055         sdev->use_10_for_rw = 1;
1056
1057         if (sdev->type == TYPE_ROM)
1058                 sdev->use_10_for_ms = 1;
1059         if (sdev->type == TYPE_DISK &&
1060             sd->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1061                 sdev->skip_ms_page_8 = 1;
1062         if (sd->workarounds & SBP2_WORKAROUND_FIX_CAPACITY) {
1063                 fw_notify("setting fix_capacity for %s\n", unit->device.bus_id);
1064                 sdev->fix_capacity = 1;
1065         }
1066
1067         return 0;
1068 }
1069
1070 /*
1071  * Called by scsi stack when something has really gone wrong.  Usually
1072  * called when a command has timed-out for some reason.
1073  */
1074 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1075 {
1076         struct fw_unit *unit = (struct fw_unit *)cmd->device->host->hostdata[0];
1077
1078         fw_notify("sbp2_scsi_abort\n");
1079         sbp2_agent_reset(unit);
1080         sbp2_cancel_orbs(unit);
1081
1082         return SUCCESS;
1083 }
1084
1085 static struct scsi_host_template scsi_driver_template = {
1086         .module                 = THIS_MODULE,
1087         .name                   = "SBP-2 IEEE-1394",
1088         .proc_name              = (char *)sbp2_driver_name,
1089         .queuecommand           = sbp2_scsi_queuecommand,
1090         .slave_alloc            = sbp2_scsi_slave_alloc,
1091         .slave_configure        = sbp2_scsi_slave_configure,
1092         .eh_abort_handler       = sbp2_scsi_abort,
1093         .this_id                = -1,
1094         .sg_tablesize           = SG_ALL,
1095         .use_clustering         = ENABLE_CLUSTERING,
1096         .cmd_per_lun            = 1,
1097         .can_queue              = 1,
1098 };
1099
1100 static int add_scsi_devices(struct fw_unit *unit)
1101 {
1102         struct sbp2_device *sd = unit->device.driver_data;
1103         int retval, lun;
1104
1105         if (sd->scsi_host != NULL)
1106                 return 0;
1107
1108         sd->scsi_host = scsi_host_alloc(&scsi_driver_template,
1109                                         sizeof(unsigned long));
1110         if (sd->scsi_host == NULL) {
1111                 fw_error("failed to register scsi host\n");
1112                 return -1;
1113         }
1114
1115         sd->scsi_host->hostdata[0] = (unsigned long)unit;
1116         retval = scsi_add_host(sd->scsi_host, &unit->device);
1117         if (retval < 0) {
1118                 fw_error("failed to add scsi host\n");
1119                 scsi_host_put(sd->scsi_host);
1120                 sd->scsi_host = NULL;
1121                 return retval;
1122         }
1123
1124         /* FIXME: Loop over luns here. */
1125         lun = 0;
1126         retval = scsi_add_device(sd->scsi_host, 0, 0, lun);
1127         if (retval < 0) {
1128                 fw_error("failed to add scsi device\n");
1129                 scsi_remove_host(sd->scsi_host);
1130                 scsi_host_put(sd->scsi_host);
1131                 sd->scsi_host = NULL;
1132                 return retval;
1133         }
1134
1135         return 0;
1136 }
1137
1138 static void remove_scsi_devices(struct fw_unit *unit)
1139 {
1140         struct sbp2_device *sd = unit->device.driver_data;
1141
1142         if (sd->scsi_host != NULL) {
1143                 scsi_remove_host(sd->scsi_host);
1144                 scsi_host_put(sd->scsi_host);
1145         }
1146         sd->scsi_host = NULL;
1147 }
1148
1149 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1150 MODULE_DESCRIPTION("SCSI over IEEE1394");
1151 MODULE_LICENSE("GPL");
1152 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1153
1154 static int __init sbp2_init(void)
1155 {
1156         return driver_register(&sbp2_driver.driver);
1157 }
1158
1159 static void __exit sbp2_cleanup(void)
1160 {
1161         driver_unregister(&sbp2_driver.driver);
1162 }
1163
1164 module_init(sbp2_init);
1165 module_exit(sbp2_cleanup);