Pileus Git - ~andy/linux/blob - drivers/firewire/fw-transaction.c

   1 /*
   2  * Core IEEE1394 transaction logic
   3  *
   4  * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include <linux/completion.h>
  22 #include <linux/idr.h>
  23 #include <linux/kernel.h>
  24 #include <linux/kref.h>
  25 #include <linux/module.h>
  26 #include <linux/mutex.h>
  27 #include <linux/init.h>
  28 #include <linux/interrupt.h>
  29 #include <linux/pci.h>
  30 #include <linux/delay.h>
  31 #include <linux/poll.h>
  32 #include <linux/list.h>
  33 #include <linux/kthread.h>
  34 #include <asm/uaccess.h>
  35
  36 #include "fw-transaction.h"
  37 #include "fw-topology.h"
  38 #include "fw-device.h"
  39
  40 #define HEADER_PRI(pri)                 ((pri) << 0)
  41 #define HEADER_TCODE(tcode)             ((tcode) << 4)
  42 #define HEADER_RETRY(retry)             ((retry) << 8)
  43 #define HEADER_TLABEL(tlabel)           ((tlabel) << 10)
  44 #define HEADER_DESTINATION(destination) ((destination) << 16)
  45 #define HEADER_SOURCE(source)           ((source) << 16)
  46 #define HEADER_RCODE(rcode)             ((rcode) << 12)
  47 #define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0)
  48 #define HEADER_DATA_LENGTH(length)      ((length) << 16)
  49 #define HEADER_EXTENDED_TCODE(tcode)    ((tcode) << 0)
  50
  51 #define HEADER_GET_TCODE(q)             (((q) >> 4) & 0x0f)
  52 #define HEADER_GET_TLABEL(q)            (((q) >> 10) & 0x3f)
  53 #define HEADER_GET_RCODE(q)             (((q) >> 12) & 0x0f)
  54 #define HEADER_GET_DESTINATION(q)       (((q) >> 16) & 0xffff)
  55 #define HEADER_GET_SOURCE(q)            (((q) >> 16) & 0xffff)
  56 #define HEADER_GET_OFFSET_HIGH(q)       (((q) >> 0) & 0xffff)
  57 #define HEADER_GET_DATA_LENGTH(q)       (((q) >> 16) & 0xffff)
  58 #define HEADER_GET_EXTENDED_TCODE(q)    (((q) >> 0) & 0xffff)
  59
  60 #define HEADER_DESTINATION_IS_BROADCAST(q) \
  61         (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))
  62
  63 #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
  64 #define PHY_CONFIG_ROOT_ID(node_id)     ((((node_id) & 0x3f) << 24) | (1 << 23))
  65 #define PHY_IDENTIFIER(id)              ((id) << 30)
  66
  67 static int close_transaction(struct fw_transaction *transaction,
  68                              struct fw_card *card, int rcode,
  69                              u32 *payload, size_t length)
  70 {
  71         struct fw_transaction *t;
  72         unsigned long flags;
  73
  74         spin_lock_irqsave(&card->lock, flags);
  75         list_for_each_entry(t, &card->transaction_list, link) {
  76                 if (t == transaction) {
  77                         list_del(&t->link);
  78                         card->tlabel_mask &= ~(1 << t->tlabel);
  79                         break;
  80                 }
  81         }
  82         spin_unlock_irqrestore(&card->lock, flags);
  83
  84         if (&t->link != &card->transaction_list) {
  85                 t->callback(card, rcode, payload, length, t->callback_data);
  86                 return 0;
  87         }
  88
  89         return -ENOENT;
  90 }
  91
  92 /*
  93  * Only valid for transactions that are potentially pending (ie have
  94  * been sent).
  95  */
  96 int fw_cancel_transaction(struct fw_card *card,
  97                           struct fw_transaction *transaction)
  98 {
  99         /*
 100          * Cancel the packet transmission if it's still queued.  That
 101          * will call the packet transmission callback which cancels
 102          * the transaction.
 103          */
 104
 105         if (card->driver->cancel_packet(card, &transaction->packet) == 0)
 106                 return 0;
 107
 108         /*
 109          * If the request packet has already been sent, we need to see
 110          * if the transaction is still pending and remove it in that case.
 111          */
 112
 113         return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
 114 }
 115 EXPORT_SYMBOL(fw_cancel_transaction);
 116
 117 static void transmit_complete_callback(struct fw_packet *packet,
 118                                        struct fw_card *card, int status)
 119 {
 120         struct fw_transaction *t =
 121             container_of(packet, struct fw_transaction, packet);
 122
 123         switch (status) {
 124         case ACK_COMPLETE:
 125                 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
 126                 break;
 127         case ACK_PENDING:
 128                 t->timestamp = packet->timestamp;
 129                 break;
 130         case ACK_BUSY_X:
 131         case ACK_BUSY_A:
 132         case ACK_BUSY_B:
 133                 close_transaction(t, card, RCODE_BUSY, NULL, 0);
 134                 break;
 135         case ACK_DATA_ERROR:
 136                 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
 137                 break;
 138         case ACK_TYPE_ERROR:
 139                 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
 140                 break;
 141         default:
 142                 /*
 143                  * In this case the ack is really a juju specific
 144                  * rcode, so just forward that to the callback.
 145                  */
 146                 close_transaction(t, card, status, NULL, 0);
 147                 break;
 148         }
 149 }
 150
 151 static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
 152                 int destination_id, int source_id, int generation, int speed,
 153                 unsigned long long offset, void *payload, size_t length)
 154 {
 155         int ext_tcode;
 156
 157         if (tcode > 0x10) {
 158                 ext_tcode = tcode & ~0x10;
 159                 tcode = TCODE_LOCK_REQUEST;
 160         } else
 161                 ext_tcode = 0;
 162
 163         packet->header[0] =
 164                 HEADER_RETRY(RETRY_X) |
 165                 HEADER_TLABEL(tlabel) |
 166                 HEADER_TCODE(tcode) |
 167                 HEADER_DESTINATION(destination_id);
 168         packet->header[1] =
 169                 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
 170         packet->header[2] =
 171                 offset;
 172
 173         switch (tcode) {
 174         case TCODE_WRITE_QUADLET_REQUEST:
 175                 packet->header[3] = *(u32 *)payload;
 176                 packet->header_length = 16;
 177                 packet->payload_length = 0;
 178                 break;
 179
 180         case TCODE_LOCK_REQUEST:
 181         case TCODE_WRITE_BLOCK_REQUEST:
 182                 packet->header[3] =
 183                         HEADER_DATA_LENGTH(length) |
 184                         HEADER_EXTENDED_TCODE(ext_tcode);
 185                 packet->header_length = 16;
 186                 packet->payload = payload;
 187                 packet->payload_length = length;
 188                 break;
 189
 190         case TCODE_READ_QUADLET_REQUEST:
 191                 packet->header_length = 12;
 192                 packet->payload_length = 0;
 193                 break;
 194
 195         case TCODE_READ_BLOCK_REQUEST:
 196                 packet->header[3] =
 197                         HEADER_DATA_LENGTH(length) |
 198                         HEADER_EXTENDED_TCODE(ext_tcode);
 199                 packet->header_length = 16;
 200                 packet->payload_length = 0;
 201                 break;
 202         }
 203
 204         packet->speed = speed;
 205         packet->generation = generation;
 206         packet->ack = 0;
 207         packet->payload_bus = 0;
 208 }
 209
 210 /**
 211  * This function provides low-level access to the IEEE1394 transaction
 212  * logic.  Most C programs would use either fw_read(), fw_write() or
 213  * fw_lock() instead - those function are convenience wrappers for
 214  * this function.  The fw_send_request() function is primarily
 215  * provided as a flexible, one-stop entry point for languages bindings
 216  * and protocol bindings.
 217  *
 218  * FIXME: Document this function further, in particular the possible
 219  * values for rcode in the callback.  In short, we map ACK_COMPLETE to
 220  * RCODE_COMPLETE, internal errors set errno and set rcode to
 221  * RCODE_SEND_ERROR (which is out of range for standard ieee1394
 222  * rcodes).  All other rcodes are forwarded unchanged.  For all
 223  * errors, payload is NULL, length is 0.
 224  *
 225  * Can not expect the callback to be called before the function
 226  * returns, though this does happen in some cases (ACK_COMPLETE and
 227  * errors).
 228  *
 229  * The payload is only used for write requests and must not be freed
 230  * until the callback has been called.
 231  *
 232  * @param card the card from which to send the request
 233  * @param tcode the tcode for this transaction.  Do not use
 234  *   TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
 235  *   etc. to specify tcode and ext_tcode.
 236  * @param node_id the destination node ID (bus ID and PHY ID concatenated)
 237  * @param generation the generation for which node_id is valid
 238  * @param speed the speed to use for sending the request
 239  * @param offset the 48 bit offset on the destination node
 240  * @param payload the data payload for the request subaction
 241  * @param length the length in bytes of the data to read
 242  * @param callback function to be called when the transaction is completed
 243  * @param callback_data pointer to arbitrary data, which will be
 244  *   passed to the callback
 245  */
 246 void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
 247                      int destination_id, int generation, int speed,
 248                      unsigned long long offset, void *payload, size_t length,
 249                      fw_transaction_callback_t callback, void *callback_data)
 250 {
 251         unsigned long flags;
 252         int tlabel;
 253
 254         /*
 255          * Bump the flush timer up 100ms first of all so we
 256          * don't race with a flush timer callback.
 257          */
 258
 259         mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
 260
 261         /*
 262          * Allocate tlabel from the bitmap and put the transaction on
 263          * the list while holding the card spinlock.
 264          */
 265
 266         spin_lock_irqsave(&card->lock, flags);
 267
 268         tlabel = card->current_tlabel;
 269         if (card->tlabel_mask & (1 << tlabel)) {
 270                 spin_unlock_irqrestore(&card->lock, flags);
 271                 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
 272                 return;
 273         }
 274
 275         card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
 276         card->tlabel_mask |= (1 << tlabel);
 277
 278         t->node_id = destination_id;
 279         t->tlabel = tlabel;
 280         t->callback = callback;
 281         t->callback_data = callback_data;
 282
 283         fw_fill_request(&t->packet, tcode, t->tlabel,
 284                         destination_id, card->node_id, generation,
 285                         speed, offset, payload, length);
 286         t->packet.callback = transmit_complete_callback;
 287
 288         list_add_tail(&t->link, &card->transaction_list);
 289
 290         spin_unlock_irqrestore(&card->lock, flags);
 291
 292         card->driver->send_request(card, &t->packet);
 293 }
 294 EXPORT_SYMBOL(fw_send_request);
 295
 296 struct transaction_callback_data {
 297         struct completion done;
 298         void *payload;
 299         int rcode;
 300 };
 301
 302 static void transaction_callback(struct fw_card *card, int rcode,
 303                                  void *payload, size_t length, void *data)
 304 {
 305         struct transaction_callback_data *d = data;
 306
 307         if (rcode == RCODE_COMPLETE)
 308                 memcpy(d->payload, payload, length);
 309         d->rcode = rcode;
 310         complete(&d->done);
 311 }
 312
 313 /**
 314  * fw_run_transaction - send request and sleep until transaction is completed
 315  *
 316  * Returns the RCODE.
 317  */
 318 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
 319                        int generation, int speed, unsigned long long offset,
 320                        void *data, size_t length)
 321 {
 322         struct transaction_callback_data d;
 323         struct fw_transaction t;
 324
 325         init_completion(&d.done);
 326         d.payload = data;
 327         fw_send_request(card, &t, tcode, destination_id, generation, speed,
 328                         offset, data, length, transaction_callback, &d);
 329         wait_for_completion(&d.done);
 330
 331         return d.rcode;
 332 }
 333 EXPORT_SYMBOL(fw_run_transaction);
 334
 335 static DEFINE_MUTEX(phy_config_mutex);
 336 static DECLARE_COMPLETION(phy_config_done);
 337
 338 static void transmit_phy_packet_callback(struct fw_packet *packet,
 339                                          struct fw_card *card, int status)
 340 {
 341         complete(&phy_config_done);
 342 }
 343
 344 static struct fw_packet phy_config_packet = {
 345         .header_length  = 8,
 346         .payload_length = 0,
 347         .speed          = SCODE_100,
 348         .callback       = transmit_phy_packet_callback,
 349 };
 350
 351 void fw_send_phy_config(struct fw_card *card,
 352                         int node_id, int generation, int gap_count)
 353 {
 354         long timeout = DIV_ROUND_UP(HZ, 10);
 355         u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
 356                    PHY_CONFIG_ROOT_ID(node_id) |
 357                    PHY_CONFIG_GAP_COUNT(gap_count);
 358
 359         mutex_lock(&phy_config_mutex);
 360
 361         phy_config_packet.header[0] = data;
 362         phy_config_packet.header[1] = ~data;
 363         phy_config_packet.generation = generation;
 364         INIT_COMPLETION(phy_config_done);
 365
 366         card->driver->send_request(card, &phy_config_packet);
 367         wait_for_completion_timeout(&phy_config_done, timeout);
 368
 369         mutex_unlock(&phy_config_mutex);
 370 }
 371
 372 void fw_flush_transactions(struct fw_card *card)
 373 {
 374         struct fw_transaction *t, *next;
 375         struct list_head list;
 376         unsigned long flags;
 377
 378         INIT_LIST_HEAD(&list);
 379         spin_lock_irqsave(&card->lock, flags);
 380         list_splice_init(&card->transaction_list, &list);
 381         card->tlabel_mask = 0;
 382         spin_unlock_irqrestore(&card->lock, flags);
 383
 384         list_for_each_entry_safe(t, next, &list, link) {
 385                 card->driver->cancel_packet(card, &t->packet);
 386
 387                 /*
 388                  * At this point cancel_packet will never call the
 389                  * transaction callback, since we just took all the
 390                  * transactions out of the list.  So do it here.
 391                  */
 392                 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
 393         }
 394 }
 395
 396 static struct fw_address_handler *lookup_overlapping_address_handler(
 397         struct list_head *list, unsigned long long offset, size_t length)
 398 {
 399         struct fw_address_handler *handler;
 400
 401         list_for_each_entry(handler, list, link) {
 402                 if (handler->offset < offset + length &&
 403                     offset < handler->offset + handler->length)
 404                         return handler;
 405         }
 406
 407         return NULL;
 408 }
 409
 410 static struct fw_address_handler *lookup_enclosing_address_handler(
 411         struct list_head *list, unsigned long long offset, size_t length)
 412 {
 413         struct fw_address_handler *handler;
 414
 415         list_for_each_entry(handler, list, link) {
 416                 if (handler->offset <= offset &&
 417                     offset + length <= handler->offset + handler->length)
 418                         return handler;
 419         }
 420
 421         return NULL;
 422 }
 423
 424 static DEFINE_SPINLOCK(address_handler_lock);
 425 static LIST_HEAD(address_handler_list);
 426
 427 const struct fw_address_region fw_high_memory_region =
 428         { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL,  };
 429 EXPORT_SYMBOL(fw_high_memory_region);
 430
 431 #if 0
 432 const struct fw_address_region fw_low_memory_region =
 433         { .start = 0x000000000000ULL, .end = 0x000100000000ULL,  };
 434 const struct fw_address_region fw_private_region =
 435         { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL,  };
 436 const struct fw_address_region fw_csr_region =
 437         { .start = CSR_REGISTER_BASE,
 438           .end   = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END,  };
 439 const struct fw_address_region fw_unit_space_region =
 440         { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
 441 #endif  /*  0  */
 442
 443 /**
 444  * fw_core_add_address_handler - register for incoming requests
 445  * @handler: callback
 446  * @region: region in the IEEE 1212 node space address range
 447  *
 448  * region->start, ->end, and handler->length have to be quadlet-aligned.
 449  *
 450  * When a request is received that falls within the specified address range,
 451  * the specified callback is invoked.  The parameters passed to the callback
 452  * give the details of the particular request.
 453  *
 454  * Return value:  0 on success, non-zero otherwise.
 455  * The start offset of the handler's address region is determined by
 456  * fw_core_add_address_handler() and is returned in handler->offset.
 457  */
 458 int fw_core_add_address_handler(struct fw_address_handler *handler,
 459                                 const struct fw_address_region *region)
 460 {
 461         struct fw_address_handler *other;
 462         unsigned long flags;
 463         int ret = -EBUSY;
 464
 465         if (region->start & 0xffff000000000003ULL ||
 466             region->end   & 0xffff000000000003ULL ||
 467             region->start >= region->end ||
 468             handler->length & 3 ||
 469             handler->length == 0)
 470                 return -EINVAL;
 471
 472         spin_lock_irqsave(&address_handler_lock, flags);
 473
 474         handler->offset = region->start;
 475         while (handler->offset + handler->length <= region->end) {
 476                 other =
 477                     lookup_overlapping_address_handler(&address_handler_list,
 478                                                        handler->offset,
 479                                                        handler->length);
 480                 if (other != NULL) {
 481                         handler->offset += other->length;
 482                 } else {
 483                         list_add_tail(&handler->link, &address_handler_list);
 484                         ret = 0;
 485                         break;
 486                 }
 487         }
 488
 489         spin_unlock_irqrestore(&address_handler_lock, flags);
 490
 491         return ret;
 492 }
 493 EXPORT_SYMBOL(fw_core_add_address_handler);
 494
 495 /**
 496  * fw_core_remove_address_handler - unregister an address handler
 497  */
 498 void fw_core_remove_address_handler(struct fw_address_handler *handler)
 499 {
 500         unsigned long flags;
 501
 502         spin_lock_irqsave(&address_handler_lock, flags);
 503         list_del(&handler->link);
 504         spin_unlock_irqrestore(&address_handler_lock, flags);
 505 }
 506 EXPORT_SYMBOL(fw_core_remove_address_handler);
 507
 508 struct fw_request {
 509         struct fw_packet response;
 510         u32 request_header[4];
 511         int ack;
 512         u32 length;
 513         u32 data[0];
 514 };
 515
 516 static void free_response_callback(struct fw_packet *packet,
 517                                    struct fw_card *card, int status)
 518 {
 519         struct fw_request *request;
 520
 521         request = container_of(packet, struct fw_request, response);
 522         kfree(request);
 523 }
 524
 525 void fw_fill_response(struct fw_packet *response, u32 *request_header,
 526                       int rcode, void *payload, size_t length)
 527 {
 528         int tcode, tlabel, extended_tcode, source, destination;
 529
 530         tcode          = HEADER_GET_TCODE(request_header[0]);
 531         tlabel         = HEADER_GET_TLABEL(request_header[0]);
 532         source         = HEADER_GET_DESTINATION(request_header[0]);
 533         destination    = HEADER_GET_SOURCE(request_header[1]);
 534         extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
 535
 536         response->header[0] =
 537                 HEADER_RETRY(RETRY_1) |
 538                 HEADER_TLABEL(tlabel) |
 539                 HEADER_DESTINATION(destination);
 540         response->header[1] =
 541                 HEADER_SOURCE(source) |
 542                 HEADER_RCODE(rcode);
 543         response->header[2] = 0;
 544
 545         switch (tcode) {
 546         case TCODE_WRITE_QUADLET_REQUEST:
 547         case TCODE_WRITE_BLOCK_REQUEST:
 548                 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
 549                 response->header_length = 12;
 550                 response->payload_length = 0;
 551                 break;
 552
 553         case TCODE_READ_QUADLET_REQUEST:
 554                 response->header[0] |=
 555                         HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
 556                 if (payload != NULL)
 557                         response->header[3] = *(u32 *)payload;
 558                 else
 559                         response->header[3] = 0;
 560                 response->header_length = 16;
 561                 response->payload_length = 0;
 562                 break;
 563
 564         case TCODE_READ_BLOCK_REQUEST:
 565         case TCODE_LOCK_REQUEST:
 566                 response->header[0] |= HEADER_TCODE(tcode + 2);
 567                 response->header[3] =
 568                         HEADER_DATA_LENGTH(length) |
 569                         HEADER_EXTENDED_TCODE(extended_tcode);
 570                 response->header_length = 16;
 571                 response->payload = payload;
 572                 response->payload_length = length;
 573                 break;
 574
 575         default:
 576                 BUG();
 577                 return;
 578         }
 579
 580         response->payload_bus = 0;
 581 }
 582 EXPORT_SYMBOL(fw_fill_response);
 583
 584 static struct fw_request *allocate_request(struct fw_packet *p)
 585 {
 586         struct fw_request *request;
 587         u32 *data, length;
 588         int request_tcode, t;
 589
 590         request_tcode = HEADER_GET_TCODE(p->header[0]);
 591         switch (request_tcode) {
 592         case TCODE_WRITE_QUADLET_REQUEST:
 593                 data = &p->header[3];
 594                 length = 4;
 595                 break;
 596
 597         case TCODE_WRITE_BLOCK_REQUEST:
 598         case TCODE_LOCK_REQUEST:
 599                 data = p->payload;
 600                 length = HEADER_GET_DATA_LENGTH(p->header[3]);
 601                 break;
 602
 603         case TCODE_READ_QUADLET_REQUEST:
 604                 data = NULL;
 605                 length = 4;
 606                 break;
 607
 608         case TCODE_READ_BLOCK_REQUEST:
 609                 data = NULL;
 610                 length = HEADER_GET_DATA_LENGTH(p->header[3]);
 611                 break;
 612
 613         default:
 614                 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
 615                          p->header[0], p->header[1], p->header[2]);
 616                 return NULL;
 617         }
 618
 619         request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
 620         if (request == NULL)
 621                 return NULL;
 622
 623         t = (p->timestamp & 0x1fff) + 4000;
 624         if (t >= 8000)
 625                 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
 626         else
 627                 t = (p->timestamp & ~0x1fff) + t;
 628
 629         request->response.speed = p->speed;
 630         request->response.timestamp = t;
 631         request->response.generation = p->generation;
 632         request->response.ack = 0;
 633         request->response.callback = free_response_callback;
 634         request->ack = p->ack;
 635         request->length = length;
 636         if (data)
 637                 memcpy(request->data, data, length);
 638
 639         memcpy(request->request_header, p->header, sizeof(p->header));
 640
 641         return request;
 642 }
 643
 644 void fw_send_response(struct fw_card *card,
 645                       struct fw_request *request, int rcode)
 646 {
 647         /* unified transaction or broadcast transaction: don't respond */
 648         if (request->ack != ACK_PENDING ||
 649             HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
 650                 kfree(request);
 651                 return;
 652         }
 653
 654         if (rcode == RCODE_COMPLETE)
 655                 fw_fill_response(&request->response, request->request_header,
 656                                  rcode, request->data, request->length);
 657         else
 658                 fw_fill_response(&request->response, request->request_header,
 659                                  rcode, NULL, 0);
 660
 661         card->driver->send_response(card, &request->response);
 662 }
 663 EXPORT_SYMBOL(fw_send_response);
 664
 665 void fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
 666 {
 667         struct fw_address_handler *handler;
 668         struct fw_request *request;
 669         unsigned long long offset;
 670         unsigned long flags;
 671         int tcode, destination, source;
 672
 673         if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
 674                 return;
 675
 676         request = allocate_request(p);
 677         if (request == NULL) {
 678                 /* FIXME: send statically allocated busy packet. */
 679                 return;
 680         }
 681
 682         offset      =
 683                 ((unsigned long long)
 684                  HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
 685         tcode       = HEADER_GET_TCODE(p->header[0]);
 686         destination = HEADER_GET_DESTINATION(p->header[0]);
 687         source      = HEADER_GET_SOURCE(p->header[1]);
 688
 689         spin_lock_irqsave(&address_handler_lock, flags);
 690         handler = lookup_enclosing_address_handler(&address_handler_list,
 691                                                    offset, request->length);
 692         spin_unlock_irqrestore(&address_handler_lock, flags);
 693
 694         /*
 695          * FIXME: lookup the fw_node corresponding to the sender of
 696          * this request and pass that to the address handler instead
 697          * of the node ID.  We may also want to move the address
 698          * allocations to fw_node so we only do this callback if the
 699          * upper layers registered it for this node.
 700          */
 701
 702         if (handler == NULL)
 703                 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
 704         else
 705                 handler->address_callback(card, request,
 706                                           tcode, destination, source,
 707                                           p->generation, p->speed, offset,
 708                                           request->data, request->length,
 709                                           handler->callback_data);
 710 }
 711 EXPORT_SYMBOL(fw_core_handle_request);
 712
 713 void fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
 714 {
 715         struct fw_transaction *t;
 716         unsigned long flags;
 717         u32 *data;
 718         size_t data_length;
 719         int tcode, tlabel, destination, source, rcode;
 720
 721         tcode       = HEADER_GET_TCODE(p->header[0]);
 722         tlabel      = HEADER_GET_TLABEL(p->header[0]);
 723         destination = HEADER_GET_DESTINATION(p->header[0]);
 724         source      = HEADER_GET_SOURCE(p->header[1]);
 725         rcode       = HEADER_GET_RCODE(p->header[1]);
 726
 727         spin_lock_irqsave(&card->lock, flags);
 728         list_for_each_entry(t, &card->transaction_list, link) {
 729                 if (t->node_id == source && t->tlabel == tlabel) {
 730                         list_del(&t->link);
 731                         card->tlabel_mask &= ~(1 << t->tlabel);
 732                         break;
 733                 }
 734         }
 735         spin_unlock_irqrestore(&card->lock, flags);
 736
 737         if (&t->link == &card->transaction_list) {
 738                 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
 739                           source, tlabel);
 740                 return;
 741         }
 742
 743         /*
 744          * FIXME: sanity check packet, is length correct, does tcodes
 745          * and addresses match.
 746          */
 747
 748         switch (tcode) {
 749         case TCODE_READ_QUADLET_RESPONSE:
 750                 data = (u32 *) &p->header[3];
 751                 data_length = 4;
 752                 break;
 753
 754         case TCODE_WRITE_RESPONSE:
 755                 data = NULL;
 756                 data_length = 0;
 757                 break;
 758
 759         case TCODE_READ_BLOCK_RESPONSE:
 760         case TCODE_LOCK_RESPONSE:
 761                 data = p->payload;
 762                 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
 763                 break;
 764
 765         default:
 766                 /* Should never happen, this is just to shut up gcc. */
 767                 data = NULL;
 768                 data_length = 0;
 769                 break;
 770         }
 771
 772         /*
 773          * The response handler may be executed while the request handler
 774          * is still pending.  Cancel the request handler.
 775          */
 776         card->driver->cancel_packet(card, &t->packet);
 777
 778         t->callback(card, rcode, data, data_length, t->callback_data);
 779 }
 780 EXPORT_SYMBOL(fw_core_handle_response);
 781
 782 static const struct fw_address_region topology_map_region =
 783         { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
 784           .end   = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
 785
 786 static void handle_topology_map(struct fw_card *card, struct fw_request *request,
 787                 int tcode, int destination, int source, int generation,
 788                 int speed, unsigned long long offset,
 789                 void *payload, size_t length, void *callback_data)
 790 {
 791         int i, start, end;
 792         __be32 *map;
 793
 794         if (!TCODE_IS_READ_REQUEST(tcode)) {
 795                 fw_send_response(card, request, RCODE_TYPE_ERROR);
 796                 return;
 797         }
 798
 799         if ((offset & 3) > 0 || (length & 3) > 0) {
 800                 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
 801                 return;
 802         }
 803
 804         start = (offset - topology_map_region.start) / 4;
 805         end = start + length / 4;
 806         map = payload;
 807
 808         for (i = 0; i < length / 4; i++)
 809                 map[i] = cpu_to_be32(card->topology_map[start + i]);
 810
 811         fw_send_response(card, request, RCODE_COMPLETE);
 812 }
 813
 814 static struct fw_address_handler topology_map = {
 815         .length                 = 0x200,
 816         .address_callback       = handle_topology_map,
 817 };
 818
 819 static const struct fw_address_region registers_region =
 820         { .start = CSR_REGISTER_BASE,
 821           .end   = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
 822
 823 static void handle_registers(struct fw_card *card, struct fw_request *request,
 824                 int tcode, int destination, int source, int generation,
 825                 int speed, unsigned long long offset,
 826                 void *payload, size_t length, void *callback_data)
 827 {
 828         int reg = offset & ~CSR_REGISTER_BASE;
 829         unsigned long long bus_time;
 830         __be32 *data = payload;
 831         int rcode = RCODE_COMPLETE;
 832
 833         switch (reg) {
 834         case CSR_CYCLE_TIME:
 835         case CSR_BUS_TIME:
 836                 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
 837                         rcode = RCODE_TYPE_ERROR;
 838                         break;
 839                 }
 840
 841                 bus_time = card->driver->get_bus_time(card);
 842                 if (reg == CSR_CYCLE_TIME)
 843                         *data = cpu_to_be32(bus_time);
 844                 else
 845                         *data = cpu_to_be32(bus_time >> 25);
 846                 break;
 847
 848         case CSR_BROADCAST_CHANNEL:
 849                 if (tcode == TCODE_READ_QUADLET_REQUEST)
 850                         *data = cpu_to_be32(card->broadcast_channel);
 851                 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
 852                         card->broadcast_channel =
 853                             (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
 854                             BROADCAST_CHANNEL_INITIAL;
 855                 else
 856                         rcode = RCODE_TYPE_ERROR;
 857                 break;
 858
 859         case CSR_BUS_MANAGER_ID:
 860         case CSR_BANDWIDTH_AVAILABLE:
 861         case CSR_CHANNELS_AVAILABLE_HI:
 862         case CSR_CHANNELS_AVAILABLE_LO:
 863                 /*
 864                  * FIXME: these are handled by the OHCI hardware and
 865                  * the stack never sees these request. If we add
 866                  * support for a new type of controller that doesn't
 867                  * handle this in hardware we need to deal with these
 868                  * transactions.
 869                  */
 870                 BUG();
 871                 break;
 872
 873         case CSR_BUSY_TIMEOUT:
 874                 /* FIXME: Implement this. */
 875
 876         default:
 877                 rcode = RCODE_ADDRESS_ERROR;
 878                 break;
 879         }
 880
 881         fw_send_response(card, request, rcode);
 882 }
 883
 884 static struct fw_address_handler registers = {
 885         .length                 = 0x400,
 886         .address_callback       = handle_registers,
 887 };
 888
 889 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
 890 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
 891 MODULE_LICENSE("GPL");
 892
 893 static const u32 vendor_textual_descriptor[] = {
 894         /* textual descriptor leaf () */
 895         0x00060000,
 896         0x00000000,
 897         0x00000000,
 898         0x4c696e75,             /* L i n u */
 899         0x78204669,             /* x   F i */
 900         0x72657769,             /* r e w i */
 901         0x72650000,             /* r e     */
 902 };
 903
 904 static const u32 model_textual_descriptor[] = {
 905         /* model descriptor leaf () */
 906         0x00030000,
 907         0x00000000,
 908         0x00000000,
 909         0x4a756a75,             /* J u j u */
 910 };
 911
 912 static struct fw_descriptor vendor_id_descriptor = {
 913         .length = ARRAY_SIZE(vendor_textual_descriptor),
 914         .immediate = 0x03d00d1e,
 915         .key = 0x81000000,
 916         .data = vendor_textual_descriptor,
 917 };
 918
 919 static struct fw_descriptor model_id_descriptor = {
 920         .length = ARRAY_SIZE(model_textual_descriptor),
 921         .immediate = 0x17000001,
 922         .key = 0x81000000,
 923         .data = model_textual_descriptor,
 924 };
 925
 926 static int __init fw_core_init(void)
 927 {
 928         int ret;
 929
 930         ret = bus_register(&fw_bus_type);
 931         if (ret < 0)
 932                 return ret;
 933
 934         fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
 935         if (fw_cdev_major < 0) {
 936                 bus_unregister(&fw_bus_type);
 937                 return fw_cdev_major;
 938         }
 939
 940         fw_core_add_address_handler(&topology_map, &topology_map_region);
 941         fw_core_add_address_handler(&registers, &registers_region);
 942         fw_core_add_descriptor(&vendor_id_descriptor);
 943         fw_core_add_descriptor(&model_id_descriptor);
 944
 945         return 0;
 946 }
 947
 948 static void __exit fw_core_cleanup(void)
 949 {
 950         unregister_chrdev(fw_cdev_major, "firewire");
 951         bus_unregister(&fw_bus_type);
 952         idr_destroy(&fw_device_idr);
 953 }
 954
 955 module_init(fw_core_init);
 956 module_exit(fw_core_cleanup);