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