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/bug.h>
22 #include <linux/completion.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/firewire.h>
26 #include <linux/firewire-constants.h>
28 #include <linux/init.h>
29 #include <linux/idr.h>
30 #include <linux/jiffies.h>
31 #include <linux/kernel.h>
32 #include <linux/list.h>
33 #include <linux/module.h>
34 #include <linux/slab.h>
35 #include <linux/spinlock.h>
36 #include <linux/string.h>
37 #include <linux/timer.h>
38 #include <linux/types.h>
40 #include <asm/byteorder.h>
44 #define HEADER_PRI(pri) ((pri) << 0)
45 #define HEADER_TCODE(tcode) ((tcode) << 4)
46 #define HEADER_RETRY(retry) ((retry) << 8)
47 #define HEADER_TLABEL(tlabel) ((tlabel) << 10)
48 #define HEADER_DESTINATION(destination) ((destination) << 16)
49 #define HEADER_SOURCE(source) ((source) << 16)
50 #define HEADER_RCODE(rcode) ((rcode) << 12)
51 #define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0)
52 #define HEADER_DATA_LENGTH(length) ((length) << 16)
53 #define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0)
55 #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
56 #define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f)
57 #define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f)
58 #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
59 #define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff)
60 #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
61 #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
62 #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
64 #define HEADER_DESTINATION_IS_BROADCAST(q) \
65 (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))
67 #define PHY_PACKET_CONFIG 0x0
68 #define PHY_PACKET_LINK_ON 0x1
69 #define PHY_PACKET_SELF_ID 0x2
71 #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
72 #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
73 #define PHY_IDENTIFIER(id) ((id) << 30)
75 static int close_transaction(struct fw_transaction
*transaction
,
76 struct fw_card
*card
, int rcode
)
78 struct fw_transaction
*t
;
81 spin_lock_irqsave(&card
->lock
, flags
);
82 list_for_each_entry(t
, &card
->transaction_list
, link
) {
83 if (t
== transaction
) {
84 list_del_init(&t
->link
);
85 card
->tlabel_mask
&= ~(1ULL << t
->tlabel
);
89 spin_unlock_irqrestore(&card
->lock
, flags
);
91 if (&t
->link
!= &card
->transaction_list
) {
92 del_timer_sync(&t
->split_timeout_timer
);
93 t
->callback(card
, rcode
, NULL
, 0, t
->callback_data
);
101 * Only valid for transactions that are potentially pending (ie have
104 int fw_cancel_transaction(struct fw_card
*card
,
105 struct fw_transaction
*transaction
)
108 * Cancel the packet transmission if it's still queued. That
109 * will call the packet transmission callback which cancels
113 if (card
->driver
->cancel_packet(card
, &transaction
->packet
) == 0)
117 * If the request packet has already been sent, we need to see
118 * if the transaction is still pending and remove it in that case.
121 return close_transaction(transaction
, card
, RCODE_CANCELLED
);
123 EXPORT_SYMBOL(fw_cancel_transaction
);
125 static void split_transaction_timeout_callback(unsigned long data
)
127 struct fw_transaction
*t
= (struct fw_transaction
*)data
;
128 struct fw_card
*card
= t
->card
;
131 spin_lock_irqsave(&card
->lock
, flags
);
132 if (list_empty(&t
->link
)) {
133 spin_unlock_irqrestore(&card
->lock
, flags
);
137 card
->tlabel_mask
&= ~(1ULL << t
->tlabel
);
138 spin_unlock_irqrestore(&card
->lock
, flags
);
140 card
->driver
->cancel_packet(card
, &t
->packet
);
143 * At this point cancel_packet will never call the transaction
144 * callback, since we just took the transaction out of the list.
147 t
->callback(card
, RCODE_CANCELLED
, NULL
, 0, t
->callback_data
);
150 static void transmit_complete_callback(struct fw_packet
*packet
,
151 struct fw_card
*card
, int status
)
153 struct fw_transaction
*t
=
154 container_of(packet
, struct fw_transaction
, packet
);
158 close_transaction(t
, card
, RCODE_COMPLETE
);
161 t
->timestamp
= packet
->timestamp
;
166 close_transaction(t
, card
, RCODE_BUSY
);
169 close_transaction(t
, card
, RCODE_DATA_ERROR
);
172 close_transaction(t
, card
, RCODE_TYPE_ERROR
);
176 * In this case the ack is really a juju specific
177 * rcode, so just forward that to the callback.
179 close_transaction(t
, card
, status
);
184 static void fw_fill_request(struct fw_packet
*packet
, int tcode
, int tlabel
,
185 int destination_id
, int source_id
, int generation
, int speed
,
186 unsigned long long offset
, void *payload
, size_t length
)
190 if (tcode
== TCODE_STREAM_DATA
) {
192 HEADER_DATA_LENGTH(length
) |
194 HEADER_TCODE(TCODE_STREAM_DATA
);
195 packet
->header_length
= 4;
196 packet
->payload
= payload
;
197 packet
->payload_length
= length
;
203 ext_tcode
= tcode
& ~0x10;
204 tcode
= TCODE_LOCK_REQUEST
;
209 HEADER_RETRY(RETRY_X
) |
210 HEADER_TLABEL(tlabel
) |
211 HEADER_TCODE(tcode
) |
212 HEADER_DESTINATION(destination_id
);
214 HEADER_OFFSET_HIGH(offset
>> 32) | HEADER_SOURCE(source_id
);
219 case TCODE_WRITE_QUADLET_REQUEST
:
220 packet
->header
[3] = *(u32
*)payload
;
221 packet
->header_length
= 16;
222 packet
->payload_length
= 0;
225 case TCODE_LOCK_REQUEST
:
226 case TCODE_WRITE_BLOCK_REQUEST
:
228 HEADER_DATA_LENGTH(length
) |
229 HEADER_EXTENDED_TCODE(ext_tcode
);
230 packet
->header_length
= 16;
231 packet
->payload
= payload
;
232 packet
->payload_length
= length
;
235 case TCODE_READ_QUADLET_REQUEST
:
236 packet
->header_length
= 12;
237 packet
->payload_length
= 0;
240 case TCODE_READ_BLOCK_REQUEST
:
242 HEADER_DATA_LENGTH(length
) |
243 HEADER_EXTENDED_TCODE(ext_tcode
);
244 packet
->header_length
= 16;
245 packet
->payload_length
= 0;
249 WARN(1, "wrong tcode %d", tcode
);
252 packet
->speed
= speed
;
253 packet
->generation
= generation
;
255 packet
->payload_mapped
= false;
258 static int allocate_tlabel(struct fw_card
*card
)
262 tlabel
= card
->current_tlabel
;
263 while (card
->tlabel_mask
& (1ULL << tlabel
)) {
264 tlabel
= (tlabel
+ 1) & 0x3f;
265 if (tlabel
== card
->current_tlabel
)
269 card
->current_tlabel
= (tlabel
+ 1) & 0x3f;
270 card
->tlabel_mask
|= 1ULL << tlabel
;
276 * fw_send_request() - submit a request packet for transmission
277 * @card: interface to send the request at
278 * @t: transaction instance to which the request belongs
279 * @tcode: transaction code
280 * @destination_id: destination node ID, consisting of bus_ID and phy_ID
281 * @generation: bus generation in which request and response are valid
282 * @speed: transmission speed
283 * @offset: 48bit wide offset into destination's address space
284 * @payload: data payload for the request subaction
285 * @length: length of the payload, in bytes
286 * @callback: function to be called when the transaction is completed
287 * @callback_data: data to be passed to the transaction completion callback
289 * Submit a request packet into the asynchronous request transmission queue.
290 * Can be called from atomic context. If you prefer a blocking API, use
291 * fw_run_transaction() in a context that can sleep.
293 * In case of lock requests, specify one of the firewire-core specific %TCODE_
294 * constants instead of %TCODE_LOCK_REQUEST in @tcode.
296 * Make sure that the value in @destination_id is not older than the one in
297 * @generation. Otherwise the request is in danger to be sent to a wrong node.
299 * In case of asynchronous stream packets i.e. %TCODE_STREAM_DATA, the caller
300 * needs to synthesize @destination_id with fw_stream_packet_destination_id().
301 * It will contain tag, channel, and sy data instead of a node ID then.
303 * The payload buffer at @data is going to be DMA-mapped except in case of
304 * quadlet-sized payload or of local (loopback) requests. Hence make sure that
305 * the buffer complies with the restrictions for DMA-mapped memory. The
306 * @payload must not be freed before the @callback is called.
308 * In case of request types without payload, @data is NULL and @length is 0.
310 * After the transaction is completed successfully or unsuccessfully, the
311 * @callback will be called. Among its parameters is the response code which
312 * is either one of the rcodes per IEEE 1394 or, in case of internal errors,
313 * the firewire-core specific %RCODE_SEND_ERROR.
315 * Note some timing corner cases: fw_send_request() may complete much earlier
316 * than when the request packet actually hits the wire. On the other hand,
317 * transaction completion and hence execution of @callback may happen even
318 * before fw_send_request() returns.
320 void fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
, int tcode
,
321 int destination_id
, int generation
, int speed
,
322 unsigned long long offset
, void *payload
, size_t length
,
323 fw_transaction_callback_t callback
, void *callback_data
)
329 * Allocate tlabel from the bitmap and put the transaction on
330 * the list while holding the card spinlock.
333 spin_lock_irqsave(&card
->lock
, flags
);
335 tlabel
= allocate_tlabel(card
);
337 spin_unlock_irqrestore(&card
->lock
, flags
);
338 callback(card
, RCODE_SEND_ERROR
, NULL
, 0, callback_data
);
342 t
->node_id
= destination_id
;
345 setup_timer(&t
->split_timeout_timer
,
346 split_transaction_timeout_callback
, (unsigned long)t
);
347 /* FIXME: start this timer later, relative to t->timestamp */
348 mod_timer(&t
->split_timeout_timer
,
349 jiffies
+ card
->split_timeout_jiffies
);
350 t
->callback
= callback
;
351 t
->callback_data
= callback_data
;
353 fw_fill_request(&t
->packet
, tcode
, t
->tlabel
,
354 destination_id
, card
->node_id
, generation
,
355 speed
, offset
, payload
, length
);
356 t
->packet
.callback
= transmit_complete_callback
;
358 list_add_tail(&t
->link
, &card
->transaction_list
);
360 spin_unlock_irqrestore(&card
->lock
, flags
);
362 card
->driver
->send_request(card
, &t
->packet
);
364 EXPORT_SYMBOL(fw_send_request
);
366 struct transaction_callback_data
{
367 struct completion done
;
372 static void transaction_callback(struct fw_card
*card
, int rcode
,
373 void *payload
, size_t length
, void *data
)
375 struct transaction_callback_data
*d
= data
;
377 if (rcode
== RCODE_COMPLETE
)
378 memcpy(d
->payload
, payload
, length
);
384 * fw_run_transaction() - send request and sleep until transaction is completed
386 * Returns the RCODE. See fw_send_request() for parameter documentation.
387 * Unlike fw_send_request(), @data points to the payload of the request or/and
388 * to the payload of the response.
390 int fw_run_transaction(struct fw_card
*card
, int tcode
, int destination_id
,
391 int generation
, int speed
, unsigned long long offset
,
392 void *payload
, size_t length
)
394 struct transaction_callback_data d
;
395 struct fw_transaction t
;
397 init_timer_on_stack(&t
.split_timeout_timer
);
398 init_completion(&d
.done
);
400 fw_send_request(card
, &t
, tcode
, destination_id
, generation
, speed
,
401 offset
, payload
, length
, transaction_callback
, &d
);
402 wait_for_completion(&d
.done
);
403 destroy_timer_on_stack(&t
.split_timeout_timer
);
407 EXPORT_SYMBOL(fw_run_transaction
);
409 static DEFINE_MUTEX(phy_config_mutex
);
410 static DECLARE_COMPLETION(phy_config_done
);
412 static void transmit_phy_packet_callback(struct fw_packet
*packet
,
413 struct fw_card
*card
, int status
)
415 complete(&phy_config_done
);
418 static struct fw_packet phy_config_packet
= {
422 .callback
= transmit_phy_packet_callback
,
425 void fw_send_phy_config(struct fw_card
*card
,
426 int node_id
, int generation
, int gap_count
)
428 long timeout
= DIV_ROUND_UP(HZ
, 10);
429 u32 data
= PHY_IDENTIFIER(PHY_PACKET_CONFIG
);
431 if (node_id
!= FW_PHY_CONFIG_NO_NODE_ID
)
432 data
|= PHY_CONFIG_ROOT_ID(node_id
);
434 if (gap_count
== FW_PHY_CONFIG_CURRENT_GAP_COUNT
) {
435 gap_count
= card
->driver
->read_phy_reg(card
, 1);
443 data
|= PHY_CONFIG_GAP_COUNT(gap_count
);
445 mutex_lock(&phy_config_mutex
);
447 phy_config_packet
.header
[0] = data
;
448 phy_config_packet
.header
[1] = ~data
;
449 phy_config_packet
.generation
= generation
;
450 INIT_COMPLETION(phy_config_done
);
452 card
->driver
->send_request(card
, &phy_config_packet
);
453 wait_for_completion_timeout(&phy_config_done
, timeout
);
455 mutex_unlock(&phy_config_mutex
);
458 static struct fw_address_handler
*lookup_overlapping_address_handler(
459 struct list_head
*list
, unsigned long long offset
, size_t length
)
461 struct fw_address_handler
*handler
;
463 list_for_each_entry(handler
, list
, link
) {
464 if (handler
->offset
< offset
+ length
&&
465 offset
< handler
->offset
+ handler
->length
)
472 static bool is_enclosing_handler(struct fw_address_handler
*handler
,
473 unsigned long long offset
, size_t length
)
475 return handler
->offset
<= offset
&&
476 offset
+ length
<= handler
->offset
+ handler
->length
;
479 static struct fw_address_handler
*lookup_enclosing_address_handler(
480 struct list_head
*list
, unsigned long long offset
, size_t length
)
482 struct fw_address_handler
*handler
;
484 list_for_each_entry(handler
, list
, link
) {
485 if (is_enclosing_handler(handler
, offset
, length
))
492 static DEFINE_SPINLOCK(address_handler_lock
);
493 static LIST_HEAD(address_handler_list
);
495 const struct fw_address_region fw_high_memory_region
=
496 { .start
= 0x000100000000ULL
, .end
= 0xffffe0000000ULL
, };
497 EXPORT_SYMBOL(fw_high_memory_region
);
500 const struct fw_address_region fw_low_memory_region
=
501 { .start
= 0x000000000000ULL
, .end
= 0x000100000000ULL
, };
502 const struct fw_address_region fw_private_region
=
503 { .start
= 0xffffe0000000ULL
, .end
= 0xfffff0000000ULL
, };
504 const struct fw_address_region fw_csr_region
=
505 { .start
= CSR_REGISTER_BASE
,
506 .end
= CSR_REGISTER_BASE
| CSR_CONFIG_ROM_END
, };
507 const struct fw_address_region fw_unit_space_region
=
508 { .start
= 0xfffff0000900ULL
, .end
= 0x1000000000000ULL
, };
511 static bool is_in_fcp_region(u64 offset
, size_t length
)
513 return offset
>= (CSR_REGISTER_BASE
| CSR_FCP_COMMAND
) &&
514 offset
+ length
<= (CSR_REGISTER_BASE
| CSR_FCP_END
);
518 * fw_core_add_address_handler() - register for incoming requests
520 * @region: region in the IEEE 1212 node space address range
522 * region->start, ->end, and handler->length have to be quadlet-aligned.
524 * When a request is received that falls within the specified address range,
525 * the specified callback is invoked. The parameters passed to the callback
526 * give the details of the particular request.
528 * Return value: 0 on success, non-zero otherwise.
530 * The start offset of the handler's address region is determined by
531 * fw_core_add_address_handler() and is returned in handler->offset.
533 * Address allocations are exclusive, except for the FCP registers.
535 int fw_core_add_address_handler(struct fw_address_handler
*handler
,
536 const struct fw_address_region
*region
)
538 struct fw_address_handler
*other
;
542 if (region
->start
& 0xffff000000000003ULL
||
543 region
->end
& 0xffff000000000003ULL
||
544 region
->start
>= region
->end
||
545 handler
->length
& 3 ||
546 handler
->length
== 0)
549 spin_lock_irqsave(&address_handler_lock
, flags
);
551 handler
->offset
= region
->start
;
552 while (handler
->offset
+ handler
->length
<= region
->end
) {
553 if (is_in_fcp_region(handler
->offset
, handler
->length
))
556 other
= lookup_overlapping_address_handler
557 (&address_handler_list
,
558 handler
->offset
, handler
->length
);
560 handler
->offset
+= other
->length
;
562 list_add_tail(&handler
->link
, &address_handler_list
);
568 spin_unlock_irqrestore(&address_handler_lock
, flags
);
572 EXPORT_SYMBOL(fw_core_add_address_handler
);
575 * fw_core_remove_address_handler() - unregister an address handler
577 void fw_core_remove_address_handler(struct fw_address_handler
*handler
)
581 spin_lock_irqsave(&address_handler_lock
, flags
);
582 list_del(&handler
->link
);
583 spin_unlock_irqrestore(&address_handler_lock
, flags
);
585 EXPORT_SYMBOL(fw_core_remove_address_handler
);
588 struct fw_packet response
;
589 u32 request_header
[4];
595 static void free_response_callback(struct fw_packet
*packet
,
596 struct fw_card
*card
, int status
)
598 struct fw_request
*request
;
600 request
= container_of(packet
, struct fw_request
, response
);
604 int fw_get_response_length(struct fw_request
*r
)
606 int tcode
, ext_tcode
, data_length
;
608 tcode
= HEADER_GET_TCODE(r
->request_header
[0]);
611 case TCODE_WRITE_QUADLET_REQUEST
:
612 case TCODE_WRITE_BLOCK_REQUEST
:
615 case TCODE_READ_QUADLET_REQUEST
:
618 case TCODE_READ_BLOCK_REQUEST
:
619 data_length
= HEADER_GET_DATA_LENGTH(r
->request_header
[3]);
622 case TCODE_LOCK_REQUEST
:
623 ext_tcode
= HEADER_GET_EXTENDED_TCODE(r
->request_header
[3]);
624 data_length
= HEADER_GET_DATA_LENGTH(r
->request_header
[3]);
626 case EXTCODE_FETCH_ADD
:
627 case EXTCODE_LITTLE_ADD
:
630 return data_length
/ 2;
634 WARN(1, "wrong tcode %d", tcode
);
639 void fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
640 int rcode
, void *payload
, size_t length
)
642 int tcode
, tlabel
, extended_tcode
, source
, destination
;
644 tcode
= HEADER_GET_TCODE(request_header
[0]);
645 tlabel
= HEADER_GET_TLABEL(request_header
[0]);
646 source
= HEADER_GET_DESTINATION(request_header
[0]);
647 destination
= HEADER_GET_SOURCE(request_header
[1]);
648 extended_tcode
= HEADER_GET_EXTENDED_TCODE(request_header
[3]);
650 response
->header
[0] =
651 HEADER_RETRY(RETRY_1
) |
652 HEADER_TLABEL(tlabel
) |
653 HEADER_DESTINATION(destination
);
654 response
->header
[1] =
655 HEADER_SOURCE(source
) |
657 response
->header
[2] = 0;
660 case TCODE_WRITE_QUADLET_REQUEST
:
661 case TCODE_WRITE_BLOCK_REQUEST
:
662 response
->header
[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE
);
663 response
->header_length
= 12;
664 response
->payload_length
= 0;
667 case TCODE_READ_QUADLET_REQUEST
:
668 response
->header
[0] |=
669 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE
);
671 response
->header
[3] = *(u32
*)payload
;
673 response
->header
[3] = 0;
674 response
->header_length
= 16;
675 response
->payload_length
= 0;
678 case TCODE_READ_BLOCK_REQUEST
:
679 case TCODE_LOCK_REQUEST
:
680 response
->header
[0] |= HEADER_TCODE(tcode
+ 2);
681 response
->header
[3] =
682 HEADER_DATA_LENGTH(length
) |
683 HEADER_EXTENDED_TCODE(extended_tcode
);
684 response
->header_length
= 16;
685 response
->payload
= payload
;
686 response
->payload_length
= length
;
690 WARN(1, "wrong tcode %d", tcode
);
693 response
->payload_mapped
= false;
695 EXPORT_SYMBOL(fw_fill_response
);
697 static u32
compute_split_timeout_timestamp(struct fw_card
*card
,
698 u32 request_timestamp
)
703 cycles
= card
->split_timeout_cycles
;
704 cycles
+= request_timestamp
& 0x1fff;
706 timestamp
= request_timestamp
& ~0x1fff;
707 timestamp
+= (cycles
/ 8000) << 13;
708 timestamp
|= cycles
% 8000;
713 static struct fw_request
*allocate_request(struct fw_card
*card
,
716 struct fw_request
*request
;
720 request_tcode
= HEADER_GET_TCODE(p
->header
[0]);
721 switch (request_tcode
) {
722 case TCODE_WRITE_QUADLET_REQUEST
:
723 data
= &p
->header
[3];
727 case TCODE_WRITE_BLOCK_REQUEST
:
728 case TCODE_LOCK_REQUEST
:
730 length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
733 case TCODE_READ_QUADLET_REQUEST
:
738 case TCODE_READ_BLOCK_REQUEST
:
740 length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
744 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
745 p
->header
[0], p
->header
[1], p
->header
[2]);
749 request
= kmalloc(sizeof(*request
) + length
, GFP_ATOMIC
);
753 request
->response
.speed
= p
->speed
;
754 request
->response
.timestamp
=
755 compute_split_timeout_timestamp(card
, p
->timestamp
);
756 request
->response
.generation
= p
->generation
;
757 request
->response
.ack
= 0;
758 request
->response
.callback
= free_response_callback
;
759 request
->ack
= p
->ack
;
760 request
->length
= length
;
762 memcpy(request
->data
, data
, length
);
764 memcpy(request
->request_header
, p
->header
, sizeof(p
->header
));
769 void fw_send_response(struct fw_card
*card
,
770 struct fw_request
*request
, int rcode
)
772 if (WARN_ONCE(!request
, "invalid for FCP address handlers"))
775 /* unified transaction or broadcast transaction: don't respond */
776 if (request
->ack
!= ACK_PENDING
||
777 HEADER_DESTINATION_IS_BROADCAST(request
->request_header
[0])) {
782 if (rcode
== RCODE_COMPLETE
)
783 fw_fill_response(&request
->response
, request
->request_header
,
784 rcode
, request
->data
,
785 fw_get_response_length(request
));
787 fw_fill_response(&request
->response
, request
->request_header
,
790 card
->driver
->send_response(card
, &request
->response
);
792 EXPORT_SYMBOL(fw_send_response
);
794 static void handle_exclusive_region_request(struct fw_card
*card
,
796 struct fw_request
*request
,
797 unsigned long long offset
)
799 struct fw_address_handler
*handler
;
801 int tcode
, destination
, source
;
803 destination
= HEADER_GET_DESTINATION(p
->header
[0]);
804 source
= HEADER_GET_SOURCE(p
->header
[1]);
805 tcode
= HEADER_GET_TCODE(p
->header
[0]);
806 if (tcode
== TCODE_LOCK_REQUEST
)
807 tcode
= 0x10 + HEADER_GET_EXTENDED_TCODE(p
->header
[3]);
809 spin_lock_irqsave(&address_handler_lock
, flags
);
810 handler
= lookup_enclosing_address_handler(&address_handler_list
,
811 offset
, request
->length
);
812 spin_unlock_irqrestore(&address_handler_lock
, flags
);
815 * FIXME: lookup the fw_node corresponding to the sender of
816 * this request and pass that to the address handler instead
817 * of the node ID. We may also want to move the address
818 * allocations to fw_node so we only do this callback if the
819 * upper layers registered it for this node.
823 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
825 handler
->address_callback(card
, request
,
826 tcode
, destination
, source
,
827 p
->generation
, offset
,
828 request
->data
, request
->length
,
829 handler
->callback_data
);
832 static void handle_fcp_region_request(struct fw_card
*card
,
834 struct fw_request
*request
,
835 unsigned long long offset
)
837 struct fw_address_handler
*handler
;
839 int tcode
, destination
, source
;
841 if ((offset
!= (CSR_REGISTER_BASE
| CSR_FCP_COMMAND
) &&
842 offset
!= (CSR_REGISTER_BASE
| CSR_FCP_RESPONSE
)) ||
843 request
->length
> 0x200) {
844 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
849 tcode
= HEADER_GET_TCODE(p
->header
[0]);
850 destination
= HEADER_GET_DESTINATION(p
->header
[0]);
851 source
= HEADER_GET_SOURCE(p
->header
[1]);
853 if (tcode
!= TCODE_WRITE_QUADLET_REQUEST
&&
854 tcode
!= TCODE_WRITE_BLOCK_REQUEST
) {
855 fw_send_response(card
, request
, RCODE_TYPE_ERROR
);
860 spin_lock_irqsave(&address_handler_lock
, flags
);
861 list_for_each_entry(handler
, &address_handler_list
, link
) {
862 if (is_enclosing_handler(handler
, offset
, request
->length
))
863 handler
->address_callback(card
, NULL
, tcode
,
865 p
->generation
, offset
,
868 handler
->callback_data
);
870 spin_unlock_irqrestore(&address_handler_lock
, flags
);
872 fw_send_response(card
, request
, RCODE_COMPLETE
);
875 void fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*p
)
877 struct fw_request
*request
;
878 unsigned long long offset
;
880 if (p
->ack
!= ACK_PENDING
&& p
->ack
!= ACK_COMPLETE
)
883 request
= allocate_request(card
, p
);
884 if (request
== NULL
) {
885 /* FIXME: send statically allocated busy packet. */
889 offset
= ((u64
)HEADER_GET_OFFSET_HIGH(p
->header
[1]) << 32) |
892 if (!is_in_fcp_region(offset
, request
->length
))
893 handle_exclusive_region_request(card
, p
, request
, offset
);
895 handle_fcp_region_request(card
, p
, request
, offset
);
898 EXPORT_SYMBOL(fw_core_handle_request
);
900 void fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*p
)
902 struct fw_transaction
*t
;
906 int tcode
, tlabel
, source
, rcode
;
908 tcode
= HEADER_GET_TCODE(p
->header
[0]);
909 tlabel
= HEADER_GET_TLABEL(p
->header
[0]);
910 source
= HEADER_GET_SOURCE(p
->header
[1]);
911 rcode
= HEADER_GET_RCODE(p
->header
[1]);
913 spin_lock_irqsave(&card
->lock
, flags
);
914 list_for_each_entry(t
, &card
->transaction_list
, link
) {
915 if (t
->node_id
== source
&& t
->tlabel
== tlabel
) {
916 list_del_init(&t
->link
);
917 card
->tlabel_mask
&= ~(1ULL << t
->tlabel
);
921 spin_unlock_irqrestore(&card
->lock
, flags
);
923 if (&t
->link
== &card
->transaction_list
) {
924 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
930 * FIXME: sanity check packet, is length correct, does tcodes
931 * and addresses match.
935 case TCODE_READ_QUADLET_RESPONSE
:
936 data
= (u32
*) &p
->header
[3];
940 case TCODE_WRITE_RESPONSE
:
945 case TCODE_READ_BLOCK_RESPONSE
:
946 case TCODE_LOCK_RESPONSE
:
948 data_length
= HEADER_GET_DATA_LENGTH(p
->header
[3]);
952 /* Should never happen, this is just to shut up gcc. */
958 del_timer_sync(&t
->split_timeout_timer
);
961 * The response handler may be executed while the request handler
962 * is still pending. Cancel the request handler.
964 card
->driver
->cancel_packet(card
, &t
->packet
);
966 t
->callback(card
, rcode
, data
, data_length
, t
->callback_data
);
968 EXPORT_SYMBOL(fw_core_handle_response
);
970 static const struct fw_address_region topology_map_region
=
971 { .start
= CSR_REGISTER_BASE
| CSR_TOPOLOGY_MAP
,
972 .end
= CSR_REGISTER_BASE
| CSR_TOPOLOGY_MAP_END
, };
974 static void handle_topology_map(struct fw_card
*card
, struct fw_request
*request
,
975 int tcode
, int destination
, int source
, int generation
,
976 unsigned long long offset
, void *payload
, size_t length
,
981 if (!TCODE_IS_READ_REQUEST(tcode
)) {
982 fw_send_response(card
, request
, RCODE_TYPE_ERROR
);
986 if ((offset
& 3) > 0 || (length
& 3) > 0) {
987 fw_send_response(card
, request
, RCODE_ADDRESS_ERROR
);
991 start
= (offset
- topology_map_region
.start
) / 4;
992 memcpy(payload
, &card
->topology_map
[start
], length
);
994 fw_send_response(card
, request
, RCODE_COMPLETE
);
997 static struct fw_address_handler topology_map
= {
999 .address_callback
= handle_topology_map
,
1002 static const struct fw_address_region registers_region
=
1003 { .start
= CSR_REGISTER_BASE
,
1004 .end
= CSR_REGISTER_BASE
| CSR_CONFIG_ROM
, };
1006 static void update_split_timeout(struct fw_card
*card
)
1008 unsigned int cycles
;
1010 cycles
= card
->split_timeout_hi
* 8000 + (card
->split_timeout_lo
>> 19);
1012 cycles
= max(cycles
, 800u); /* minimum as per the spec */
1013 cycles
= min(cycles
, 3u * 8000u); /* maximum OHCI timeout */
1015 card
->split_timeout_cycles
= cycles
;
1016 card
->split_timeout_jiffies
= DIV_ROUND_UP(cycles
* HZ
, 8000);
1019 static void handle_registers(struct fw_card
*card
, struct fw_request
*request
,
1020 int tcode
, int destination
, int source
, int generation
,
1021 unsigned long long offset
, void *payload
, size_t length
,
1022 void *callback_data
)
1024 int reg
= offset
& ~CSR_REGISTER_BASE
;
1025 __be32
*data
= payload
;
1026 int rcode
= RCODE_COMPLETE
;
1027 unsigned long flags
;
1030 case CSR_PRIORITY_BUDGET
:
1031 if (!card
->priority_budget_implemented
) {
1032 rcode
= RCODE_ADDRESS_ERROR
;
1035 /* else fall through */
1039 * per IEEE 1394-2008 8.3.22.3, not IEEE 1394.1-2004 3.2.8
1040 * and 9.6, but interoperable with IEEE 1394.1-2004 bridges
1044 case CSR_STATE_CLEAR
:
1046 case CSR_CYCLE_TIME
:
1048 case CSR_BUSY_TIMEOUT
:
1049 if (tcode
== TCODE_READ_QUADLET_REQUEST
)
1050 *data
= cpu_to_be32(card
->driver
->read_csr(card
, reg
));
1051 else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
)
1052 card
->driver
->write_csr(card
, reg
, be32_to_cpu(*data
));
1054 rcode
= RCODE_TYPE_ERROR
;
1057 case CSR_RESET_START
:
1058 if (tcode
== TCODE_WRITE_QUADLET_REQUEST
)
1059 card
->driver
->write_csr(card
, CSR_STATE_CLEAR
,
1060 CSR_STATE_BIT_ABDICATE
);
1062 rcode
= RCODE_TYPE_ERROR
;
1065 case CSR_SPLIT_TIMEOUT_HI
:
1066 if (tcode
== TCODE_READ_QUADLET_REQUEST
) {
1067 *data
= cpu_to_be32(card
->split_timeout_hi
);
1068 } else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
) {
1069 spin_lock_irqsave(&card
->lock
, flags
);
1070 card
->split_timeout_hi
= be32_to_cpu(*data
) & 7;
1071 update_split_timeout(card
);
1072 spin_unlock_irqrestore(&card
->lock
, flags
);
1074 rcode
= RCODE_TYPE_ERROR
;
1078 case CSR_SPLIT_TIMEOUT_LO
:
1079 if (tcode
== TCODE_READ_QUADLET_REQUEST
) {
1080 *data
= cpu_to_be32(card
->split_timeout_lo
);
1081 } else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
) {
1082 spin_lock_irqsave(&card
->lock
, flags
);
1083 card
->split_timeout_lo
=
1084 be32_to_cpu(*data
) & 0xfff80000;
1085 update_split_timeout(card
);
1086 spin_unlock_irqrestore(&card
->lock
, flags
);
1088 rcode
= RCODE_TYPE_ERROR
;
1092 case CSR_MAINT_UTILITY
:
1093 if (tcode
== TCODE_READ_QUADLET_REQUEST
)
1094 *data
= card
->maint_utility_register
;
1095 else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
)
1096 card
->maint_utility_register
= *data
;
1098 rcode
= RCODE_TYPE_ERROR
;
1101 case CSR_BROADCAST_CHANNEL
:
1102 if (tcode
== TCODE_READ_QUADLET_REQUEST
)
1103 *data
= cpu_to_be32(card
->broadcast_channel
);
1104 else if (tcode
== TCODE_WRITE_QUADLET_REQUEST
)
1105 card
->broadcast_channel
=
1106 (be32_to_cpu(*data
) & BROADCAST_CHANNEL_VALID
) |
1107 BROADCAST_CHANNEL_INITIAL
;
1109 rcode
= RCODE_TYPE_ERROR
;
1112 case CSR_BUS_MANAGER_ID
:
1113 case CSR_BANDWIDTH_AVAILABLE
:
1114 case CSR_CHANNELS_AVAILABLE_HI
:
1115 case CSR_CHANNELS_AVAILABLE_LO
:
1117 * FIXME: these are handled by the OHCI hardware and
1118 * the stack never sees these request. If we add
1119 * support for a new type of controller that doesn't
1120 * handle this in hardware we need to deal with these
1127 rcode
= RCODE_ADDRESS_ERROR
;
1131 fw_send_response(card
, request
, rcode
);
1134 static struct fw_address_handler registers
= {
1136 .address_callback
= handle_registers
,
1139 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1140 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
1141 MODULE_LICENSE("GPL");
1143 static const u32 vendor_textual_descriptor
[] = {
1144 /* textual descriptor leaf () */
1148 0x4c696e75, /* L i n u */
1149 0x78204669, /* x F i */
1150 0x72657769, /* r e w i */
1151 0x72650000, /* r e */
1154 static const u32 model_textual_descriptor
[] = {
1155 /* model descriptor leaf () */
1159 0x4a756a75, /* J u j u */
1162 static struct fw_descriptor vendor_id_descriptor
= {
1163 .length
= ARRAY_SIZE(vendor_textual_descriptor
),
1164 .immediate
= 0x03d00d1e,
1166 .data
= vendor_textual_descriptor
,
1169 static struct fw_descriptor model_id_descriptor
= {
1170 .length
= ARRAY_SIZE(model_textual_descriptor
),
1171 .immediate
= 0x17000001,
1173 .data
= model_textual_descriptor
,
1176 static int __init
fw_core_init(void)
1180 ret
= bus_register(&fw_bus_type
);
1184 fw_cdev_major
= register_chrdev(0, "firewire", &fw_device_ops
);
1185 if (fw_cdev_major
< 0) {
1186 bus_unregister(&fw_bus_type
);
1187 return fw_cdev_major
;
1190 fw_core_add_address_handler(&topology_map
, &topology_map_region
);
1191 fw_core_add_address_handler(®isters
, ®isters_region
);
1192 fw_core_add_descriptor(&vendor_id_descriptor
);
1193 fw_core_add_descriptor(&model_id_descriptor
);
1198 static void __exit
fw_core_cleanup(void)
1200 unregister_chrdev(fw_cdev_major
, "firewire");
1201 bus_unregister(&fw_bus_type
);
1202 idr_destroy(&fw_device_idr
);
1205 module_init(fw_core_init
);
1206 module_exit(fw_core_cleanup
);