drivers/firewire/fw-card.c

   1 /*
   2  * Copyright (C) 2005-2007  Kristian Hoegsberg <krh@bitplanet.net>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 #include <linux/completion.h>
  20 #include <linux/crc-itu-t.h>
  21 #include <linux/delay.h>
  22 #include <linux/device.h>
  23 #include <linux/errno.h>
  24 #include <linux/kref.h>
  25 #include <linux/module.h>
  26 #include <linux/mutex.h>
  27
  28 #include "fw-transaction.h"
  29 #include "fw-topology.h"
  30 #include "fw-device.h"
  31
  32 int fw_compute_block_crc(u32 *block)
  33 {
  34         __be32 be32_block[256];
  35         int i, length;
  36
  37         length = (*block >> 16) & 0xff;
  38         for (i = 0; i < length; i++)
  39                 be32_block[i] = cpu_to_be32(block[i + 1]);
  40         *block |= crc_itu_t(0, (u8 *) be32_block, length * 4);
  41
  42         return length;
  43 }
  44
  45 static DEFINE_MUTEX(card_mutex);
  46 static LIST_HEAD(card_list);
  47
  48 static LIST_HEAD(descriptor_list);
  49 static int descriptor_count;
  50
  51 #define BIB_CRC(v)              ((v) <<  0)
  52 #define BIB_CRC_LENGTH(v)       ((v) << 16)
  53 #define BIB_INFO_LENGTH(v)      ((v) << 24)
  54
  55 #define BIB_LINK_SPEED(v)       ((v) <<  0)
  56 #define BIB_GENERATION(v)       ((v) <<  4)
  57 #define BIB_MAX_ROM(v)          ((v) <<  8)
  58 #define BIB_MAX_RECEIVE(v)      ((v) << 12)
  59 #define BIB_CYC_CLK_ACC(v)      ((v) << 16)
  60 #define BIB_PMC                 ((1) << 27)
  61 #define BIB_BMC                 ((1) << 28)
  62 #define BIB_ISC                 ((1) << 29)
  63 #define BIB_CMC                 ((1) << 30)
  64 #define BIB_IMC                 ((1) << 31)
  65
  66 static u32 *
  67 generate_config_rom(struct fw_card *card, size_t *config_rom_length)
  68 {
  69         struct fw_descriptor *desc;
  70         static u32 config_rom[256];
  71         int i, j, length;
  72
  73         /*
  74          * Initialize contents of config rom buffer.  On the OHCI
  75          * controller, block reads to the config rom accesses the host
  76          * memory, but quadlet read access the hardware bus info block
  77          * registers.  That's just crack, but it means we should make
  78          * sure the contents of bus info block in host memory mathces
  79          * the version stored in the OHCI registers.
  80          */
  81
  82         memset(config_rom, 0, sizeof(config_rom));
  83         config_rom[0] = BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0);
  84         config_rom[1] = 0x31333934;
  85
  86         config_rom[2] =
  87                 BIB_LINK_SPEED(card->link_speed) |
  88                 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
  89                 BIB_MAX_ROM(2) |
  90                 BIB_MAX_RECEIVE(card->max_receive) |
  91                 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IMC;
  92         config_rom[3] = card->guid >> 32;
  93         config_rom[4] = card->guid;
  94
  95         /* Generate root directory. */
  96         i = 5;
  97         config_rom[i++] = 0;
  98         config_rom[i++] = 0x0c0083c0; /* node capabilities */
  99         j = i + descriptor_count;
 100
 101         /* Generate root directory entries for descriptors. */
 102         list_for_each_entry (desc, &descriptor_list, link) {
 103                 if (desc->immediate > 0)
 104                         config_rom[i++] = desc->immediate;
 105                 config_rom[i] = desc->key | (j - i);
 106                 i++;
 107                 j += desc->length;
 108         }
 109
 110         /* Update root directory length. */
 111         config_rom[5] = (i - 5 - 1) << 16;
 112
 113         /* End of root directory, now copy in descriptors. */
 114         list_for_each_entry (desc, &descriptor_list, link) {
 115                 memcpy(&config_rom[i], desc->data, desc->length * 4);
 116                 i += desc->length;
 117         }
 118
 119         /* Calculate CRCs for all blocks in the config rom.  This
 120          * assumes that CRC length and info length are identical for
 121          * the bus info block, which is always the case for this
 122          * implementation. */
 123         for (i = 0; i < j; i += length + 1)
 124                 length = fw_compute_block_crc(config_rom + i);
 125
 126         *config_rom_length = j;
 127
 128         return config_rom;
 129 }
 130
 131 static void
 132 update_config_roms(void)
 133 {
 134         struct fw_card *card;
 135         u32 *config_rom;
 136         size_t length;
 137
 138         list_for_each_entry (card, &card_list, link) {
 139                 config_rom = generate_config_rom(card, &length);
 140                 card->driver->set_config_rom(card, config_rom, length);
 141         }
 142 }
 143
 144 int
 145 fw_core_add_descriptor(struct fw_descriptor *desc)
 146 {
 147         size_t i;
 148
 149         /*
 150          * Check descriptor is valid; the length of all blocks in the
 151          * descriptor has to add up to exactly the length of the
 152          * block.
 153          */
 154         i = 0;
 155         while (i < desc->length)
 156                 i += (desc->data[i] >> 16) + 1;
 157
 158         if (i != desc->length)
 159                 return -EINVAL;
 160
 161         mutex_lock(&card_mutex);
 162
 163         list_add_tail(&desc->link, &descriptor_list);
 164         descriptor_count++;
 165         if (desc->immediate > 0)
 166                 descriptor_count++;
 167         update_config_roms();
 168
 169         mutex_unlock(&card_mutex);
 170
 171         return 0;
 172 }
 173
 174 void
 175 fw_core_remove_descriptor(struct fw_descriptor *desc)
 176 {
 177         mutex_lock(&card_mutex);
 178
 179         list_del(&desc->link);
 180         descriptor_count--;
 181         if (desc->immediate > 0)
 182                 descriptor_count--;
 183         update_config_roms();
 184
 185         mutex_unlock(&card_mutex);
 186 }
 187
 188 static const char gap_count_table[] = {
 189         63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
 190 };
 191
 192 struct bm_data {
 193         struct fw_transaction t;
 194         struct {
 195                 __be32 arg;
 196                 __be32 data;
 197         } lock;
 198         u32 old;
 199         int rcode;
 200         struct completion done;
 201 };
 202
 203 static void
 204 complete_bm_lock(struct fw_card *card, int rcode,
 205                  void *payload, size_t length, void *data)
 206 {
 207         struct bm_data *bmd = data;
 208
 209         if (rcode == RCODE_COMPLETE)
 210                 bmd->old = be32_to_cpu(*(__be32 *) payload);
 211         bmd->rcode = rcode;
 212         complete(&bmd->done);
 213 }
 214
 215 static void
 216 fw_card_bm_work(struct work_struct *work)
 217 {
 218         struct fw_card *card = container_of(work, struct fw_card, work.work);
 219         struct fw_device *root_device;
 220         struct fw_node *root_node, *local_node;
 221         struct bm_data bmd;
 222         unsigned long flags;
 223         int root_id, new_root_id, irm_id, gap_count, generation, grace;
 224         bool do_reset = false;
 225
 226         spin_lock_irqsave(&card->lock, flags);
 227         local_node = card->local_node;
 228         root_node  = card->root_node;
 229
 230         if (local_node == NULL) {
 231                 spin_unlock_irqrestore(&card->lock, flags);
 232                 return;
 233         }
 234         fw_node_get(local_node);
 235         fw_node_get(root_node);
 236
 237         generation = card->generation;
 238         root_device = root_node->data;
 239         if (root_device)
 240                 fw_device_get(root_device);
 241         root_id = root_node->node_id;
 242         grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 10));
 243
 244         if (card->bm_generation + 1 == generation ||
 245             (card->bm_generation != generation && grace)) {
 246                 /*
 247                  * This first step is to figure out who is IRM and
 248                  * then try to become bus manager.  If the IRM is not
 249                  * well defined (e.g. does not have an active link
 250                  * layer or does not responds to our lock request, we
 251                  * will have to do a little vigilante bus management.
 252                  * In that case, we do a goto into the gap count logic
 253                  * so that when we do the reset, we still optimize the
 254                  * gap count.  That could well save a reset in the
 255                  * next generation.
 256                  */
 257
 258                 irm_id = card->irm_node->node_id;
 259                 if (!card->irm_node->link_on) {
 260                         new_root_id = local_node->node_id;
 261                         fw_notify("IRM has link off, making local node (%02x) root.\n",
 262                                   new_root_id);
 263                         goto pick_me;
 264                 }
 265
 266                 bmd.lock.arg = cpu_to_be32(0x3f);
 267                 bmd.lock.data = cpu_to_be32(local_node->node_id);
 268
 269                 spin_unlock_irqrestore(&card->lock, flags);
 270
 271                 init_completion(&bmd.done);
 272                 fw_send_request(card, &bmd.t, TCODE_LOCK_COMPARE_SWAP,
 273                                 irm_id, generation,
 274                                 SCODE_100, CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
 275                                 &bmd.lock, sizeof(bmd.lock),
 276                                 complete_bm_lock, &bmd);
 277                 wait_for_completion(&bmd.done);
 278
 279                 if (bmd.rcode == RCODE_GENERATION) {
 280                         /*
 281                          * Another bus reset happened. Just return,
 282                          * the BM work has been rescheduled.
 283                          */
 284                         goto out;
 285                 }
 286
 287                 if (bmd.rcode == RCODE_COMPLETE && bmd.old != 0x3f)
 288                         /* Somebody else is BM, let them do the work. */
 289                         goto out;
 290
 291                 spin_lock_irqsave(&card->lock, flags);
 292                 if (bmd.rcode != RCODE_COMPLETE) {
 293                         /*
 294                          * The lock request failed, maybe the IRM
 295                          * isn't really IRM capable after all. Let's
 296                          * do a bus reset and pick the local node as
 297                          * root, and thus, IRM.
 298                          */
 299                         new_root_id = local_node->node_id;
 300                         fw_notify("BM lock failed, making local node (%02x) root.\n",
 301                                   new_root_id);
 302                         goto pick_me;
 303                 }
 304         } else if (card->bm_generation != generation) {
 305                 /*
 306                  * OK, we weren't BM in the last generation, and it's
 307                  * less than 100ms since last bus reset. Reschedule
 308                  * this task 100ms from now.
 309                  */
 310                 spin_unlock_irqrestore(&card->lock, flags);
 311                 schedule_delayed_work(&card->work, DIV_ROUND_UP(HZ, 10));
 312                 goto out;
 313         }
 314
 315         /*
 316          * We're bus manager for this generation, so next step is to
 317          * make sure we have an active cycle master and do gap count
 318          * optimization.
 319          */
 320         card->bm_generation = generation;
 321
 322         if (root_device == NULL) {
 323                 /*
 324                  * Either link_on is false, or we failed to read the
 325                  * config rom.  In either case, pick another root.
 326                  */
 327                 new_root_id = local_node->node_id;
 328         } else if (atomic_read(&root_device->state) != FW_DEVICE_RUNNING) {
 329                 /*
 330                  * If we haven't probed this device yet, bail out now
 331                  * and let's try again once that's done.
 332                  */
 333                 spin_unlock_irqrestore(&card->lock, flags);
 334                 goto out;
 335         } else if (root_device->cmc) {
 336                 /*
 337                  * FIXME: I suppose we should set the cmstr bit in the
 338                  * STATE_CLEAR register of this node, as described in
 339                  * 1394-1995, 8.4.2.6.  Also, send out a force root
 340                  * packet for this node.
 341                  */
 342                 new_root_id = root_id;
 343         } else {
 344                 /*
 345                  * Current root has an active link layer and we
 346                  * successfully read the config rom, but it's not
 347                  * cycle master capable.
 348                  */
 349                 new_root_id = local_node->node_id;
 350         }
 351
 352  pick_me:
 353         /*
 354          * Pick a gap count from 1394a table E-1.  The table doesn't cover
 355          * the typically much larger 1394b beta repeater delays though.
 356          */
 357         if (!card->beta_repeaters_present &&
 358             root_node->max_hops < ARRAY_SIZE(gap_count_table))
 359                 gap_count = gap_count_table[root_node->max_hops];
 360         else
 361                 gap_count = 63;
 362
 363         /*
 364          * Finally, figure out if we should do a reset or not.  If we have
 365          * done less than 5 resets with the same physical topology and we
 366          * have either a new root or a new gap count setting, let's do it.
 367          */
 368
 369         if (card->bm_retries++ < 5 &&
 370             (card->gap_count != gap_count || new_root_id != root_id))
 371                 do_reset = true;
 372
 373         spin_unlock_irqrestore(&card->lock, flags);
 374
 375         if (do_reset) {
 376                 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
 377                           card->index, new_root_id, gap_count);
 378                 fw_send_phy_config(card, new_root_id, generation, gap_count);
 379                 fw_core_initiate_bus_reset(card, 1);
 380         }
 381  out:
 382         if (root_device)
 383                 fw_device_put(root_device);
 384         fw_node_put(root_node);
 385         fw_node_put(local_node);
 386 }
 387
 388 static void
 389 flush_timer_callback(unsigned long data)
 390 {
 391         struct fw_card *card = (struct fw_card *)data;
 392
 393         fw_flush_transactions(card);
 394 }
 395
 396 void
 397 fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
 398                    struct device *device)
 399 {
 400         static atomic_t index = ATOMIC_INIT(-1);
 401
 402         card->index = atomic_inc_return(&index);
 403         card->driver = driver;
 404         card->device = device;
 405         card->current_tlabel = 0;
 406         card->tlabel_mask = 0;
 407         card->color = 0;
 408         card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
 409
 410         kref_init(&card->kref);
 411         init_completion(&card->done);
 412         INIT_LIST_HEAD(&card->transaction_list);
 413         spin_lock_init(&card->lock);
 414         setup_timer(&card->flush_timer,
 415                     flush_timer_callback, (unsigned long)card);
 416
 417         card->local_node = NULL;
 418
 419         INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
 420 }
 421 EXPORT_SYMBOL(fw_card_initialize);
 422
 423 int
 424 fw_card_add(struct fw_card *card,
 425             u32 max_receive, u32 link_speed, u64 guid)
 426 {
 427         u32 *config_rom;
 428         size_t length;
 429
 430         card->max_receive = max_receive;
 431         card->link_speed = link_speed;
 432         card->guid = guid;
 433
 434         mutex_lock(&card_mutex);
 435         config_rom = generate_config_rom(card, &length);
 436         list_add_tail(&card->link, &card_list);
 437         mutex_unlock(&card_mutex);
 438
 439         return card->driver->enable(card, config_rom, length);
 440 }
 441 EXPORT_SYMBOL(fw_card_add);
 442
 443
 444 /*
 445  * The next few functions implements a dummy driver that use once a
 446  * card driver shuts down an fw_card.  This allows the driver to
 447  * cleanly unload, as all IO to the card will be handled by the dummy
 448  * driver instead of calling into the (possibly) unloaded module.  The
 449  * dummy driver just fails all IO.
 450  */
 451
 452 static int
 453 dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
 454 {
 455         BUG();
 456         return -1;
 457 }
 458
 459 static int
 460 dummy_update_phy_reg(struct fw_card *card, int address,
 461                      int clear_bits, int set_bits)
 462 {
 463         return -ENODEV;
 464 }
 465
 466 static int
 467 dummy_set_config_rom(struct fw_card *card,
 468                      u32 *config_rom, size_t length)
 469 {
 470         /*
 471          * We take the card out of card_list before setting the dummy
 472          * driver, so this should never get called.
 473          */
 474         BUG();
 475         return -1;
 476 }
 477
 478 static void
 479 dummy_send_request(struct fw_card *card, struct fw_packet *packet)
 480 {
 481         packet->callback(packet, card, -ENODEV);
 482 }
 483
 484 static void
 485 dummy_send_response(struct fw_card *card, struct fw_packet *packet)
 486 {
 487         packet->callback(packet, card, -ENODEV);
 488 }
 489
 490 static int
 491 dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
 492 {
 493         return -ENOENT;
 494 }
 495
 496 static int
 497 dummy_enable_phys_dma(struct fw_card *card,
 498                       int node_id, int generation)
 499 {
 500         return -ENODEV;
 501 }
 502
 503 static struct fw_card_driver dummy_driver = {
 504         .enable          = dummy_enable,
 505         .update_phy_reg  = dummy_update_phy_reg,
 506         .set_config_rom  = dummy_set_config_rom,
 507         .send_request    = dummy_send_request,
 508         .cancel_packet   = dummy_cancel_packet,
 509         .send_response   = dummy_send_response,
 510         .enable_phys_dma = dummy_enable_phys_dma,
 511 };
 512
 513 void
 514 fw_card_release(struct kref *kref)
 515 {
 516         struct fw_card *card = container_of(kref, struct fw_card, kref);
 517
 518         complete(&card->done);
 519 }
 520
 521 void
 522 fw_core_remove_card(struct fw_card *card)
 523 {
 524         card->driver->update_phy_reg(card, 4,
 525                                      PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
 526         fw_core_initiate_bus_reset(card, 1);
 527
 528         mutex_lock(&card_mutex);
 529         list_del(&card->link);
 530         mutex_unlock(&card_mutex);
 531
 532         /* Set up the dummy driver. */
 533         card->driver = &dummy_driver;
 534
 535         fw_destroy_nodes(card);
 536
 537         /* Wait for all users, especially device workqueue jobs, to finish. */
 538         fw_card_put(card);
 539         wait_for_completion(&card->done);
 540
 541         cancel_delayed_work_sync(&card->work);
 542         WARN_ON(!list_empty(&card->transaction_list));
 543         del_timer_sync(&card->flush_timer);
 544 }
 545 EXPORT_SYMBOL(fw_core_remove_card);
 546
 547 int
 548 fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
 549 {
 550         int reg = short_reset ? 5 : 1;
 551         int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
 552
 553         return card->driver->update_phy_reg(card, reg, 0, bit);
 554 }
 555 EXPORT_SYMBOL(fw_core_initiate_bus_reset);