1 /* -*- c-basic-offset: 8 -*-
3 * fw-transaction.c - core IEEE1394 transaction logic
5 * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
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>
32 #include <asm/semaphore.h>
34 #include "fw-transaction.h"
35 #include "fw-topology.h"
36 #include "fw-device.h"
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)
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)
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)
63 close_transaction(struct fw_transaction *transaction,
64 struct fw_card *card, int rcode,
65 u32 *payload, size_t length)
67 struct fw_transaction *t;
70 spin_lock_irqsave(&card->lock, flags);
71 list_for_each_entry(t, &card->transaction_list, link) {
72 if (t == transaction) {
74 card->tlabel_mask &= ~(1 << t->tlabel);
78 spin_unlock_irqrestore(&card->lock, flags);
80 if (&t->link != &card->transaction_list) {
81 t->callback(card, rcode, payload, length, t->callback_data);
88 /* Only valid for transactions that are potentially pending (ie have
91 fw_cancel_transaction(struct fw_card *card,
92 struct fw_transaction *transaction)
94 /* Cancel the packet transmission if it's still queued. That
95 * will call the packet transmission callback which cancels
98 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
101 /* If the request packet has already been sent, we need to see
102 * if the transaction is still pending and remove it in that case. */
104 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
106 EXPORT_SYMBOL(fw_cancel_transaction);
109 transmit_complete_callback(struct fw_packet *packet,
110 struct fw_card *card, int status)
112 struct fw_transaction *t =
113 container_of(packet, struct fw_transaction, packet);
117 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
120 t->timestamp = packet->timestamp;
125 close_transaction(t, card, RCODE_BUSY, NULL, 0);
128 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
131 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
134 /* In this case the ack is really a juju specific
135 * rcode, so just forward that to the callback. */
136 close_transaction(t, card, status, NULL, 0);
142 fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
143 int node_id, int source_id, int generation, int speed,
144 unsigned long long offset, void *payload, size_t length)
149 ext_tcode = tcode - 0x10;
150 tcode = TCODE_LOCK_REQUEST;
155 header_retry(RETRY_X) |
156 header_tlabel(tlabel) |
157 header_tcode(tcode) |
158 header_destination(node_id);
160 header_offset_high(offset >> 32) | header_source(source_id);
165 case TCODE_WRITE_QUADLET_REQUEST:
166 packet->header[3] = *(u32 *)payload;
167 packet->header_length = 16;
168 packet->payload_length = 0;
171 case TCODE_LOCK_REQUEST:
172 case TCODE_WRITE_BLOCK_REQUEST:
174 header_data_length(length) |
175 header_extended_tcode(ext_tcode);
176 packet->header_length = 16;
177 packet->payload = payload;
178 packet->payload_length = length;
181 case TCODE_READ_QUADLET_REQUEST:
182 packet->header_length = 12;
183 packet->payload_length = 0;
186 case TCODE_READ_BLOCK_REQUEST:
188 header_data_length(length) |
189 header_extended_tcode(ext_tcode);
190 packet->header_length = 16;
191 packet->payload_length = 0;
195 packet->speed = speed;
196 packet->generation = generation;
201 * This function provides low-level access to the IEEE1394 transaction
202 * logic. Most C programs would use either fw_read(), fw_write() or
203 * fw_lock() instead - those function are convenience wrappers for
204 * this function. The fw_send_request() function is primarily
205 * provided as a flexible, one-stop entry point for languages bindings
206 * and protocol bindings.
208 * FIXME: Document this function further, in particular the possible
209 * values for rcode in the callback. In short, we map ACK_COMPLETE to
210 * RCODE_COMPLETE, internal errors set errno and set rcode to
211 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
212 * rcodes). All other rcodes are forwarded unchanged. For all
213 * errors, payload is NULL, length is 0.
215 * Can not expect the callback to be called before the function
216 * returns, though this does happen in some cases (ACK_COMPLETE and
219 * The payload is only used for write requests and must not be freed
220 * until the callback has been called.
222 * @param card the card from which to send the request
223 * @param tcode the tcode for this transaction. Do not use
224 * TCODE_LOCK_REQUEST directly, insted use TCODE_LOCK_MASK_SWAP
225 * etc. to specify tcode and ext_tcode.
226 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
227 * @param generation the generation for which node_id is valid
228 * @param speed the speed to use for sending the request
229 * @param offset the 48 bit offset on the destination node
230 * @param payload the data payload for the request subaction
231 * @param length the length in bytes of the data to read
232 * @param callback function to be called when the transaction is completed
233 * @param callback_data pointer to arbitrary data, which will be
234 * passed to the callback
237 fw_send_request(struct fw_card *card, struct fw_transaction *t,
238 int tcode, int node_id, int generation, int speed,
239 unsigned long long offset,
240 void *payload, size_t length,
241 fw_transaction_callback_t callback, void *callback_data)
246 /* Bump the flush timer up 100ms first of all so we
247 * don't race with a flush timer callback. */
249 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
251 /* Allocate tlabel from the bitmap and put the transaction on
252 * the list while holding the card spinlock. */
254 spin_lock_irqsave(&card->lock, flags);
256 source = card->node_id;
257 tlabel = card->current_tlabel;
258 if (card->tlabel_mask & (1 << tlabel)) {
259 spin_unlock_irqrestore(&card->lock, flags);
260 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
264 card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
265 card->tlabel_mask |= (1 << tlabel);
267 list_add_tail(&t->link, &card->transaction_list);
269 spin_unlock_irqrestore(&card->lock, flags);
271 /* Initialize rest of transaction, fill out packet and send it. */
272 t->node_id = node_id;
274 t->callback = callback;
275 t->callback_data = callback_data;
277 fw_fill_request(&t->packet, tcode, t->tlabel,
278 node_id, source, generation,
279 speed, offset, payload, length);
280 t->packet.callback = transmit_complete_callback;
282 card->driver->send_request(card, &t->packet);
284 EXPORT_SYMBOL(fw_send_request);
287 transmit_phy_packet_callback(struct fw_packet *packet,
288 struct fw_card *card, int status)
293 static void send_phy_packet(struct fw_card *card, u32 data, int generation)
295 struct fw_packet *packet;
297 packet = kzalloc(sizeof *packet, GFP_ATOMIC);
301 packet->header[0] = data;
302 packet->header[1] = ~data;
303 packet->header_length = 8;
304 packet->payload_length = 0;
305 packet->speed = SCODE_100;
306 packet->generation = generation;
307 packet->callback = transmit_phy_packet_callback;
309 card->driver->send_request(card, packet);
312 void fw_send_phy_config(struct fw_card *card,
313 int node_id, int generation, int gap_count)
317 q = phy_identifier(PHY_PACKET_CONFIG) |
318 phy_config_root_id(node_id) |
319 phy_config_gap_count(gap_count);
321 send_phy_packet(card, q, generation);
324 void fw_flush_transactions(struct fw_card *card)
326 struct fw_transaction *t, *next;
327 struct list_head list;
330 INIT_LIST_HEAD(&list);
331 spin_lock_irqsave(&card->lock, flags);
332 list_splice_init(&card->transaction_list, &list);
333 card->tlabel_mask = 0;
334 spin_unlock_irqrestore(&card->lock, flags);
336 list_for_each_entry_safe(t, next, &list, link) {
337 card->driver->cancel_packet(card, &t->packet);
339 /* At this point cancel_packet will never call the
340 * transaction callback, since we just took all the
341 * transactions out of the list. So do it here.*/
342 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
346 static struct fw_address_handler *
347 lookup_overlapping_address_handler(struct list_head *list,
348 unsigned long long offset, size_t length)
350 struct fw_address_handler *handler;
352 list_for_each_entry(handler, list, link) {
353 if (handler->offset < offset + length &&
354 offset < handler->offset + handler->length)
361 static struct fw_address_handler *
362 lookup_enclosing_address_handler(struct list_head *list,
363 unsigned long long offset, size_t length)
365 struct fw_address_handler *handler;
367 list_for_each_entry(handler, list, link) {
368 if (handler->offset <= offset &&
369 offset + length <= handler->offset + handler->length)
376 static DEFINE_SPINLOCK(address_handler_lock);
377 static LIST_HEAD(address_handler_list);
379 const struct fw_address_region fw_low_memory_region =
380 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
381 const struct fw_address_region fw_high_memory_region =
382 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
383 const struct fw_address_region fw_private_region =
384 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
385 const struct fw_address_region fw_csr_region =
386 { .start = 0xfffff0000000ULL, .end = 0xfffff0000800ULL, };
387 const struct fw_address_region fw_unit_space_region =
388 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
389 EXPORT_SYMBOL(fw_low_memory_region);
390 EXPORT_SYMBOL(fw_high_memory_region);
391 EXPORT_SYMBOL(fw_private_region);
392 EXPORT_SYMBOL(fw_csr_region);
393 EXPORT_SYMBOL(fw_unit_space_region);
396 * Allocate a range of addresses in the node space of the OHCI
397 * controller. When a request is received that falls within the
398 * specified address range, the specified callback is invoked. The
399 * parameters passed to the callback give the details of the
403 fw_core_add_address_handler(struct fw_address_handler *handler,
404 const struct fw_address_region *region)
406 struct fw_address_handler *other;
410 spin_lock_irqsave(&address_handler_lock, flags);
412 handler->offset = region->start;
413 while (handler->offset + handler->length <= region->end) {
415 lookup_overlapping_address_handler(&address_handler_list,
419 handler->offset += other->length;
421 list_add_tail(&handler->link, &address_handler_list);
427 spin_unlock_irqrestore(&address_handler_lock, flags);
431 EXPORT_SYMBOL(fw_core_add_address_handler);
434 * Deallocate a range of addresses allocated with fw_allocate. This
435 * will call the associated callback one last time with a the special
436 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
437 * callback data. For convenience, the callback parameters offset and
438 * length are set to the start and the length respectively for the
439 * deallocated region, payload is set to NULL.
441 void fw_core_remove_address_handler(struct fw_address_handler *handler)
445 spin_lock_irqsave(&address_handler_lock, flags);
446 list_del(&handler->link);
447 spin_unlock_irqrestore(&address_handler_lock, flags);
449 EXPORT_SYMBOL(fw_core_remove_address_handler);
452 struct fw_packet response;
453 u32 request_header[4];
460 free_response_callback(struct fw_packet *packet,
461 struct fw_card *card, int status)
463 struct fw_request *request;
465 request = container_of(packet, struct fw_request, response);
470 fw_fill_response(struct fw_packet *response, u32 *request_header,
471 int rcode, void *payload, size_t length)
473 int tcode, tlabel, extended_tcode, source, destination;
475 tcode = header_get_tcode(request_header[0]);
476 tlabel = header_get_tlabel(request_header[0]);
477 source = header_get_destination(request_header[0]);
478 destination = header_get_source(request_header[1]);
479 extended_tcode = header_get_extended_tcode(request_header[3]);
481 response->header[0] =
482 header_retry(RETRY_1) |
483 header_tlabel(tlabel) |
484 header_destination(destination);
485 response->header[1] =
486 header_source(source) |
488 response->header[2] = 0;
491 case TCODE_WRITE_QUADLET_REQUEST:
492 case TCODE_WRITE_BLOCK_REQUEST:
493 response->header[0] |= header_tcode(TCODE_WRITE_RESPONSE);
494 response->header_length = 12;
495 response->payload_length = 0;
498 case TCODE_READ_QUADLET_REQUEST:
499 response->header[0] |=
500 header_tcode(TCODE_READ_QUADLET_RESPONSE);
502 response->header[3] = *(u32 *)payload;
504 response->header[3] = 0;
505 response->header_length = 16;
506 response->payload_length = 0;
509 case TCODE_READ_BLOCK_REQUEST:
510 case TCODE_LOCK_REQUEST:
511 response->header[0] |= header_tcode(tcode + 2);
512 response->header[3] =
513 header_data_length(length) |
514 header_extended_tcode(extended_tcode);
515 response->header_length = 16;
516 response->payload = payload;
517 response->payload_length = length;
525 EXPORT_SYMBOL(fw_fill_response);
527 static struct fw_request *
528 allocate_request(struct fw_packet *p)
530 struct fw_request *request;
532 int request_tcode, t;
534 request_tcode = header_get_tcode(p->header[0]);
535 switch (request_tcode) {
536 case TCODE_WRITE_QUADLET_REQUEST:
537 data = &p->header[3];
541 case TCODE_WRITE_BLOCK_REQUEST:
542 case TCODE_LOCK_REQUEST:
544 length = header_get_data_length(p->header[3]);
547 case TCODE_READ_QUADLET_REQUEST:
552 case TCODE_READ_BLOCK_REQUEST:
554 length = header_get_data_length(p->header[3]);
562 request = kmalloc(sizeof *request + length, GFP_ATOMIC);
566 t = (p->timestamp & 0x1fff) + 4000;
568 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
570 t = (p->timestamp & ~0x1fff) + t;
572 request->response.speed = p->speed;
573 request->response.timestamp = t;
574 request->response.generation = p->generation;
575 request->response.ack = 0;
576 request->response.callback = free_response_callback;
577 request->ack = p->ack;
578 request->length = length;
580 memcpy(request->data, data, length);
582 memcpy(request->request_header, p->header, sizeof p->header);
588 fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
590 /* Broadcast packets are reported as ACK_COMPLETE, so this
591 * check is sufficient to ensure we don't send response to
592 * broadcast packets or posted writes. */
593 if (request->ack != ACK_PENDING)
596 if (rcode == RCODE_COMPLETE)
597 fw_fill_response(&request->response, request->request_header,
598 rcode, request->data, request->length);
600 fw_fill_response(&request->response, request->request_header,
603 card->driver->send_response(card, &request->response);
605 EXPORT_SYMBOL(fw_send_response);
608 fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
610 struct fw_address_handler *handler;
611 struct fw_request *request;
612 unsigned long long offset;
614 int tcode, destination, source;
616 if (p->payload_length > 2048) {
617 /* FIXME: send error response. */
621 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
624 request = allocate_request(p);
625 if (request == NULL) {
626 /* FIXME: send statically allocated busy packet. */
631 ((unsigned long long)
632 header_get_offset_high(p->header[1]) << 32) | p->header[2];
633 tcode = header_get_tcode(p->header[0]);
634 destination = header_get_destination(p->header[0]);
635 source = header_get_source(p->header[0]);
637 spin_lock_irqsave(&address_handler_lock, flags);
638 handler = lookup_enclosing_address_handler(&address_handler_list,
639 offset, request->length);
640 spin_unlock_irqrestore(&address_handler_lock, flags);
642 /* FIXME: lookup the fw_node corresponding to the sender of
643 * this request and pass that to the address handler instead
644 * of the node ID. We may also want to move the address
645 * allocations to fw_node so we only do this callback if the
646 * upper layers registered it for this node. */
649 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
651 handler->address_callback(card, request,
652 tcode, destination, source,
653 p->generation, p->speed, offset,
654 request->data, request->length,
655 handler->callback_data);
657 EXPORT_SYMBOL(fw_core_handle_request);
660 fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
662 struct fw_transaction *t;
666 int tcode, tlabel, destination, source, rcode;
668 tcode = header_get_tcode(p->header[0]);
669 tlabel = header_get_tlabel(p->header[0]);
670 destination = header_get_destination(p->header[0]);
671 source = header_get_source(p->header[1]);
672 rcode = header_get_rcode(p->header[1]);
674 spin_lock_irqsave(&card->lock, flags);
675 list_for_each_entry(t, &card->transaction_list, link) {
676 if (t->node_id == source && t->tlabel == tlabel) {
678 card->tlabel_mask &= ~(1 << t->tlabel);
682 spin_unlock_irqrestore(&card->lock, flags);
684 if (&t->link == &card->transaction_list) {
685 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
690 /* FIXME: sanity check packet, is length correct, does tcodes
691 * and addresses match. */
694 case TCODE_READ_QUADLET_RESPONSE:
695 data = (u32 *) &p->header[3];
699 case TCODE_WRITE_RESPONSE:
704 case TCODE_READ_BLOCK_RESPONSE:
705 case TCODE_LOCK_RESPONSE:
707 data_length = header_get_data_length(p->header[3]);
711 /* Should never happen, this is just to shut up gcc. */
717 t->callback(card, rcode, data, data_length, t->callback_data);
719 EXPORT_SYMBOL(fw_core_handle_response);
721 const struct fw_address_region topology_map_region =
722 { .start = 0xfffff0001000ull, .end = 0xfffff0001400ull, };
725 handle_topology_map(struct fw_card *card, struct fw_request *request,
726 int tcode, int destination, int source,
727 int generation, int speed,
728 unsigned long long offset,
729 void *payload, size_t length, void *callback_data)
734 if (!TCODE_IS_READ_REQUEST(tcode)) {
735 fw_send_response(card, request, RCODE_TYPE_ERROR);
739 if ((offset & 3) > 0 || (length & 3) > 0) {
740 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
744 start = (offset - topology_map_region.start) / 4;
745 end = start + length / 4;
748 for (i = 0; i < length / 4; i++)
749 map[i] = cpu_to_be32(card->topology_map[start + i]);
751 fw_send_response(card, request, RCODE_COMPLETE);
754 static struct fw_address_handler topology_map = {
756 .address_callback = handle_topology_map,
759 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
760 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
761 MODULE_LICENSE("GPL");
763 static const u32 vendor_textual_descriptor[] = {
764 /* textual descriptor leaf () */
768 0x4c696e75, /* L i n u */
769 0x78204669, /* x F i */
770 0x72657769, /* r e w i */
771 0x72650000, /* r e */
774 static const u32 model_textual_descriptor[] = {
775 /* model descriptor leaf () */
779 0x4a756a75, /* J u j u */
782 static struct fw_descriptor vendor_id_descriptor = {
783 .length = ARRAY_SIZE(vendor_textual_descriptor),
784 .immediate = 0x03d00d1e,
786 .data = vendor_textual_descriptor,
789 static struct fw_descriptor model_id_descriptor = {
790 .length = ARRAY_SIZE(model_textual_descriptor),
791 .immediate = 0x17000001,
793 .data = model_textual_descriptor,
796 static int __init fw_core_init(void)
800 retval = bus_register(&fw_bus_type);
804 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
805 if (fw_cdev_major < 0) {
806 bus_unregister(&fw_bus_type);
807 return fw_cdev_major;
810 retval = fw_core_add_address_handler(&topology_map,
811 &topology_map_region);
814 /* Add the vendor textual descriptor. */
815 retval = fw_core_add_descriptor(&vendor_id_descriptor);
817 retval = fw_core_add_descriptor(&model_id_descriptor);
823 static void __exit fw_core_cleanup(void)
825 unregister_chrdev(fw_cdev_major, "firewire");
826 bus_unregister(&fw_bus_type);
829 module_init(fw_core_init);
830 module_exit(fw_core_cleanup);