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 /* returns 0 if the split timeout handler is already running */
76 static int try_cancel_split_timeout(struct fw_transaction *t)
78 if (t->is_split_transaction)
79 return del_timer(&t->split_timeout_timer);
84 static int close_transaction(struct fw_transaction *transaction,
85 struct fw_card *card, int rcode)
87 struct fw_transaction *t;
90 spin_lock_irqsave(&card->lock, flags);
91 list_for_each_entry(t, &card->transaction_list, link) {
92 if (t == transaction) {
93 if (!try_cancel_split_timeout(t)) {
94 spin_unlock_irqrestore(&card->lock, flags);
97 list_del_init(&t->link);
98 card->tlabel_mask &= ~(1ULL << t->tlabel);
102 spin_unlock_irqrestore(&card->lock, flags);
104 if (&t->link != &card->transaction_list) {
105 t->callback(card, rcode, NULL, 0, t->callback_data);
114 * Only valid for transactions that are potentially pending (ie have
117 int fw_cancel_transaction(struct fw_card *card,
118 struct fw_transaction *transaction)
121 * Cancel the packet transmission if it's still queued. That
122 * will call the packet transmission callback which cancels
126 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
130 * If the request packet has already been sent, we need to see
131 * if the transaction is still pending and remove it in that case.
134 return close_transaction(transaction, card, RCODE_CANCELLED);
136 EXPORT_SYMBOL(fw_cancel_transaction);
138 static void split_transaction_timeout_callback(unsigned long data)
140 struct fw_transaction *t = (struct fw_transaction *)data;
141 struct fw_card *card = t->card;
144 spin_lock_irqsave(&card->lock, flags);
145 if (list_empty(&t->link)) {
146 spin_unlock_irqrestore(&card->lock, flags);
150 card->tlabel_mask &= ~(1ULL << t->tlabel);
151 spin_unlock_irqrestore(&card->lock, flags);
153 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
156 static void start_split_transaction_timeout(struct fw_transaction *t,
157 struct fw_card *card)
161 spin_lock_irqsave(&card->lock, flags);
163 if (list_empty(&t->link) || WARN_ON(t->is_split_transaction)) {
164 spin_unlock_irqrestore(&card->lock, flags);
168 t->is_split_transaction = true;
169 mod_timer(&t->split_timeout_timer,
170 jiffies + card->split_timeout_jiffies);
172 spin_unlock_irqrestore(&card->lock, flags);
175 static void transmit_complete_callback(struct fw_packet *packet,
176 struct fw_card *card, int status)
178 struct fw_transaction *t =
179 container_of(packet, struct fw_transaction, packet);
183 close_transaction(t, card, RCODE_COMPLETE);
186 start_split_transaction_timeout(t, card);
191 close_transaction(t, card, RCODE_BUSY);
194 close_transaction(t, card, RCODE_DATA_ERROR);
197 close_transaction(t, card, RCODE_TYPE_ERROR);
201 * In this case the ack is really a juju specific
202 * rcode, so just forward that to the callback.
204 close_transaction(t, card, status);
209 static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
210 int destination_id, int source_id, int generation, int speed,
211 unsigned long long offset, void *payload, size_t length)
215 if (tcode == TCODE_STREAM_DATA) {
217 HEADER_DATA_LENGTH(length) |
219 HEADER_TCODE(TCODE_STREAM_DATA);
220 packet->header_length = 4;
221 packet->payload = payload;
222 packet->payload_length = length;
228 ext_tcode = tcode & ~0x10;
229 tcode = TCODE_LOCK_REQUEST;
234 HEADER_RETRY(RETRY_X) |
235 HEADER_TLABEL(tlabel) |
236 HEADER_TCODE(tcode) |
237 HEADER_DESTINATION(destination_id);
239 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
244 case TCODE_WRITE_QUADLET_REQUEST:
245 packet->header[3] = *(u32 *)payload;
246 packet->header_length = 16;
247 packet->payload_length = 0;
250 case TCODE_LOCK_REQUEST:
251 case TCODE_WRITE_BLOCK_REQUEST:
253 HEADER_DATA_LENGTH(length) |
254 HEADER_EXTENDED_TCODE(ext_tcode);
255 packet->header_length = 16;
256 packet->payload = payload;
257 packet->payload_length = length;
260 case TCODE_READ_QUADLET_REQUEST:
261 packet->header_length = 12;
262 packet->payload_length = 0;
265 case TCODE_READ_BLOCK_REQUEST:
267 HEADER_DATA_LENGTH(length) |
268 HEADER_EXTENDED_TCODE(ext_tcode);
269 packet->header_length = 16;
270 packet->payload_length = 0;
274 WARN(1, "wrong tcode %d\n", tcode);
277 packet->speed = speed;
278 packet->generation = generation;
280 packet->payload_mapped = false;
283 static int allocate_tlabel(struct fw_card *card)
287 tlabel = card->current_tlabel;
288 while (card->tlabel_mask & (1ULL << tlabel)) {
289 tlabel = (tlabel + 1) & 0x3f;
290 if (tlabel == card->current_tlabel)
294 card->current_tlabel = (tlabel + 1) & 0x3f;
295 card->tlabel_mask |= 1ULL << tlabel;
301 * fw_send_request() - submit a request packet for transmission
302 * @card: interface to send the request at
303 * @t: transaction instance to which the request belongs
304 * @tcode: transaction code
305 * @destination_id: destination node ID, consisting of bus_ID and phy_ID
306 * @generation: bus generation in which request and response are valid
307 * @speed: transmission speed
308 * @offset: 48bit wide offset into destination's address space
309 * @payload: data payload for the request subaction
310 * @length: length of the payload, in bytes
311 * @callback: function to be called when the transaction is completed
312 * @callback_data: data to be passed to the transaction completion callback
314 * Submit a request packet into the asynchronous request transmission queue.
315 * Can be called from atomic context. If you prefer a blocking API, use
316 * fw_run_transaction() in a context that can sleep.
318 * In case of lock requests, specify one of the firewire-core specific %TCODE_
319 * constants instead of %TCODE_LOCK_REQUEST in @tcode.
321 * Make sure that the value in @destination_id is not older than the one in
322 * @generation. Otherwise the request is in danger to be sent to a wrong node.
324 * In case of asynchronous stream packets i.e. %TCODE_STREAM_DATA, the caller
325 * needs to synthesize @destination_id with fw_stream_packet_destination_id().
326 * It will contain tag, channel, and sy data instead of a node ID then.
328 * The payload buffer at @data is going to be DMA-mapped except in case of
329 * @length <= 8 or of local (loopback) requests. Hence make sure that the
330 * buffer complies with the restrictions of the streaming DMA mapping API.
331 * @payload must not be freed before the @callback is called.
333 * In case of request types without payload, @data is NULL and @length is 0.
335 * After the transaction is completed successfully or unsuccessfully, the
336 * @callback will be called. Among its parameters is the response code which
337 * is either one of the rcodes per IEEE 1394 or, in case of internal errors,
338 * the firewire-core specific %RCODE_SEND_ERROR. The other firewire-core
339 * specific rcodes (%RCODE_CANCELLED, %RCODE_BUSY, %RCODE_GENERATION,
340 * %RCODE_NO_ACK) denote transaction timeout, busy responder, stale request
341 * generation, or missing ACK respectively.
343 * Note some timing corner cases: fw_send_request() may complete much earlier
344 * than when the request packet actually hits the wire. On the other hand,
345 * transaction completion and hence execution of @callback may happen even
346 * before fw_send_request() returns.
348 void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
349 int destination_id, int generation, int speed,
350 unsigned long long offset, void *payload, size_t length,
351 fw_transaction_callback_t callback, void *callback_data)
357 * Allocate tlabel from the bitmap and put the transaction on
358 * the list while holding the card spinlock.
361 spin_lock_irqsave(&card->lock, flags);
363 tlabel = allocate_tlabel(card);
365 spin_unlock_irqrestore(&card->lock, flags);
366 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
370 t->node_id = destination_id;
373 t->is_split_transaction = false;
374 setup_timer(&t->split_timeout_timer,
375 split_transaction_timeout_callback, (unsigned long)t);
376 t->callback = callback;
377 t->callback_data = callback_data;
379 fw_fill_request(&t->packet, tcode, t->tlabel,
380 destination_id, card->node_id, generation,
381 speed, offset, payload, length);
382 t->packet.callback = transmit_complete_callback;
384 list_add_tail(&t->link, &card->transaction_list);
386 spin_unlock_irqrestore(&card->lock, flags);
388 card->driver->send_request(card, &t->packet);
390 EXPORT_SYMBOL(fw_send_request);
392 struct transaction_callback_data {
393 struct completion done;
398 static void transaction_callback(struct fw_card *card, int rcode,
399 void *payload, size_t length, void *data)
401 struct transaction_callback_data *d = data;
403 if (rcode == RCODE_COMPLETE)
404 memcpy(d->payload, payload, length);
410 * fw_run_transaction() - send request and sleep until transaction is completed
412 * Returns the RCODE. See fw_send_request() for parameter documentation.
413 * Unlike fw_send_request(), @data points to the payload of the request or/and
414 * to the payload of the response. DMA mapping restrictions apply to outbound
415 * request payloads of >= 8 bytes but not to inbound response payloads.
417 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
418 int generation, int speed, unsigned long long offset,
419 void *payload, size_t length)
421 struct transaction_callback_data d;
422 struct fw_transaction t;
424 init_timer_on_stack(&t.split_timeout_timer);
425 init_completion(&d.done);
427 fw_send_request(card, &t, tcode, destination_id, generation, speed,
428 offset, payload, length, transaction_callback, &d);
429 wait_for_completion(&d.done);
430 destroy_timer_on_stack(&t.split_timeout_timer);
434 EXPORT_SYMBOL(fw_run_transaction);
436 static DEFINE_MUTEX(phy_config_mutex);
437 static DECLARE_COMPLETION(phy_config_done);
439 static void transmit_phy_packet_callback(struct fw_packet *packet,
440 struct fw_card *card, int status)
442 complete(&phy_config_done);
445 static struct fw_packet phy_config_packet = {
447 .header[0] = TCODE_LINK_INTERNAL << 4,
450 .callback = transmit_phy_packet_callback,
453 void fw_send_phy_config(struct fw_card *card,
454 int node_id, int generation, int gap_count)
456 long timeout = DIV_ROUND_UP(HZ, 10);
457 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG);
459 if (node_id != FW_PHY_CONFIG_NO_NODE_ID)
460 data |= PHY_CONFIG_ROOT_ID(node_id);
462 if (gap_count == FW_PHY_CONFIG_CURRENT_GAP_COUNT) {
463 gap_count = card->driver->read_phy_reg(card, 1);
471 data |= PHY_CONFIG_GAP_COUNT(gap_count);
473 mutex_lock(&phy_config_mutex);
475 phy_config_packet.header[1] = data;
476 phy_config_packet.header[2] = ~data;
477 phy_config_packet.generation = generation;
478 INIT_COMPLETION(phy_config_done);
480 card->driver->send_request(card, &phy_config_packet);
481 wait_for_completion_timeout(&phy_config_done, timeout);
483 mutex_unlock(&phy_config_mutex);
486 static struct fw_address_handler *lookup_overlapping_address_handler(
487 struct list_head *list, unsigned long long offset, size_t length)
489 struct fw_address_handler *handler;
491 list_for_each_entry(handler, list, link) {
492 if (handler->offset < offset + length &&
493 offset < handler->offset + handler->length)
500 static bool is_enclosing_handler(struct fw_address_handler *handler,
501 unsigned long long offset, size_t length)
503 return handler->offset <= offset &&
504 offset + length <= handler->offset + handler->length;
507 static struct fw_address_handler *lookup_enclosing_address_handler(
508 struct list_head *list, unsigned long long offset, size_t length)
510 struct fw_address_handler *handler;
512 list_for_each_entry(handler, list, link) {
513 if (is_enclosing_handler(handler, offset, length))
520 static DEFINE_SPINLOCK(address_handler_lock);
521 static LIST_HEAD(address_handler_list);
523 const struct fw_address_region fw_high_memory_region =
524 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
525 EXPORT_SYMBOL(fw_high_memory_region);
528 const struct fw_address_region fw_low_memory_region =
529 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
530 const struct fw_address_region fw_private_region =
531 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
532 const struct fw_address_region fw_csr_region =
533 { .start = CSR_REGISTER_BASE,
534 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
535 const struct fw_address_region fw_unit_space_region =
536 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
539 static bool is_in_fcp_region(u64 offset, size_t length)
541 return offset >= (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
542 offset + length <= (CSR_REGISTER_BASE | CSR_FCP_END);
546 * fw_core_add_address_handler() - register for incoming requests
548 * @region: region in the IEEE 1212 node space address range
550 * region->start, ->end, and handler->length have to be quadlet-aligned.
552 * When a request is received that falls within the specified address range,
553 * the specified callback is invoked. The parameters passed to the callback
554 * give the details of the particular request.
556 * Return value: 0 on success, non-zero otherwise.
558 * The start offset of the handler's address region is determined by
559 * fw_core_add_address_handler() and is returned in handler->offset.
561 * Address allocations are exclusive, except for the FCP registers.
563 int fw_core_add_address_handler(struct fw_address_handler *handler,
564 const struct fw_address_region *region)
566 struct fw_address_handler *other;
570 if (region->start & 0xffff000000000003ULL ||
571 region->start >= region->end ||
572 region->end > 0x0001000000000000ULL ||
573 handler->length & 3 ||
574 handler->length == 0)
577 spin_lock_irqsave(&address_handler_lock, flags);
579 handler->offset = region->start;
580 while (handler->offset + handler->length <= region->end) {
581 if (is_in_fcp_region(handler->offset, handler->length))
584 other = lookup_overlapping_address_handler
585 (&address_handler_list,
586 handler->offset, handler->length);
588 handler->offset += other->length;
590 list_add_tail(&handler->link, &address_handler_list);
596 spin_unlock_irqrestore(&address_handler_lock, flags);
600 EXPORT_SYMBOL(fw_core_add_address_handler);
603 * fw_core_remove_address_handler() - unregister an address handler
605 void fw_core_remove_address_handler(struct fw_address_handler *handler)
609 spin_lock_irqsave(&address_handler_lock, flags);
610 list_del(&handler->link);
611 spin_unlock_irqrestore(&address_handler_lock, flags);
613 EXPORT_SYMBOL(fw_core_remove_address_handler);
616 struct fw_packet response;
617 u32 request_header[4];
623 static void free_response_callback(struct fw_packet *packet,
624 struct fw_card *card, int status)
626 struct fw_request *request;
628 request = container_of(packet, struct fw_request, response);
632 int fw_get_response_length(struct fw_request *r)
634 int tcode, ext_tcode, data_length;
636 tcode = HEADER_GET_TCODE(r->request_header[0]);
639 case TCODE_WRITE_QUADLET_REQUEST:
640 case TCODE_WRITE_BLOCK_REQUEST:
643 case TCODE_READ_QUADLET_REQUEST:
646 case TCODE_READ_BLOCK_REQUEST:
647 data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]);
650 case TCODE_LOCK_REQUEST:
651 ext_tcode = HEADER_GET_EXTENDED_TCODE(r->request_header[3]);
652 data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]);
654 case EXTCODE_FETCH_ADD:
655 case EXTCODE_LITTLE_ADD:
658 return data_length / 2;
662 WARN(1, "wrong tcode %d\n", tcode);
667 void fw_fill_response(struct fw_packet *response, u32 *request_header,
668 int rcode, void *payload, size_t length)
670 int tcode, tlabel, extended_tcode, source, destination;
672 tcode = HEADER_GET_TCODE(request_header[0]);
673 tlabel = HEADER_GET_TLABEL(request_header[0]);
674 source = HEADER_GET_DESTINATION(request_header[0]);
675 destination = HEADER_GET_SOURCE(request_header[1]);
676 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
678 response->header[0] =
679 HEADER_RETRY(RETRY_1) |
680 HEADER_TLABEL(tlabel) |
681 HEADER_DESTINATION(destination);
682 response->header[1] =
683 HEADER_SOURCE(source) |
685 response->header[2] = 0;
688 case TCODE_WRITE_QUADLET_REQUEST:
689 case TCODE_WRITE_BLOCK_REQUEST:
690 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
691 response->header_length = 12;
692 response->payload_length = 0;
695 case TCODE_READ_QUADLET_REQUEST:
696 response->header[0] |=
697 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
699 response->header[3] = *(u32 *)payload;
701 response->header[3] = 0;
702 response->header_length = 16;
703 response->payload_length = 0;
706 case TCODE_READ_BLOCK_REQUEST:
707 case TCODE_LOCK_REQUEST:
708 response->header[0] |= HEADER_TCODE(tcode + 2);
709 response->header[3] =
710 HEADER_DATA_LENGTH(length) |
711 HEADER_EXTENDED_TCODE(extended_tcode);
712 response->header_length = 16;
713 response->payload = payload;
714 response->payload_length = length;
718 WARN(1, "wrong tcode %d\n", tcode);
721 response->payload_mapped = false;
723 EXPORT_SYMBOL(fw_fill_response);
725 static u32 compute_split_timeout_timestamp(struct fw_card *card,
726 u32 request_timestamp)
731 cycles = card->split_timeout_cycles;
732 cycles += request_timestamp & 0x1fff;
734 timestamp = request_timestamp & ~0x1fff;
735 timestamp += (cycles / 8000) << 13;
736 timestamp |= cycles % 8000;
741 static struct fw_request *allocate_request(struct fw_card *card,
744 struct fw_request *request;
748 request_tcode = HEADER_GET_TCODE(p->header[0]);
749 switch (request_tcode) {
750 case TCODE_WRITE_QUADLET_REQUEST:
751 data = &p->header[3];
755 case TCODE_WRITE_BLOCK_REQUEST:
756 case TCODE_LOCK_REQUEST:
758 length = HEADER_GET_DATA_LENGTH(p->header[3]);
761 case TCODE_READ_QUADLET_REQUEST:
766 case TCODE_READ_BLOCK_REQUEST:
768 length = HEADER_GET_DATA_LENGTH(p->header[3]);
772 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
773 p->header[0], p->header[1], p->header[2]);
777 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
781 request->response.speed = p->speed;
782 request->response.timestamp =
783 compute_split_timeout_timestamp(card, p->timestamp);
784 request->response.generation = p->generation;
785 request->response.ack = 0;
786 request->response.callback = free_response_callback;
787 request->ack = p->ack;
788 request->length = length;
790 memcpy(request->data, data, length);
792 memcpy(request->request_header, p->header, sizeof(p->header));
797 void fw_send_response(struct fw_card *card,
798 struct fw_request *request, int rcode)
800 if (WARN_ONCE(!request, "invalid for FCP address handlers"))
803 /* unified transaction or broadcast transaction: don't respond */
804 if (request->ack != ACK_PENDING ||
805 HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
810 if (rcode == RCODE_COMPLETE)
811 fw_fill_response(&request->response, request->request_header,
812 rcode, request->data,
813 fw_get_response_length(request));
815 fw_fill_response(&request->response, request->request_header,
818 card->driver->send_response(card, &request->response);
820 EXPORT_SYMBOL(fw_send_response);
822 static void handle_exclusive_region_request(struct fw_card *card,
824 struct fw_request *request,
825 unsigned long long offset)
827 struct fw_address_handler *handler;
829 int tcode, destination, source;
831 destination = HEADER_GET_DESTINATION(p->header[0]);
832 source = HEADER_GET_SOURCE(p->header[1]);
833 tcode = HEADER_GET_TCODE(p->header[0]);
834 if (tcode == TCODE_LOCK_REQUEST)
835 tcode = 0x10 + HEADER_GET_EXTENDED_TCODE(p->header[3]);
837 spin_lock_irqsave(&address_handler_lock, flags);
838 handler = lookup_enclosing_address_handler(&address_handler_list,
839 offset, request->length);
840 spin_unlock_irqrestore(&address_handler_lock, flags);
843 * FIXME: lookup the fw_node corresponding to the sender of
844 * this request and pass that to the address handler instead
845 * of the node ID. We may also want to move the address
846 * allocations to fw_node so we only do this callback if the
847 * upper layers registered it for this node.
851 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
853 handler->address_callback(card, request,
854 tcode, destination, source,
855 p->generation, offset,
856 request->data, request->length,
857 handler->callback_data);
860 static void handle_fcp_region_request(struct fw_card *card,
862 struct fw_request *request,
863 unsigned long long offset)
865 struct fw_address_handler *handler;
867 int tcode, destination, source;
869 if ((offset != (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
870 offset != (CSR_REGISTER_BASE | CSR_FCP_RESPONSE)) ||
871 request->length > 0x200) {
872 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
877 tcode = HEADER_GET_TCODE(p->header[0]);
878 destination = HEADER_GET_DESTINATION(p->header[0]);
879 source = HEADER_GET_SOURCE(p->header[1]);
881 if (tcode != TCODE_WRITE_QUADLET_REQUEST &&
882 tcode != TCODE_WRITE_BLOCK_REQUEST) {
883 fw_send_response(card, request, RCODE_TYPE_ERROR);
888 spin_lock_irqsave(&address_handler_lock, flags);
889 list_for_each_entry(handler, &address_handler_list, link) {
890 if (is_enclosing_handler(handler, offset, request->length))
891 handler->address_callback(card, NULL, tcode,
893 p->generation, offset,
896 handler->callback_data);
898 spin_unlock_irqrestore(&address_handler_lock, flags);
900 fw_send_response(card, request, RCODE_COMPLETE);
903 void fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
905 struct fw_request *request;
906 unsigned long long offset;
908 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
911 if (TCODE_IS_LINK_INTERNAL(HEADER_GET_TCODE(p->header[0]))) {
912 fw_cdev_handle_phy_packet(card, p);
916 request = allocate_request(card, p);
917 if (request == NULL) {
918 /* FIXME: send statically allocated busy packet. */
922 offset = ((u64)HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) |
925 if (!is_in_fcp_region(offset, request->length))
926 handle_exclusive_region_request(card, p, request, offset);
928 handle_fcp_region_request(card, p, request, offset);
931 EXPORT_SYMBOL(fw_core_handle_request);
933 void fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
935 struct fw_transaction *t;
939 int tcode, tlabel, source, rcode;
941 tcode = HEADER_GET_TCODE(p->header[0]);
942 tlabel = HEADER_GET_TLABEL(p->header[0]);
943 source = HEADER_GET_SOURCE(p->header[1]);
944 rcode = HEADER_GET_RCODE(p->header[1]);
946 spin_lock_irqsave(&card->lock, flags);
947 list_for_each_entry(t, &card->transaction_list, link) {
948 if (t->node_id == source && t->tlabel == tlabel) {
949 if (!try_cancel_split_timeout(t)) {
950 spin_unlock_irqrestore(&card->lock, flags);
953 list_del_init(&t->link);
954 card->tlabel_mask &= ~(1ULL << t->tlabel);
958 spin_unlock_irqrestore(&card->lock, flags);
960 if (&t->link == &card->transaction_list) {
962 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
968 * FIXME: sanity check packet, is length correct, does tcodes
969 * and addresses match.
973 case TCODE_READ_QUADLET_RESPONSE:
974 data = (u32 *) &p->header[3];
978 case TCODE_WRITE_RESPONSE:
983 case TCODE_READ_BLOCK_RESPONSE:
984 case TCODE_LOCK_RESPONSE:
986 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
990 /* Should never happen, this is just to shut up gcc. */
997 * The response handler may be executed while the request handler
998 * is still pending. Cancel the request handler.
1000 card->driver->cancel_packet(card, &t->packet);
1002 t->callback(card, rcode, data, data_length, t->callback_data);
1004 EXPORT_SYMBOL(fw_core_handle_response);
1006 static const struct fw_address_region topology_map_region =
1007 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
1008 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
1010 static void handle_topology_map(struct fw_card *card, struct fw_request *request,
1011 int tcode, int destination, int source, int generation,
1012 unsigned long long offset, void *payload, size_t length,
1013 void *callback_data)
1017 if (!TCODE_IS_READ_REQUEST(tcode)) {
1018 fw_send_response(card, request, RCODE_TYPE_ERROR);
1022 if ((offset & 3) > 0 || (length & 3) > 0) {
1023 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
1027 start = (offset - topology_map_region.start) / 4;
1028 memcpy(payload, &card->topology_map[start], length);
1030 fw_send_response(card, request, RCODE_COMPLETE);
1033 static struct fw_address_handler topology_map = {
1035 .address_callback = handle_topology_map,
1038 static const struct fw_address_region registers_region =
1039 { .start = CSR_REGISTER_BASE,
1040 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
1042 static void update_split_timeout(struct fw_card *card)
1044 unsigned int cycles;
1046 cycles = card->split_timeout_hi * 8000 + (card->split_timeout_lo >> 19);
1048 cycles = max(cycles, 800u); /* minimum as per the spec */
1049 cycles = min(cycles, 3u * 8000u); /* maximum OHCI timeout */
1051 card->split_timeout_cycles = cycles;
1052 card->split_timeout_jiffies = DIV_ROUND_UP(cycles * HZ, 8000);
1055 static void handle_registers(struct fw_card *card, struct fw_request *request,
1056 int tcode, int destination, int source, int generation,
1057 unsigned long long offset, void *payload, size_t length,
1058 void *callback_data)
1060 int reg = offset & ~CSR_REGISTER_BASE;
1061 __be32 *data = payload;
1062 int rcode = RCODE_COMPLETE;
1063 unsigned long flags;
1066 case CSR_PRIORITY_BUDGET:
1067 if (!card->priority_budget_implemented) {
1068 rcode = RCODE_ADDRESS_ERROR;
1071 /* else fall through */
1075 * per IEEE 1394-2008 8.3.22.3, not IEEE 1394.1-2004 3.2.8
1076 * and 9.6, but interoperable with IEEE 1394.1-2004 bridges
1080 case CSR_STATE_CLEAR:
1082 case CSR_CYCLE_TIME:
1084 case CSR_BUSY_TIMEOUT:
1085 if (tcode == TCODE_READ_QUADLET_REQUEST)
1086 *data = cpu_to_be32(card->driver->read_csr(card, reg));
1087 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1088 card->driver->write_csr(card, reg, be32_to_cpu(*data));
1090 rcode = RCODE_TYPE_ERROR;
1093 case CSR_RESET_START:
1094 if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1095 card->driver->write_csr(card, CSR_STATE_CLEAR,
1096 CSR_STATE_BIT_ABDICATE);
1098 rcode = RCODE_TYPE_ERROR;
1101 case CSR_SPLIT_TIMEOUT_HI:
1102 if (tcode == TCODE_READ_QUADLET_REQUEST) {
1103 *data = cpu_to_be32(card->split_timeout_hi);
1104 } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) {
1105 spin_lock_irqsave(&card->lock, flags);
1106 card->split_timeout_hi = be32_to_cpu(*data) & 7;
1107 update_split_timeout(card);
1108 spin_unlock_irqrestore(&card->lock, flags);
1110 rcode = RCODE_TYPE_ERROR;
1114 case CSR_SPLIT_TIMEOUT_LO:
1115 if (tcode == TCODE_READ_QUADLET_REQUEST) {
1116 *data = cpu_to_be32(card->split_timeout_lo);
1117 } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) {
1118 spin_lock_irqsave(&card->lock, flags);
1119 card->split_timeout_lo =
1120 be32_to_cpu(*data) & 0xfff80000;
1121 update_split_timeout(card);
1122 spin_unlock_irqrestore(&card->lock, flags);
1124 rcode = RCODE_TYPE_ERROR;
1128 case CSR_MAINT_UTILITY:
1129 if (tcode == TCODE_READ_QUADLET_REQUEST)
1130 *data = card->maint_utility_register;
1131 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1132 card->maint_utility_register = *data;
1134 rcode = RCODE_TYPE_ERROR;
1137 case CSR_BROADCAST_CHANNEL:
1138 if (tcode == TCODE_READ_QUADLET_REQUEST)
1139 *data = cpu_to_be32(card->broadcast_channel);
1140 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1141 card->broadcast_channel =
1142 (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
1143 BROADCAST_CHANNEL_INITIAL;
1145 rcode = RCODE_TYPE_ERROR;
1148 case CSR_BUS_MANAGER_ID:
1149 case CSR_BANDWIDTH_AVAILABLE:
1150 case CSR_CHANNELS_AVAILABLE_HI:
1151 case CSR_CHANNELS_AVAILABLE_LO:
1153 * FIXME: these are handled by the OHCI hardware and
1154 * the stack never sees these request. If we add
1155 * support for a new type of controller that doesn't
1156 * handle this in hardware we need to deal with these
1163 rcode = RCODE_ADDRESS_ERROR;
1167 fw_send_response(card, request, rcode);
1170 static struct fw_address_handler registers = {
1172 .address_callback = handle_registers,
1175 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1176 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
1177 MODULE_LICENSE("GPL");
1179 static const u32 vendor_textual_descriptor[] = {
1180 /* textual descriptor leaf () */
1184 0x4c696e75, /* L i n u */
1185 0x78204669, /* x F i */
1186 0x72657769, /* r e w i */
1187 0x72650000, /* r e */
1190 static const u32 model_textual_descriptor[] = {
1191 /* model descriptor leaf () */
1195 0x4a756a75, /* J u j u */
1198 static struct fw_descriptor vendor_id_descriptor = {
1199 .length = ARRAY_SIZE(vendor_textual_descriptor),
1200 .immediate = 0x03d00d1e,
1202 .data = vendor_textual_descriptor,
1205 static struct fw_descriptor model_id_descriptor = {
1206 .length = ARRAY_SIZE(model_textual_descriptor),
1207 .immediate = 0x17000001,
1209 .data = model_textual_descriptor,
1212 static int __init fw_core_init(void)
1216 ret = bus_register(&fw_bus_type);
1220 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
1221 if (fw_cdev_major < 0) {
1222 bus_unregister(&fw_bus_type);
1223 return fw_cdev_major;
1226 fw_core_add_address_handler(&topology_map, &topology_map_region);
1227 fw_core_add_address_handler(®isters, ®isters_region);
1228 fw_core_add_descriptor(&vendor_id_descriptor);
1229 fw_core_add_descriptor(&model_id_descriptor);
1234 static void __exit fw_core_cleanup(void)
1236 unregister_chrdev(fw_cdev_major, "firewire");
1237 bus_unregister(&fw_bus_type);
1238 idr_destroy(&fw_device_idr);
1241 module_init(fw_core_init);
1242 module_exit(fw_core_cleanup);