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