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