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