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