SAFE public projects git trees. - safe/jmp/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 "fw-transaction.h"
  26 #include "fw-topology.h"
  27 #include "fw-device.h"
  28
  29 /* The lib/crc16.c implementation uses the standard (0x8005)
  30  * polynomial, but we need the ITU-T (or CCITT) polynomial (0x1021).
  31  * The implementation below works on an array of host-endian u32
  32  * words, assuming they'll be transmited msb first. */
  33 static u16
  34 crc16_itu_t(const u32 *buffer, size_t length)
  35 {
  36         int shift, i;
  37         u32 data;
  38         u16 sum, crc = 0;
  39
  40         for (i = 0; i < length; i++) {
  41                 data = *buffer++;
  42                 for (shift = 28; shift >= 0; shift -= 4 ) {
  43                         sum = ((crc >> 12) ^ (data >> shift)) & 0xf;
  44                         crc = (crc << 4) ^ (sum << 12) ^ (sum << 5) ^ (sum);
  45                 }
  46                 crc &= 0xffff;
  47         }
  48
  49         return crc;
  50 }
  51
  52 static LIST_HEAD(card_list);
  53
  54 static LIST_HEAD(descriptor_list);
  55 static int descriptor_count;
  56
  57 #define bib_crc(v)              ((v) <<  0)
  58 #define bib_crc_length(v)       ((v) << 16)
  59 #define bib_info_length(v)      ((v) << 24)
  60
  61 #define bib_link_speed(v)       ((v) <<  0)
  62 #define bib_generation(v)       ((v) <<  4)
  63 #define bib_max_rom(v)          ((v) <<  8)
  64 #define bib_max_receive(v)      ((v) << 12)
  65 #define bib_cyc_clk_acc(v)      ((v) << 16)
  66 #define bib_pmc                 ((1) << 27)
  67 #define bib_bmc                 ((1) << 28)
  68 #define bib_isc                 ((1) << 29)
  69 #define bib_cmc                 ((1) << 30)
  70 #define bib_imc                 ((1) << 31)
  71
  72 static u32 *
  73 generate_config_rom (struct fw_card *card, size_t *config_rom_length)
  74 {
  75         struct fw_descriptor *desc;
  76         static u32 config_rom[256];
  77         int i, j, length;
  78
  79         /* Initialize contents of config rom buffer.  On the OHCI
  80          * controller, block reads to the config rom accesses the host
  81          * memory, but quadlet read access the hardware bus info block
  82          * registers.  That's just crack, but it means we should make
  83          * sure the contents of bus info block in host memory mathces
  84          * the version stored in the OHCI registers. */
  85
  86         memset(config_rom, 0, sizeof config_rom);
  87         config_rom[0] = bib_crc_length(4) | bib_info_length(4) | bib_crc(0);
  88         config_rom[1] = 0x31333934;
  89
  90         config_rom[2] =
  91                 bib_link_speed(card->link_speed) |
  92                 bib_generation(card->config_rom_generation++ % 14 + 2) |
  93                 bib_max_rom(2) |
  94                 bib_max_receive(card->max_receive) |
  95                 bib_isc | bib_cmc | bib_imc;
  96         config_rom[3] = card->guid >> 32;
  97         config_rom[4] = card->guid;
  98
  99         /* Generate root directory. */
 100         i = 5;
 101         config_rom[i++] = 0;
 102         config_rom[i++] = 0x0c0083c0; /* node capabilities */
 103         config_rom[i++] = 0x03d00d1e; /* vendor id */
 104         j = i + descriptor_count;
 105
 106         /* Generate root directory entries for descriptors. */
 107         list_for_each_entry (desc, &descriptor_list, link) {
 108                 config_rom[i] = desc->key | (j - i);
 109                 i++;
 110                 j += desc->length;
 111         }
 112
 113         /* Update root directory length. */
 114         config_rom[5] = (i - 5 - 1) << 16;
 115
 116         /* End of root directory, now copy in descriptors. */
 117         list_for_each_entry (desc, &descriptor_list, link) {
 118                 memcpy(&config_rom[i], desc->data, desc->length * 4);
 119                 i += desc->length;
 120         }
 121
 122         /* Calculate CRCs for all blocks in the config rom.  This
 123          * assumes that CRC length and info length are identical for
 124          * the bus info block, which is always the case for this
 125          * implementation. */
 126         for (i = 0; i < j; i += length + 1) {
 127                 length = (config_rom[i] >> 16) & 0xff;
 128                 config_rom[i] |= crc16_itu_t(&config_rom[i + 1], length);
 129         }
 130
 131         *config_rom_length = j;
 132
 133         return config_rom;
 134 }
 135
 136 static void
 137 update_config_roms (void)
 138 {
 139         struct fw_card *card;
 140         u32 *config_rom;
 141         size_t length;
 142
 143         list_for_each_entry (card, &card_list, link) {
 144                 config_rom = generate_config_rom(card, &length);
 145                 card->driver->set_config_rom(card, config_rom, length);
 146         }
 147 }
 148
 149 int
 150 fw_core_add_descriptor (struct fw_descriptor *desc)
 151 {
 152         size_t i;
 153
 154         /* Check descriptor is valid; the length of all blocks in the
 155          * descriptor has to add up to exactly the length of the
 156          * block. */
 157         i = 0;
 158         while (i < desc->length)
 159                 i += (desc->data[i] >> 16) + 1;
 160
 161         if (i != desc->length)
 162                 return -1;
 163
 164         down_write(&fw_bus_type.subsys.rwsem);
 165
 166         list_add_tail (&desc->link, &descriptor_list);
 167         descriptor_count++;
 168         update_config_roms();
 169
 170         up_write(&fw_bus_type.subsys.rwsem);
 171
 172         return 0;
 173 }
 174 EXPORT_SYMBOL(fw_core_add_descriptor);
 175
 176 void
 177 fw_core_remove_descriptor (struct fw_descriptor *desc)
 178 {
 179         down_write(&fw_bus_type.subsys.rwsem);
 180
 181         list_del(&desc->link);
 182         descriptor_count--;
 183         update_config_roms();
 184
 185         up_write(&fw_bus_type.subsys.rwsem);
 186 }
 187 EXPORT_SYMBOL(fw_core_remove_descriptor);
 188
 189 static void
 190 fw_card_irm_work(struct work_struct *work)
 191 {
 192         struct fw_card *card =
 193                 container_of(work, struct fw_card, work.work);
 194         struct fw_device *root;
 195         unsigned long flags;
 196         int new_irm_id, generation;
 197
 198         /* FIXME: This simple bus management unconditionally picks a
 199          * cycle master if the current root can't do it.  We need to
 200          * not do this if there is a bus manager already.  Also, some
 201          * hubs set the contender bit, which is bogus, so we should
 202          * probably do a little sanity check on the IRM (like, read
 203          * the bandwidth register) if it's not us. */
 204
 205         spin_lock_irqsave(&card->lock, flags);
 206
 207         generation = card->generation;
 208         root = card->root_node->data;
 209
 210         if (root == NULL)
 211                 /* Either link_on is false, or we failed to read the
 212                  * config rom.  In either case, pick another root. */
 213                 new_irm_id = card->local_node->node_id;
 214         else if (root->state != FW_DEVICE_RUNNING)
 215                 /* If we haven't probed this device yet, bail out now
 216                  * and let's try again once that's done. */
 217                 new_irm_id = -1;
 218         else if (root->config_rom[2] & bib_cmc)
 219                 /* FIXME: I suppose we should set the cmstr bit in the
 220                  * STATE_CLEAR register of this node, as described in
 221                  * 1394-1995, 8.4.2.6.  Also, send out a force root
 222                  * packet for this node. */
 223                 new_irm_id = -1;
 224         else
 225                 /* Current root has an active link layer and we
 226                  * successfully read the config rom, but it's not
 227                  * cycle master capable. */
 228                 new_irm_id = card->local_node->node_id;
 229
 230         if (card->irm_retries++ > 5)
 231                 new_irm_id = -1;
 232
 233         spin_unlock_irqrestore(&card->lock, flags);
 234
 235         if (new_irm_id > 0) {
 236                 fw_notify("Trying to become root (card %d)\n", card->index);
 237                 fw_send_force_root(card, new_irm_id, generation);
 238                 fw_core_initiate_bus_reset(card, 1);
 239         }
 240 }
 241
 242 static void
 243 release_card(struct device *device)
 244 {
 245         struct fw_card *card =
 246                 container_of(device, struct fw_card, card_device);
 247
 248         kfree(card);
 249 }
 250
 251 static void
 252 flush_timer_callback(unsigned long data)
 253 {
 254         struct fw_card *card = (struct fw_card *)data;
 255
 256         fw_flush_transactions(card);
 257 }
 258
 259 void
 260 fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
 261                    struct device *device)
 262 {
 263         static int index;
 264
 265         card->index = index++;
 266         card->driver = driver;
 267         card->device = device;
 268         card->current_tlabel = 0;
 269         card->tlabel_mask = 0;
 270         card->color = 0;
 271
 272         INIT_LIST_HEAD(&card->transaction_list);
 273         spin_lock_init(&card->lock);
 274         setup_timer(&card->flush_timer,
 275                     flush_timer_callback, (unsigned long)card);
 276
 277         card->local_node = NULL;
 278
 279         INIT_DELAYED_WORK(&card->work, fw_card_irm_work);
 280
 281         card->card_device.bus     = &fw_bus_type;
 282         card->card_device.release = release_card;
 283         card->card_device.parent  = card->device;
 284         snprintf(card->card_device.bus_id, sizeof card->card_device.bus_id,
 285                  "fwcard%d", card->index);
 286
 287         device_initialize(&card->card_device);
 288 }
 289 EXPORT_SYMBOL(fw_card_initialize);
 290
 291 int
 292 fw_card_add(struct fw_card *card,
 293             u32 max_receive, u32 link_speed, u64 guid)
 294 {
 295         int retval;
 296         u32 *config_rom;
 297         size_t length;
 298
 299         card->max_receive = max_receive;
 300         card->link_speed = link_speed;
 301         card->guid = guid;
 302
 303         /* FIXME: add #define's for phy registers. */
 304         /* Activate link_on bit and contender bit in our self ID packets.*/
 305         if (card->driver->update_phy_reg(card, 4, 0, 0x80 | 0x40) < 0)
 306                 return -EIO;
 307
 308         retval = device_add(&card->card_device);
 309         if (retval < 0) {
 310                 fw_error("Failed to register card device.");
 311                 return retval;
 312         }
 313
 314         /* The subsystem grabs a reference when the card is added and
 315          * drops it when the driver calls fw_core_remove_card. */
 316         fw_card_get(card);
 317
 318         down_write(&fw_bus_type.subsys.rwsem);
 319         config_rom = generate_config_rom (card, &length);
 320         list_add_tail(&card->link, &card_list);
 321         up_write(&fw_bus_type.subsys.rwsem);
 322
 323         return card->driver->enable(card, config_rom, length);
 324 }
 325 EXPORT_SYMBOL(fw_card_add);
 326
 327
 328 /* The next few functions implements a dummy driver that use once a
 329  * card driver shuts down an fw_card.  This allows the driver to
 330  * cleanly unload, as all IO to the card will be handled by the dummy
 331  * driver instead of calling into the (possibly) unloaded module.  The
 332  * dummy driver just fails all IO. */
 333
 334 static int
 335 dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
 336 {
 337         BUG();
 338         return -1;
 339 }
 340
 341 static int
 342 dummy_update_phy_reg(struct fw_card *card, int address,
 343                      int clear_bits, int set_bits)
 344 {
 345         return -ENODEV;
 346 }
 347
 348 static int
 349 dummy_set_config_rom(struct fw_card *card,
 350                      u32 *config_rom, size_t length)
 351 {
 352         /* We take the card out of card_list before setting the dummy
 353          * driver, so this should never get called. */
 354         BUG();
 355         return -1;
 356 }
 357
 358 static void
 359 dummy_send_request(struct fw_card *card, struct fw_packet *packet)
 360 {
 361         packet->callback(packet, card, -ENODEV);
 362 }
 363
 364 static void
 365 dummy_send_response(struct fw_card *card, struct fw_packet *packet)
 366 {
 367         packet->callback(packet, card, -ENODEV);
 368 }
 369
 370 static int
 371 dummy_enable_phys_dma(struct fw_card *card,
 372                       int node_id, int generation)
 373 {
 374         return -ENODEV;
 375 }
 376
 377 static struct fw_card_driver dummy_driver = {
 378         .name            = "dummy",
 379         .enable          = dummy_enable,
 380         .update_phy_reg  = dummy_update_phy_reg,
 381         .set_config_rom  = dummy_set_config_rom,
 382         .send_request    = dummy_send_request,
 383         .send_response   = dummy_send_response,
 384         .enable_phys_dma = dummy_enable_phys_dma
 385 };
 386
 387 void
 388 fw_core_remove_card(struct fw_card *card)
 389 {
 390         card->driver->update_phy_reg(card, 4, 0x80 | 0x40, 0);
 391         fw_core_initiate_bus_reset(card, 1);
 392
 393         down_write(&fw_bus_type.subsys.rwsem);
 394         list_del(&card->link);
 395         up_write(&fw_bus_type.subsys.rwsem);
 396
 397         /* Set up the dummy driver. */
 398         card->driver = &dummy_driver;
 399
 400         fw_flush_transactions(card);
 401
 402         fw_destroy_nodes(card);
 403
 404         /* This also drops the subsystem reference. */
 405         device_unregister(&card->card_device);
 406 }
 407 EXPORT_SYMBOL(fw_core_remove_card);
 408
 409 struct fw_card *
 410 fw_card_get(struct fw_card *card)
 411 {
 412         get_device(&card->card_device);
 413
 414         return card;
 415 }
 416 EXPORT_SYMBOL(fw_card_get);
 417
 418 /* An assumption for fw_card_put() is that the card driver allocates
 419  * the fw_card struct with kalloc and that it has been shut down
 420  * before the last ref is dropped. */
 421 void
 422 fw_card_put(struct fw_card *card)
 423 {
 424         put_device(&card->card_device);
 425 }
 426 EXPORT_SYMBOL(fw_card_put);
 427
 428 int
 429 fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
 430 {
 431         u32 address;
 432
 433         if (short_reset)
 434                 address = 5;
 435         else
 436                 address = 1;
 437
 438         return card->driver->update_phy_reg(card, address, 0, 0x40);
 439 }
 440 EXPORT_SYMBOL(fw_core_initiate_bus_reset);