proc: simplify locking in remove_proc_entry()
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / firewire / fw-transaction.c
blobccf0e4cf108f4b65298f1cde98041cc08027d7e2
1 /*
2 * Core IEEE1394 transaction logic
4 * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
21 #include <linux/completion.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/interrupt.h>
26 #include <linux/pci.h>
27 #include <linux/delay.h>
28 #include <linux/poll.h>
29 #include <linux/list.h>
30 #include <linux/kthread.h>
31 #include <asm/uaccess.h>
33 #include "fw-transaction.h"
34 #include "fw-topology.h"
35 #include "fw-device.h"
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)
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)
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)
61 static int
62 close_transaction(struct fw_transaction *transaction,
63 struct fw_card *card, int rcode,
64 u32 *payload, size_t length)
66 struct fw_transaction *t;
67 unsigned long flags;
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;
77 spin_unlock_irqrestore(&card->lock, flags);
79 if (&t->link != &card->transaction_list) {
80 t->callback(card, rcode, payload, length, t->callback_data);
81 return 0;
84 return -ENOENT;
88 * Only valid for transactions that are potentially pending (ie have
89 * been sent).
91 int
92 fw_cancel_transaction(struct fw_card *card,
93 struct fw_transaction *transaction)
96 * Cancel the packet transmission if it's still queued. That
97 * will call the packet transmission callback which cancels
98 * the transaction.
101 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
102 return 0;
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.
109 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
111 EXPORT_SYMBOL(fw_cancel_transaction);
113 static void
114 transmit_complete_callback(struct fw_packet *packet,
115 struct fw_card *card, int status)
117 struct fw_transaction *t =
118 container_of(packet, struct fw_transaction, packet);
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:
140 * In this case the ack is really a juju specific
141 * rcode, so just forward that to the callback.
143 close_transaction(t, card, status, NULL, 0);
144 break;
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)
153 int ext_tcode;
155 if (tcode > 0x10) {
156 ext_tcode = tcode & ~0x10;
157 tcode = TCODE_LOCK_REQUEST;
158 } else
159 ext_tcode = 0;
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;
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;
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;
188 case TCODE_READ_QUADLET_REQUEST:
189 packet->header_length = 12;
190 packet->payload_length = 0;
191 break;
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;
202 packet->speed = speed;
203 packet->generation = generation;
204 packet->ack = 0;
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.
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.
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).
226 * The payload is only used for write requests and must not be freed
227 * until the callback has been called.
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, instead 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
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)
250 unsigned long flags;
251 int tlabel, source;
254 * Bump the flush timer up 100ms first of all so we
255 * don't race with a flush timer callback.
258 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
261 * Allocate tlabel from the bitmap and put the transaction on
262 * the list while holding the card spinlock.
265 spin_lock_irqsave(&card->lock, flags);
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;
275 card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
276 card->tlabel_mask |= (1 << tlabel);
278 list_add_tail(&t->link, &card->transaction_list);
280 spin_unlock_irqrestore(&card->lock, flags);
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;
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;
293 card->driver->send_request(card, &t->packet);
295 EXPORT_SYMBOL(fw_send_request);
297 struct fw_phy_packet {
298 struct fw_packet packet;
299 struct completion done;
302 static void
303 transmit_phy_packet_callback(struct fw_packet *packet,
304 struct fw_card *card, int status)
306 struct fw_phy_packet *p =
307 container_of(packet, struct fw_phy_packet, packet);
309 complete(&p->done);
312 void fw_send_phy_config(struct fw_card *card,
313 int node_id, int generation, int gap_count)
315 struct fw_phy_packet p;
316 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
317 PHY_CONFIG_ROOT_ID(node_id) |
318 PHY_CONFIG_GAP_COUNT(gap_count);
320 p.packet.header[0] = data;
321 p.packet.header[1] = ~data;
322 p.packet.header_length = 8;
323 p.packet.payload_length = 0;
324 p.packet.speed = SCODE_100;
325 p.packet.generation = generation;
326 p.packet.callback = transmit_phy_packet_callback;
327 init_completion(&p.done);
329 card->driver->send_request(card, &p.packet);
330 wait_for_completion(&p.done);
333 void fw_flush_transactions(struct fw_card *card)
335 struct fw_transaction *t, *next;
336 struct list_head list;
337 unsigned long flags;
339 INIT_LIST_HEAD(&list);
340 spin_lock_irqsave(&card->lock, flags);
341 list_splice_init(&card->transaction_list, &list);
342 card->tlabel_mask = 0;
343 spin_unlock_irqrestore(&card->lock, flags);
345 list_for_each_entry_safe(t, next, &list, link) {
346 card->driver->cancel_packet(card, &t->packet);
349 * At this point cancel_packet will never call the
350 * transaction callback, since we just took all the
351 * transactions out of the list. So do it here.
353 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
357 static struct fw_address_handler *
358 lookup_overlapping_address_handler(struct list_head *list,
359 unsigned long long offset, size_t length)
361 struct fw_address_handler *handler;
363 list_for_each_entry(handler, list, link) {
364 if (handler->offset < offset + length &&
365 offset < handler->offset + handler->length)
366 return handler;
369 return NULL;
372 static struct fw_address_handler *
373 lookup_enclosing_address_handler(struct list_head *list,
374 unsigned long long offset, size_t length)
376 struct fw_address_handler *handler;
378 list_for_each_entry(handler, list, link) {
379 if (handler->offset <= offset &&
380 offset + length <= handler->offset + handler->length)
381 return handler;
384 return NULL;
387 static DEFINE_SPINLOCK(address_handler_lock);
388 static LIST_HEAD(address_handler_list);
390 const struct fw_address_region fw_high_memory_region =
391 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
392 EXPORT_SYMBOL(fw_high_memory_region);
394 #if 0
395 const struct fw_address_region fw_low_memory_region =
396 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
397 const struct fw_address_region fw_private_region =
398 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
399 const struct fw_address_region fw_csr_region =
400 { .start = CSR_REGISTER_BASE,
401 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
402 const struct fw_address_region fw_unit_space_region =
403 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
404 #endif /* 0 */
407 * Allocate a range of addresses in the node space of the OHCI
408 * controller. When a request is received that falls within the
409 * specified address range, the specified callback is invoked. The
410 * parameters passed to the callback give the details of the
411 * particular request.
413 * Return value: 0 on success, non-zero otherwise.
414 * The start offset of the handler's address region is determined by
415 * fw_core_add_address_handler() and is returned in handler->offset.
416 * The offset is quadlet-aligned.
419 fw_core_add_address_handler(struct fw_address_handler *handler,
420 const struct fw_address_region *region)
422 struct fw_address_handler *other;
423 unsigned long flags;
424 int ret = -EBUSY;
426 spin_lock_irqsave(&address_handler_lock, flags);
428 handler->offset = roundup(region->start, 4);
429 while (handler->offset + handler->length <= region->end) {
430 other =
431 lookup_overlapping_address_handler(&address_handler_list,
432 handler->offset,
433 handler->length);
434 if (other != NULL) {
435 handler->offset =
436 roundup(other->offset + other->length, 4);
437 } else {
438 list_add_tail(&handler->link, &address_handler_list);
439 ret = 0;
440 break;
444 spin_unlock_irqrestore(&address_handler_lock, flags);
446 return ret;
448 EXPORT_SYMBOL(fw_core_add_address_handler);
451 * Deallocate a range of addresses allocated with fw_allocate. This
452 * will call the associated callback one last time with a the special
453 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
454 * callback data. For convenience, the callback parameters offset and
455 * length are set to the start and the length respectively for the
456 * deallocated region, payload is set to NULL.
458 void fw_core_remove_address_handler(struct fw_address_handler *handler)
460 unsigned long flags;
462 spin_lock_irqsave(&address_handler_lock, flags);
463 list_del(&handler->link);
464 spin_unlock_irqrestore(&address_handler_lock, flags);
466 EXPORT_SYMBOL(fw_core_remove_address_handler);
468 struct fw_request {
469 struct fw_packet response;
470 u32 request_header[4];
471 int ack;
472 u32 length;
473 u32 data[0];
476 static void
477 free_response_callback(struct fw_packet *packet,
478 struct fw_card *card, int status)
480 struct fw_request *request;
482 request = container_of(packet, struct fw_request, response);
483 kfree(request);
486 void
487 fw_fill_response(struct fw_packet *response, u32 *request_header,
488 int rcode, void *payload, size_t length)
490 int tcode, tlabel, extended_tcode, source, destination;
492 tcode = HEADER_GET_TCODE(request_header[0]);
493 tlabel = HEADER_GET_TLABEL(request_header[0]);
494 source = HEADER_GET_DESTINATION(request_header[0]);
495 destination = HEADER_GET_SOURCE(request_header[1]);
496 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
498 response->header[0] =
499 HEADER_RETRY(RETRY_1) |
500 HEADER_TLABEL(tlabel) |
501 HEADER_DESTINATION(destination);
502 response->header[1] =
503 HEADER_SOURCE(source) |
504 HEADER_RCODE(rcode);
505 response->header[2] = 0;
507 switch (tcode) {
508 case TCODE_WRITE_QUADLET_REQUEST:
509 case TCODE_WRITE_BLOCK_REQUEST:
510 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
511 response->header_length = 12;
512 response->payload_length = 0;
513 break;
515 case TCODE_READ_QUADLET_REQUEST:
516 response->header[0] |=
517 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
518 if (payload != NULL)
519 response->header[3] = *(u32 *)payload;
520 else
521 response->header[3] = 0;
522 response->header_length = 16;
523 response->payload_length = 0;
524 break;
526 case TCODE_READ_BLOCK_REQUEST:
527 case TCODE_LOCK_REQUEST:
528 response->header[0] |= HEADER_TCODE(tcode + 2);
529 response->header[3] =
530 HEADER_DATA_LENGTH(length) |
531 HEADER_EXTENDED_TCODE(extended_tcode);
532 response->header_length = 16;
533 response->payload = payload;
534 response->payload_length = length;
535 break;
537 default:
538 BUG();
539 return;
542 EXPORT_SYMBOL(fw_fill_response);
544 static struct fw_request *
545 allocate_request(struct fw_packet *p)
547 struct fw_request *request;
548 u32 *data, length;
549 int request_tcode, t;
551 request_tcode = HEADER_GET_TCODE(p->header[0]);
552 switch (request_tcode) {
553 case TCODE_WRITE_QUADLET_REQUEST:
554 data = &p->header[3];
555 length = 4;
556 break;
558 case TCODE_WRITE_BLOCK_REQUEST:
559 case TCODE_LOCK_REQUEST:
560 data = p->payload;
561 length = HEADER_GET_DATA_LENGTH(p->header[3]);
562 break;
564 case TCODE_READ_QUADLET_REQUEST:
565 data = NULL;
566 length = 4;
567 break;
569 case TCODE_READ_BLOCK_REQUEST:
570 data = NULL;
571 length = HEADER_GET_DATA_LENGTH(p->header[3]);
572 break;
574 default:
575 BUG();
576 return NULL;
579 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
580 if (request == NULL)
581 return NULL;
583 t = (p->timestamp & 0x1fff) + 4000;
584 if (t >= 8000)
585 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
586 else
587 t = (p->timestamp & ~0x1fff) + t;
589 request->response.speed = p->speed;
590 request->response.timestamp = t;
591 request->response.generation = p->generation;
592 request->response.ack = 0;
593 request->response.callback = free_response_callback;
594 request->ack = p->ack;
595 request->length = length;
596 if (data)
597 memcpy(request->data, data, length);
599 memcpy(request->request_header, p->header, sizeof(p->header));
601 return request;
604 void
605 fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
608 * Broadcast packets are reported as ACK_COMPLETE, so this
609 * check is sufficient to ensure we don't send response to
610 * broadcast packets or posted writes.
612 if (request->ack != ACK_PENDING) {
613 kfree(request);
614 return;
617 if (rcode == RCODE_COMPLETE)
618 fw_fill_response(&request->response, request->request_header,
619 rcode, request->data, request->length);
620 else
621 fw_fill_response(&request->response, request->request_header,
622 rcode, NULL, 0);
624 card->driver->send_response(card, &request->response);
626 EXPORT_SYMBOL(fw_send_response);
628 void
629 fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
631 struct fw_address_handler *handler;
632 struct fw_request *request;
633 unsigned long long offset;
634 unsigned long flags;
635 int tcode, destination, source;
637 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
638 return;
640 request = allocate_request(p);
641 if (request == NULL) {
642 /* FIXME: send statically allocated busy packet. */
643 return;
646 offset =
647 ((unsigned long long)
648 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
649 tcode = HEADER_GET_TCODE(p->header[0]);
650 destination = HEADER_GET_DESTINATION(p->header[0]);
651 source = HEADER_GET_SOURCE(p->header[1]);
653 spin_lock_irqsave(&address_handler_lock, flags);
654 handler = lookup_enclosing_address_handler(&address_handler_list,
655 offset, request->length);
656 spin_unlock_irqrestore(&address_handler_lock, flags);
659 * FIXME: lookup the fw_node corresponding to the sender of
660 * this request and pass that to the address handler instead
661 * of the node ID. We may also want to move the address
662 * allocations to fw_node so we only do this callback if the
663 * upper layers registered it for this node.
666 if (handler == NULL)
667 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
668 else
669 handler->address_callback(card, request,
670 tcode, destination, source,
671 p->generation, p->speed, offset,
672 request->data, request->length,
673 handler->callback_data);
675 EXPORT_SYMBOL(fw_core_handle_request);
677 void
678 fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
680 struct fw_transaction *t;
681 unsigned long flags;
682 u32 *data;
683 size_t data_length;
684 int tcode, tlabel, destination, source, rcode;
686 tcode = HEADER_GET_TCODE(p->header[0]);
687 tlabel = HEADER_GET_TLABEL(p->header[0]);
688 destination = HEADER_GET_DESTINATION(p->header[0]);
689 source = HEADER_GET_SOURCE(p->header[1]);
690 rcode = HEADER_GET_RCODE(p->header[1]);
692 spin_lock_irqsave(&card->lock, flags);
693 list_for_each_entry(t, &card->transaction_list, link) {
694 if (t->node_id == source && t->tlabel == tlabel) {
695 list_del(&t->link);
696 card->tlabel_mask &= ~(1 << t->tlabel);
697 break;
700 spin_unlock_irqrestore(&card->lock, flags);
702 if (&t->link == &card->transaction_list) {
703 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
704 source, tlabel);
705 return;
709 * FIXME: sanity check packet, is length correct, does tcodes
710 * and addresses match.
713 switch (tcode) {
714 case TCODE_READ_QUADLET_RESPONSE:
715 data = (u32 *) &p->header[3];
716 data_length = 4;
717 break;
719 case TCODE_WRITE_RESPONSE:
720 data = NULL;
721 data_length = 0;
722 break;
724 case TCODE_READ_BLOCK_RESPONSE:
725 case TCODE_LOCK_RESPONSE:
726 data = p->payload;
727 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
728 break;
730 default:
731 /* Should never happen, this is just to shut up gcc. */
732 data = NULL;
733 data_length = 0;
734 break;
738 * The response handler may be executed while the request handler
739 * is still pending. Cancel the request handler.
741 card->driver->cancel_packet(card, &t->packet);
743 t->callback(card, rcode, data, data_length, t->callback_data);
745 EXPORT_SYMBOL(fw_core_handle_response);
747 static const struct fw_address_region topology_map_region =
748 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
749 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
751 static void
752 handle_topology_map(struct fw_card *card, struct fw_request *request,
753 int tcode, int destination, int source,
754 int generation, int speed,
755 unsigned long long offset,
756 void *payload, size_t length, void *callback_data)
758 int i, start, end;
759 __be32 *map;
761 if (!TCODE_IS_READ_REQUEST(tcode)) {
762 fw_send_response(card, request, RCODE_TYPE_ERROR);
763 return;
766 if ((offset & 3) > 0 || (length & 3) > 0) {
767 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
768 return;
771 start = (offset - topology_map_region.start) / 4;
772 end = start + length / 4;
773 map = payload;
775 for (i = 0; i < length / 4; i++)
776 map[i] = cpu_to_be32(card->topology_map[start + i]);
778 fw_send_response(card, request, RCODE_COMPLETE);
781 static struct fw_address_handler topology_map = {
782 .length = 0x200,
783 .address_callback = handle_topology_map,
786 static const struct fw_address_region registers_region =
787 { .start = CSR_REGISTER_BASE,
788 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
790 static void
791 handle_registers(struct fw_card *card, struct fw_request *request,
792 int tcode, int destination, int source,
793 int generation, int speed,
794 unsigned long long offset,
795 void *payload, size_t length, void *callback_data)
797 int reg = offset & ~CSR_REGISTER_BASE;
798 unsigned long long bus_time;
799 __be32 *data = payload;
801 switch (reg) {
802 case CSR_CYCLE_TIME:
803 case CSR_BUS_TIME:
804 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
805 fw_send_response(card, request, RCODE_TYPE_ERROR);
806 break;
809 bus_time = card->driver->get_bus_time(card);
810 if (reg == CSR_CYCLE_TIME)
811 *data = cpu_to_be32(bus_time);
812 else
813 *data = cpu_to_be32(bus_time >> 25);
814 fw_send_response(card, request, RCODE_COMPLETE);
815 break;
817 case CSR_BUS_MANAGER_ID:
818 case CSR_BANDWIDTH_AVAILABLE:
819 case CSR_CHANNELS_AVAILABLE_HI:
820 case CSR_CHANNELS_AVAILABLE_LO:
822 * FIXME: these are handled by the OHCI hardware and
823 * the stack never sees these request. If we add
824 * support for a new type of controller that doesn't
825 * handle this in hardware we need to deal with these
826 * transactions.
828 BUG();
829 break;
831 case CSR_BUSY_TIMEOUT:
832 /* FIXME: Implement this. */
833 default:
834 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
835 break;
839 static struct fw_address_handler registers = {
840 .length = 0x400,
841 .address_callback = handle_registers,
844 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
845 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
846 MODULE_LICENSE("GPL");
848 static const u32 vendor_textual_descriptor[] = {
849 /* textual descriptor leaf () */
850 0x00060000,
851 0x00000000,
852 0x00000000,
853 0x4c696e75, /* L i n u */
854 0x78204669, /* x F i */
855 0x72657769, /* r e w i */
856 0x72650000, /* r e */
859 static const u32 model_textual_descriptor[] = {
860 /* model descriptor leaf () */
861 0x00030000,
862 0x00000000,
863 0x00000000,
864 0x4a756a75, /* J u j u */
867 static struct fw_descriptor vendor_id_descriptor = {
868 .length = ARRAY_SIZE(vendor_textual_descriptor),
869 .immediate = 0x03d00d1e,
870 .key = 0x81000000,
871 .data = vendor_textual_descriptor,
874 static struct fw_descriptor model_id_descriptor = {
875 .length = ARRAY_SIZE(model_textual_descriptor),
876 .immediate = 0x17000001,
877 .key = 0x81000000,
878 .data = model_textual_descriptor,
881 static int __init fw_core_init(void)
883 int retval;
885 retval = bus_register(&fw_bus_type);
886 if (retval < 0)
887 return retval;
889 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
890 if (fw_cdev_major < 0) {
891 bus_unregister(&fw_bus_type);
892 return fw_cdev_major;
895 retval = fw_core_add_address_handler(&topology_map,
896 &topology_map_region);
897 BUG_ON(retval < 0);
899 retval = fw_core_add_address_handler(&registers,
900 &registers_region);
901 BUG_ON(retval < 0);
903 /* Add the vendor textual descriptor. */
904 retval = fw_core_add_descriptor(&vendor_id_descriptor);
905 BUG_ON(retval < 0);
906 retval = fw_core_add_descriptor(&model_id_descriptor);
907 BUG_ON(retval < 0);
909 return 0;
912 static void __exit fw_core_cleanup(void)
914 unregister_chrdev(fw_cdev_major, "firewire");
915 bus_unregister(&fw_bus_type);
918 module_init(fw_core_init);
919 module_exit(fw_core_cleanup);