drivers/firewire/sbp2.c

   1 /*
   2  * 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 /*
  22  * The basic structure of this driver is based on the old storage driver,
  23  * drivers/ieee1394/sbp2.c, originally written by
  24  *     James Goodwin <jamesg@filanet.com>
  25  * with later contributions and ongoing maintenance from
  26  *     Ben Collins <bcollins@debian.org>,
  27  *     Stefan Richter <stefanr@s5r6.in-berlin.de>
  28  * and many others.
  29  */
  30
  31 #include <linux/blkdev.h>
  32 #include <linux/bug.h>
  33 #include <linux/completion.h>
  34 #include <linux/delay.h>
  35 #include <linux/device.h>
  36 #include <linux/dma-mapping.h>
  37 #include <linux/firewire.h>
  38 #include <linux/firewire-constants.h>
  39 #include <linux/init.h>
  40 #include <linux/jiffies.h>
  41 #include <linux/kernel.h>
  42 #include <linux/kref.h>
  43 #include <linux/list.h>
  44 #include <linux/mod_devicetable.h>
  45 #include <linux/module.h>
  46 #include <linux/moduleparam.h>
  47 #include <linux/scatterlist.h>
  48 #include <linux/slab.h>
  49 #include <linux/spinlock.h>
  50 #include <linux/string.h>
  51 #include <linux/stringify.h>
  52 #include <linux/workqueue.h>
  53
  54 #include <asm/byteorder.h>
  55 #include <asm/system.h>
  56
  57 #include <scsi/scsi.h>
  58 #include <scsi/scsi_cmnd.h>
  59 #include <scsi/scsi_device.h>
  60 #include <scsi/scsi_host.h>
  61
  62 /*
  63  * So far only bridges from Oxford Semiconductor are known to support
  64  * concurrent logins. Depending on firmware, four or two concurrent logins
  65  * are possible on OXFW911 and newer Oxsemi bridges.
  66  *
  67  * Concurrent logins are useful together with cluster filesystems.
  68  */
  69 static int sbp2_param_exclusive_login = 1;
  70 module_param_named(exclusive_login, sbp2_param_exclusive_login, bool, 0644);
  71 MODULE_PARM_DESC(exclusive_login, "Exclusive login to sbp2 device "
  72                  "(default = Y, use N for concurrent initiators)");
  73
  74 /*
  75  * Flags for firmware oddities
  76  *
  77  * - 128kB max transfer
  78  *   Limit transfer size. Necessary for some old bridges.
  79  *
  80  * - 36 byte inquiry
  81  *   When scsi_mod probes the device, let the inquiry command look like that
  82  *   from MS Windows.
  83  *
  84  * - skip mode page 8
  85  *   Suppress sending of mode_sense for mode page 8 if the device pretends to
  86  *   support the SCSI Primary Block commands instead of Reduced Block Commands.
  87  *
  88  * - fix capacity
  89  *   Tell sd_mod to correct the last sector number reported by read_capacity.
  90  *   Avoids access beyond actual disk limits on devices with an off-by-one bug.
  91  *   Don't use this with devices which don't have this bug.
  92  *
  93  * - delay inquiry
  94  *   Wait extra SBP2_INQUIRY_DELAY seconds after login before SCSI inquiry.
  95  *
  96  * - power condition
  97  *   Set the power condition field in the START STOP UNIT commands sent by
  98  *   sd_mod on suspend, resume, and shutdown (if manage_start_stop is on).
  99  *   Some disks need this to spin down or to resume properly.
 100  *
 101  * - override internal blacklist
 102  *   Instead of adding to the built-in blacklist, use only the workarounds
 103  *   specified in the module load parameter.
 104  *   Useful if a blacklist entry interfered with a non-broken device.
 105  */
 106 #define SBP2_WORKAROUND_128K_MAX_TRANS  0x1
 107 #define SBP2_WORKAROUND_INQUIRY_36      0x2
 108 #define SBP2_WORKAROUND_MODE_SENSE_8    0x4
 109 #define SBP2_WORKAROUND_FIX_CAPACITY    0x8
 110 #define SBP2_WORKAROUND_DELAY_INQUIRY   0x10
 111 #define SBP2_INQUIRY_DELAY              12
 112 #define SBP2_WORKAROUND_POWER_CONDITION 0x20
 113 #define SBP2_WORKAROUND_OVERRIDE        0x100
 114
 115 static int sbp2_param_workarounds;
 116 module_param_named(workarounds, sbp2_param_workarounds, int, 0644);
 117 MODULE_PARM_DESC(workarounds, "Work around device bugs (default = 0"
 118         ", 128kB max transfer = " __stringify(SBP2_WORKAROUND_128K_MAX_TRANS)
 119         ", 36 byte inquiry = "    __stringify(SBP2_WORKAROUND_INQUIRY_36)
 120         ", skip mode page 8 = "   __stringify(SBP2_WORKAROUND_MODE_SENSE_8)
 121         ", fix capacity = "       __stringify(SBP2_WORKAROUND_FIX_CAPACITY)
 122         ", delay inquiry = "      __stringify(SBP2_WORKAROUND_DELAY_INQUIRY)
 123         ", set power condition in start stop unit = "
 124                                   __stringify(SBP2_WORKAROUND_POWER_CONDITION)
 125         ", override internal blacklist = " __stringify(SBP2_WORKAROUND_OVERRIDE)
 126         ", or a combination)");
 127
 128 static const char sbp2_driver_name[] = "sbp2";
 129
 130 /*
 131  * We create one struct sbp2_logical_unit per SBP-2 Logical Unit Number Entry
 132  * and one struct scsi_device per sbp2_logical_unit.
 133  */
 134 struct sbp2_logical_unit {
 135         struct sbp2_target *tgt;
 136         struct list_head link;
 137         struct fw_address_handler address_handler;
 138         struct list_head orb_list;
 139
 140         u64 command_block_agent_address;
 141         u16 lun;
 142         int login_id;
 143
 144         /*
 145          * The generation is updated once we've logged in or reconnected
 146          * to the logical unit.  Thus, I/O to the device will automatically
 147          * fail and get retried if it happens in a window where the device
 148          * is not ready, e.g. after a bus reset but before we reconnect.
 149          */
 150         int generation;
 151         int retries;
 152         struct delayed_work work;
 153         bool has_sdev;
 154         bool blocked;
 155 };
 156
 157 /*
 158  * We create one struct sbp2_target per IEEE 1212 Unit Directory
 159  * and one struct Scsi_Host per sbp2_target.
 160  */
 161 struct sbp2_target {
 162         struct fw_unit *unit;
 163         const char *bus_id;
 164         struct list_head lu_list;
 165
 166         u64 management_agent_address;
 167         u64 guid;
 168         int directory_id;
 169         int node_id;
 170         int address_high;
 171         unsigned int workarounds;
 172         unsigned int mgt_orb_timeout;
 173         unsigned int max_payload;
 174
 175         int dont_block; /* counter for each logical unit */
 176         int blocked;    /* ditto */
 177 };
 178
 179 static struct fw_device *target_device(struct sbp2_target *tgt)
 180 {
 181         return fw_parent_device(tgt->unit);
 182 }
 183
 184 /* Impossible login_id, to detect logout attempt before successful login */
 185 #define INVALID_LOGIN_ID 0x10000
 186
 187 #define SBP2_ORB_TIMEOUT                2000U           /* Timeout in ms */
 188 #define SBP2_ORB_NULL                   0x80000000
 189 #define SBP2_RETRY_LIMIT                0xf             /* 15 retries */
 190 #define SBP2_CYCLE_LIMIT                (0xc8 << 12)    /* 200 125us cycles */
 191
 192 /*
 193  * There is no transport protocol limit to the CDB length,  but we implement
 194  * a fixed length only.  16 bytes is enough for disks larger than 2 TB.
 195  */
 196 #define SBP2_MAX_CDB_SIZE               16
 197
 198 /*
 199  * The default maximum s/g segment size of a FireWire controller is
 200  * usually 0x10000, but SBP-2 only allows 0xffff. Since buffers have to
 201  * be quadlet-aligned, we set the length limit to 0xffff & ~3.
 202  */
 203 #define SBP2_MAX_SEG_SIZE               0xfffc
 204
 205 /* Unit directory keys */
 206 #define SBP2_CSR_UNIT_CHARACTERISTICS   0x3a
 207 #define SBP2_CSR_FIRMWARE_REVISION      0x3c
 208 #define SBP2_CSR_LOGICAL_UNIT_NUMBER    0x14
 209 #define SBP2_CSR_LOGICAL_UNIT_DIRECTORY 0xd4
 210
 211 /* Management orb opcodes */
 212 #define SBP2_LOGIN_REQUEST              0x0
 213 #define SBP2_QUERY_LOGINS_REQUEST       0x1
 214 #define SBP2_RECONNECT_REQUEST          0x3
 215 #define SBP2_SET_PASSWORD_REQUEST       0x4
 216 #define SBP2_LOGOUT_REQUEST             0x7
 217 #define SBP2_ABORT_TASK_REQUEST         0xb
 218 #define SBP2_ABORT_TASK_SET             0xc
 219 #define SBP2_LOGICAL_UNIT_RESET         0xe
 220 #define SBP2_TARGET_RESET_REQUEST       0xf
 221
 222 /* Offsets for command block agent registers */
 223 #define SBP2_AGENT_STATE                0x00
 224 #define SBP2_AGENT_RESET                0x04
 225 #define SBP2_ORB_POINTER                0x08
 226 #define SBP2_DOORBELL                   0x10
 227 #define SBP2_UNSOLICITED_STATUS_ENABLE  0x14
 228
 229 /* Status write response codes */
 230 #define SBP2_STATUS_REQUEST_COMPLETE    0x0
 231 #define SBP2_STATUS_TRANSPORT_FAILURE   0x1
 232 #define SBP2_STATUS_ILLEGAL_REQUEST     0x2
 233 #define SBP2_STATUS_VENDOR_DEPENDENT    0x3
 234
 235 #define STATUS_GET_ORB_HIGH(v)          ((v).status & 0xffff)
 236 #define STATUS_GET_SBP_STATUS(v)        (((v).status >> 16) & 0xff)
 237 #define STATUS_GET_LEN(v)               (((v).status >> 24) & 0x07)
 238 #define STATUS_GET_DEAD(v)              (((v).status >> 27) & 0x01)
 239 #define STATUS_GET_RESPONSE(v)          (((v).status >> 28) & 0x03)
 240 #define STATUS_GET_SOURCE(v)            (((v).status >> 30) & 0x03)
 241 #define STATUS_GET_ORB_LOW(v)           ((v).orb_low)
 242 #define STATUS_GET_DATA(v)              ((v).data)
 243
 244 struct sbp2_status {
 245         u32 status;
 246         u32 orb_low;
 247         u8 data[24];
 248 };
 249
 250 struct sbp2_pointer {
 251         __be32 high;
 252         __be32 low;
 253 };
 254
 255 struct sbp2_orb {
 256         struct fw_transaction t;
 257         struct kref kref;
 258         dma_addr_t request_bus;
 259         int rcode;
 260         void (*callback)(struct sbp2_orb * orb, struct sbp2_status * status);
 261         struct list_head link;
 262 };
 263
 264 #define MANAGEMENT_ORB_LUN(v)                   ((v))
 265 #define MANAGEMENT_ORB_FUNCTION(v)              ((v) << 16)
 266 #define MANAGEMENT_ORB_RECONNECT(v)             ((v) << 20)
 267 #define MANAGEMENT_ORB_EXCLUSIVE(v)             ((v) ? 1 << 28 : 0)
 268 #define MANAGEMENT_ORB_REQUEST_FORMAT(v)        ((v) << 29)
 269 #define MANAGEMENT_ORB_NOTIFY                   ((1) << 31)
 270
 271 #define MANAGEMENT_ORB_RESPONSE_LENGTH(v)       ((v))
 272 #define MANAGEMENT_ORB_PASSWORD_LENGTH(v)       ((v) << 16)
 273
 274 struct sbp2_management_orb {
 275         struct sbp2_orb base;
 276         struct {
 277                 struct sbp2_pointer password;
 278                 struct sbp2_pointer response;
 279                 __be32 misc;
 280                 __be32 length;
 281                 struct sbp2_pointer status_fifo;
 282         } request;
 283         __be32 response[4];
 284         dma_addr_t response_bus;
 285         struct completion done;
 286         struct sbp2_status status;
 287 };
 288
 289 struct sbp2_login_response {
 290         __be32 misc;
 291         struct sbp2_pointer command_block_agent;
 292         __be32 reconnect_hold;
 293 };
 294 #define COMMAND_ORB_DATA_SIZE(v)        ((v))
 295 #define COMMAND_ORB_PAGE_SIZE(v)        ((v) << 16)
 296 #define COMMAND_ORB_PAGE_TABLE_PRESENT  ((1) << 19)
 297 #define COMMAND_ORB_MAX_PAYLOAD(v)      ((v) << 20)
 298 #define COMMAND_ORB_SPEED(v)            ((v) << 24)
 299 #define COMMAND_ORB_DIRECTION           ((1) << 27)
 300 #define COMMAND_ORB_REQUEST_FORMAT(v)   ((v) << 29)
 301 #define COMMAND_ORB_NOTIFY              ((1) << 31)
 302
 303 struct sbp2_command_orb {
 304         struct sbp2_orb base;
 305         struct {
 306                 struct sbp2_pointer next;
 307                 struct sbp2_pointer data_descriptor;
 308                 __be32 misc;
 309                 u8 command_block[SBP2_MAX_CDB_SIZE];
 310         } request;
 311         struct scsi_cmnd *cmd;
 312         struct sbp2_logical_unit *lu;
 313
 314         struct sbp2_pointer page_table[SG_ALL] __attribute__((aligned(8)));
 315         dma_addr_t page_table_bus;
 316 };
 317
 318 #define SBP2_ROM_VALUE_WILDCARD ~0         /* match all */
 319 #define SBP2_ROM_VALUE_MISSING  0xff000000 /* not present in the unit dir. */
 320
 321 /*
 322  * List of devices with known bugs.
 323  *
 324  * The firmware_revision field, masked with 0xffff00, is the best
 325  * indicator for the type of bridge chip of a device.  It yields a few
 326  * false positives but this did not break correctly behaving devices
 327  * so far.
 328  */
 329 static const struct {
 330         u32 firmware_revision;
 331         u32 model;
 332         unsigned int workarounds;
 333 } sbp2_workarounds_table[] = {
 334         /* DViCO Momobay CX-1 with TSB42AA9 bridge */ {
 335                 .firmware_revision      = 0x002800,
 336                 .model                  = 0x001010,
 337                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36 |
 338                                           SBP2_WORKAROUND_MODE_SENSE_8 |
 339                                           SBP2_WORKAROUND_POWER_CONDITION,
 340         },
 341         /* DViCO Momobay FX-3A with TSB42AA9A bridge */ {
 342                 .firmware_revision      = 0x002800,
 343                 .model                  = 0x000000,
 344                 .workarounds            = SBP2_WORKAROUND_POWER_CONDITION,
 345         },
 346         /* Initio bridges, actually only needed for some older ones */ {
 347                 .firmware_revision      = 0x000200,
 348                 .model                  = SBP2_ROM_VALUE_WILDCARD,
 349                 .workarounds            = SBP2_WORKAROUND_INQUIRY_36,
 350         },
 351         /* PL-3507 bridge with Prolific firmware */ {
 352                 .firmware_revision      = 0x012800,
 353                 .model                  = SBP2_ROM_VALUE_WILDCARD,
 354                 .workarounds            = SBP2_WORKAROUND_POWER_CONDITION,
 355         },
 356         /* Symbios bridge */ {
 357                 .firmware_revision      = 0xa0b800,
 358                 .model                  = SBP2_ROM_VALUE_WILDCARD,
 359                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS,
 360         },
 361         /* Datafab MD2-FW2 with Symbios/LSILogic SYM13FW500 bridge */ {
 362                 .firmware_revision      = 0x002600,
 363                 .model                  = SBP2_ROM_VALUE_WILDCARD,
 364                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS,
 365         },
 366         /*
 367          * iPod 2nd generation: needs 128k max transfer size workaround
 368          * iPod 3rd generation: needs fix capacity workaround
 369          */
 370         {
 371                 .firmware_revision      = 0x0a2700,
 372                 .model                  = 0x000000,
 373                 .workarounds            = SBP2_WORKAROUND_128K_MAX_TRANS |
 374                                           SBP2_WORKAROUND_FIX_CAPACITY,
 375         },
 376         /* iPod 4th generation */ {
 377                 .firmware_revision      = 0x0a2700,
 378                 .model                  = 0x000021,
 379                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
 380         },
 381         /* iPod mini */ {
 382                 .firmware_revision      = 0x0a2700,
 383                 .model                  = 0x000022,
 384                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
 385         },
 386         /* iPod mini */ {
 387                 .firmware_revision      = 0x0a2700,
 388                 .model                  = 0x000023,
 389                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
 390         },
 391         /* iPod Photo */ {
 392                 .firmware_revision      = 0x0a2700,
 393                 .model                  = 0x00007e,
 394                 .workarounds            = SBP2_WORKAROUND_FIX_CAPACITY,
 395         }
 396 };
 397
 398 static void free_orb(struct kref *kref)
 399 {
 400         struct sbp2_orb *orb = container_of(kref, struct sbp2_orb, kref);
 401
 402         kfree(orb);
 403 }
 404
 405 static void sbp2_status_write(struct fw_card *card, struct fw_request *request,
 406                               int tcode, int destination, int source,
 407                               int generation, unsigned long long offset,
 408                               void *payload, size_t length, void *callback_data)
 409 {
 410         struct sbp2_logical_unit *lu = callback_data;
 411         struct sbp2_orb *orb;
 412         struct sbp2_status status;
 413         unsigned long flags;
 414
 415         if (tcode != TCODE_WRITE_BLOCK_REQUEST ||
 416             length < 8 || length > sizeof(status)) {
 417                 fw_send_response(card, request, RCODE_TYPE_ERROR);
 418                 return;
 419         }
 420
 421         status.status  = be32_to_cpup(payload);
 422         status.orb_low = be32_to_cpup(payload + 4);
 423         memset(status.data, 0, sizeof(status.data));
 424         if (length > 8)
 425                 memcpy(status.data, payload + 8, length - 8);
 426
 427         if (STATUS_GET_SOURCE(status) == 2 || STATUS_GET_SOURCE(status) == 3) {
 428                 fw_notify("non-orb related status write, not handled\n");
 429                 fw_send_response(card, request, RCODE_COMPLETE);
 430                 return;
 431         }
 432
 433         /* Lookup the orb corresponding to this status write. */
 434         spin_lock_irqsave(&card->lock, flags);
 435         list_for_each_entry(orb, &lu->orb_list, link) {
 436                 if (STATUS_GET_ORB_HIGH(status) == 0 &&
 437                     STATUS_GET_ORB_LOW(status) == orb->request_bus) {
 438                         orb->rcode = RCODE_COMPLETE;
 439                         list_del(&orb->link);
 440                         break;
 441                 }
 442         }
 443         spin_unlock_irqrestore(&card->lock, flags);
 444
 445         if (&orb->link != &lu->orb_list) {
 446                 orb->callback(orb, &status);
 447                 kref_put(&orb->kref, free_orb); /* orb callback reference */
 448         } else {
 449                 fw_error("status write for unknown orb\n");
 450         }
 451
 452         fw_send_response(card, request, RCODE_COMPLETE);
 453 }
 454
 455 static void complete_transaction(struct fw_card *card, int rcode,
 456                                  void *payload, size_t length, void *data)
 457 {
 458         struct sbp2_orb *orb = data;
 459         unsigned long flags;
 460
 461         /*
 462          * This is a little tricky.  We can get the status write for
 463          * the orb before we get this callback.  The status write
 464          * handler above will assume the orb pointer transaction was
 465          * successful and set the rcode to RCODE_COMPLETE for the orb.
 466          * So this callback only sets the rcode if it hasn't already
 467          * been set and only does the cleanup if the transaction
 468          * failed and we didn't already get a status write.
 469          */
 470         spin_lock_irqsave(&card->lock, flags);
 471
 472         if (orb->rcode == -1)
 473                 orb->rcode = rcode;
 474         if (orb->rcode != RCODE_COMPLETE) {
 475                 list_del(&orb->link);
 476                 spin_unlock_irqrestore(&card->lock, flags);
 477
 478                 orb->callback(orb, NULL);
 479                 kref_put(&orb->kref, free_orb); /* orb callback reference */
 480         } else {
 481                 spin_unlock_irqrestore(&card->lock, flags);
 482         }
 483
 484         kref_put(&orb->kref, free_orb); /* transaction callback reference */
 485 }
 486
 487 static void sbp2_send_orb(struct sbp2_orb *orb, struct sbp2_logical_unit *lu,
 488                           int node_id, int generation, u64 offset)
 489 {
 490         struct fw_device *device = target_device(lu->tgt);
 491         struct sbp2_pointer orb_pointer;
 492         unsigned long flags;
 493
 494         orb_pointer.high = 0;
 495         orb_pointer.low = cpu_to_be32(orb->request_bus);
 496
 497         spin_lock_irqsave(&device->card->lock, flags);
 498         list_add_tail(&orb->link, &lu->orb_list);
 499         spin_unlock_irqrestore(&device->card->lock, flags);
 500
 501         kref_get(&orb->kref); /* transaction callback reference */
 502         kref_get(&orb->kref); /* orb callback reference */
 503
 504         fw_send_request(device->card, &orb->t, TCODE_WRITE_BLOCK_REQUEST,
 505                         node_id, generation, device->max_speed, offset,
 506                         &orb_pointer, 8, complete_transaction, orb);
 507 }
 508
 509 static int sbp2_cancel_orbs(struct sbp2_logical_unit *lu)
 510 {
 511         struct fw_device *device = target_device(lu->tgt);
 512         struct sbp2_orb *orb, *next;
 513         struct list_head list;
 514         unsigned long flags;
 515         int retval = -ENOENT;
 516
 517         INIT_LIST_HEAD(&list);
 518         spin_lock_irqsave(&device->card->lock, flags);
 519         list_splice_init(&lu->orb_list, &list);
 520         spin_unlock_irqrestore(&device->card->lock, flags);
 521
 522         list_for_each_entry_safe(orb, next, &list, link) {
 523                 retval = 0;
 524                 if (fw_cancel_transaction(device->card, &orb->t) == 0)
 525                         continue;
 526
 527                 orb->rcode = RCODE_CANCELLED;
 528                 orb->callback(orb, NULL);
 529                 kref_put(&orb->kref, free_orb); /* orb callback reference */
 530         }
 531
 532         return retval;
 533 }
 534
 535 static void complete_management_orb(struct sbp2_orb *base_orb,
 536                                     struct sbp2_status *status)
 537 {
 538         struct sbp2_management_orb *orb =
 539                 container_of(base_orb, struct sbp2_management_orb, base);
 540
 541         if (status)
 542                 memcpy(&orb->status, status, sizeof(*status));
 543         complete(&orb->done);
 544 }
 545
 546 static int sbp2_send_management_orb(struct sbp2_logical_unit *lu, int node_id,
 547                                     int generation, int function,
 548                                     int lun_or_login_id, void *response)
 549 {
 550         struct fw_device *device = target_device(lu->tgt);
 551         struct sbp2_management_orb *orb;
 552         unsigned int timeout;
 553         int retval = -ENOMEM;
 554
 555         if (function == SBP2_LOGOUT_REQUEST && fw_device_is_shutdown(device))
 556                 return 0;
 557
 558         orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
 559         if (orb == NULL)
 560                 return -ENOMEM;
 561
 562         kref_init(&orb->base.kref);
 563         orb->response_bus =
 564                 dma_map_single(device->card->device, &orb->response,
 565                                sizeof(orb->response), DMA_FROM_DEVICE);
 566         if (dma_mapping_error(device->card->device, orb->response_bus))
 567                 goto fail_mapping_response;
 568
 569         orb->request.response.high = 0;
 570         orb->request.response.low  = cpu_to_be32(orb->response_bus);
 571
 572         orb->request.misc = cpu_to_be32(
 573                 MANAGEMENT_ORB_NOTIFY |
 574                 MANAGEMENT_ORB_FUNCTION(function) |
 575                 MANAGEMENT_ORB_LUN(lun_or_login_id));
 576         orb->request.length = cpu_to_be32(
 577                 MANAGEMENT_ORB_RESPONSE_LENGTH(sizeof(orb->response)));
 578
 579         orb->request.status_fifo.high =
 580                 cpu_to_be32(lu->address_handler.offset >> 32);
 581         orb->request.status_fifo.low  =
 582                 cpu_to_be32(lu->address_handler.offset);
 583
 584         if (function == SBP2_LOGIN_REQUEST) {
 585                 /* Ask for 2^2 == 4 seconds reconnect grace period */
 586                 orb->request.misc |= cpu_to_be32(
 587                         MANAGEMENT_ORB_RECONNECT(2) |
 588                         MANAGEMENT_ORB_EXCLUSIVE(sbp2_param_exclusive_login));
 589                 timeout = lu->tgt->mgt_orb_timeout;
 590         } else {
 591                 timeout = SBP2_ORB_TIMEOUT;
 592         }
 593
 594         init_completion(&orb->done);
 595         orb->base.callback = complete_management_orb;
 596
 597         orb->base.request_bus =
 598                 dma_map_single(device->card->device, &orb->request,
 599                                sizeof(orb->request), DMA_TO_DEVICE);
 600         if (dma_mapping_error(device->card->device, orb->base.request_bus))
 601                 goto fail_mapping_request;
 602
 603         sbp2_send_orb(&orb->base, lu, node_id, generation,
 604                       lu->tgt->management_agent_address);
 605
 606         wait_for_completion_timeout(&orb->done, msecs_to_jiffies(timeout));
 607
 608         retval = -EIO;
 609         if (sbp2_cancel_orbs(lu) == 0) {
 610                 fw_error("%s: orb reply timed out, rcode=0x%02x\n",
 611                          lu->tgt->bus_id, orb->base.rcode);
 612                 goto out;
 613         }
 614
 615         if (orb->base.rcode != RCODE_COMPLETE) {
 616                 fw_error("%s: management write failed, rcode 0x%02x\n",
 617                          lu->tgt->bus_id, orb->base.rcode);
 618                 goto out;
 619         }
 620
 621         if (STATUS_GET_RESPONSE(orb->status) != 0 ||
 622             STATUS_GET_SBP_STATUS(orb->status) != 0) {
 623                 fw_error("%s: error status: %d:%d\n", lu->tgt->bus_id,
 624                          STATUS_GET_RESPONSE(orb->status),
 625                          STATUS_GET_SBP_STATUS(orb->status));
 626                 goto out;
 627         }
 628
 629         retval = 0;
 630  out:
 631         dma_unmap_single(device->card->device, orb->base.request_bus,
 632                          sizeof(orb->request), DMA_TO_DEVICE);
 633  fail_mapping_request:
 634         dma_unmap_single(device->card->device, orb->response_bus,
 635                          sizeof(orb->response), DMA_FROM_DEVICE);
 636  fail_mapping_response:
 637         if (response)
 638                 memcpy(response, orb->response, sizeof(orb->response));
 639         kref_put(&orb->base.kref, free_orb);
 640
 641         return retval;
 642 }
 643
 644 static void sbp2_agent_reset(struct sbp2_logical_unit *lu)
 645 {
 646         struct fw_device *device = target_device(lu->tgt);
 647         __be32 d = 0;
 648
 649         fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
 650                            lu->tgt->node_id, lu->generation, device->max_speed,
 651                            lu->command_block_agent_address + SBP2_AGENT_RESET,
 652                            &d, 4);
 653 }
 654
 655 static void complete_agent_reset_write_no_wait(struct fw_card *card,
 656                 int rcode, void *payload, size_t length, void *data)
 657 {
 658         kfree(data);
 659 }
 660
 661 static void sbp2_agent_reset_no_wait(struct sbp2_logical_unit *lu)
 662 {
 663         struct fw_device *device = target_device(lu->tgt);
 664         struct fw_transaction *t;
 665         static __be32 d;
 666
 667         t = kmalloc(sizeof(*t), GFP_ATOMIC);
 668         if (t == NULL)
 669                 return;
 670
 671         fw_send_request(device->card, t, TCODE_WRITE_QUADLET_REQUEST,
 672                         lu->tgt->node_id, lu->generation, device->max_speed,
 673                         lu->command_block_agent_address + SBP2_AGENT_RESET,
 674                         &d, 4, complete_agent_reset_write_no_wait, t);
 675 }
 676
 677 static inline void sbp2_allow_block(struct sbp2_logical_unit *lu)
 678 {
 679         /*
 680          * We may access dont_block without taking card->lock here:
 681          * All callers of sbp2_allow_block() and all callers of sbp2_unblock()
 682          * are currently serialized against each other.
 683          * And a wrong result in sbp2_conditionally_block()'s access of
 684          * dont_block is rather harmless, it simply misses its first chance.
 685          */
 686         --lu->tgt->dont_block;
 687 }
 688
 689 /*
 690  * Blocks lu->tgt if all of the following conditions are met:
 691  *   - Login, INQUIRY, and high-level SCSI setup of all of the target's
 692  *     logical units have been finished (indicated by dont_block == 0).
 693  *   - lu->generation is stale.
 694  *
 695  * Note, scsi_block_requests() must be called while holding card->lock,
 696  * otherwise it might foil sbp2_[conditionally_]unblock()'s attempt to
 697  * unblock the target.
 698  */
 699 static void sbp2_conditionally_block(struct sbp2_logical_unit *lu)
 700 {
 701         struct sbp2_target *tgt = lu->tgt;
 702         struct fw_card *card = target_device(tgt)->card;
 703         struct Scsi_Host *shost =
 704                 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
 705         unsigned long flags;
 706
 707         spin_lock_irqsave(&card->lock, flags);
 708         if (!tgt->dont_block && !lu->blocked &&
 709             lu->generation != card->generation) {
 710                 lu->blocked = true;
 711                 if (++tgt->blocked == 1)
 712                         scsi_block_requests(shost);
 713         }
 714         spin_unlock_irqrestore(&card->lock, flags);
 715 }
 716
 717 /*
 718  * Unblocks lu->tgt as soon as all its logical units can be unblocked.
 719  * Note, it is harmless to run scsi_unblock_requests() outside the
 720  * card->lock protected section.  On the other hand, running it inside
 721  * the section might clash with shost->host_lock.
 722  */
 723 static void sbp2_conditionally_unblock(struct sbp2_logical_unit *lu)
 724 {
 725         struct sbp2_target *tgt = lu->tgt;
 726         struct fw_card *card = target_device(tgt)->card;
 727         struct Scsi_Host *shost =
 728                 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
 729         unsigned long flags;
 730         bool unblock = false;
 731
 732         spin_lock_irqsave(&card->lock, flags);
 733         if (lu->blocked && lu->generation == card->generation) {
 734                 lu->blocked = false;
 735                 unblock = --tgt->blocked == 0;
 736         }
 737         spin_unlock_irqrestore(&card->lock, flags);
 738
 739         if (unblock)
 740                 scsi_unblock_requests(shost);
 741 }
 742
 743 /*
 744  * Prevents future blocking of tgt and unblocks it.
 745  * Note, it is harmless to run scsi_unblock_requests() outside the
 746  * card->lock protected section.  On the other hand, running it inside
 747  * the section might clash with shost->host_lock.
 748  */
 749 static void sbp2_unblock(struct sbp2_target *tgt)
 750 {
 751         struct fw_card *card = target_device(tgt)->card;
 752         struct Scsi_Host *shost =
 753                 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
 754         unsigned long flags;
 755
 756         spin_lock_irqsave(&card->lock, flags);
 757         ++tgt->dont_block;
 758         spin_unlock_irqrestore(&card->lock, flags);
 759
 760         scsi_unblock_requests(shost);
 761 }
 762
 763 static int sbp2_lun2int(u16 lun)
 764 {
 765         struct scsi_lun eight_bytes_lun;
 766
 767         memset(&eight_bytes_lun, 0, sizeof(eight_bytes_lun));
 768         eight_bytes_lun.scsi_lun[0] = (lun >> 8) & 0xff;
 769         eight_bytes_lun.scsi_lun[1] = lun & 0xff;
 770
 771         return scsilun_to_int(&eight_bytes_lun);
 772 }
 773
 774 static void sbp2_release_target(struct sbp2_target *tgt)
 775 {
 776         struct sbp2_logical_unit *lu, *next;
 777         struct Scsi_Host *shost =
 778                 container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
 779         struct scsi_device *sdev;
 780         struct fw_device *device = target_device(tgt);
 781
 782         /* prevent deadlocks */
 783         sbp2_unblock(tgt);
 784
 785         list_for_each_entry_safe(lu, next, &tgt->lu_list, link) {
 786                 sdev = scsi_device_lookup(shost, 0, 0, sbp2_lun2int(lu->lun));
 787                 if (sdev) {
 788                         scsi_remove_device(sdev);
 789                         scsi_device_put(sdev);
 790                 }
 791                 if (lu->login_id != INVALID_LOGIN_ID) {
 792                         int generation, node_id;
 793                         /*
 794                          * tgt->node_id may be obsolete here if we failed
 795                          * during initial login or after a bus reset where
 796                          * the topology changed.
 797                          */
 798                         generation = device->generation;
 799                         smp_rmb(); /* node_id vs. generation */
 800                         node_id    = device->node_id;
 801                         sbp2_send_management_orb(lu, node_id, generation,
 802                                                  SBP2_LOGOUT_REQUEST,
 803                                                  lu->login_id, NULL);
 804                 }
 805                 fw_core_remove_address_handler(&lu->address_handler);
 806                 list_del(&lu->link);
 807                 kfree(lu);
 808         }
 809         scsi_remove_host(shost);
 810         fw_notify("released %s, target %d:0:0\n", tgt->bus_id, shost->host_no);
 811
 812         scsi_host_put(shost);
 813 }
 814
 815 static void sbp2_queue_work(struct sbp2_logical_unit *lu, unsigned long delay)
 816 {
 817         queue_delayed_work(fw_workqueue, &lu->work, delay);
 818 }
 819
 820 /*
 821  * Write retransmit retry values into the BUSY_TIMEOUT register.
 822  * - The single-phase retry protocol is supported by all SBP-2 devices, but the
 823  *   default retry_limit value is 0 (i.e. never retry transmission). We write a
 824  *   saner value after logging into the device.
 825  * - The dual-phase retry protocol is optional to implement, and if not
 826  *   supported, writes to the dual-phase portion of the register will be
 827  *   ignored. We try to write the original 1394-1995 default here.
 828  * - In the case of devices that are also SBP-3-compliant, all writes are
 829  *   ignored, as the register is read-only, but contains single-phase retry of
 830  *   15, which is what we're trying to set for all SBP-2 device anyway, so this
 831  *   write attempt is safe and yields more consistent behavior for all devices.
 832  *
 833  * See section 8.3.2.3.5 of the 1394-1995 spec, section 6.2 of the SBP-2 spec,
 834  * and section 6.4 of the SBP-3 spec for further details.
 835  */
 836 static void sbp2_set_busy_timeout(struct sbp2_logical_unit *lu)
 837 {
 838         struct fw_device *device = target_device(lu->tgt);
 839         __be32 d = cpu_to_be32(SBP2_CYCLE_LIMIT | SBP2_RETRY_LIMIT);
 840
 841         fw_run_transaction(device->card, TCODE_WRITE_QUADLET_REQUEST,
 842                            lu->tgt->node_id, lu->generation, device->max_speed,
 843                            CSR_REGISTER_BASE + CSR_BUSY_TIMEOUT, &d, 4);
 844 }
 845
 846 static void sbp2_reconnect(struct work_struct *work);
 847
 848 static void sbp2_login(struct work_struct *work)
 849 {
 850         struct sbp2_logical_unit *lu =
 851                 container_of(work, struct sbp2_logical_unit, work.work);
 852         struct sbp2_target *tgt = lu->tgt;
 853         struct fw_device *device = target_device(tgt);
 854         struct Scsi_Host *shost;
 855         struct scsi_device *sdev;
 856         struct sbp2_login_response response;
 857         int generation, node_id, local_node_id;
 858
 859         if (fw_device_is_shutdown(device))
 860                 return;
 861
 862         generation    = device->generation;
 863         smp_rmb();    /* node IDs must not be older than generation */
 864         node_id       = device->node_id;
 865         local_node_id = device->card->node_id;
 866
 867         /* If this is a re-login attempt, log out, or we might be rejected. */
 868         if (lu->has_sdev)
 869                 sbp2_send_management_orb(lu, device->node_id, generation,
 870                                 SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
 871
 872         if (sbp2_send_management_orb(lu, node_id, generation,
 873                                 SBP2_LOGIN_REQUEST, lu->lun, &response) < 0) {
 874                 if (lu->retries++ < 5) {
 875                         sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
 876                 } else {
 877                         fw_error("%s: failed to login to LUN %04x\n",
 878                                  tgt->bus_id, lu->lun);
 879                         /* Let any waiting I/O fail from now on. */
 880                         sbp2_unblock(lu->tgt);
 881                 }
 882                 return;
 883         }
 884
 885         tgt->node_id      = node_id;
 886         tgt->address_high = local_node_id << 16;
 887         smp_wmb();        /* node IDs must not be older than generation */
 888         lu->generation    = generation;
 889
 890         lu->command_block_agent_address =
 891                 ((u64)(be32_to_cpu(response.command_block_agent.high) & 0xffff)
 892                       << 32) | be32_to_cpu(response.command_block_agent.low);
 893         lu->login_id = be32_to_cpu(response.misc) & 0xffff;
 894
 895         fw_notify("%s: logged in to LUN %04x (%d retries)\n",
 896                   tgt->bus_id, lu->lun, lu->retries);
 897
 898         /* set appropriate retry limit(s) in BUSY_TIMEOUT register */
 899         sbp2_set_busy_timeout(lu);
 900
 901         PREPARE_DELAYED_WORK(&lu->work, sbp2_reconnect);
 902         sbp2_agent_reset(lu);
 903
 904         /* This was a re-login. */
 905         if (lu->has_sdev) {
 906                 sbp2_cancel_orbs(lu);
 907                 sbp2_conditionally_unblock(lu);
 908
 909                 return;
 910         }
 911
 912         if (lu->tgt->workarounds & SBP2_WORKAROUND_DELAY_INQUIRY)
 913                 ssleep(SBP2_INQUIRY_DELAY);
 914
 915         shost = container_of((void *)tgt, struct Scsi_Host, hostdata[0]);
 916         sdev = __scsi_add_device(shost, 0, 0, sbp2_lun2int(lu->lun), lu);
 917         /*
 918          * FIXME:  We are unable to perform reconnects while in sbp2_login().
 919          * Therefore __scsi_add_device() will get into trouble if a bus reset
 920          * happens in parallel.  It will either fail or leave us with an
 921          * unusable sdev.  As a workaround we check for this and retry the
 922          * whole login and SCSI probing.
 923          */
 924
 925         /* Reported error during __scsi_add_device() */
 926         if (IS_ERR(sdev))
 927                 goto out_logout_login;
 928
 929         /* Unreported error during __scsi_add_device() */
 930         smp_rmb(); /* get current card generation */
 931         if (generation != device->card->generation) {
 932                 scsi_remove_device(sdev);
 933                 scsi_device_put(sdev);
 934                 goto out_logout_login;
 935         }
 936
 937         /* No error during __scsi_add_device() */
 938         lu->has_sdev = true;
 939         scsi_device_put(sdev);
 940         sbp2_allow_block(lu);
 941
 942         return;
 943
 944  out_logout_login:
 945         smp_rmb(); /* generation may have changed */
 946         generation = device->generation;
 947         smp_rmb(); /* node_id must not be older than generation */
 948
 949         sbp2_send_management_orb(lu, device->node_id, generation,
 950                                  SBP2_LOGOUT_REQUEST, lu->login_id, NULL);
 951         /*
 952          * If a bus reset happened, sbp2_update will have requeued
 953          * lu->work already.  Reset the work from reconnect to login.
 954          */
 955         PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
 956 }
 957
 958 static int sbp2_add_logical_unit(struct sbp2_target *tgt, int lun_entry)
 959 {
 960         struct sbp2_logical_unit *lu;
 961
 962         lu = kmalloc(sizeof(*lu), GFP_KERNEL);
 963         if (!lu)
 964                 return -ENOMEM;
 965
 966         lu->address_handler.length           = 0x100;
 967         lu->address_handler.address_callback = sbp2_status_write;
 968         lu->address_handler.callback_data    = lu;
 969
 970         if (fw_core_add_address_handler(&lu->address_handler,
 971                                         &fw_high_memory_region) < 0) {
 972                 kfree(lu);
 973                 return -ENOMEM;
 974         }
 975
 976         lu->tgt      = tgt;
 977         lu->lun      = lun_entry & 0xffff;
 978         lu->login_id = INVALID_LOGIN_ID;
 979         lu->retries  = 0;
 980         lu->has_sdev = false;
 981         lu->blocked  = false;
 982         ++tgt->dont_block;
 983         INIT_LIST_HEAD(&lu->orb_list);
 984         INIT_DELAYED_WORK(&lu->work, sbp2_login);
 985
 986         list_add_tail(&lu->link, &tgt->lu_list);
 987         return 0;
 988 }
 989
 990 static int sbp2_scan_logical_unit_dir(struct sbp2_target *tgt,
 991                                       const u32 *directory)
 992 {
 993         struct fw_csr_iterator ci;
 994         int key, value;
 995
 996         fw_csr_iterator_init(&ci, directory);
 997         while (fw_csr_iterator_next(&ci, &key, &value))
 998                 if (key == SBP2_CSR_LOGICAL_UNIT_NUMBER &&
 999                     sbp2_add_logical_unit(tgt, value) < 0)
1000                         return -ENOMEM;
1001         return 0;
1002 }
1003
1004 static int sbp2_scan_unit_dir(struct sbp2_target *tgt, const u32 *directory,
1005                               u32 *model, u32 *firmware_revision)
1006 {
1007         struct fw_csr_iterator ci;
1008         int key, value;
1009
1010         fw_csr_iterator_init(&ci, directory);
1011         while (fw_csr_iterator_next(&ci, &key, &value)) {
1012                 switch (key) {
1013
1014                 case CSR_DEPENDENT_INFO | CSR_OFFSET:
1015                         tgt->management_agent_address =
1016                                         CSR_REGISTER_BASE + 4 * value;
1017                         break;
1018
1019                 case CSR_DIRECTORY_ID:
1020                         tgt->directory_id = value;
1021                         break;
1022
1023                 case CSR_MODEL:
1024                         *model = value;
1025                         break;
1026
1027                 case SBP2_CSR_FIRMWARE_REVISION:
1028                         *firmware_revision = value;
1029                         break;
1030
1031                 case SBP2_CSR_UNIT_CHARACTERISTICS:
1032                         /* the timeout value is stored in 500ms units */
1033                         tgt->mgt_orb_timeout = (value >> 8 & 0xff) * 500;
1034                         break;
1035
1036                 case SBP2_CSR_LOGICAL_UNIT_NUMBER:
1037                         if (sbp2_add_logical_unit(tgt, value) < 0)
1038                                 return -ENOMEM;
1039                         break;
1040
1041                 case SBP2_CSR_LOGICAL_UNIT_DIRECTORY:
1042                         /* Adjust for the increment in the iterator */
1043                         if (sbp2_scan_logical_unit_dir(tgt, ci.p - 1 + value) < 0)
1044                                 return -ENOMEM;
1045                         break;
1046                 }
1047         }
1048         return 0;
1049 }
1050
1051 /*
1052  * Per section 7.4.8 of the SBP-2 spec, a mgt_ORB_timeout value can be
1053  * provided in the config rom. Most devices do provide a value, which
1054  * we'll use for login management orbs, but with some sane limits.
1055  */
1056 static void sbp2_clamp_management_orb_timeout(struct sbp2_target *tgt)
1057 {
1058         unsigned int timeout = tgt->mgt_orb_timeout;
1059
1060         if (timeout > 40000)
1061                 fw_notify("%s: %ds mgt_ORB_timeout limited to 40s\n",
1062                           tgt->bus_id, timeout / 1000);
1063
1064         tgt->mgt_orb_timeout = clamp_val(timeout, 5000, 40000);
1065 }
1066
1067 static void sbp2_init_workarounds(struct sbp2_target *tgt, u32 model,
1068                                   u32 firmware_revision)
1069 {
1070         int i;
1071         unsigned int w = sbp2_param_workarounds;
1072
1073         if (w)
1074                 fw_notify("Please notify linux1394-devel@lists.sourceforge.net "
1075                           "if you need the workarounds parameter for %s\n",
1076                           tgt->bus_id);
1077
1078         if (w & SBP2_WORKAROUND_OVERRIDE)
1079                 goto out;
1080
1081         for (i = 0; i < ARRAY_SIZE(sbp2_workarounds_table); i++) {
1082
1083                 if (sbp2_workarounds_table[i].firmware_revision !=
1084                     (firmware_revision & 0xffffff00))
1085                         continue;
1086
1087                 if (sbp2_workarounds_table[i].model != model &&
1088                     sbp2_workarounds_table[i].model != SBP2_ROM_VALUE_WILDCARD)
1089                         continue;
1090
1091                 w |= sbp2_workarounds_table[i].workarounds;
1092                 break;
1093         }
1094  out:
1095         if (w)
1096                 fw_notify("Workarounds for %s: 0x%x "
1097                           "(firmware_revision 0x%06x, model_id 0x%06x)\n",
1098                           tgt->bus_id, w, firmware_revision, model);
1099         tgt->workarounds = w;
1100 }
1101
1102 static struct scsi_host_template scsi_driver_template;
1103
1104 static int sbp2_probe(struct device *dev)
1105 {
1106         struct fw_unit *unit = fw_unit(dev);
1107         struct fw_device *device = fw_parent_device(unit);
1108         struct sbp2_target *tgt;
1109         struct sbp2_logical_unit *lu;
1110         struct Scsi_Host *shost;
1111         u32 model, firmware_revision;
1112
1113         if (dma_get_max_seg_size(device->card->device) > SBP2_MAX_SEG_SIZE)
1114                 BUG_ON(dma_set_max_seg_size(device->card->device,
1115                                             SBP2_MAX_SEG_SIZE));
1116
1117         shost = scsi_host_alloc(&scsi_driver_template, sizeof(*tgt));
1118         if (shost == NULL)
1119                 return -ENOMEM;
1120
1121         tgt = (struct sbp2_target *)shost->hostdata;
1122         dev_set_drvdata(&unit->device, tgt);
1123         tgt->unit = unit;
1124         INIT_LIST_HEAD(&tgt->lu_list);
1125         tgt->bus_id = dev_name(&unit->device);
1126         tgt->guid = (u64)device->config_rom[3] << 32 | device->config_rom[4];
1127
1128         if (fw_device_enable_phys_dma(device) < 0)
1129                 goto fail_shost_put;
1130
1131         shost->max_cmd_len = SBP2_MAX_CDB_SIZE;
1132
1133         if (scsi_add_host(shost, &unit->device) < 0)
1134                 goto fail_shost_put;
1135
1136         /* implicit directory ID */
1137         tgt->directory_id = ((unit->directory - device->config_rom) * 4
1138                              + CSR_CONFIG_ROM) & 0xffffff;
1139
1140         firmware_revision = SBP2_ROM_VALUE_MISSING;
1141         model             = SBP2_ROM_VALUE_MISSING;
1142
1143         if (sbp2_scan_unit_dir(tgt, unit->directory, &model,
1144                                &firmware_revision) < 0)
1145                 goto fail_release_target;
1146
1147         sbp2_clamp_management_orb_timeout(tgt);
1148         sbp2_init_workarounds(tgt, model, firmware_revision);
1149
1150         /*
1151          * At S100 we can do 512 bytes per packet, at S200 1024 bytes,
1152          * and so on up to 4096 bytes.  The SBP-2 max_payload field
1153          * specifies the max payload size as 2 ^ (max_payload + 2), so
1154          * if we set this to max_speed + 7, we get the right value.
1155          */
1156         tgt->max_payload = min(device->max_speed + 7, 10U);
1157         tgt->max_payload = min(tgt->max_payload, device->card->max_receive - 1);
1158
1159         /* Do the login in a workqueue so we can easily reschedule retries. */
1160         list_for_each_entry(lu, &tgt->lu_list, link)
1161                 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1162
1163         return 0;
1164
1165  fail_release_target:
1166         sbp2_release_target(tgt);
1167         return -ENOMEM;
1168
1169  fail_shost_put:
1170         scsi_host_put(shost);
1171         return -ENOMEM;
1172 }
1173
1174 static int sbp2_remove(struct device *dev)
1175 {
1176         struct fw_unit *unit = fw_unit(dev);
1177         struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
1178         struct sbp2_logical_unit *lu;
1179
1180         list_for_each_entry(lu, &tgt->lu_list, link)
1181                 cancel_delayed_work_sync(&lu->work);
1182
1183         sbp2_release_target(tgt);
1184
1185         return 0;
1186 }
1187
1188 static void sbp2_reconnect(struct work_struct *work)
1189 {
1190         struct sbp2_logical_unit *lu =
1191                 container_of(work, struct sbp2_logical_unit, work.work);
1192         struct sbp2_target *tgt = lu->tgt;
1193         struct fw_device *device = target_device(tgt);
1194         int generation, node_id, local_node_id;
1195
1196         if (fw_device_is_shutdown(device))
1197                 return;
1198
1199         generation    = device->generation;
1200         smp_rmb();    /* node IDs must not be older than generation */
1201         node_id       = device->node_id;
1202         local_node_id = device->card->node_id;
1203
1204         if (sbp2_send_management_orb(lu, node_id, generation,
1205                                      SBP2_RECONNECT_REQUEST,
1206                                      lu->login_id, NULL) < 0) {
1207                 /*
1208                  * If reconnect was impossible even though we are in the
1209                  * current generation, fall back and try to log in again.
1210                  *
1211                  * We could check for "Function rejected" status, but
1212                  * looking at the bus generation as simpler and more general.
1213                  */
1214                 smp_rmb(); /* get current card generation */
1215                 if (generation == device->card->generation ||
1216                     lu->retries++ >= 5) {
1217                         fw_error("%s: failed to reconnect\n", tgt->bus_id);
1218                         lu->retries = 0;
1219                         PREPARE_DELAYED_WORK(&lu->work, sbp2_login);
1220                 }
1221                 sbp2_queue_work(lu, DIV_ROUND_UP(HZ, 5));
1222
1223                 return;
1224         }
1225
1226         tgt->node_id      = node_id;
1227         tgt->address_high = local_node_id << 16;
1228         smp_wmb();        /* node IDs must not be older than generation */
1229         lu->generation    = generation;
1230
1231         fw_notify("%s: reconnected to LUN %04x (%d retries)\n",
1232                   tgt->bus_id, lu->lun, lu->retries);
1233
1234         sbp2_agent_reset(lu);
1235         sbp2_cancel_orbs(lu);
1236         sbp2_conditionally_unblock(lu);
1237 }
1238
1239 static void sbp2_update(struct fw_unit *unit)
1240 {
1241         struct sbp2_target *tgt = dev_get_drvdata(&unit->device);
1242         struct sbp2_logical_unit *lu;
1243
1244         fw_device_enable_phys_dma(fw_parent_device(unit));
1245
1246         /*
1247          * Fw-core serializes sbp2_update() against sbp2_remove().
1248          * Iteration over tgt->lu_list is therefore safe here.
1249          */
1250         list_for_each_entry(lu, &tgt->lu_list, link) {
1251                 sbp2_conditionally_block(lu);
1252                 lu->retries = 0;
1253                 sbp2_queue_work(lu, 0);
1254         }
1255 }
1256
1257 #define SBP2_UNIT_SPEC_ID_ENTRY 0x0000609e
1258 #define SBP2_SW_VERSION_ENTRY   0x00010483
1259
1260 static const struct ieee1394_device_id sbp2_id_table[] = {
1261         {
1262                 .match_flags  = IEEE1394_MATCH_SPECIFIER_ID |
1263                                 IEEE1394_MATCH_VERSION,
1264                 .specifier_id = SBP2_UNIT_SPEC_ID_ENTRY,
1265                 .version      = SBP2_SW_VERSION_ENTRY,
1266         },
1267         { }
1268 };
1269
1270 static struct fw_driver sbp2_driver = {
1271         .driver   = {
1272                 .owner  = THIS_MODULE,
1273                 .name   = sbp2_driver_name,
1274                 .bus    = &fw_bus_type,
1275                 .probe  = sbp2_probe,
1276                 .remove = sbp2_remove,
1277         },
1278         .update   = sbp2_update,
1279         .id_table = sbp2_id_table,
1280 };
1281
1282 static void sbp2_unmap_scatterlist(struct device *card_device,
1283                                    struct sbp2_command_orb *orb)
1284 {
1285         if (scsi_sg_count(orb->cmd))
1286                 dma_unmap_sg(card_device, scsi_sglist(orb->cmd),
1287                              scsi_sg_count(orb->cmd),
1288                              orb->cmd->sc_data_direction);
1289
1290         if (orb->request.misc & cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT))
1291                 dma_unmap_single(card_device, orb->page_table_bus,
1292                                  sizeof(orb->page_table), DMA_TO_DEVICE);
1293 }
1294
1295 static unsigned int sbp2_status_to_sense_data(u8 *sbp2_status, u8 *sense_data)
1296 {
1297         int sam_status;
1298
1299         sense_data[0] = 0x70;
1300         sense_data[1] = 0x0;
1301         sense_data[2] = sbp2_status[1];
1302         sense_data[3] = sbp2_status[4];
1303         sense_data[4] = sbp2_status[5];
1304         sense_data[5] = sbp2_status[6];
1305         sense_data[6] = sbp2_status[7];
1306         sense_data[7] = 10;
1307         sense_data[8] = sbp2_status[8];
1308         sense_data[9] = sbp2_status[9];
1309         sense_data[10] = sbp2_status[10];
1310         sense_data[11] = sbp2_status[11];
1311         sense_data[12] = sbp2_status[2];
1312         sense_data[13] = sbp2_status[3];
1313         sense_data[14] = sbp2_status[12];
1314         sense_data[15] = sbp2_status[13];
1315
1316         sam_status = sbp2_status[0] & 0x3f;
1317
1318         switch (sam_status) {
1319         case SAM_STAT_GOOD:
1320         case SAM_STAT_CHECK_CONDITION:
1321         case SAM_STAT_CONDITION_MET:
1322         case SAM_STAT_BUSY:
1323         case SAM_STAT_RESERVATION_CONFLICT:
1324         case SAM_STAT_COMMAND_TERMINATED:
1325                 return DID_OK << 16 | sam_status;
1326
1327         default:
1328                 return DID_ERROR << 16;
1329         }
1330 }
1331
1332 static void complete_command_orb(struct sbp2_orb *base_orb,
1333                                  struct sbp2_status *status)
1334 {
1335         struct sbp2_command_orb *orb =
1336                 container_of(base_orb, struct sbp2_command_orb, base);
1337         struct fw_device *device = target_device(orb->lu->tgt);
1338         int result;
1339
1340         if (status != NULL) {
1341                 if (STATUS_GET_DEAD(*status))
1342                         sbp2_agent_reset_no_wait(orb->lu);
1343
1344                 switch (STATUS_GET_RESPONSE(*status)) {
1345                 case SBP2_STATUS_REQUEST_COMPLETE:
1346                         result = DID_OK << 16;
1347                         break;
1348                 case SBP2_STATUS_TRANSPORT_FAILURE:
1349                         result = DID_BUS_BUSY << 16;
1350                         break;
1351                 case SBP2_STATUS_ILLEGAL_REQUEST:
1352                 case SBP2_STATUS_VENDOR_DEPENDENT:
1353                 default:
1354                         result = DID_ERROR << 16;
1355                         break;
1356                 }
1357
1358                 if (result == DID_OK << 16 && STATUS_GET_LEN(*status) > 1)
1359                         result = sbp2_status_to_sense_data(STATUS_GET_DATA(*status),
1360                                                            orb->cmd->sense_buffer);
1361         } else {
1362                 /*
1363                  * If the orb completes with status == NULL, something
1364                  * went wrong, typically a bus reset happened mid-orb
1365                  * or when sending the write (less likely).
1366                  */
1367                 result = DID_BUS_BUSY << 16;
1368                 sbp2_conditionally_block(orb->lu);
1369         }
1370
1371         dma_unmap_single(device->card->device, orb->base.request_bus,
1372                          sizeof(orb->request), DMA_TO_DEVICE);
1373         sbp2_unmap_scatterlist(device->card->device, orb);
1374
1375         orb->cmd->result = result;
1376         orb->cmd->scsi_done(orb->cmd);
1377 }
1378
1379 static int sbp2_map_scatterlist(struct sbp2_command_orb *orb,
1380                 struct fw_device *device, struct sbp2_logical_unit *lu)
1381 {
1382         struct scatterlist *sg = scsi_sglist(orb->cmd);
1383         int i, n;
1384
1385         n = dma_map_sg(device->card->device, sg, scsi_sg_count(orb->cmd),
1386                        orb->cmd->sc_data_direction);
1387         if (n == 0)
1388                 goto fail;
1389
1390         /*
1391          * Handle the special case where there is only one element in
1392          * the scatter list by converting it to an immediate block
1393          * request. This is also a workaround for broken devices such
1394          * as the second generation iPod which doesn't support page
1395          * tables.
1396          */
1397         if (n == 1) {
1398                 orb->request.data_descriptor.high =
1399                         cpu_to_be32(lu->tgt->address_high);
1400                 orb->request.data_descriptor.low  =
1401                         cpu_to_be32(sg_dma_address(sg));
1402                 orb->request.misc |=
1403                         cpu_to_be32(COMMAND_ORB_DATA_SIZE(sg_dma_len(sg)));
1404                 return 0;
1405         }
1406
1407         for_each_sg(sg, sg, n, i) {
1408                 orb->page_table[i].high = cpu_to_be32(sg_dma_len(sg) << 16);
1409                 orb->page_table[i].low = cpu_to_be32(sg_dma_address(sg));
1410         }
1411
1412         orb->page_table_bus =
1413                 dma_map_single(device->card->device, orb->page_table,
1414                                sizeof(orb->page_table), DMA_TO_DEVICE);
1415         if (dma_mapping_error(device->card->device, orb->page_table_bus))
1416                 goto fail_page_table;
1417
1418         /*
1419          * The data_descriptor pointer is the one case where we need
1420          * to fill in the node ID part of the address.  All other
1421          * pointers assume that the data referenced reside on the
1422          * initiator (i.e. us), but data_descriptor can refer to data
1423          * on other nodes so we need to put our ID in descriptor.high.
1424          */
1425         orb->request.data_descriptor.high = cpu_to_be32(lu->tgt->address_high);
1426         orb->request.data_descriptor.low  = cpu_to_be32(orb->page_table_bus);
1427         orb->request.misc |= cpu_to_be32(COMMAND_ORB_PAGE_TABLE_PRESENT |
1428                                          COMMAND_ORB_DATA_SIZE(n));
1429
1430         return 0;
1431
1432  fail_page_table:
1433         dma_unmap_sg(device->card->device, scsi_sglist(orb->cmd),
1434                      scsi_sg_count(orb->cmd), orb->cmd->sc_data_direction);
1435  fail:
1436         return -ENOMEM;
1437 }
1438
1439 /* SCSI stack integration */
1440
1441 static int sbp2_scsi_queuecommand(struct Scsi_Host *shost,
1442                                   struct scsi_cmnd *cmd)
1443 {
1444         struct sbp2_logical_unit *lu = cmd->device->hostdata;
1445         struct fw_device *device = target_device(lu->tgt);
1446         struct sbp2_command_orb *orb;
1447         int generation, retval = SCSI_MLQUEUE_HOST_BUSY;
1448
1449         /*
1450          * Bidirectional commands are not yet implemented, and unknown
1451          * transfer direction not handled.
1452          */
1453         if (cmd->sc_data_direction == DMA_BIDIRECTIONAL) {
1454                 fw_error("Can't handle DMA_BIDIRECTIONAL, rejecting command\n");
1455                 cmd->result = DID_ERROR << 16;
1456                 cmd->scsi_done(cmd);
1457                 return 0;
1458         }
1459
1460         orb = kzalloc(sizeof(*orb), GFP_ATOMIC);
1461         if (orb == NULL) {
1462                 fw_notify("failed to alloc orb\n");
1463                 return SCSI_MLQUEUE_HOST_BUSY;
1464         }
1465
1466         /* Initialize rcode to something not RCODE_COMPLETE. */
1467         orb->base.rcode = -1;
1468         kref_init(&orb->base.kref);
1469         orb->lu = lu;
1470         orb->cmd = cmd;
1471         orb->request.next.high = cpu_to_be32(SBP2_ORB_NULL);
1472         orb->request.misc = cpu_to_be32(
1473                 COMMAND_ORB_MAX_PAYLOAD(lu->tgt->max_payload) |
1474                 COMMAND_ORB_SPEED(device->max_speed) |
1475                 COMMAND_ORB_NOTIFY);
1476
1477         if (cmd->sc_data_direction == DMA_FROM_DEVICE)
1478                 orb->request.misc |= cpu_to_be32(COMMAND_ORB_DIRECTION);
1479
1480         generation = device->generation;
1481         smp_rmb();    /* sbp2_map_scatterlist looks at tgt->address_high */
1482
1483         if (scsi_sg_count(cmd) && sbp2_map_scatterlist(orb, device, lu) < 0)
1484                 goto out;
1485
1486         memcpy(orb->request.command_block, cmd->cmnd, cmd->cmd_len);
1487
1488         orb->base.callback = complete_command_orb;
1489         orb->base.request_bus =
1490                 dma_map_single(device->card->device, &orb->request,
1491                                sizeof(orb->request), DMA_TO_DEVICE);
1492         if (dma_mapping_error(device->card->device, orb->base.request_bus)) {
1493                 sbp2_unmap_scatterlist(device->card->device, orb);
1494                 goto out;
1495         }
1496
1497         sbp2_send_orb(&orb->base, lu, lu->tgt->node_id, generation,
1498                       lu->command_block_agent_address + SBP2_ORB_POINTER);
1499         retval = 0;
1500  out:
1501         kref_put(&orb->base.kref, free_orb);
1502         return retval;
1503 }
1504
1505 static int sbp2_scsi_slave_alloc(struct scsi_device *sdev)
1506 {
1507         struct sbp2_logical_unit *lu = sdev->hostdata;
1508
1509         /* (Re-)Adding logical units via the SCSI stack is not supported. */
1510         if (!lu)
1511                 return -ENOSYS;
1512
1513         sdev->allow_restart = 1;
1514
1515         /* SBP-2 requires quadlet alignment of the data buffers. */
1516         blk_queue_update_dma_alignment(sdev->request_queue, 4 - 1);
1517
1518         if (lu->tgt->workarounds & SBP2_WORKAROUND_INQUIRY_36)
1519                 sdev->inquiry_len = 36;
1520
1521         return 0;
1522 }
1523
1524 static int sbp2_scsi_slave_configure(struct scsi_device *sdev)
1525 {
1526         struct sbp2_logical_unit *lu = sdev->hostdata;
1527
1528         sdev->use_10_for_rw = 1;
1529
1530         if (sbp2_param_exclusive_login)
1531                 sdev->manage_start_stop = 1;
1532
1533         if (sdev->type == TYPE_ROM)
1534                 sdev->use_10_for_ms = 1;
1535
1536         if (sdev->type == TYPE_DISK &&
1537             lu->tgt->workarounds & SBP2_WORKAROUND_MODE_SENSE_8)
1538                 sdev->skip_ms_page_8 = 1;
1539
1540         if (lu->tgt->workarounds & SBP2_WORKAROUND_FIX_CAPACITY)
1541                 sdev->fix_capacity = 1;
1542
1543         if (lu->tgt->workarounds & SBP2_WORKAROUND_POWER_CONDITION)
1544                 sdev->start_stop_pwr_cond = 1;
1545
1546         if (lu->tgt->workarounds & SBP2_WORKAROUND_128K_MAX_TRANS)
1547                 blk_queue_max_hw_sectors(sdev->request_queue, 128 * 1024 / 512);
1548
1549         blk_queue_max_segment_size(sdev->request_queue, SBP2_MAX_SEG_SIZE);
1550
1551         return 0;
1552 }
1553
1554 /*
1555  * Called by scsi stack when something has really gone wrong.  Usually
1556  * called when a command has timed-out for some reason.
1557  */
1558 static int sbp2_scsi_abort(struct scsi_cmnd *cmd)
1559 {
1560         struct sbp2_logical_unit *lu = cmd->device->hostdata;
1561
1562         fw_notify("%s: sbp2_scsi_abort\n", lu->tgt->bus_id);
1563         sbp2_agent_reset(lu);
1564         sbp2_cancel_orbs(lu);
1565
1566         return SUCCESS;
1567 }
1568
1569 /*
1570  * Format of /sys/bus/scsi/devices/.../ieee1394_id:
1571  * u64 EUI-64 : u24 directory_ID : u16 LUN  (all printed in hexadecimal)
1572  *
1573  * This is the concatenation of target port identifier and logical unit
1574  * identifier as per SAM-2...SAM-4 annex A.
1575  */
1576 static ssize_t sbp2_sysfs_ieee1394_id_show(struct device *dev,
1577                         struct device_attribute *attr, char *buf)
1578 {
1579         struct scsi_device *sdev = to_scsi_device(dev);
1580         struct sbp2_logical_unit *lu;
1581
1582         if (!sdev)
1583                 return 0;
1584
1585         lu = sdev->hostdata;
1586
1587         return sprintf(buf, "%016llx:%06x:%04x\n",
1588                         (unsigned long long)lu->tgt->guid,
1589                         lu->tgt->directory_id, lu->lun);
1590 }
1591
1592 static DEVICE_ATTR(ieee1394_id, S_IRUGO, sbp2_sysfs_ieee1394_id_show, NULL);
1593
1594 static struct device_attribute *sbp2_scsi_sysfs_attrs[] = {
1595         &dev_attr_ieee1394_id,
1596         NULL
1597 };
1598
1599 static struct scsi_host_template scsi_driver_template = {
1600         .module                 = THIS_MODULE,
1601         .name                   = "SBP-2 IEEE-1394",
1602         .proc_name              = sbp2_driver_name,
1603         .queuecommand           = sbp2_scsi_queuecommand,
1604         .slave_alloc            = sbp2_scsi_slave_alloc,
1605         .slave_configure        = sbp2_scsi_slave_configure,
1606         .eh_abort_handler       = sbp2_scsi_abort,
1607         .this_id                = -1,
1608         .sg_tablesize           = SG_ALL,
1609         .use_clustering         = ENABLE_CLUSTERING,
1610         .cmd_per_lun            = 1,
1611         .can_queue              = 1,
1612         .sdev_attrs             = sbp2_scsi_sysfs_attrs,
1613 };
1614
1615 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1616 MODULE_DESCRIPTION("SCSI over IEEE1394");
1617 MODULE_LICENSE("GPL");
1618 MODULE_DEVICE_TABLE(ieee1394, sbp2_id_table);
1619
1620 /* Provide a module alias so root-on-sbp2 initrds don't break. */
1621 #ifndef CONFIG_IEEE1394_SBP2_MODULE
1622 MODULE_ALIAS("sbp2");
1623 #endif
1624
1625 static int __init sbp2_init(void)
1626 {
1627         return driver_register(&sbp2_driver.driver);
1628 }
1629
1630 static void __exit sbp2_cleanup(void)
1631 {
1632         driver_unregister(&sbp2_driver.driver);
1633 }
1634
1635 module_init(sbp2_init);
1636 module_exit(sbp2_cleanup);