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 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(0);
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 tlabel
= card
->current_tlabel
;
257 if (card
->tlabel_mask
& (1 << tlabel
)) {
258 spin_unlock_irqrestore(&card
->lock
, flags
);
259 callback(card
, RCODE_SEND_ERROR
, NULL
, 0, callback_data
);
263 card
->current_tlabel
= (card
->current_tlabel
+ 1) & 0x1f;
264 card
->tlabel_mask
|= (1 << tlabel
);
266 list_add_tail(&t
->link
, &card
->transaction_list
);
268 spin_unlock_irqrestore(&card
->lock
, flags
);
270 /* Initialize rest of transaction, fill out packet and send it. */
271 t
->node_id
= node_id
;
273 t
->callback
= callback
;
274 t
->callback_data
= callback_data
;
276 fw_fill_request(&t
->packet
, tcode
, t
->tlabel
,
277 node_id
, generation
, speed
, offset
, payload
, length
);
278 t
->packet
.callback
= transmit_complete_callback
;
280 card
->driver
->send_request(card
, &t
->packet
);
282 EXPORT_SYMBOL(fw_send_request
);
285 transmit_phy_packet_callback(struct fw_packet
*packet
,
286 struct fw_card
*card
, int status
)
291 static void send_phy_packet(struct fw_card
*card
, u32 data
, int generation
)
293 struct fw_packet
*packet
;
295 packet
= kzalloc(sizeof *packet
, GFP_ATOMIC
);
299 packet
->header
[0] = data
;
300 packet
->header
[1] = ~data
;
301 packet
->header_length
= 8;
302 packet
->payload_length
= 0;
303 packet
->speed
= SCODE_100
;
304 packet
->generation
= generation
;
305 packet
->callback
= transmit_phy_packet_callback
;
307 card
->driver
->send_request(card
, packet
);
310 void fw_send_phy_config(struct fw_card
*card
,
311 int node_id
, int generation
, int gap_count
)
315 q
= phy_identifier(PHY_PACKET_CONFIG
) |
316 phy_config_root_id(node_id
) |
317 phy_config_gap_count(gap_count
);
319 send_phy_packet(card
, q
, generation
);
322 void fw_flush_transactions(struct fw_card
*card
)
324 struct fw_transaction
*t
, *next
;
325 struct list_head list
;
328 INIT_LIST_HEAD(&list
);
329 spin_lock_irqsave(&card
->lock
, flags
);
330 list_splice_init(&card
->transaction_list
, &list
);
331 card
->tlabel_mask
= 0;
332 spin_unlock_irqrestore(&card
->lock
, flags
);
334 list_for_each_entry_safe(t
, next
, &list
, link
) {
335 card
->driver
->cancel_packet(card
, &t
->packet
);
337 /* At this point cancel_packet will never call the
338 * transaction callback, since we just took all the
339 * transactions out of the list. So do it here.*/
340 t
->callback(card
, RCODE_CANCELLED
, NULL
, 0, t
->callback_data
);
344 static struct fw_address_handler
*
345 lookup_overlapping_address_handler(struct list_head
*list
,
346 unsigned long long offset
, size_t length
)
348 struct fw_address_handler
*handler
;
350 list_for_each_entry(handler
, list
, link
) {
351 if (handler
->offset
< offset
+ length
&&
352 offset
< handler
->offset
+ handler
->length
)
359 static struct fw_address_handler
*
360 lookup_enclosing_address_handler(struct list_head
*list
,
361 unsigned long long offset
, size_t length
)
363 struct fw_address_handler
*handler
;
365 list_for_each_entry(handler
, list
, link
) {
366 if (handler
->offset
<= offset
&&
367 offset
+ length
<= handler
->offset
+ handler
->length
)
374 static DEFINE_SPINLOCK(address_handler_lock
);
375 static LIST_HEAD(address_handler_list
);
377 const struct fw_address_region fw_low_memory_region
=
378 { .start
= 0x000000000000ULL
, .end
= 0x000100000000ULL
, };
379 const struct fw_address_region fw_high_memory_region
=
380 { .start
= 0x000100000000ULL
, .end
= 0xffffe0000000ULL
, };
381 const struct fw_address_region fw_private_region
=
382 { .start
= 0xffffe0000000ULL
, .end
= 0xfffff0000000ULL
, };
383 const struct fw_address_region fw_csr_region
=
384 { .start
= 0xfffff0000000ULL
, .end
= 0xfffff0000800ULL
, };
385 const struct fw_address_region fw_unit_space_region
=
386 { .start
= 0xfffff0000900ULL
, .end
= 0x1000000000000ULL
, };
387 EXPORT_SYMBOL(fw_low_memory_region
);
388 EXPORT_SYMBOL(fw_high_memory_region
);
389 EXPORT_SYMBOL(fw_private_region
);
390 EXPORT_SYMBOL(fw_csr_region
);
391 EXPORT_SYMBOL(fw_unit_space_region
);
394 * Allocate a range of addresses in the node space of the OHCI
395 * controller. When a request is received that falls within the
396 * specified address range, the specified callback is invoked. The
397 * parameters passed to the callback give the details of the
401 fw_core_add_address_handler(struct fw_address_handler
*handler
,
402 const struct fw_address_region
*region
)
404 struct fw_address_handler
*other
;
408 spin_lock_irqsave(&address_handler_lock
, flags
);
410 handler
->offset
= region
->start
;
411 while (handler
->offset
+ handler
->length
<= region
->end
) {
413 lookup_overlapping_address_handler(&address_handler_list
,
417 handler
->offset
+= other
->length
;
419 list_add_tail(&handler
->link
, &address_handler_list
);
425 spin_unlock_irqrestore(&address_handler_lock
, flags
);
429 EXPORT_SYMBOL(fw_core_add_address_handler
);
432 * Deallocate a range of addresses allocated with fw_allocate. This
433 * will call the associated callback one last time with a the special
434 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
435 * callback data. For convenience, the callback parameters offset and
436 * length are set to the start and the length respectively for the
437 * deallocated region, payload is set to NULL.
439 void fw_core_remove_address_handler(struct fw_address_handler
*handler
)
443 spin_lock_irqsave(&address_handler_lock
, flags
);
444 list_del(&handler
->link
);
445 spin_unlock_irqrestore(&address_handler_lock
, flags
);
447 EXPORT_SYMBOL(fw_core_remove_address_handler
);
450 struct fw_packet response
;
451 u32 request_header
[4];
458 free_response_callback(struct fw_packet
*packet
,
459 struct fw_card
*card
, int status
)
461 struct fw_request
*request
;
463 request
= container_of(packet
, struct fw_request
, response
);
468 fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
469 int rcode
, void *payload
, size_t length
)
471 int tcode
, tlabel
, extended_tcode
, source
, destination
;
473 tcode
= header_get_tcode(request_header
[0]);
474 tlabel
= header_get_tlabel(request_header
[0]);
475 source
= header_get_destination(request_header
[0]);
476 destination
= header_get_source(request_header
[1]);
477 extended_tcode
= header_get_extended_tcode(request_header
[3]);
479 response
->header
[0] =
480 header_retry(RETRY_1
) |
481 header_tlabel(tlabel
) |
482 header_destination(destination
);
483 response
->header
[1] =
484 header_source(source
) |
486 response
->header
[2] = 0;
489 case TCODE_WRITE_QUADLET_REQUEST
:
490 case TCODE_WRITE_BLOCK_REQUEST
:
491 response
->header
[0] |= header_tcode(TCODE_WRITE_RESPONSE
);
492 response
->header_length
= 12;
493 response
->payload_length
= 0;
496 case TCODE_READ_QUADLET_REQUEST
:
497 response
->header
[0] |=
498 header_tcode(TCODE_READ_QUADLET_RESPONSE
);
500 response
->header
[3] = *(u32
*)payload
;
502 response
->header
[3] = 0;
503 response
->header_length
= 16;
504 response
->payload_length
= 0;
507 case TCODE_READ_BLOCK_REQUEST
:
508 case TCODE_LOCK_REQUEST
:
509 response
->header
[0] |= header_tcode(tcode
+ 2);
510 response
->header
[3] =
511 header_data_length(length
) |
512 header_extended_tcode(extended_tcode
);
513 response
->header_length
= 16;
514 response
->payload
= payload
;
515 response
->payload_length
= length
;
523 EXPORT_SYMBOL(fw_fill_response
);
525 static struct fw_request
*
526 allocate_request(struct fw_packet
*p
)
528 struct fw_request
*request
;
530 int request_tcode
, t
;
532 request_tcode
= header_get_tcode(p
->header
[0]);
533 switch (request_tcode
) {
534 case TCODE_WRITE_QUADLET_REQUEST
:
535 data
= &p
->header
[3];
539 case TCODE_WRITE_BLOCK_REQUEST
:
540 case TCODE_LOCK_REQUEST
:
542 length
= header_get_data_length(p
->header
[3]);
545 case TCODE_READ_QUADLET_REQUEST
:
550 case TCODE_READ_BLOCK_REQUEST
:
552 length
= header_get_data_length(p
->header
[3]);
560 request
= kmalloc(sizeof *request
+ length
, GFP_ATOMIC
);
564 t
= (p
->timestamp
& 0x1fff) + 4000;
566 t
= (p
->timestamp
& ~0x1fff) + 0x2000 + t
- 8000;
568 t
= (p
->timestamp
& ~0x1fff) + t
;
570 request
->response
.speed
= p
->speed
;
571 request
->response
.timestamp
= t
;
572 request
->response
.generation
= p
->generation
;
573 request
->response
.ack
= 0;
574 request
->response
.callback
= free_response_callback
;
575 request
->ack
= p
->ack
;
576 request
->length
= length
;
578 memcpy(request
->data
, p
->payload
, length
);
580 memcpy(request
->request_header
, p
->header
, sizeof p
->header
);
586 fw_send_response(struct fw_card
*card
, struct fw_request
*request
, int rcode
)
588 /* Broadcast packets are reported as ACK_COMPLETE, so this
589 * check is sufficient to ensure we don't send response to
590 * broadcast packets or posted writes. */
591 if (request
->ack
!= ACK_PENDING
)
594 if (rcode
== RCODE_COMPLETE
)
595 fw_fill_response(&request
->response
, request
->request_header
,
596 rcode
, request
->data
, request
->length
);
598 fw_fill_response(&request
->response
, request
->request_header
,
601 card
->driver
->send_response(card
, &request
->response
);
603 EXPORT_SYMBOL(fw_send_response
);
606 fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*p
)
608 struct fw_address_handler
*handler
;
609 struct fw_request
*request
;
610 unsigned long long offset
;
612 int tcode
, destination
, source
;
614 if (p
->payload_length
> 2048) {
615 /* FIXME: send error response. */
619 if (p
->ack
!= ACK_PENDING
&& p
->ack
!= ACK_COMPLETE
)
622 request
= allocate_request(p
);
623 if (request
== NULL
) {
624 /* FIXME: send statically allocated busy packet. */
629 ((unsigned long long)
630 header_get_offset_high(p
->header
[1]) << 32) | p
->header
[2];
631 tcode
= header_get_tcode(p
->header
[0]);
632 destination
= header_get_destination(p
->header
[0]);
633 source
= header_get_source(p
->header
[0]);
635 spin_lock_irqsave(&address_handler_lock
, flags
);
636 handler
= lookup_enclosing_address_handler(&address_handler_list
,
637 offset
, request
->length
);
638 spin_unlock_irqrestore(&address_handler_lock
, flags
);
640 /* FIXME: lookup the fw_node corresponding to the sender of
641 * this request and pass that to the address handler instead
642 * of the node ID. We may also want to move the address
643 * allocations to fw_node so we only do this callback if the
644 * upper layers registered it for this node. */
647 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
649 handler
->address_callback(card
, request
,
650 tcode
, destination
, source
,
651 p
->generation
, p
->speed
, offset
,
652 request
->data
, request
->length
,
653 handler
->callback_data
);
655 EXPORT_SYMBOL(fw_core_handle_request
);
658 fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*p
)
660 struct fw_transaction
*t
;
664 int tcode
, tlabel
, destination
, source
, rcode
;
666 tcode
= header_get_tcode(p
->header
[0]);
667 tlabel
= header_get_tlabel(p
->header
[0]);
668 destination
= header_get_destination(p
->header
[0]);
669 source
= header_get_source(p
->header
[1]);
670 rcode
= header_get_rcode(p
->header
[1]);
672 spin_lock_irqsave(&card
->lock
, flags
);
673 list_for_each_entry(t
, &card
->transaction_list
, link
) {
674 if (t
->node_id
== source
&& t
->tlabel
== tlabel
) {
676 card
->tlabel_mask
&= ~(1 << t
->tlabel
);
680 spin_unlock_irqrestore(&card
->lock
, flags
);
682 if (&t
->link
== &card
->transaction_list
) {
683 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
688 /* FIXME: sanity check packet, is length correct, does tcodes
689 * and addresses match. */
692 case TCODE_READ_QUADLET_RESPONSE
:
693 data
= (u32
*) &p
->header
[3];
697 case TCODE_WRITE_RESPONSE
:
702 case TCODE_READ_BLOCK_RESPONSE
:
703 case TCODE_LOCK_RESPONSE
:
705 data_length
= header_get_data_length(p
->header
[3]);
709 /* Should never happen, this is just to shut up gcc. */
715 t
->callback(card
, rcode
, data
, data_length
, t
->callback_data
);
717 EXPORT_SYMBOL(fw_core_handle_response
);
719 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
720 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
721 MODULE_LICENSE("GPL");
723 static const u32 vendor_textual_descriptor_data
[] = {
724 /* textual descriptor leaf () */
728 0x4c696e75, /* L i n u */
729 0x78204669, /* x F i */
730 0x72657769, /* r e w i */
731 0x72652028, /* r e ( */
732 0x4a554a55, /* J U J U */
736 static struct fw_descriptor vendor_textual_descriptor
= {
737 .length
= ARRAY_SIZE(vendor_textual_descriptor_data
),
739 .data
= vendor_textual_descriptor_data
,
742 static int __init
fw_core_init(void)
746 retval
= bus_register(&fw_bus_type
);
750 /* Add the vendor textual descriptor. */
751 retval
= fw_core_add_descriptor(&vendor_textual_descriptor
);
757 static void __exit
fw_core_cleanup(void)
759 bus_unregister(&fw_bus_type
);
762 module_init(fw_core_init
);
763 module_exit(fw_core_cleanup
);