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/idr.h>
23 #include <linux/kernel.h>
24 #include <linux/kref.h>
25 #include <linux/module.h>
26 #include <linux/mutex.h>
27 #include <linux/init.h>
28 #include <linux/interrupt.h>
29 #include <linux/pci.h>
30 #include <linux/delay.h>
31 #include <linux/poll.h>
32 #include <linux/list.h>
33 #include <linux/kthread.h>
34 #include <asm/uaccess.h>
36 #include "fw-transaction.h"
37 #include "fw-topology.h"
38 #include "fw-device.h"
40 #define HEADER_TAG(tag) ((tag) << 14)
41 #define HEADER_CHANNEL(ch) ((ch) << 8)
42 #define HEADER_SY(sy) ((sy) << 0)
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_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
68 #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
69 #define PHY_IDENTIFIER(id) ((id) << 30)
71 static int close_transaction(struct fw_transaction *transaction,
72 struct fw_card *card, int rcode,
73 u32 *payload, size_t length)
75 struct fw_transaction *t;
78 spin_lock_irqsave(&card->lock, flags);
79 list_for_each_entry(t, &card->transaction_list, link) {
80 if (t == transaction) {
82 card->tlabel_mask &= ~(1 << t->tlabel);
86 spin_unlock_irqrestore(&card->lock, flags);
88 if (&t->link != &card->transaction_list) {
89 t->callback(card, rcode, payload, length, t->callback_data);
97 * Only valid for transactions that are potentially pending (ie have
100 int fw_cancel_transaction(struct fw_card *card,
101 struct fw_transaction *transaction)
104 * Cancel the packet transmission if it's still queued. That
105 * will call the packet transmission callback which cancels
109 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
113 * If the request packet has already been sent, we need to see
114 * if the transaction is still pending and remove it in that case.
117 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
119 EXPORT_SYMBOL(fw_cancel_transaction);
121 static void transmit_complete_callback(struct fw_packet *packet,
122 struct fw_card *card, int status)
124 struct fw_transaction *t =
125 container_of(packet, struct fw_transaction, packet);
129 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
132 t->timestamp = packet->timestamp;
137 close_transaction(t, card, RCODE_BUSY, NULL, 0);
140 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
143 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
147 * In this case the ack is really a juju specific
148 * rcode, so just forward that to the callback.
150 close_transaction(t, card, status, NULL, 0);
155 static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
156 int destination_id, int source_id, int generation, int speed,
157 unsigned long long offset, void *payload, size_t length)
162 ext_tcode = tcode & ~0x10;
163 tcode = TCODE_LOCK_REQUEST;
168 HEADER_RETRY(RETRY_X) |
169 HEADER_TLABEL(tlabel) |
170 HEADER_TCODE(tcode) |
171 HEADER_DESTINATION(destination_id);
173 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
178 case TCODE_WRITE_QUADLET_REQUEST:
179 packet->header[3] = *(u32 *)payload;
180 packet->header_length = 16;
181 packet->payload_length = 0;
184 case TCODE_LOCK_REQUEST:
185 case TCODE_WRITE_BLOCK_REQUEST:
187 HEADER_DATA_LENGTH(length) |
188 HEADER_EXTENDED_TCODE(ext_tcode);
189 packet->header_length = 16;
190 packet->payload = payload;
191 packet->payload_length = length;
194 case TCODE_READ_QUADLET_REQUEST:
195 packet->header_length = 12;
196 packet->payload_length = 0;
199 case TCODE_READ_BLOCK_REQUEST:
201 HEADER_DATA_LENGTH(length) |
202 HEADER_EXTENDED_TCODE(ext_tcode);
203 packet->header_length = 16;
204 packet->payload_length = 0;
208 packet->speed = speed;
209 packet->generation = generation;
211 packet->payload_bus = 0;
215 * This function provides low-level access to the IEEE1394 transaction
216 * logic. Most C programs would use either fw_read(), fw_write() or
217 * fw_lock() instead - those function are convenience wrappers for
218 * this function. The fw_send_request() function is primarily
219 * provided as a flexible, one-stop entry point for languages bindings
220 * and protocol bindings.
222 * FIXME: Document this function further, in particular the possible
223 * values for rcode in the callback. In short, we map ACK_COMPLETE to
224 * RCODE_COMPLETE, internal errors set errno and set rcode to
225 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
226 * rcodes). All other rcodes are forwarded unchanged. For all
227 * errors, payload is NULL, length is 0.
229 * Can not expect the callback to be called before the function
230 * returns, though this does happen in some cases (ACK_COMPLETE and
233 * The payload is only used for write requests and must not be freed
234 * until the callback has been called.
236 * @param card the card from which to send the request
237 * @param tcode the tcode for this transaction. Do not use
238 * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
239 * etc. to specify tcode and ext_tcode.
240 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
241 * @param generation the generation for which node_id is valid
242 * @param speed the speed to use for sending the request
243 * @param offset the 48 bit offset on the destination node
244 * @param payload the data payload for the request subaction
245 * @param length the length in bytes of the data to read
246 * @param callback function to be called when the transaction is completed
247 * @param callback_data pointer to arbitrary data, which will be
248 * passed to the callback
250 void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
251 int destination_id, int generation, int speed,
252 unsigned long long offset, void *payload, size_t length,
253 fw_transaction_callback_t callback, void *callback_data)
259 * Bump the flush timer up 100ms first of all so we
260 * don't race with a flush timer callback.
263 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
266 * Allocate tlabel from the bitmap and put the transaction on
267 * the list while holding the card spinlock.
270 spin_lock_irqsave(&card->lock, flags);
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 t->node_id = destination_id;
284 t->callback = callback;
285 t->callback_data = callback_data;
287 fw_fill_request(&t->packet, tcode, t->tlabel,
288 destination_id, card->node_id, generation,
289 speed, offset, payload, length);
290 t->packet.callback = transmit_complete_callback;
292 list_add_tail(&t->link, &card->transaction_list);
294 spin_unlock_irqrestore(&card->lock, flags);
296 card->driver->send_request(card, &t->packet);
298 EXPORT_SYMBOL(fw_send_request);
300 void fw_send_stream_packet(struct fw_card *card, struct fw_packet *p,
301 int generation, int speed, int channel, int sy, int tag,
302 void *payload, size_t length, fw_packet_callback_t callback)
304 p->callback = callback;
306 HEADER_DATA_LENGTH(length)
308 | HEADER_CHANNEL(channel)
309 | HEADER_TCODE(TCODE_STREAM_DATA)
311 p->header_length = 4;
312 p->payload = payload;
313 p->payload_length = length;
315 p->generation = generation;
318 card->driver->send_request(card, p);
321 struct transaction_callback_data {
322 struct completion done;
327 static void transaction_callback(struct fw_card *card, int rcode,
328 void *payload, size_t length, void *data)
330 struct transaction_callback_data *d = data;
332 if (rcode == RCODE_COMPLETE)
333 memcpy(d->payload, payload, length);
339 * fw_run_transaction - send request and sleep until transaction is completed
343 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
344 int generation, int speed, unsigned long long offset,
345 void *payload, size_t length)
347 struct transaction_callback_data d;
348 struct fw_transaction t;
350 init_completion(&d.done);
352 fw_send_request(card, &t, tcode, destination_id, generation, speed,
353 offset, payload, length, transaction_callback, &d);
354 wait_for_completion(&d.done);
358 EXPORT_SYMBOL(fw_run_transaction);
360 static DEFINE_MUTEX(phy_config_mutex);
361 static DECLARE_COMPLETION(phy_config_done);
363 static void transmit_phy_packet_callback(struct fw_packet *packet,
364 struct fw_card *card, int status)
366 complete(&phy_config_done);
369 static struct fw_packet phy_config_packet = {
373 .callback = transmit_phy_packet_callback,
376 void fw_send_phy_config(struct fw_card *card,
377 int node_id, int generation, int gap_count)
379 long timeout = DIV_ROUND_UP(HZ, 10);
380 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
381 PHY_CONFIG_ROOT_ID(node_id) |
382 PHY_CONFIG_GAP_COUNT(gap_count);
384 mutex_lock(&phy_config_mutex);
386 phy_config_packet.header[0] = data;
387 phy_config_packet.header[1] = ~data;
388 phy_config_packet.generation = generation;
389 INIT_COMPLETION(phy_config_done);
391 card->driver->send_request(card, &phy_config_packet);
392 wait_for_completion_timeout(&phy_config_done, timeout);
394 mutex_unlock(&phy_config_mutex);
397 void fw_flush_transactions(struct fw_card *card)
399 struct fw_transaction *t, *next;
400 struct list_head list;
403 INIT_LIST_HEAD(&list);
404 spin_lock_irqsave(&card->lock, flags);
405 list_splice_init(&card->transaction_list, &list);
406 card->tlabel_mask = 0;
407 spin_unlock_irqrestore(&card->lock, flags);
409 list_for_each_entry_safe(t, next, &list, link) {
410 card->driver->cancel_packet(card, &t->packet);
413 * At this point cancel_packet will never call the
414 * transaction callback, since we just took all the
415 * transactions out of the list. So do it here.
417 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
421 static struct fw_address_handler *lookup_overlapping_address_handler(
422 struct list_head *list, unsigned long long offset, size_t length)
424 struct fw_address_handler *handler;
426 list_for_each_entry(handler, list, link) {
427 if (handler->offset < offset + length &&
428 offset < handler->offset + handler->length)
435 static struct fw_address_handler *lookup_enclosing_address_handler(
436 struct list_head *list, unsigned long long offset, size_t length)
438 struct fw_address_handler *handler;
440 list_for_each_entry(handler, list, link) {
441 if (handler->offset <= offset &&
442 offset + length <= handler->offset + handler->length)
449 static DEFINE_SPINLOCK(address_handler_lock);
450 static LIST_HEAD(address_handler_list);
452 const struct fw_address_region fw_high_memory_region =
453 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
454 EXPORT_SYMBOL(fw_high_memory_region);
457 const struct fw_address_region fw_low_memory_region =
458 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
459 const struct fw_address_region fw_private_region =
460 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
461 const struct fw_address_region fw_csr_region =
462 { .start = CSR_REGISTER_BASE,
463 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
464 const struct fw_address_region fw_unit_space_region =
465 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
469 * fw_core_add_address_handler - register for incoming requests
471 * @region: region in the IEEE 1212 node space address range
473 * region->start, ->end, and handler->length have to be quadlet-aligned.
475 * When a request is received that falls within the specified address range,
476 * the specified callback is invoked. The parameters passed to the callback
477 * give the details of the particular request.
479 * Return value: 0 on success, non-zero otherwise.
480 * The start offset of the handler's address region is determined by
481 * fw_core_add_address_handler() and is returned in handler->offset.
483 int fw_core_add_address_handler(struct fw_address_handler *handler,
484 const struct fw_address_region *region)
486 struct fw_address_handler *other;
490 if (region->start & 0xffff000000000003ULL ||
491 region->end & 0xffff000000000003ULL ||
492 region->start >= region->end ||
493 handler->length & 3 ||
494 handler->length == 0)
497 spin_lock_irqsave(&address_handler_lock, flags);
499 handler->offset = region->start;
500 while (handler->offset + handler->length <= region->end) {
502 lookup_overlapping_address_handler(&address_handler_list,
506 handler->offset += other->length;
508 list_add_tail(&handler->link, &address_handler_list);
514 spin_unlock_irqrestore(&address_handler_lock, flags);
518 EXPORT_SYMBOL(fw_core_add_address_handler);
521 * fw_core_remove_address_handler - unregister an address handler
523 void fw_core_remove_address_handler(struct fw_address_handler *handler)
527 spin_lock_irqsave(&address_handler_lock, flags);
528 list_del(&handler->link);
529 spin_unlock_irqrestore(&address_handler_lock, flags);
531 EXPORT_SYMBOL(fw_core_remove_address_handler);
534 struct fw_packet response;
535 u32 request_header[4];
541 static void free_response_callback(struct fw_packet *packet,
542 struct fw_card *card, int status)
544 struct fw_request *request;
546 request = container_of(packet, struct fw_request, response);
550 void fw_fill_response(struct fw_packet *response, u32 *request_header,
551 int rcode, void *payload, size_t length)
553 int tcode, tlabel, extended_tcode, source, destination;
555 tcode = HEADER_GET_TCODE(request_header[0]);
556 tlabel = HEADER_GET_TLABEL(request_header[0]);
557 source = HEADER_GET_DESTINATION(request_header[0]);
558 destination = HEADER_GET_SOURCE(request_header[1]);
559 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
561 response->header[0] =
562 HEADER_RETRY(RETRY_1) |
563 HEADER_TLABEL(tlabel) |
564 HEADER_DESTINATION(destination);
565 response->header[1] =
566 HEADER_SOURCE(source) |
568 response->header[2] = 0;
571 case TCODE_WRITE_QUADLET_REQUEST:
572 case TCODE_WRITE_BLOCK_REQUEST:
573 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
574 response->header_length = 12;
575 response->payload_length = 0;
578 case TCODE_READ_QUADLET_REQUEST:
579 response->header[0] |=
580 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
582 response->header[3] = *(u32 *)payload;
584 response->header[3] = 0;
585 response->header_length = 16;
586 response->payload_length = 0;
589 case TCODE_READ_BLOCK_REQUEST:
590 case TCODE_LOCK_REQUEST:
591 response->header[0] |= HEADER_TCODE(tcode + 2);
592 response->header[3] =
593 HEADER_DATA_LENGTH(length) |
594 HEADER_EXTENDED_TCODE(extended_tcode);
595 response->header_length = 16;
596 response->payload = payload;
597 response->payload_length = length;
605 response->payload_bus = 0;
607 EXPORT_SYMBOL(fw_fill_response);
609 static struct fw_request *allocate_request(struct fw_packet *p)
611 struct fw_request *request;
613 int request_tcode, t;
615 request_tcode = HEADER_GET_TCODE(p->header[0]);
616 switch (request_tcode) {
617 case TCODE_WRITE_QUADLET_REQUEST:
618 data = &p->header[3];
622 case TCODE_WRITE_BLOCK_REQUEST:
623 case TCODE_LOCK_REQUEST:
625 length = HEADER_GET_DATA_LENGTH(p->header[3]);
628 case TCODE_READ_QUADLET_REQUEST:
633 case TCODE_READ_BLOCK_REQUEST:
635 length = HEADER_GET_DATA_LENGTH(p->header[3]);
639 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
640 p->header[0], p->header[1], p->header[2]);
644 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
648 t = (p->timestamp & 0x1fff) + 4000;
650 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
652 t = (p->timestamp & ~0x1fff) + t;
654 request->response.speed = p->speed;
655 request->response.timestamp = t;
656 request->response.generation = p->generation;
657 request->response.ack = 0;
658 request->response.callback = free_response_callback;
659 request->ack = p->ack;
660 request->length = length;
662 memcpy(request->data, data, length);
664 memcpy(request->request_header, p->header, sizeof(p->header));
669 void fw_send_response(struct fw_card *card,
670 struct fw_request *request, int rcode)
672 /* unified transaction or broadcast transaction: don't respond */
673 if (request->ack != ACK_PENDING ||
674 HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
679 if (rcode == RCODE_COMPLETE)
680 fw_fill_response(&request->response, request->request_header,
681 rcode, request->data, request->length);
683 fw_fill_response(&request->response, request->request_header,
686 card->driver->send_response(card, &request->response);
688 EXPORT_SYMBOL(fw_send_response);
690 void fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
692 struct fw_address_handler *handler;
693 struct fw_request *request;
694 unsigned long long offset;
696 int tcode, destination, source;
698 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
701 request = allocate_request(p);
702 if (request == NULL) {
703 /* FIXME: send statically allocated busy packet. */
708 ((unsigned long long)
709 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
710 tcode = HEADER_GET_TCODE(p->header[0]);
711 destination = HEADER_GET_DESTINATION(p->header[0]);
712 source = HEADER_GET_SOURCE(p->header[1]);
714 spin_lock_irqsave(&address_handler_lock, flags);
715 handler = lookup_enclosing_address_handler(&address_handler_list,
716 offset, request->length);
717 spin_unlock_irqrestore(&address_handler_lock, flags);
720 * FIXME: lookup the fw_node corresponding to the sender of
721 * this request and pass that to the address handler instead
722 * of the node ID. We may also want to move the address
723 * allocations to fw_node so we only do this callback if the
724 * upper layers registered it for this node.
728 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
730 handler->address_callback(card, request,
731 tcode, destination, source,
732 p->generation, p->speed, offset,
733 request->data, request->length,
734 handler->callback_data);
736 EXPORT_SYMBOL(fw_core_handle_request);
738 void fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
740 struct fw_transaction *t;
744 int tcode, tlabel, destination, source, rcode;
746 tcode = HEADER_GET_TCODE(p->header[0]);
747 tlabel = HEADER_GET_TLABEL(p->header[0]);
748 destination = HEADER_GET_DESTINATION(p->header[0]);
749 source = HEADER_GET_SOURCE(p->header[1]);
750 rcode = HEADER_GET_RCODE(p->header[1]);
752 spin_lock_irqsave(&card->lock, flags);
753 list_for_each_entry(t, &card->transaction_list, link) {
754 if (t->node_id == source && t->tlabel == tlabel) {
756 card->tlabel_mask &= ~(1 << t->tlabel);
760 spin_unlock_irqrestore(&card->lock, flags);
762 if (&t->link == &card->transaction_list) {
763 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
769 * FIXME: sanity check packet, is length correct, does tcodes
770 * and addresses match.
774 case TCODE_READ_QUADLET_RESPONSE:
775 data = (u32 *) &p->header[3];
779 case TCODE_WRITE_RESPONSE:
784 case TCODE_READ_BLOCK_RESPONSE:
785 case TCODE_LOCK_RESPONSE:
787 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
791 /* Should never happen, this is just to shut up gcc. */
798 * The response handler may be executed while the request handler
799 * is still pending. Cancel the request handler.
801 card->driver->cancel_packet(card, &t->packet);
803 t->callback(card, rcode, data, data_length, t->callback_data);
805 EXPORT_SYMBOL(fw_core_handle_response);
807 static const struct fw_address_region topology_map_region =
808 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
809 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
811 static void handle_topology_map(struct fw_card *card, struct fw_request *request,
812 int tcode, int destination, int source, int generation,
813 int speed, unsigned long long offset,
814 void *payload, size_t length, void *callback_data)
819 if (!TCODE_IS_READ_REQUEST(tcode)) {
820 fw_send_response(card, request, RCODE_TYPE_ERROR);
824 if ((offset & 3) > 0 || (length & 3) > 0) {
825 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
829 start = (offset - topology_map_region.start) / 4;
830 end = start + length / 4;
833 for (i = 0; i < length / 4; i++)
834 map[i] = cpu_to_be32(card->topology_map[start + i]);
836 fw_send_response(card, request, RCODE_COMPLETE);
839 static struct fw_address_handler topology_map = {
841 .address_callback = handle_topology_map,
844 static const struct fw_address_region registers_region =
845 { .start = CSR_REGISTER_BASE,
846 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
848 static void handle_registers(struct fw_card *card, struct fw_request *request,
849 int tcode, int destination, int source, int generation,
850 int speed, unsigned long long offset,
851 void *payload, size_t length, void *callback_data)
853 int reg = offset & ~CSR_REGISTER_BASE;
854 unsigned long long bus_time;
855 __be32 *data = payload;
856 int rcode = RCODE_COMPLETE;
861 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
862 rcode = RCODE_TYPE_ERROR;
866 bus_time = card->driver->get_bus_time(card);
867 if (reg == CSR_CYCLE_TIME)
868 *data = cpu_to_be32(bus_time);
870 *data = cpu_to_be32(bus_time >> 25);
873 case CSR_BROADCAST_CHANNEL:
874 if (tcode == TCODE_READ_QUADLET_REQUEST)
875 *data = cpu_to_be32(card->broadcast_channel);
876 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
877 card->broadcast_channel =
878 (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
879 BROADCAST_CHANNEL_INITIAL;
881 rcode = RCODE_TYPE_ERROR;
884 case CSR_BUS_MANAGER_ID:
885 case CSR_BANDWIDTH_AVAILABLE:
886 case CSR_CHANNELS_AVAILABLE_HI:
887 case CSR_CHANNELS_AVAILABLE_LO:
889 * FIXME: these are handled by the OHCI hardware and
890 * the stack never sees these request. If we add
891 * support for a new type of controller that doesn't
892 * handle this in hardware we need to deal with these
898 case CSR_BUSY_TIMEOUT:
899 /* FIXME: Implement this. */
902 rcode = RCODE_ADDRESS_ERROR;
906 fw_send_response(card, request, rcode);
909 static struct fw_address_handler registers = {
911 .address_callback = handle_registers,
914 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
915 MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
916 MODULE_LICENSE("GPL");
918 static const u32 vendor_textual_descriptor[] = {
919 /* textual descriptor leaf () */
923 0x4c696e75, /* L i n u */
924 0x78204669, /* x F i */
925 0x72657769, /* r e w i */
926 0x72650000, /* r e */
929 static const u32 model_textual_descriptor[] = {
930 /* model descriptor leaf () */
934 0x4a756a75, /* J u j u */
937 static struct fw_descriptor vendor_id_descriptor = {
938 .length = ARRAY_SIZE(vendor_textual_descriptor),
939 .immediate = 0x03d00d1e,
941 .data = vendor_textual_descriptor,
944 static struct fw_descriptor model_id_descriptor = {
945 .length = ARRAY_SIZE(model_textual_descriptor),
946 .immediate = 0x17000001,
948 .data = model_textual_descriptor,
951 static int __init fw_core_init(void)
955 ret = bus_register(&fw_bus_type);
959 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
960 if (fw_cdev_major < 0) {
961 bus_unregister(&fw_bus_type);
962 return fw_cdev_major;
965 fw_core_add_address_handler(&topology_map, &topology_map_region);
966 fw_core_add_address_handler(®isters, ®isters_region);
967 fw_core_add_descriptor(&vendor_id_descriptor);
968 fw_core_add_descriptor(&model_id_descriptor);
973 static void __exit fw_core_cleanup(void)
975 unregister_chrdev(fw_cdev_major, "firewire");
976 bus_unregister(&fw_bus_type);
977 idr_destroy(&fw_device_idr);
980 module_init(fw_core_init);
981 module_exit(fw_core_cleanup);