firewire: deadline for PHY config transmission
[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/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 PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
59 #define PHY_CONFIG_ROOT_ID(node_id)     ((((node_id) & 0x3f) << 24) | (1 << 23))
60 #define PHY_IDENTIFIER(id)              ((id) << 30)
61
62 static int
63 close_transaction(struct fw_transaction *transaction,
64                   struct fw_card *card, int rcode,
65                   u32 *payload, size_t length)
66 {
67         struct fw_transaction *t;
68         unsigned long flags;
69
70         spin_lock_irqsave(&card->lock, flags);
71         list_for_each_entry(t, &card->transaction_list, link) {
72                 if (t == transaction) {
73                         list_del(&t->link);
74                         card->tlabel_mask &= ~(1 << t->tlabel);
75                         break;
76                 }
77         }
78         spin_unlock_irqrestore(&card->lock, flags);
79
80         if (&t->link != &card->transaction_list) {
81                 t->callback(card, rcode, payload, length, t->callback_data);
82                 return 0;
83         }
84
85         return -ENOENT;
86 }
87
88 /*
89  * Only valid for transactions that are potentially pending (ie have
90  * been sent).
91  */
92 int
93 fw_cancel_transaction(struct fw_card *card,
94                       struct fw_transaction *transaction)
95 {
96         /*
97          * Cancel the packet transmission if it's still queued.  That
98          * will call the packet transmission callback which cancels
99          * the transaction.
100          */
101
102         if (card->driver->cancel_packet(card, &transaction->packet) == 0)
103                 return 0;
104
105         /*
106          * If the request packet has already been sent, we need to see
107          * if the transaction is still pending and remove it in that case.
108          */
109
110         return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
111 }
112 EXPORT_SYMBOL(fw_cancel_transaction);
113
114 static void
115 transmit_complete_callback(struct fw_packet *packet,
116                            struct fw_card *card, int status)
117 {
118         struct fw_transaction *t =
119             container_of(packet, struct fw_transaction, packet);
120
121         switch (status) {
122         case ACK_COMPLETE:
123                 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
124                 break;
125         case ACK_PENDING:
126                 t->timestamp = packet->timestamp;
127                 break;
128         case ACK_BUSY_X:
129         case ACK_BUSY_A:
130         case ACK_BUSY_B:
131                 close_transaction(t, card, RCODE_BUSY, NULL, 0);
132                 break;
133         case ACK_DATA_ERROR:
134                 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
135                 break;
136         case ACK_TYPE_ERROR:
137                 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
138                 break;
139         default:
140                 /*
141                  * In this case the ack is really a juju specific
142                  * rcode, so just forward that to the callback.
143                  */
144                 close_transaction(t, card, status, NULL, 0);
145                 break;
146         }
147 }
148
149 static void
150 fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
151                 int node_id, int source_id, int generation, int speed,
152                 unsigned long long offset, void *payload, size_t length)
153 {
154         int ext_tcode;
155
156         if (tcode > 0x10) {
157                 ext_tcode = tcode & ~0x10;
158                 tcode = TCODE_LOCK_REQUEST;
159         } else
160                 ext_tcode = 0;
161
162         packet->header[0] =
163                 HEADER_RETRY(RETRY_X) |
164                 HEADER_TLABEL(tlabel) |
165                 HEADER_TCODE(tcode) |
166                 HEADER_DESTINATION(node_id);
167         packet->header[1] =
168                 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
169         packet->header[2] =
170                 offset;
171
172         switch (tcode) {
173         case TCODE_WRITE_QUADLET_REQUEST:
174                 packet->header[3] = *(u32 *)payload;
175                 packet->header_length = 16;
176                 packet->payload_length = 0;
177                 break;
178
179         case TCODE_LOCK_REQUEST:
180         case TCODE_WRITE_BLOCK_REQUEST:
181                 packet->header[3] =
182                         HEADER_DATA_LENGTH(length) |
183                         HEADER_EXTENDED_TCODE(ext_tcode);
184                 packet->header_length = 16;
185                 packet->payload = payload;
186                 packet->payload_length = length;
187                 break;
188
189         case TCODE_READ_QUADLET_REQUEST:
190                 packet->header_length = 12;
191                 packet->payload_length = 0;
192                 break;
193
194         case TCODE_READ_BLOCK_REQUEST:
195                 packet->header[3] =
196                         HEADER_DATA_LENGTH(length) |
197                         HEADER_EXTENDED_TCODE(ext_tcode);
198                 packet->header_length = 16;
199                 packet->payload_length = 0;
200                 break;
201         }
202
203         packet->speed = speed;
204         packet->generation = generation;
205         packet->ack = 0;
206 }
207
208 /**
209  * This function provides low-level access to the IEEE1394 transaction
210  * logic.  Most C programs would use either fw_read(), fw_write() or
211  * fw_lock() instead - those function are convenience wrappers for
212  * this function.  The fw_send_request() function is primarily
213  * provided as a flexible, one-stop entry point for languages bindings
214  * and protocol bindings.
215  *
216  * FIXME: Document this function further, in particular the possible
217  * values for rcode in the callback.  In short, we map ACK_COMPLETE to
218  * RCODE_COMPLETE, internal errors set errno and set rcode to
219  * RCODE_SEND_ERROR (which is out of range for standard ieee1394
220  * rcodes).  All other rcodes are forwarded unchanged.  For all
221  * errors, payload is NULL, length is 0.
222  *
223  * Can not expect the callback to be called before the function
224  * returns, though this does happen in some cases (ACK_COMPLETE and
225  * errors).
226  *
227  * The payload is only used for write requests and must not be freed
228  * until the callback has been called.
229  *
230  * @param card the card from which to send the request
231  * @param tcode the tcode for this transaction.  Do not use
232  *   TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
233  *   etc. to specify tcode and ext_tcode.
234  * @param node_id the destination node ID (bus ID and PHY ID concatenated)
235  * @param generation the generation for which node_id is valid
236  * @param speed the speed to use for sending the request
237  * @param offset the 48 bit offset on the destination node
238  * @param payload the data payload for the request subaction
239  * @param length the length in bytes of the data to read
240  * @param callback function to be called when the transaction is completed
241  * @param callback_data pointer to arbitrary data, which will be
242  *   passed to the callback
243  */
244 void
245 fw_send_request(struct fw_card *card, struct fw_transaction *t,
246                 int tcode, int node_id, int generation, int speed,
247                 unsigned long long offset,
248                 void *payload, size_t length,
249                 fw_transaction_callback_t callback, void *callback_data)
250 {
251         unsigned long flags;
252         int tlabel, source;
253
254         /*
255          * Bump the flush timer up 100ms first of all so we
256          * don't race with a flush timer callback.
257          */
258
259         mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
260
261         /*
262          * Allocate tlabel from the bitmap and put the transaction on
263          * the list while holding the card spinlock.
264          */
265
266         spin_lock_irqsave(&card->lock, flags);
267
268         source = card->node_id;
269         tlabel = card->current_tlabel;
270         if (card->tlabel_mask & (1 << tlabel)) {
271                 spin_unlock_irqrestore(&card->lock, flags);
272                 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
273                 return;
274         }
275
276         card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
277         card->tlabel_mask |= (1 << tlabel);
278
279         list_add_tail(&t->link, &card->transaction_list);
280
281         spin_unlock_irqrestore(&card->lock, flags);
282
283         /* Initialize rest of transaction, fill out packet and send it. */
284         t->node_id = node_id;
285         t->tlabel = tlabel;
286         t->callback = callback;
287         t->callback_data = callback_data;
288
289         fw_fill_request(&t->packet, tcode, t->tlabel,
290                         node_id, source, generation,
291                         speed, offset, payload, length);
292         t->packet.callback = transmit_complete_callback;
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         /*
628          * Broadcast packets are reported as ACK_COMPLETE, so this
629          * check is sufficient to ensure we don't send response to
630          * broadcast packets or posted writes.
631          */
632         if (request->ack != ACK_PENDING) {
633                 kfree(request);
634                 return;
635         }
636
637         if (rcode == RCODE_COMPLETE)
638                 fw_fill_response(&request->response, request->request_header,
639                                  rcode, request->data, request->length);
640         else
641                 fw_fill_response(&request->response, request->request_header,
642                                  rcode, NULL, 0);
643
644         card->driver->send_response(card, &request->response);
645 }
646 EXPORT_SYMBOL(fw_send_response);
647
648 void
649 fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
650 {
651         struct fw_address_handler *handler;
652         struct fw_request *request;
653         unsigned long long offset;
654         unsigned long flags;
655         int tcode, destination, source;
656
657         if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
658                 return;
659
660         request = allocate_request(p);
661         if (request == NULL) {
662                 /* FIXME: send statically allocated busy packet. */
663                 return;
664         }
665
666         offset      =
667                 ((unsigned long long)
668                  HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
669         tcode       = HEADER_GET_TCODE(p->header[0]);
670         destination = HEADER_GET_DESTINATION(p->header[0]);
671         source      = HEADER_GET_SOURCE(p->header[1]);
672
673         spin_lock_irqsave(&address_handler_lock, flags);
674         handler = lookup_enclosing_address_handler(&address_handler_list,
675                                                    offset, request->length);
676         spin_unlock_irqrestore(&address_handler_lock, flags);
677
678         /*
679          * FIXME: lookup the fw_node corresponding to the sender of
680          * this request and pass that to the address handler instead
681          * of the node ID.  We may also want to move the address
682          * allocations to fw_node so we only do this callback if the
683          * upper layers registered it for this node.
684          */
685
686         if (handler == NULL)
687                 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
688         else
689                 handler->address_callback(card, request,
690                                           tcode, destination, source,
691                                           p->generation, p->speed, offset,
692                                           request->data, request->length,
693                                           handler->callback_data);
694 }
695 EXPORT_SYMBOL(fw_core_handle_request);
696
697 void
698 fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
699 {
700         struct fw_transaction *t;
701         unsigned long flags;
702         u32 *data;
703         size_t data_length;
704         int tcode, tlabel, destination, source, rcode;
705
706         tcode       = HEADER_GET_TCODE(p->header[0]);
707         tlabel      = HEADER_GET_TLABEL(p->header[0]);
708         destination = HEADER_GET_DESTINATION(p->header[0]);
709         source      = HEADER_GET_SOURCE(p->header[1]);
710         rcode       = HEADER_GET_RCODE(p->header[1]);
711
712         spin_lock_irqsave(&card->lock, flags);
713         list_for_each_entry(t, &card->transaction_list, link) {
714                 if (t->node_id == source && t->tlabel == tlabel) {
715                         list_del(&t->link);
716                         card->tlabel_mask &= ~(1 << t->tlabel);
717                         break;
718                 }
719         }
720         spin_unlock_irqrestore(&card->lock, flags);
721
722         if (&t->link == &card->transaction_list) {
723                 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
724                           source, tlabel);
725                 return;
726         }
727
728         /*
729          * FIXME: sanity check packet, is length correct, does tcodes
730          * and addresses match.
731          */
732
733         switch (tcode) {
734         case TCODE_READ_QUADLET_RESPONSE:
735                 data = (u32 *) &p->header[3];
736                 data_length = 4;
737                 break;
738
739         case TCODE_WRITE_RESPONSE:
740                 data = NULL;
741                 data_length = 0;
742                 break;
743
744         case TCODE_READ_BLOCK_RESPONSE:
745         case TCODE_LOCK_RESPONSE:
746                 data = p->payload;
747                 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
748                 break;
749
750         default:
751                 /* Should never happen, this is just to shut up gcc. */
752                 data = NULL;
753                 data_length = 0;
754                 break;
755         }
756
757         /*
758          * The response handler may be executed while the request handler
759          * is still pending.  Cancel the request handler.
760          */
761         card->driver->cancel_packet(card, &t->packet);
762
763         t->callback(card, rcode, data, data_length, t->callback_data);
764 }
765 EXPORT_SYMBOL(fw_core_handle_response);
766
767 static const struct fw_address_region topology_map_region =
768         { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
769           .end   = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
770
771 static void
772 handle_topology_map(struct fw_card *card, struct fw_request *request,
773                     int tcode, int destination, int source,
774                     int generation, int speed,
775                     unsigned long long offset,
776                     void *payload, size_t length, void *callback_data)
777 {
778         int i, start, end;
779         __be32 *map;
780
781         if (!TCODE_IS_READ_REQUEST(tcode)) {
782                 fw_send_response(card, request, RCODE_TYPE_ERROR);
783                 return;
784         }
785
786         if ((offset & 3) > 0 || (length & 3) > 0) {
787                 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
788                 return;
789         }
790
791         start = (offset - topology_map_region.start) / 4;
792         end = start + length / 4;
793         map = payload;
794
795         for (i = 0; i < length / 4; i++)
796                 map[i] = cpu_to_be32(card->topology_map[start + i]);
797
798         fw_send_response(card, request, RCODE_COMPLETE);
799 }
800
801 static struct fw_address_handler topology_map = {
802         .length                 = 0x200,
803         .address_callback       = handle_topology_map,
804 };
805
806 static const struct fw_address_region registers_region =
807         { .start = CSR_REGISTER_BASE,
808           .end   = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
809
810 static void
811 handle_registers(struct fw_card *card, struct fw_request *request,
812                  int tcode, int destination, int source,
813                  int generation, int speed,
814                  unsigned long long offset,
815                  void *payload, size_t length, void *callback_data)
816 {
817         int reg = offset & ~CSR_REGISTER_BASE;
818         unsigned long long bus_time;
819         __be32 *data = payload;
820
821         switch (reg) {
822         case CSR_CYCLE_TIME:
823         case CSR_BUS_TIME:
824                 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
825                         fw_send_response(card, request, RCODE_TYPE_ERROR);
826                         break;
827                 }
828
829                 bus_time = card->driver->get_bus_time(card);
830                 if (reg == CSR_CYCLE_TIME)
831                         *data = cpu_to_be32(bus_time);
832                 else
833                         *data = cpu_to_be32(bus_time >> 25);
834                 fw_send_response(card, request, RCODE_COMPLETE);
835                 break;
836
837         case CSR_BUS_MANAGER_ID:
838         case CSR_BANDWIDTH_AVAILABLE:
839         case CSR_CHANNELS_AVAILABLE_HI:
840         case CSR_CHANNELS_AVAILABLE_LO:
841                 /*
842                  * FIXME: these are handled by the OHCI hardware and
843                  * the stack never sees these request. If we add
844                  * support for a new type of controller that doesn't
845                  * handle this in hardware we need to deal with these
846                  * transactions.
847                  */
848                 BUG();
849                 break;
850
851         case CSR_BUSY_TIMEOUT:
852                 /* FIXME: Implement this. */
853         default:
854                 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
855                 break;
856         }
857 }
858
859 static struct fw_address_handler registers = {
860         .length                 = 0x400,
861         .address_callback       = handle_registers,
862 };
863
864 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
865 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
866 MODULE_LICENSE("GPL");
867
868 static const u32 vendor_textual_descriptor[] = {
869         /* textual descriptor leaf () */
870         0x00060000,
871         0x00000000,
872         0x00000000,
873         0x4c696e75,             /* L i n u */
874         0x78204669,             /* x   F i */
875         0x72657769,             /* r e w i */
876         0x72650000,             /* r e     */
877 };
878
879 static const u32 model_textual_descriptor[] = {
880         /* model descriptor leaf () */
881         0x00030000,
882         0x00000000,
883         0x00000000,
884         0x4a756a75,             /* J u j u */
885 };
886
887 static struct fw_descriptor vendor_id_descriptor = {
888         .length = ARRAY_SIZE(vendor_textual_descriptor),
889         .immediate = 0x03d00d1e,
890         .key = 0x81000000,
891         .data = vendor_textual_descriptor,
892 };
893
894 static struct fw_descriptor model_id_descriptor = {
895         .length = ARRAY_SIZE(model_textual_descriptor),
896         .immediate = 0x17000001,
897         .key = 0x81000000,
898         .data = model_textual_descriptor,
899 };
900
901 static int __init fw_core_init(void)
902 {
903         int retval;
904
905         retval = bus_register(&fw_bus_type);
906         if (retval < 0)
907                 return retval;
908
909         fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
910         if (fw_cdev_major < 0) {
911                 bus_unregister(&fw_bus_type);
912                 return fw_cdev_major;
913         }
914
915         retval = fw_core_add_address_handler(&topology_map,
916                                              &topology_map_region);
917         BUG_ON(retval < 0);
918
919         retval = fw_core_add_address_handler(&registers,
920                                              &registers_region);
921         BUG_ON(retval < 0);
922
923         /* Add the vendor textual descriptor. */
924         retval = fw_core_add_descriptor(&vendor_id_descriptor);
925         BUG_ON(retval < 0);
926         retval = fw_core_add_descriptor(&model_id_descriptor);
927         BUG_ON(retval < 0);
928
929         return 0;
930 }
931
932 static void __exit fw_core_cleanup(void)
933 {
934         unregister_chrdev(fw_cdev_major, "firewire");
935         bus_unregister(&fw_bus_type);
936 }
937
938 module_init(fw_core_init);
939 module_exit(fw_core_cleanup);