drivers/firewire/fw-transaction.c

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