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