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) >> 4) & 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
*t
, struct fw_card
*card
, int rcode
,
64 u32
* payload
, size_t length
)
68 spin_lock_irqsave(&card
->lock
, flags
);
69 card
->tlabel_mask
&= ~(1 << t
->tlabel
);
71 spin_unlock_irqrestore(&card
->lock
, flags
);
73 t
->callback(card
, rcode
, payload
, length
, t
->callback_data
);
77 transmit_complete_callback(struct fw_packet
*packet
,
78 struct fw_card
*card
, int status
)
80 struct fw_transaction
*t
=
81 container_of(packet
, struct fw_transaction
, packet
);
85 close_transaction(t
, card
, RCODE_COMPLETE
, NULL
, 0);
88 t
->timestamp
= packet
->timestamp
;
93 close_transaction(t
, card
, RCODE_BUSY
, NULL
, 0);
97 close_transaction(t
, card
, RCODE_SEND_ERROR
, NULL
, 0);
100 /* FIXME: In this case, status is a negative errno,
101 * corresponding to an OHCI specific transmit error
102 * code. We should map that to an RCODE instead of
103 * just the generic RCODE_SEND_ERROR. */
104 close_transaction(t
, card
, RCODE_SEND_ERROR
, NULL
, 0);
110 fw_fill_request(struct fw_packet
*packet
, int tcode
, int tlabel
,
111 int node_id
, int generation
, int speed
,
112 unsigned long long offset
, void *payload
, size_t length
)
117 ext_tcode
= tcode
- 0x10;
118 tcode
= TCODE_LOCK_REQUEST
;
123 header_retry(RETRY_X
) |
124 header_tlabel(tlabel
) |
125 header_tcode(tcode
) |
126 header_destination(node_id
);
128 header_offset_high(offset
>> 32) | header_source(0);
133 case TCODE_WRITE_QUADLET_REQUEST
:
134 packet
->header
[3] = *(u32
*)payload
;
135 packet
->header_length
= 16;
136 packet
->payload_length
= 0;
139 case TCODE_LOCK_REQUEST
:
140 case TCODE_WRITE_BLOCK_REQUEST
:
142 header_data_length(length
) |
143 header_extended_tcode(ext_tcode
);
144 packet
->header_length
= 16;
145 packet
->payload
= payload
;
146 packet
->payload_length
= length
;
149 case TCODE_READ_QUADLET_REQUEST
:
150 packet
->header_length
= 12;
151 packet
->payload_length
= 0;
154 case TCODE_READ_BLOCK_REQUEST
:
156 header_data_length(length
) |
157 header_extended_tcode(ext_tcode
);
158 packet
->header_length
= 16;
159 packet
->payload_length
= 0;
163 packet
->speed
= speed
;
164 packet
->generation
= generation
;
168 * This function provides low-level access to the IEEE1394 transaction
169 * logic. Most C programs would use either fw_read(), fw_write() or
170 * fw_lock() instead - those function are convenience wrappers for
171 * this function. The fw_send_request() function is primarily
172 * provided as a flexible, one-stop entry point for languages bindings
173 * and protocol bindings.
175 * FIXME: Document this function further, in particular the possible
176 * values for rcode in the callback. In short, we map ACK_COMPLETE to
177 * RCODE_COMPLETE, internal errors set errno and set rcode to
178 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
179 * rcodes). All other rcodes are forwarded unchanged. For all
180 * errors, payload is NULL, length is 0.
182 * Can not expect the callback to be called before the function
183 * returns, though this does happen in some cases (ACK_COMPLETE and
186 * The payload is only used for write requests and must not be freed
187 * until the callback has been called.
189 * @param card the card from which to send the request
190 * @param tcode the tcode for this transaction. Do not use
191 * TCODE_LOCK_REQUEST directly, insted use TCODE_LOCK_MASK_SWAP
192 * etc. to specify tcode and ext_tcode.
193 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
194 * @param generation the generation for which node_id is valid
195 * @param speed the speed to use for sending the request
196 * @param offset the 48 bit offset on the destination node
197 * @param payload the data payload for the request subaction
198 * @param length the length in bytes of the data to read
199 * @param callback function to be called when the transaction is completed
200 * @param callback_data pointer to arbitrary data, which will be
201 * passed to the callback
204 fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
205 int tcode
, int node_id
, int generation
, int speed
,
206 unsigned long long offset
,
207 void *payload
, size_t length
,
208 fw_transaction_callback_t callback
, void *callback_data
)
213 /* Bump the flush timer up 100ms first of all so we
214 * don't race with a flush timer callback. */
216 mod_timer(&card
->flush_timer
, jiffies
+ DIV_ROUND_UP(HZ
, 10));
218 /* Allocate tlabel from the bitmap and put the transaction on
219 * the list while holding the card spinlock. */
221 spin_lock_irqsave(&card
->lock
, flags
);
223 tlabel
= card
->current_tlabel
;
224 if (card
->tlabel_mask
& (1 << tlabel
)) {
225 spin_unlock_irqrestore(&card
->lock
, flags
);
226 callback(card
, RCODE_SEND_ERROR
, NULL
, 0, callback_data
);
230 card
->current_tlabel
= (card
->current_tlabel
+ 1) & 0x1f;
231 card
->tlabel_mask
|= (1 << tlabel
);
233 list_add_tail(&t
->link
, &card
->transaction_list
);
235 spin_unlock_irqrestore(&card
->lock
, flags
);
237 /* Initialize rest of transaction, fill out packet and send it. */
238 t
->node_id
= node_id
;
240 t
->callback
= callback
;
241 t
->callback_data
= callback_data
;
243 fw_fill_request(&t
->packet
, tcode
, t
->tlabel
,
244 node_id
, generation
, speed
, offset
, payload
, length
);
245 t
->packet
.callback
= transmit_complete_callback
;
247 card
->driver
->send_request(card
, &t
->packet
);
249 EXPORT_SYMBOL(fw_send_request
);
252 transmit_phy_packet_callback(struct fw_packet
*packet
,
253 struct fw_card
*card
, int status
)
258 static void send_phy_packet(struct fw_card
*card
, u32 data
, int generation
)
260 struct fw_packet
*packet
;
262 packet
= kzalloc(sizeof *packet
, GFP_ATOMIC
);
266 packet
->header
[0] = data
;
267 packet
->header
[1] = ~data
;
268 packet
->header_length
= 8;
269 packet
->payload_length
= 0;
270 packet
->speed
= SCODE_100
;
271 packet
->generation
= generation
;
272 packet
->callback
= transmit_phy_packet_callback
;
274 card
->driver
->send_request(card
, packet
);
277 void fw_send_phy_config(struct fw_card
*card
,
278 int node_id
, int generation
, int gap_count
)
282 q
= phy_identifier(PHY_PACKET_CONFIG
) |
283 phy_config_root_id(node_id
) |
284 phy_config_gap_count(gap_count
);
286 send_phy_packet(card
, q
, generation
);
289 void fw_flush_transactions(struct fw_card
*card
)
291 struct fw_transaction
*t
, *next
;
292 struct list_head list
;
295 INIT_LIST_HEAD(&list
);
296 spin_lock_irqsave(&card
->lock
, flags
);
297 list_splice_init(&card
->transaction_list
, &list
);
298 card
->tlabel_mask
= 0;
299 spin_unlock_irqrestore(&card
->lock
, flags
);
301 list_for_each_entry_safe(t
, next
, &list
, link
)
302 t
->callback(card
, RCODE_CANCELLED
, NULL
, 0, t
->callback_data
);
305 static struct fw_address_handler
*
306 lookup_overlapping_address_handler(struct list_head
*list
,
307 unsigned long long offset
, size_t length
)
309 struct fw_address_handler
*handler
;
311 list_for_each_entry(handler
, list
, link
) {
312 if (handler
->offset
< offset
+ length
&&
313 offset
< handler
->offset
+ handler
->length
)
320 static struct fw_address_handler
*
321 lookup_enclosing_address_handler(struct list_head
*list
,
322 unsigned long long offset
, size_t length
)
324 struct fw_address_handler
*handler
;
326 list_for_each_entry(handler
, list
, link
) {
327 if (handler
->offset
<= offset
&&
328 offset
+ length
<= handler
->offset
+ handler
->length
)
335 static DEFINE_SPINLOCK(address_handler_lock
);
336 static LIST_HEAD(address_handler_list
);
338 const struct fw_address_region fw_low_memory_region
=
339 { .start
= 0x000000000000ULL
, .end
= 0x000100000000ULL
, };
340 const struct fw_address_region fw_high_memory_region
=
341 { .start
= 0x000100000000ULL
, .end
= 0xffffe0000000ULL
, };
342 const struct fw_address_region fw_private_region
=
343 { .start
= 0xffffe0000000ULL
, .end
= 0xfffff0000000ULL
, };
344 const struct fw_address_region fw_csr_region
=
345 { .start
= 0xfffff0000000ULL
, .end
= 0xfffff0000800ULL
, };
346 const struct fw_address_region fw_unit_space_region
=
347 { .start
= 0xfffff0000900ULL
, .end
= 0x1000000000000ULL
, };
348 EXPORT_SYMBOL(fw_low_memory_region
);
349 EXPORT_SYMBOL(fw_high_memory_region
);
350 EXPORT_SYMBOL(fw_private_region
);
351 EXPORT_SYMBOL(fw_csr_region
);
352 EXPORT_SYMBOL(fw_unit_space_region
);
355 * Allocate a range of addresses in the node space of the OHCI
356 * controller. When a request is received that falls within the
357 * specified address range, the specified callback is invoked. The
358 * parameters passed to the callback give the details of the
362 fw_core_add_address_handler(struct fw_address_handler
*handler
,
363 const struct fw_address_region
*region
)
365 struct fw_address_handler
*other
;
369 spin_lock_irqsave(&address_handler_lock
, flags
);
371 handler
->offset
= region
->start
;
372 while (handler
->offset
+ handler
->length
<= region
->end
) {
374 lookup_overlapping_address_handler(&address_handler_list
,
378 handler
->offset
+= other
->length
;
380 list_add_tail(&handler
->link
, &address_handler_list
);
386 spin_unlock_irqrestore(&address_handler_lock
, flags
);
390 EXPORT_SYMBOL(fw_core_add_address_handler
);
393 * Deallocate a range of addresses allocated with fw_allocate. This
394 * will call the associated callback one last time with a the special
395 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
396 * callback data. For convenience, the callback parameters offset and
397 * length are set to the start and the length respectively for the
398 * deallocated region, payload is set to NULL.
400 void fw_core_remove_address_handler(struct fw_address_handler
*handler
)
404 spin_lock_irqsave(&address_handler_lock
, flags
);
405 list_del(&handler
->link
);
406 spin_unlock_irqrestore(&address_handler_lock
, flags
);
408 EXPORT_SYMBOL(fw_core_remove_address_handler
);
411 struct fw_packet response
;
412 u32 request_header
[4];
419 free_response_callback(struct fw_packet
*packet
,
420 struct fw_card
*card
, int status
)
422 struct fw_request
*request
;
424 request
= container_of(packet
, struct fw_request
, response
);
429 fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
430 int rcode
, void *payload
, size_t length
)
432 int tcode
, tlabel
, extended_tcode
, source
, destination
;
434 tcode
= header_get_tcode(request_header
[0]);
435 tlabel
= header_get_tlabel(request_header
[0]);
436 source
= header_get_destination(request_header
[0]);
437 destination
= header_get_source(request_header
[1]);
438 extended_tcode
= header_get_extended_tcode(request_header
[3]);
440 response
->header
[0] =
441 header_retry(RETRY_1
) |
442 header_tlabel(tlabel
) |
443 header_destination(destination
);
444 response
->header
[1] =
445 header_source(source
) |
447 response
->header
[2] = 0;
450 case TCODE_WRITE_QUADLET_REQUEST
:
451 case TCODE_WRITE_BLOCK_REQUEST
:
452 response
->header
[0] |= header_tcode(TCODE_WRITE_RESPONSE
);
453 response
->header_length
= 12;
454 response
->payload_length
= 0;
457 case TCODE_READ_QUADLET_REQUEST
:
458 response
->header
[0] |=
459 header_tcode(TCODE_READ_QUADLET_RESPONSE
);
461 response
->header
[3] = *(u32
*)payload
;
463 response
->header
[3] = 0;
464 response
->header_length
= 16;
465 response
->payload_length
= 0;
468 case TCODE_READ_BLOCK_REQUEST
:
469 case TCODE_LOCK_REQUEST
:
470 response
->header
[0] |= header_tcode(tcode
+ 2);
471 response
->header
[3] =
472 header_data_length(length
) |
473 header_extended_tcode(extended_tcode
);
474 response
->header_length
= 16;
475 response
->payload
= payload
;
476 response
->payload_length
= length
;
484 EXPORT_SYMBOL(fw_fill_response
);
486 static struct fw_request
*
487 allocate_request(struct fw_packet
*p
)
489 struct fw_request
*request
;
491 int request_tcode
, t
;
493 request_tcode
= header_get_tcode(p
->header
[0]);
494 switch (request_tcode
) {
495 case TCODE_WRITE_QUADLET_REQUEST
:
496 data
= &p
->header
[3];
500 case TCODE_WRITE_BLOCK_REQUEST
:
501 case TCODE_LOCK_REQUEST
:
503 length
= header_get_data_length(p
->header
[3]);
506 case TCODE_READ_QUADLET_REQUEST
:
511 case TCODE_READ_BLOCK_REQUEST
:
513 length
= header_get_data_length(p
->header
[3]);
521 request
= kmalloc(sizeof *request
+ length
, GFP_ATOMIC
);
525 t
= (p
->timestamp
& 0x1fff) + 4000;
527 t
= (p
->timestamp
& ~0x1fff) + 0x2000 + t
- 8000;
529 t
= (p
->timestamp
& ~0x1fff) + t
;
531 request
->response
.speed
= p
->speed
;
532 request
->response
.timestamp
= t
;
533 request
->response
.generation
= p
->generation
;
534 request
->response
.callback
= free_response_callback
;
535 request
->ack
= p
->ack
;
536 request
->length
= length
;
538 memcpy(request
->data
, p
->payload
, length
);
540 memcpy(request
->request_header
, p
->header
, sizeof p
->header
);
546 fw_send_response(struct fw_card
*card
, struct fw_request
*request
, int rcode
)
548 /* Broadcast packets are reported as ACK_COMPLETE, so this
549 * check is sufficient to ensure we don't send response to
550 * broadcast packets or posted writes. */
551 if (request
->ack
!= ACK_PENDING
)
554 if (rcode
== RCODE_COMPLETE
)
555 fw_fill_response(&request
->response
, request
->request_header
,
556 rcode
, request
->data
, request
->length
);
558 fw_fill_response(&request
->response
, request
->request_header
,
561 card
->driver
->send_response(card
, &request
->response
);
563 EXPORT_SYMBOL(fw_send_response
);
566 fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*p
)
568 struct fw_address_handler
*handler
;
569 struct fw_request
*request
;
570 unsigned long long offset
;
572 int tcode
, destination
, source
;
574 if (p
->payload_length
> 2048) {
575 /* FIXME: send error response. */
579 if (p
->ack
!= ACK_PENDING
&& p
->ack
!= ACK_COMPLETE
)
582 request
= allocate_request(p
);
583 if (request
== NULL
) {
584 /* FIXME: send statically allocated busy packet. */
589 ((unsigned long long)
590 header_get_offset_high(p
->header
[1]) << 32) | p
->header
[2];
591 tcode
= header_get_tcode(p
->header
[0]);
592 destination
= header_get_destination(p
->header
[0]);
593 source
= header_get_source(p
->header
[0]);
595 spin_lock_irqsave(&address_handler_lock
, flags
);
596 handler
= lookup_enclosing_address_handler(&address_handler_list
,
597 offset
, request
->length
);
598 spin_unlock_irqrestore(&address_handler_lock
, flags
);
600 /* FIXME: lookup the fw_node corresponding to the sender of
601 * this request and pass that to the address handler instead
602 * of the node ID. We may also want to move the address
603 * allocations to fw_node so we only do this callback if the
604 * upper layers registered it for this node. */
607 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
609 handler
->address_callback(card
, request
,
610 tcode
, destination
, source
,
611 p
->generation
, p
->speed
, offset
,
612 request
->data
, request
->length
,
613 handler
->callback_data
);
615 EXPORT_SYMBOL(fw_core_handle_request
);
618 fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*p
)
620 struct fw_transaction
*t
;
624 int tcode
, tlabel
, destination
, source
, rcode
;
626 tcode
= header_get_tcode(p
->header
[0]);
627 tlabel
= header_get_tlabel(p
->header
[0]);
628 destination
= header_get_destination(p
->header
[0]);
629 source
= header_get_source(p
->header
[1]);
630 rcode
= header_get_rcode(p
->header
[1]);
632 spin_lock_irqsave(&card
->lock
, flags
);
633 list_for_each_entry(t
, &card
->transaction_list
, link
) {
634 if (t
->node_id
== source
&& t
->tlabel
== tlabel
) {
636 card
->tlabel_mask
&= ~(1 << t
->tlabel
);
640 spin_unlock_irqrestore(&card
->lock
, flags
);
642 if (&t
->link
== &card
->transaction_list
) {
643 fw_notify("Unsolicited response\n");
647 /* FIXME: sanity check packet, is length correct, does tcodes
648 * and addresses match. */
651 case TCODE_READ_QUADLET_RESPONSE
:
652 data
= (u32
*) &p
->header
[3];
656 case TCODE_WRITE_RESPONSE
:
661 case TCODE_READ_BLOCK_RESPONSE
:
662 case TCODE_LOCK_RESPONSE
:
664 data_length
= header_get_data_length(p
->header
[3]);
668 /* Should never happen, this is just to shut up gcc. */
674 t
->callback(card
, rcode
, data
, data_length
, t
->callback_data
);
676 EXPORT_SYMBOL(fw_core_handle_response
);
678 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
679 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
680 MODULE_LICENSE("GPL");
682 static const u32 vendor_textual_descriptor_data
[] = {
683 /* textual descriptor leaf () */
687 0x4c696e75, /* L i n u */
688 0x78204669, /* x F i */
689 0x72657769, /* r e w i */
690 0x72652028, /* r e ( */
691 0x4a554a55, /* J U J U */
695 static struct fw_descriptor vendor_textual_descriptor
= {
696 .length
= ARRAY_SIZE(vendor_textual_descriptor_data
),
698 .data
= vendor_textual_descriptor_data
,
701 static int __init
fw_core_init(void)
705 retval
= bus_register(&fw_bus_type
);
709 /* Add the vendor textual descriptor. */
710 retval
= fw_core_add_descriptor(&vendor_textual_descriptor
);
716 static void __exit
fw_core_cleanup(void)
718 bus_unregister(&fw_bus_type
);
721 module_init(fw_core_init
);
722 module_exit(fw_core_cleanup
);