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/kref.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
27 #include <linux/pci.h>
28 #include <linux/delay.h>
29 #include <linux/poll.h>
30 #include <linux/list.h>
31 #include <linux/kthread.h>
32 #include <asm/uaccess.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 HEADER_DESTINATION_IS_BROADCAST(q) \
59 (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))
61 #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
62 #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
63 #define PHY_IDENTIFIER(id) ((id) << 30)
66 close_transaction(struct fw_transaction
*transaction
,
67 struct fw_card
*card
, int rcode
,
68 u32
*payload
, size_t length
)
70 struct fw_transaction
*t
;
73 spin_lock_irqsave(&card
->lock
, flags
);
74 list_for_each_entry(t
, &card
->transaction_list
, link
) {
75 if (t
== transaction
) {
77 card
->tlabel_mask
&= ~(1 << t
->tlabel
);
81 spin_unlock_irqrestore(&card
->lock
, flags
);
83 if (&t
->link
!= &card
->transaction_list
) {
84 t
->callback(card
, rcode
, payload
, length
, t
->callback_data
);
92 * Only valid for transactions that are potentially pending (ie have
96 fw_cancel_transaction(struct fw_card
*card
,
97 struct fw_transaction
*transaction
)
100 * Cancel the packet transmission if it's still queued. That
101 * will call the packet transmission callback which cancels
105 if (card
->driver
->cancel_packet(card
, &transaction
->packet
) == 0)
109 * If the request packet has already been sent, we need to see
110 * if the transaction is still pending and remove it in that case.
113 return close_transaction(transaction
, card
, RCODE_CANCELLED
, NULL
, 0);
115 EXPORT_SYMBOL(fw_cancel_transaction
);
118 transmit_complete_callback(struct fw_packet
*packet
,
119 struct fw_card
*card
, int status
)
121 struct fw_transaction
*t
=
122 container_of(packet
, struct fw_transaction
, packet
);
126 close_transaction(t
, card
, RCODE_COMPLETE
, NULL
, 0);
129 t
->timestamp
= packet
->timestamp
;
134 close_transaction(t
, card
, RCODE_BUSY
, NULL
, 0);
137 close_transaction(t
, card
, RCODE_DATA_ERROR
, NULL
, 0);
140 close_transaction(t
, card
, RCODE_TYPE_ERROR
, NULL
, 0);
144 * In this case the ack is really a juju specific
145 * rcode, so just forward that to the callback.
147 close_transaction(t
, card
, status
, NULL
, 0);
153 fw_fill_request(struct fw_packet
*packet
, int tcode
, int tlabel
,
154 int node_id
, int source_id
, int generation
, int speed
,
155 unsigned long long offset
, void *payload
, size_t length
)
160 ext_tcode
= tcode
& ~0x10;
161 tcode
= TCODE_LOCK_REQUEST
;
166 HEADER_RETRY(RETRY_X
) |
167 HEADER_TLABEL(tlabel
) |
168 HEADER_TCODE(tcode
) |
169 HEADER_DESTINATION(node_id
);
171 HEADER_OFFSET_HIGH(offset
>> 32) | HEADER_SOURCE(source_id
);
176 case TCODE_WRITE_QUADLET_REQUEST
:
177 packet
->header
[3] = *(u32
*)payload
;
178 packet
->header_length
= 16;
179 packet
->payload_length
= 0;
182 case TCODE_LOCK_REQUEST
:
183 case TCODE_WRITE_BLOCK_REQUEST
:
185 HEADER_DATA_LENGTH(length
) |
186 HEADER_EXTENDED_TCODE(ext_tcode
);
187 packet
->header_length
= 16;
188 packet
->payload
= payload
;
189 packet
->payload_length
= length
;
192 case TCODE_READ_QUADLET_REQUEST
:
193 packet
->header_length
= 12;
194 packet
->payload_length
= 0;
197 case TCODE_READ_BLOCK_REQUEST
:
199 HEADER_DATA_LENGTH(length
) |
200 HEADER_EXTENDED_TCODE(ext_tcode
);
201 packet
->header_length
= 16;
202 packet
->payload_length
= 0;
206 packet
->speed
= speed
;
207 packet
->generation
= generation
;
212 * This function provides low-level access to the IEEE1394 transaction
213 * logic. Most C programs would use either fw_read(), fw_write() or
214 * fw_lock() instead - those function are convenience wrappers for
215 * this function. The fw_send_request() function is primarily
216 * provided as a flexible, one-stop entry point for languages bindings
217 * and protocol bindings.
219 * FIXME: Document this function further, in particular the possible
220 * values for rcode in the callback. In short, we map ACK_COMPLETE to
221 * RCODE_COMPLETE, internal errors set errno and set rcode to
222 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
223 * rcodes). All other rcodes are forwarded unchanged. For all
224 * errors, payload is NULL, length is 0.
226 * Can not expect the callback to be called before the function
227 * returns, though this does happen in some cases (ACK_COMPLETE and
230 * The payload is only used for write requests and must not be freed
231 * until the callback has been called.
233 * @param card the card from which to send the request
234 * @param tcode the tcode for this transaction. Do not use
235 * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
236 * etc. to specify tcode and ext_tcode.
237 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
238 * @param generation the generation for which node_id is valid
239 * @param speed the speed to use for sending the request
240 * @param offset the 48 bit offset on the destination node
241 * @param payload the data payload for the request subaction
242 * @param length the length in bytes of the data to read
243 * @param callback function to be called when the transaction is completed
244 * @param callback_data pointer to arbitrary data, which will be
245 * passed to the callback
248 fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
249 int tcode
, int node_id
, int generation
, int speed
,
250 unsigned long long offset
,
251 void *payload
, size_t length
,
252 fw_transaction_callback_t callback
, void *callback_data
)
258 * Bump the flush timer up 100ms first of all so we
259 * don't race with a flush timer callback.
262 mod_timer(&card
->flush_timer
, jiffies
+ DIV_ROUND_UP(HZ
, 10));
265 * Allocate tlabel from the bitmap and put the transaction on
266 * the list while holding the card spinlock.
269 spin_lock_irqsave(&card
->lock
, flags
);
271 source
= card
->node_id
;
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
);
279 card
->current_tlabel
= (card
->current_tlabel
+ 1) & 0x1f;
280 card
->tlabel_mask
|= (1 << tlabel
);
282 list_add_tail(&t
->link
, &card
->transaction_list
);
284 spin_unlock_irqrestore(&card
->lock
, flags
);
286 /* Initialize rest of transaction, fill out packet and send it. */
287 t
->node_id
= node_id
;
289 t
->callback
= callback
;
290 t
->callback_data
= callback_data
;
292 fw_fill_request(&t
->packet
, tcode
, t
->tlabel
,
293 node_id
, source
, generation
,
294 speed
, offset
, payload
, length
);
295 t
->packet
.callback
= transmit_complete_callback
;
297 card
->driver
->send_request(card
, &t
->packet
);
299 EXPORT_SYMBOL(fw_send_request
);
301 struct fw_phy_packet
{
302 struct fw_packet packet
;
303 struct completion done
;
307 static void phy_packet_release(struct kref
*kref
)
309 struct fw_phy_packet
*p
=
310 container_of(kref
, struct fw_phy_packet
, kref
);
314 static void transmit_phy_packet_callback(struct fw_packet
*packet
,
315 struct fw_card
*card
, int status
)
317 struct fw_phy_packet
*p
=
318 container_of(packet
, struct fw_phy_packet
, packet
);
321 kref_put(&p
->kref
, phy_packet_release
);
324 void fw_send_phy_config(struct fw_card
*card
,
325 int node_id
, int generation
, int gap_count
)
327 struct fw_phy_packet
*p
;
328 long timeout
= DIV_ROUND_UP(HZ
, 10);
329 u32 data
= PHY_IDENTIFIER(PHY_PACKET_CONFIG
) |
330 PHY_CONFIG_ROOT_ID(node_id
) |
331 PHY_CONFIG_GAP_COUNT(gap_count
);
333 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
337 p
->packet
.header
[0] = data
;
338 p
->packet
.header
[1] = ~data
;
339 p
->packet
.header_length
= 8;
340 p
->packet
.payload_length
= 0;
341 p
->packet
.speed
= SCODE_100
;
342 p
->packet
.generation
= generation
;
343 p
->packet
.callback
= transmit_phy_packet_callback
;
344 init_completion(&p
->done
);
345 kref_set(&p
->kref
, 2);
347 card
->driver
->send_request(card
, &p
->packet
);
348 timeout
= wait_for_completion_timeout(&p
->done
, timeout
);
349 kref_put(&p
->kref
, phy_packet_release
);
351 /* will leak p if the callback is never executed */
352 WARN_ON(timeout
== 0);
355 void fw_flush_transactions(struct fw_card
*card
)
357 struct fw_transaction
*t
, *next
;
358 struct list_head list
;
361 INIT_LIST_HEAD(&list
);
362 spin_lock_irqsave(&card
->lock
, flags
);
363 list_splice_init(&card
->transaction_list
, &list
);
364 card
->tlabel_mask
= 0;
365 spin_unlock_irqrestore(&card
->lock
, flags
);
367 list_for_each_entry_safe(t
, next
, &list
, link
) {
368 card
->driver
->cancel_packet(card
, &t
->packet
);
371 * At this point cancel_packet will never call the
372 * transaction callback, since we just took all the
373 * transactions out of the list. So do it here.
375 t
->callback(card
, RCODE_CANCELLED
, NULL
, 0, t
->callback_data
);
379 static struct fw_address_handler
*
380 lookup_overlapping_address_handler(struct list_head
*list
,
381 unsigned long long offset
, size_t length
)
383 struct fw_address_handler
*handler
;
385 list_for_each_entry(handler
, list
, link
) {
386 if (handler
->offset
< offset
+ length
&&
387 offset
< handler
->offset
+ handler
->length
)
394 static struct fw_address_handler
*
395 lookup_enclosing_address_handler(struct list_head
*list
,
396 unsigned long long offset
, size_t length
)
398 struct fw_address_handler
*handler
;
400 list_for_each_entry(handler
, list
, link
) {
401 if (handler
->offset
<= offset
&&
402 offset
+ length
<= handler
->offset
+ handler
->length
)
409 static DEFINE_SPINLOCK(address_handler_lock
);
410 static LIST_HEAD(address_handler_list
);
412 const struct fw_address_region fw_high_memory_region
=
413 { .start
= 0x000100000000ULL
, .end
= 0xffffe0000000ULL
, };
414 EXPORT_SYMBOL(fw_high_memory_region
);
417 const struct fw_address_region fw_low_memory_region
=
418 { .start
= 0x000000000000ULL
, .end
= 0x000100000000ULL
, };
419 const struct fw_address_region fw_private_region
=
420 { .start
= 0xffffe0000000ULL
, .end
= 0xfffff0000000ULL
, };
421 const struct fw_address_region fw_csr_region
=
422 { .start
= CSR_REGISTER_BASE
,
423 .end
= CSR_REGISTER_BASE
| CSR_CONFIG_ROM_END
, };
424 const struct fw_address_region fw_unit_space_region
=
425 { .start
= 0xfffff0000900ULL
, .end
= 0x1000000000000ULL
, };
429 * Allocate a range of addresses in the node space of the OHCI
430 * controller. When a request is received that falls within the
431 * specified address range, the specified callback is invoked. The
432 * parameters passed to the callback give the details of the
433 * particular request.
435 * Return value: 0 on success, non-zero otherwise.
436 * The start offset of the handler's address region is determined by
437 * fw_core_add_address_handler() and is returned in handler->offset.
438 * The offset is quadlet-aligned.
441 fw_core_add_address_handler(struct fw_address_handler
*handler
,
442 const struct fw_address_region
*region
)
444 struct fw_address_handler
*other
;
448 spin_lock_irqsave(&address_handler_lock
, flags
);
450 handler
->offset
= roundup(region
->start
, 4);
451 while (handler
->offset
+ handler
->length
<= region
->end
) {
453 lookup_overlapping_address_handler(&address_handler_list
,
458 roundup(other
->offset
+ other
->length
, 4);
460 list_add_tail(&handler
->link
, &address_handler_list
);
466 spin_unlock_irqrestore(&address_handler_lock
, flags
);
470 EXPORT_SYMBOL(fw_core_add_address_handler
);
473 * Deallocate a range of addresses allocated with fw_allocate. This
474 * will call the associated callback one last time with a the special
475 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
476 * callback data. For convenience, the callback parameters offset and
477 * length are set to the start and the length respectively for the
478 * deallocated region, payload is set to NULL.
480 void fw_core_remove_address_handler(struct fw_address_handler
*handler
)
484 spin_lock_irqsave(&address_handler_lock
, flags
);
485 list_del(&handler
->link
);
486 spin_unlock_irqrestore(&address_handler_lock
, flags
);
488 EXPORT_SYMBOL(fw_core_remove_address_handler
);
491 struct fw_packet response
;
492 u32 request_header
[4];
499 free_response_callback(struct fw_packet
*packet
,
500 struct fw_card
*card
, int status
)
502 struct fw_request
*request
;
504 request
= container_of(packet
, struct fw_request
, response
);
509 fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
510 int rcode
, void *payload
, size_t length
)
512 int tcode
, tlabel
, extended_tcode
, source
, destination
;
514 tcode
= HEADER_GET_TCODE(request_header
[0]);
515 tlabel
= HEADER_GET_TLABEL(request_header
[0]);
516 source
= HEADER_GET_DESTINATION(request_header
[0]);
517 destination
= HEADER_GET_SOURCE(request_header
[1]);
518 extended_tcode
= HEADER_GET_EXTENDED_TCODE(request_header
[3]);
520 response
->header
[0] =
521 HEADER_RETRY(RETRY_1
) |
522 HEADER_TLABEL(tlabel
) |
523 HEADER_DESTINATION(destination
);
524 response
->header
[1] =
525 HEADER_SOURCE(source
) |
527 response
->header
[2] = 0;
530 case TCODE_WRITE_QUADLET_REQUEST
:
531 case TCODE_WRITE_BLOCK_REQUEST
:
532 response
->header
[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE
);
533 response
->header_length
= 12;
534 response
->payload_length
= 0;
537 case TCODE_READ_QUADLET_REQUEST
:
538 response
->header
[0] |=
539 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE
);
541 response
->header
[3] = *(u32
*)payload
;
543 response
->header
[3] = 0;
544 response
->header_length
= 16;
545 response
->payload_length
= 0;
548 case TCODE_READ_BLOCK_REQUEST
:
549 case TCODE_LOCK_REQUEST
:
550 response
->header
[0] |= HEADER_TCODE(tcode
+ 2);
551 response
->header
[3] =
552 HEADER_DATA_LENGTH(length
) |
553 HEADER_EXTENDED_TCODE(extended_tcode
);
554 response
->header_length
= 16;
555 response
->payload
= payload
;
556 response
->payload_length
= length
;
564 EXPORT_SYMBOL(fw_fill_response
);
566 static struct fw_request
*
567 allocate_request(struct fw_packet
*p
)
569 struct fw_request
*request
;
571 int request_tcode
, t
;
573 request_tcode
= HEADER_GET_TCODE(p
->header
[0]);
574 switch (request_tcode
) {
575 case TCODE_WRITE_QUADLET_REQUEST
:
576 data
= &p
->header
[3];
580 case TCODE_WRITE_BLOCK_REQUEST
:
581 case TCODE_LOCK_REQUEST
:
583 length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
586 case TCODE_READ_QUADLET_REQUEST
:
591 case TCODE_READ_BLOCK_REQUEST
:
593 length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
597 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
598 p
->header
[0], p
->header
[1], p
->header
[2]);
602 request
= kmalloc(sizeof(*request
) + length
, GFP_ATOMIC
);
606 t
= (p
->timestamp
& 0x1fff) + 4000;
608 t
= (p
->timestamp
& ~0x1fff) + 0x2000 + t
- 8000;
610 t
= (p
->timestamp
& ~0x1fff) + t
;
612 request
->response
.speed
= p
->speed
;
613 request
->response
.timestamp
= t
;
614 request
->response
.generation
= p
->generation
;
615 request
->response
.ack
= 0;
616 request
->response
.callback
= free_response_callback
;
617 request
->ack
= p
->ack
;
618 request
->length
= length
;
620 memcpy(request
->data
, data
, length
);
622 memcpy(request
->request_header
, p
->header
, sizeof(p
->header
));
628 fw_send_response(struct fw_card
*card
, struct fw_request
*request
, int rcode
)
630 /* unified transaction or broadcast transaction: don't respond */
631 if (request
->ack
!= ACK_PENDING
||
632 HEADER_DESTINATION_IS_BROADCAST(request
->request_header
[0])) {
637 if (rcode
== RCODE_COMPLETE
)
638 fw_fill_response(&request
->response
, request
->request_header
,
639 rcode
, request
->data
, request
->length
);
641 fw_fill_response(&request
->response
, request
->request_header
,
644 card
->driver
->send_response(card
, &request
->response
);
646 EXPORT_SYMBOL(fw_send_response
);
649 fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*p
)
651 struct fw_address_handler
*handler
;
652 struct fw_request
*request
;
653 unsigned long long offset
;
655 int tcode
, destination
, source
;
657 if (p
->ack
!= ACK_PENDING
&& p
->ack
!= ACK_COMPLETE
)
660 request
= allocate_request(p
);
661 if (request
== NULL
) {
662 /* FIXME: send statically allocated busy packet. */
667 ((unsigned long long)
668 HEADER_GET_OFFSET_HIGH(p
->header
[1]) << 32) | p
->header
[2];
669 tcode
= HEADER_GET_TCODE(p
->header
[0]);
670 destination
= HEADER_GET_DESTINATION(p
->header
[0]);
671 source
= HEADER_GET_SOURCE(p
->header
[1]);
673 spin_lock_irqsave(&address_handler_lock
, flags
);
674 handler
= lookup_enclosing_address_handler(&address_handler_list
,
675 offset
, request
->length
);
676 spin_unlock_irqrestore(&address_handler_lock
, flags
);
679 * FIXME: lookup the fw_node corresponding to the sender of
680 * this request and pass that to the address handler instead
681 * of the node ID. We may also want to move the address
682 * allocations to fw_node so we only do this callback if the
683 * upper layers registered it for this node.
687 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
689 handler
->address_callback(card
, request
,
690 tcode
, destination
, source
,
691 p
->generation
, p
->speed
, offset
,
692 request
->data
, request
->length
,
693 handler
->callback_data
);
695 EXPORT_SYMBOL(fw_core_handle_request
);
698 fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*p
)
700 struct fw_transaction
*t
;
704 int tcode
, tlabel
, destination
, source
, rcode
;
706 tcode
= HEADER_GET_TCODE(p
->header
[0]);
707 tlabel
= HEADER_GET_TLABEL(p
->header
[0]);
708 destination
= HEADER_GET_DESTINATION(p
->header
[0]);
709 source
= HEADER_GET_SOURCE(p
->header
[1]);
710 rcode
= HEADER_GET_RCODE(p
->header
[1]);
712 spin_lock_irqsave(&card
->lock
, flags
);
713 list_for_each_entry(t
, &card
->transaction_list
, link
) {
714 if (t
->node_id
== source
&& t
->tlabel
== tlabel
) {
716 card
->tlabel_mask
&= ~(1 << t
->tlabel
);
720 spin_unlock_irqrestore(&card
->lock
, flags
);
722 if (&t
->link
== &card
->transaction_list
) {
723 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
729 * FIXME: sanity check packet, is length correct, does tcodes
730 * and addresses match.
734 case TCODE_READ_QUADLET_RESPONSE
:
735 data
= (u32
*) &p
->header
[3];
739 case TCODE_WRITE_RESPONSE
:
744 case TCODE_READ_BLOCK_RESPONSE
:
745 case TCODE_LOCK_RESPONSE
:
747 data_length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
751 /* Should never happen, this is just to shut up gcc. */
758 * The response handler may be executed while the request handler
759 * is still pending. Cancel the request handler.
761 card
->driver
->cancel_packet(card
, &t
->packet
);
763 t
->callback(card
, rcode
, data
, data_length
, t
->callback_data
);
765 EXPORT_SYMBOL(fw_core_handle_response
);
767 static const struct fw_address_region topology_map_region
=
768 { .start
= CSR_REGISTER_BASE
| CSR_TOPOLOGY_MAP
,
769 .end
= CSR_REGISTER_BASE
| CSR_TOPOLOGY_MAP_END
, };
772 handle_topology_map(struct fw_card
*card
, struct fw_request
*request
,
773 int tcode
, int destination
, int source
,
774 int generation
, int speed
,
775 unsigned long long offset
,
776 void *payload
, size_t length
, void *callback_data
)
781 if (!TCODE_IS_READ_REQUEST(tcode
)) {
782 fw_send_response(card
, request
, RCODE_TYPE_ERROR
);
786 if ((offset
& 3) > 0 || (length
& 3) > 0) {
787 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
791 start
= (offset
- topology_map_region
.start
) / 4;
792 end
= start
+ length
/ 4;
795 for (i
= 0; i
< length
/ 4; i
++)
796 map
[i
] = cpu_to_be32(card
->topology_map
[start
+ i
]);
798 fw_send_response(card
, request
, RCODE_COMPLETE
);
801 static struct fw_address_handler topology_map
= {
803 .address_callback
= handle_topology_map
,
806 static const struct fw_address_region registers_region
=
807 { .start
= CSR_REGISTER_BASE
,
808 .end
= CSR_REGISTER_BASE
| CSR_CONFIG_ROM
, };
811 handle_registers(struct fw_card
*card
, struct fw_request
*request
,
812 int tcode
, int destination
, int source
,
813 int generation
, int speed
,
814 unsigned long long offset
,
815 void *payload
, size_t length
, void *callback_data
)
817 int reg
= offset
& ~CSR_REGISTER_BASE
;
818 unsigned long long bus_time
;
819 __be32
*data
= payload
;
820 int rcode
= RCODE_COMPLETE
;
825 if (!TCODE_IS_READ_REQUEST(tcode
) || length
!= 4) {
826 rcode
= RCODE_TYPE_ERROR
;
830 bus_time
= card
->driver
->get_bus_time(card
);
831 if (reg
== CSR_CYCLE_TIME
)
832 *data
= cpu_to_be32(bus_time
);
834 *data
= cpu_to_be32(bus_time
>> 25);
837 case CSR_BROADCAST_CHANNEL
:
838 if (tcode
== TCODE_READ_QUADLET_REQUEST
)
839 *data
= cpu_to_be32(card
->broadcast_channel
);
840 else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
)
841 card
->broadcast_channel
=
842 (be32_to_cpu(*data
) & BROADCAST_CHANNEL_VALID
) |
843 BROADCAST_CHANNEL_INITIAL
;
845 rcode
= RCODE_TYPE_ERROR
;
848 case CSR_BUS_MANAGER_ID
:
849 case CSR_BANDWIDTH_AVAILABLE
:
850 case CSR_CHANNELS_AVAILABLE_HI
:
851 case CSR_CHANNELS_AVAILABLE_LO
:
853 * FIXME: these are handled by the OHCI hardware and
854 * the stack never sees these request. If we add
855 * support for a new type of controller that doesn't
856 * handle this in hardware we need to deal with these
862 case CSR_BUSY_TIMEOUT
:
863 /* FIXME: Implement this. */
866 rcode
= RCODE_ADDRESS_ERROR
;
870 fw_send_response(card
, request
, rcode
);
873 static struct fw_address_handler registers
= {
875 .address_callback
= handle_registers
,
878 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
879 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
880 MODULE_LICENSE("GPL");
882 static const u32 vendor_textual_descriptor
[] = {
883 /* textual descriptor leaf () */
887 0x4c696e75, /* L i n u */
888 0x78204669, /* x F i */
889 0x72657769, /* r e w i */
890 0x72650000, /* r e */
893 static const u32 model_textual_descriptor
[] = {
894 /* model descriptor leaf () */
898 0x4a756a75, /* J u j u */
901 static struct fw_descriptor vendor_id_descriptor
= {
902 .length
= ARRAY_SIZE(vendor_textual_descriptor
),
903 .immediate
= 0x03d00d1e,
905 .data
= vendor_textual_descriptor
,
908 static struct fw_descriptor model_id_descriptor
= {
909 .length
= ARRAY_SIZE(model_textual_descriptor
),
910 .immediate
= 0x17000001,
912 .data
= model_textual_descriptor
,
915 static int __init
fw_core_init(void)
919 retval
= bus_register(&fw_bus_type
);
923 fw_cdev_major
= register_chrdev(0, "firewire", &fw_device_ops
);
924 if (fw_cdev_major
< 0) {
925 bus_unregister(&fw_bus_type
);
926 return fw_cdev_major
;
929 retval
= fw_core_add_address_handler(&topology_map
,
930 &topology_map_region
);
933 retval
= fw_core_add_address_handler(®isters
,
937 /* Add the vendor textual descriptor. */
938 retval
= fw_core_add_descriptor(&vendor_id_descriptor
);
940 retval
= fw_core_add_descriptor(&model_id_descriptor
);
946 static void __exit
fw_core_cleanup(void)
948 unregister_chrdev(fw_cdev_major
, "firewire");
949 bus_unregister(&fw_bus_type
);
952 module_init(fw_core_init
);
953 module_exit(fw_core_cleanup
);