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