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