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