err.no Git - linux-2.6/blob - drivers/firewire/fw-card.c

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