]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/firewire/fw-transaction.c
firewire: fw-ohci: unify printk prefixes
[mirror_ubuntu-zesty-kernel.git] / drivers / firewire / fw-transaction.c
CommitLineData
c781c06d
KH
1/*
2 * Core IEEE1394 transaction logic
3038e353
KH
3 *
4 * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net>
5 *
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.
10 *
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.
15 *
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.
19 */
20
2a0a2590 21#include <linux/completion.h>
3038e353
KH
22#include <linux/kernel.h>
23#include <linux/module.h>
24#include <linux/init.h>
25#include <linux/interrupt.h>
26#include <linux/pci.h>
27#include <linux/delay.h>
28#include <linux/poll.h>
29#include <linux/list.h>
30#include <linux/kthread.h>
31#include <asm/uaccess.h>
3038e353
KH
32
33#include "fw-transaction.h"
34#include "fw-topology.h"
19a15b93 35#include "fw-device.h"
3038e353 36
a77754a7
KH
37#define HEADER_PRI(pri) ((pri) << 0)
38#define HEADER_TCODE(tcode) ((tcode) << 4)
39#define HEADER_RETRY(retry) ((retry) << 8)
40#define HEADER_TLABEL(tlabel) ((tlabel) << 10)
41#define HEADER_DESTINATION(destination) ((destination) << 16)
42#define HEADER_SOURCE(source) ((source) << 16)
43#define HEADER_RCODE(rcode) ((rcode) << 12)
44#define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0)
45#define HEADER_DATA_LENGTH(length) ((length) << 16)
46#define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0)
47
48#define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
49#define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f)
50#define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f)
51#define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
52#define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff)
53#define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
54#define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
55#define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
56
57#define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
58#define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
59#define PHY_IDENTIFIER(id) ((id) << 30)
3038e353 60
730c32f5
KH
61static int
62close_transaction(struct fw_transaction *transaction,
63 struct fw_card *card, int rcode,
64 u32 *payload, size_t length)
3038e353 65{
730c32f5 66 struct fw_transaction *t;
3038e353
KH
67 unsigned long flags;
68
69 spin_lock_irqsave(&card->lock, flags);
730c32f5
KH
70 list_for_each_entry(t, &card->transaction_list, link) {
71 if (t == transaction) {
72 list_del(&t->link);
73 card->tlabel_mask &= ~(1 << t->tlabel);
74 break;
75 }
76 }
3038e353
KH
77 spin_unlock_irqrestore(&card->lock, flags);
78
730c32f5
KH
79 if (&t->link != &card->transaction_list) {
80 t->callback(card, rcode, payload, length, t->callback_data);
81 return 0;
82 }
83
84 return -ENOENT;
3038e353
KH
85}
86
c781c06d
KH
87/*
88 * Only valid for transactions that are potentially pending (ie have
89 * been sent).
90 */
730c32f5
KH
91int
92fw_cancel_transaction(struct fw_card *card,
93 struct fw_transaction *transaction)
94{
c781c06d
KH
95 /*
96 * Cancel the packet transmission if it's still queued. That
730c32f5 97 * will call the packet transmission callback which cancels
c781c06d
KH
98 * the transaction.
99 */
730c32f5
KH
100
101 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
102 return 0;
103
c781c06d
KH
104 /*
105 * If the request packet has already been sent, we need to see
106 * if the transaction is still pending and remove it in that case.
107 */
730c32f5
KH
108
109 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
110}
111EXPORT_SYMBOL(fw_cancel_transaction);
112
3038e353
KH
113static void
114transmit_complete_callback(struct fw_packet *packet,
115 struct fw_card *card, int status)
116{
117 struct fw_transaction *t =
118 container_of(packet, struct fw_transaction, packet);
119
120 switch (status) {
121 case ACK_COMPLETE:
122 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
123 break;
124 case ACK_PENDING:
125 t->timestamp = packet->timestamp;
126 break;
127 case ACK_BUSY_X:
128 case ACK_BUSY_A:
129 case ACK_BUSY_B:
130 close_transaction(t, card, RCODE_BUSY, NULL, 0);
131 break;
132 case ACK_DATA_ERROR:
e5f49c3b
KH
133 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
134 break;
3038e353 135 case ACK_TYPE_ERROR:
e5f49c3b 136 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
3038e353
KH
137 break;
138 default:
c781c06d
KH
139 /*
140 * In this case the ack is really a juju specific
141 * rcode, so just forward that to the callback.
142 */
e5f49c3b 143 close_transaction(t, card, status, NULL, 0);
3038e353
KH
144 break;
145 }
146}
147
95688e97 148static void
36bfe49d 149fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
473d28c7 150 int node_id, int source_id, int generation, int speed,
36bfe49d 151 unsigned long long offset, void *payload, size_t length)
3038e353
KH
152{
153 int ext_tcode;
154
155 if (tcode > 0x10) {
8f9f963e 156 ext_tcode = tcode & ~0x10;
3038e353
KH
157 tcode = TCODE_LOCK_REQUEST;
158 } else
159 ext_tcode = 0;
160
161 packet->header[0] =
a77754a7
KH
162 HEADER_RETRY(RETRY_X) |
163 HEADER_TLABEL(tlabel) |
164 HEADER_TCODE(tcode) |
165 HEADER_DESTINATION(node_id);
3038e353 166 packet->header[1] =
a77754a7 167 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
3038e353
KH
168 packet->header[2] =
169 offset;
170
171 switch (tcode) {
172 case TCODE_WRITE_QUADLET_REQUEST:
173 packet->header[3] = *(u32 *)payload;
174 packet->header_length = 16;
175 packet->payload_length = 0;
176 break;
177
178 case TCODE_LOCK_REQUEST:
179 case TCODE_WRITE_BLOCK_REQUEST:
180 packet->header[3] =
a77754a7
KH
181 HEADER_DATA_LENGTH(length) |
182 HEADER_EXTENDED_TCODE(ext_tcode);
3038e353
KH
183 packet->header_length = 16;
184 packet->payload = payload;
185 packet->payload_length = length;
186 break;
187
188 case TCODE_READ_QUADLET_REQUEST:
189 packet->header_length = 12;
190 packet->payload_length = 0;
191 break;
192
193 case TCODE_READ_BLOCK_REQUEST:
194 packet->header[3] =
a77754a7
KH
195 HEADER_DATA_LENGTH(length) |
196 HEADER_EXTENDED_TCODE(ext_tcode);
3038e353
KH
197 packet->header_length = 16;
198 packet->payload_length = 0;
199 break;
200 }
201
202 packet->speed = speed;
203 packet->generation = generation;
730c32f5 204 packet->ack = 0;
3038e353
KH
205}
206
207/**
208 * This function provides low-level access to the IEEE1394 transaction
209 * logic. Most C programs would use either fw_read(), fw_write() or
210 * fw_lock() instead - those function are convenience wrappers for
211 * this function. The fw_send_request() function is primarily
212 * provided as a flexible, one-stop entry point for languages bindings
213 * and protocol bindings.
214 *
215 * FIXME: Document this function further, in particular the possible
216 * values for rcode in the callback. In short, we map ACK_COMPLETE to
217 * RCODE_COMPLETE, internal errors set errno and set rcode to
218 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
219 * rcodes). All other rcodes are forwarded unchanged. For all
220 * errors, payload is NULL, length is 0.
221 *
222 * Can not expect the callback to be called before the function
223 * returns, though this does happen in some cases (ACK_COMPLETE and
224 * errors).
225 *
226 * The payload is only used for write requests and must not be freed
227 * until the callback has been called.
228 *
229 * @param card the card from which to send the request
230 * @param tcode the tcode for this transaction. Do not use
dbe7f76d 231 * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
3038e353 232 * etc. to specify tcode and ext_tcode.
907293d7 233 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
3038e353
KH
234 * @param generation the generation for which node_id is valid
235 * @param speed the speed to use for sending the request
236 * @param offset the 48 bit offset on the destination node
237 * @param payload the data payload for the request subaction
238 * @param length the length in bytes of the data to read
239 * @param callback function to be called when the transaction is completed
240 * @param callback_data pointer to arbitrary data, which will be
241 * passed to the callback
242 */
243void
244fw_send_request(struct fw_card *card, struct fw_transaction *t,
245 int tcode, int node_id, int generation, int speed,
246 unsigned long long offset,
247 void *payload, size_t length,
248 fw_transaction_callback_t callback, void *callback_data)
249{
250 unsigned long flags;
473d28c7 251 int tlabel, source;
3038e353 252
c781c06d
KH
253 /*
254 * Bump the flush timer up 100ms first of all so we
255 * don't race with a flush timer callback.
256 */
3038e353
KH
257
258 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
259
c781c06d
KH
260 /*
261 * Allocate tlabel from the bitmap and put the transaction on
262 * the list while holding the card spinlock.
263 */
3038e353
KH
264
265 spin_lock_irqsave(&card->lock, flags);
266
473d28c7 267 source = card->node_id;
3038e353
KH
268 tlabel = card->current_tlabel;
269 if (card->tlabel_mask & (1 << tlabel)) {
270 spin_unlock_irqrestore(&card->lock, flags);
271 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
272 return;
273 }
274
275 card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
276 card->tlabel_mask |= (1 << tlabel);
277
278 list_add_tail(&t->link, &card->transaction_list);
279
280 spin_unlock_irqrestore(&card->lock, flags);
281
282 /* Initialize rest of transaction, fill out packet and send it. */
283 t->node_id = node_id;
284 t->tlabel = tlabel;
285 t->callback = callback;
286 t->callback_data = callback_data;
287
36bfe49d 288 fw_fill_request(&t->packet, tcode, t->tlabel,
473d28c7
KH
289 node_id, source, generation,
290 speed, offset, payload, length);
3038e353
KH
291 t->packet.callback = transmit_complete_callback;
292
293 card->driver->send_request(card, &t->packet);
294}
295EXPORT_SYMBOL(fw_send_request);
296
2a0a2590
SR
297struct fw_phy_packet {
298 struct fw_packet packet;
299 struct completion done;
300};
301
3038e353
KH
302static void
303transmit_phy_packet_callback(struct fw_packet *packet,
304 struct fw_card *card, int status)
305{
2a0a2590
SR
306 struct fw_phy_packet *p =
307 container_of(packet, struct fw_phy_packet, packet);
3038e353 308
2a0a2590 309 complete(&p->done);
3038e353
KH
310}
311
83db801c
KH
312void fw_send_phy_config(struct fw_card *card,
313 int node_id, int generation, int gap_count)
3038e353 314{
2a0a2590
SR
315 struct fw_phy_packet p;
316 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
317 PHY_CONFIG_ROOT_ID(node_id) |
318 PHY_CONFIG_GAP_COUNT(gap_count);
319
320 p.packet.header[0] = data;
321 p.packet.header[1] = ~data;
322 p.packet.header_length = 8;
323 p.packet.payload_length = 0;
324 p.packet.speed = SCODE_100;
325 p.packet.generation = generation;
326 p.packet.callback = transmit_phy_packet_callback;
327 init_completion(&p.done);
328
329 card->driver->send_request(card, &p.packet);
330 wait_for_completion(&p.done);
3038e353
KH
331}
332
333void fw_flush_transactions(struct fw_card *card)
334{
335 struct fw_transaction *t, *next;
336 struct list_head list;
337 unsigned long flags;
338
339 INIT_LIST_HEAD(&list);
340 spin_lock_irqsave(&card->lock, flags);
341 list_splice_init(&card->transaction_list, &list);
342 card->tlabel_mask = 0;
343 spin_unlock_irqrestore(&card->lock, flags);
344
730c32f5
KH
345 list_for_each_entry_safe(t, next, &list, link) {
346 card->driver->cancel_packet(card, &t->packet);
347
c781c06d
KH
348 /*
349 * At this point cancel_packet will never call the
730c32f5 350 * transaction callback, since we just took all the
c781c06d
KH
351 * transactions out of the list. So do it here.
352 */
3038e353 353 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
730c32f5 354 }
3038e353
KH
355}
356
357static struct fw_address_handler *
358lookup_overlapping_address_handler(struct list_head *list,
359 unsigned long long offset, size_t length)
360{
361 struct fw_address_handler *handler;
362
363 list_for_each_entry(handler, list, link) {
364 if (handler->offset < offset + length &&
365 offset < handler->offset + handler->length)
366 return handler;
367 }
368
369 return NULL;
370}
371
372static struct fw_address_handler *
373lookup_enclosing_address_handler(struct list_head *list,
374 unsigned long long offset, size_t length)
375{
376 struct fw_address_handler *handler;
377
378 list_for_each_entry(handler, list, link) {
379 if (handler->offset <= offset &&
380 offset + length <= handler->offset + handler->length)
381 return handler;
382 }
383
384 return NULL;
385}
386
387static DEFINE_SPINLOCK(address_handler_lock);
388static LIST_HEAD(address_handler_list);
389
21ebcd12 390const struct fw_address_region fw_high_memory_region =
5af4e5ea 391 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
db8be076
AB
392EXPORT_SYMBOL(fw_high_memory_region);
393
394#if 0
395const struct fw_address_region fw_low_memory_region =
396 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
21ebcd12 397const struct fw_address_region fw_private_region =
5af4e5ea 398 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
21ebcd12 399const struct fw_address_region fw_csr_region =
cca60977
JW
400 { .start = CSR_REGISTER_BASE,
401 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
21ebcd12 402const struct fw_address_region fw_unit_space_region =
5af4e5ea 403 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
db8be076 404#endif /* 0 */
3038e353
KH
405
406/**
407 * Allocate a range of addresses in the node space of the OHCI
408 * controller. When a request is received that falls within the
409 * specified address range, the specified callback is invoked. The
410 * parameters passed to the callback give the details of the
1415d918
SR
411 * particular request.
412 *
413 * Return value: 0 on success, non-zero otherwise.
414 * The start offset of the handler's address region is determined by
415 * fw_core_add_address_handler() and is returned in handler->offset.
416 * The offset is quadlet-aligned.
3038e353 417 */
3038e353
KH
418int
419fw_core_add_address_handler(struct fw_address_handler *handler,
21ebcd12 420 const struct fw_address_region *region)
3038e353
KH
421{
422 struct fw_address_handler *other;
423 unsigned long flags;
424 int ret = -EBUSY;
425
426 spin_lock_irqsave(&address_handler_lock, flags);
427
1415d918 428 handler->offset = roundup(region->start, 4);
3038e353
KH
429 while (handler->offset + handler->length <= region->end) {
430 other =
431 lookup_overlapping_address_handler(&address_handler_list,
432 handler->offset,
433 handler->length);
434 if (other != NULL) {
1415d918
SR
435 handler->offset =
436 roundup(other->offset + other->length, 4);
3038e353
KH
437 } else {
438 list_add_tail(&handler->link, &address_handler_list);
439 ret = 0;
440 break;
441 }
442 }
443
444 spin_unlock_irqrestore(&address_handler_lock, flags);
445
446 return ret;
447}
3038e353
KH
448EXPORT_SYMBOL(fw_core_add_address_handler);
449
450/**
451 * Deallocate a range of addresses allocated with fw_allocate. This
452 * will call the associated callback one last time with a the special
453 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
454 * callback data. For convenience, the callback parameters offset and
455 * length are set to the start and the length respectively for the
456 * deallocated region, payload is set to NULL.
457 */
3038e353
KH
458void fw_core_remove_address_handler(struct fw_address_handler *handler)
459{
460 unsigned long flags;
461
462 spin_lock_irqsave(&address_handler_lock, flags);
463 list_del(&handler->link);
464 spin_unlock_irqrestore(&address_handler_lock, flags);
465}
3038e353
KH
466EXPORT_SYMBOL(fw_core_remove_address_handler);
467
468struct fw_request {
469 struct fw_packet response;
36bfe49d 470 u32 request_header[4];
3038e353
KH
471 int ack;
472 u32 length;
473 u32 data[0];
474};
475
476static void
477free_response_callback(struct fw_packet *packet,
478 struct fw_card *card, int status)
479{
480 struct fw_request *request;
481
482 request = container_of(packet, struct fw_request, response);
483 kfree(request);
484}
485
93c4cceb 486void
36bfe49d
KH
487fw_fill_response(struct fw_packet *response, u32 *request_header,
488 int rcode, void *payload, size_t length)
3038e353
KH
489{
490 int tcode, tlabel, extended_tcode, source, destination;
491
a77754a7
KH
492 tcode = HEADER_GET_TCODE(request_header[0]);
493 tlabel = HEADER_GET_TLABEL(request_header[0]);
494 source = HEADER_GET_DESTINATION(request_header[0]);
495 destination = HEADER_GET_SOURCE(request_header[1]);
496 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
3038e353
KH
497
498 response->header[0] =
a77754a7
KH
499 HEADER_RETRY(RETRY_1) |
500 HEADER_TLABEL(tlabel) |
501 HEADER_DESTINATION(destination);
36bfe49d 502 response->header[1] =
a77754a7
KH
503 HEADER_SOURCE(source) |
504 HEADER_RCODE(rcode);
3038e353
KH
505 response->header[2] = 0;
506
507 switch (tcode) {
508 case TCODE_WRITE_QUADLET_REQUEST:
509 case TCODE_WRITE_BLOCK_REQUEST:
a77754a7 510 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
3038e353
KH
511 response->header_length = 12;
512 response->payload_length = 0;
513 break;
514
515 case TCODE_READ_QUADLET_REQUEST:
516 response->header[0] |=
a77754a7 517 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
93c4cceb
KH
518 if (payload != NULL)
519 response->header[3] = *(u32 *)payload;
520 else
521 response->header[3] = 0;
3038e353
KH
522 response->header_length = 16;
523 response->payload_length = 0;
524 break;
525
526 case TCODE_READ_BLOCK_REQUEST:
527 case TCODE_LOCK_REQUEST:
a77754a7 528 response->header[0] |= HEADER_TCODE(tcode + 2);
3038e353 529 response->header[3] =
a77754a7
KH
530 HEADER_DATA_LENGTH(length) |
531 HEADER_EXTENDED_TCODE(extended_tcode);
3038e353 532 response->header_length = 16;
36bfe49d
KH
533 response->payload = payload;
534 response->payload_length = length;
3038e353
KH
535 break;
536
537 default:
538 BUG();
539 return;
540 }
541}
93c4cceb 542EXPORT_SYMBOL(fw_fill_response);
3038e353
KH
543
544static struct fw_request *
2639a6fb 545allocate_request(struct fw_packet *p)
3038e353
KH
546{
547 struct fw_request *request;
548 u32 *data, length;
2639a6fb 549 int request_tcode, t;
3038e353 550
a77754a7 551 request_tcode = HEADER_GET_TCODE(p->header[0]);
3038e353
KH
552 switch (request_tcode) {
553 case TCODE_WRITE_QUADLET_REQUEST:
2639a6fb 554 data = &p->header[3];
3038e353
KH
555 length = 4;
556 break;
557
558 case TCODE_WRITE_BLOCK_REQUEST:
559 case TCODE_LOCK_REQUEST:
2639a6fb 560 data = p->payload;
a77754a7 561 length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
562 break;
563
564 case TCODE_READ_QUADLET_REQUEST:
565 data = NULL;
566 length = 4;
567 break;
568
569 case TCODE_READ_BLOCK_REQUEST:
570 data = NULL;
a77754a7 571 length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
572 break;
573
574 default:
0bf607c5
SR
575 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
576 p->header[0], p->header[1], p->header[2]);
3038e353
KH
577 return NULL;
578 }
579
2d826cc5 580 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
3038e353
KH
581 if (request == NULL)
582 return NULL;
583
2639a6fb
KH
584 t = (p->timestamp & 0x1fff) + 4000;
585 if (t >= 8000)
586 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
587 else
588 t = (p->timestamp & ~0x1fff) + t;
589
590 request->response.speed = p->speed;
591 request->response.timestamp = t;
592 request->response.generation = p->generation;
730c32f5 593 request->response.ack = 0;
3038e353 594 request->response.callback = free_response_callback;
2639a6fb 595 request->ack = p->ack;
93c4cceb 596 request->length = length;
3038e353 597 if (data)
6e2e8424 598 memcpy(request->data, data, length);
3038e353 599
2d826cc5 600 memcpy(request->request_header, p->header, sizeof(p->header));
3038e353
KH
601
602 return request;
603}
604
605void
606fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
607{
c781c06d
KH
608 /*
609 * Broadcast packets are reported as ACK_COMPLETE, so this
3038e353 610 * check is sufficient to ensure we don't send response to
c781c06d
KH
611 * broadcast packets or posted writes.
612 */
9c9bdf4d
SR
613 if (request->ack != ACK_PENDING) {
614 kfree(request);
3038e353 615 return;
9c9bdf4d 616 }
3038e353 617
36bfe49d
KH
618 if (rcode == RCODE_COMPLETE)
619 fw_fill_response(&request->response, request->request_header,
620 rcode, request->data, request->length);
621 else
622 fw_fill_response(&request->response, request->request_header,
623 rcode, NULL, 0);
3038e353
KH
624
625 card->driver->send_response(card, &request->response);
626}
3038e353
KH
627EXPORT_SYMBOL(fw_send_response);
628
629void
2639a6fb 630fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
3038e353
KH
631{
632 struct fw_address_handler *handler;
633 struct fw_request *request;
634 unsigned long long offset;
635 unsigned long flags;
2639a6fb 636 int tcode, destination, source;
3038e353 637
2639a6fb 638 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
3038e353
KH
639 return;
640
2639a6fb 641 request = allocate_request(p);
3038e353
KH
642 if (request == NULL) {
643 /* FIXME: send statically allocated busy packet. */
644 return;
645 }
646
647 offset =
648 ((unsigned long long)
a77754a7
KH
649 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
650 tcode = HEADER_GET_TCODE(p->header[0]);
651 destination = HEADER_GET_DESTINATION(p->header[0]);
478b233e 652 source = HEADER_GET_SOURCE(p->header[1]);
3038e353
KH
653
654 spin_lock_irqsave(&address_handler_lock, flags);
655 handler = lookup_enclosing_address_handler(&address_handler_list,
656 offset, request->length);
657 spin_unlock_irqrestore(&address_handler_lock, flags);
658
c781c06d
KH
659 /*
660 * FIXME: lookup the fw_node corresponding to the sender of
3038e353
KH
661 * this request and pass that to the address handler instead
662 * of the node ID. We may also want to move the address
663 * allocations to fw_node so we only do this callback if the
c781c06d
KH
664 * upper layers registered it for this node.
665 */
3038e353
KH
666
667 if (handler == NULL)
668 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
669 else
670 handler->address_callback(card, request,
671 tcode, destination, source,
2639a6fb 672 p->generation, p->speed, offset,
3038e353
KH
673 request->data, request->length,
674 handler->callback_data);
675}
3038e353
KH
676EXPORT_SYMBOL(fw_core_handle_request);
677
678void
2639a6fb 679fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
3038e353
KH
680{
681 struct fw_transaction *t;
682 unsigned long flags;
683 u32 *data;
684 size_t data_length;
685 int tcode, tlabel, destination, source, rcode;
686
a77754a7
KH
687 tcode = HEADER_GET_TCODE(p->header[0]);
688 tlabel = HEADER_GET_TLABEL(p->header[0]);
689 destination = HEADER_GET_DESTINATION(p->header[0]);
690 source = HEADER_GET_SOURCE(p->header[1]);
691 rcode = HEADER_GET_RCODE(p->header[1]);
3038e353
KH
692
693 spin_lock_irqsave(&card->lock, flags);
694 list_for_each_entry(t, &card->transaction_list, link) {
695 if (t->node_id == source && t->tlabel == tlabel) {
696 list_del(&t->link);
697 card->tlabel_mask &= ~(1 << t->tlabel);
698 break;
699 }
700 }
701 spin_unlock_irqrestore(&card->lock, flags);
702
703 if (&t->link == &card->transaction_list) {
32b46093
KH
704 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
705 source, tlabel);
3038e353
KH
706 return;
707 }
708
c781c06d
KH
709 /*
710 * FIXME: sanity check packet, is length correct, does tcodes
711 * and addresses match.
712 */
3038e353
KH
713
714 switch (tcode) {
715 case TCODE_READ_QUADLET_RESPONSE:
2639a6fb 716 data = (u32 *) &p->header[3];
3038e353
KH
717 data_length = 4;
718 break;
719
720 case TCODE_WRITE_RESPONSE:
721 data = NULL;
722 data_length = 0;
723 break;
724
725 case TCODE_READ_BLOCK_RESPONSE:
726 case TCODE_LOCK_RESPONSE:
93c4cceb 727 data = p->payload;
a77754a7 728 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
729 break;
730
731 default:
732 /* Should never happen, this is just to shut up gcc. */
733 data = NULL;
734 data_length = 0;
735 break;
736 }
737
10a4c735
SR
738 /*
739 * The response handler may be executed while the request handler
740 * is still pending. Cancel the request handler.
741 */
742 card->driver->cancel_packet(card, &t->packet);
743
3038e353
KH
744 t->callback(card, rcode, data, data_length, t->callback_data);
745}
3038e353
KH
746EXPORT_SYMBOL(fw_core_handle_response);
747
ae57988f 748static const struct fw_address_region topology_map_region =
cca60977
JW
749 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
750 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
473d28c7
KH
751
752static void
753handle_topology_map(struct fw_card *card, struct fw_request *request,
754 int tcode, int destination, int source,
755 int generation, int speed,
756 unsigned long long offset,
757 void *payload, size_t length, void *callback_data)
758{
759 int i, start, end;
efbf390a 760 __be32 *map;
473d28c7
KH
761
762 if (!TCODE_IS_READ_REQUEST(tcode)) {
763 fw_send_response(card, request, RCODE_TYPE_ERROR);
764 return;
765 }
766
767 if ((offset & 3) > 0 || (length & 3) > 0) {
768 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
769 return;
770 }
771
772 start = (offset - topology_map_region.start) / 4;
773 end = start + length / 4;
774 map = payload;
775
776 for (i = 0; i < length / 4; i++)
777 map[i] = cpu_to_be32(card->topology_map[start + i]);
778
779 fw_send_response(card, request, RCODE_COMPLETE);
780}
781
782static struct fw_address_handler topology_map = {
d60d7f1d 783 .length = 0x200,
473d28c7
KH
784 .address_callback = handle_topology_map,
785};
786
ae57988f 787static const struct fw_address_region registers_region =
cca60977
JW
788 { .start = CSR_REGISTER_BASE,
789 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
d60d7f1d
KH
790
791static void
792handle_registers(struct fw_card *card, struct fw_request *request,
793 int tcode, int destination, int source,
794 int generation, int speed,
795 unsigned long long offset,
796 void *payload, size_t length, void *callback_data)
797{
15f0d833 798 int reg = offset & ~CSR_REGISTER_BASE;
d60d7f1d
KH
799 unsigned long long bus_time;
800 __be32 *data = payload;
801
802 switch (reg) {
803 case CSR_CYCLE_TIME:
804 case CSR_BUS_TIME:
805 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
806 fw_send_response(card, request, RCODE_TYPE_ERROR);
807 break;
808 }
809
810 bus_time = card->driver->get_bus_time(card);
811 if (reg == CSR_CYCLE_TIME)
812 *data = cpu_to_be32(bus_time);
813 else
814 *data = cpu_to_be32(bus_time >> 25);
815 fw_send_response(card, request, RCODE_COMPLETE);
816 break;
817
818 case CSR_BUS_MANAGER_ID:
819 case CSR_BANDWIDTH_AVAILABLE:
820 case CSR_CHANNELS_AVAILABLE_HI:
821 case CSR_CHANNELS_AVAILABLE_LO:
c781c06d
KH
822 /*
823 * FIXME: these are handled by the OHCI hardware and
d60d7f1d
KH
824 * the stack never sees these request. If we add
825 * support for a new type of controller that doesn't
826 * handle this in hardware we need to deal with these
c781c06d
KH
827 * transactions.
828 */
d60d7f1d
KH
829 BUG();
830 break;
831
832 case CSR_BUSY_TIMEOUT:
833 /* FIXME: Implement this. */
834 default:
835 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
836 break;
837 }
838}
839
840static struct fw_address_handler registers = {
841 .length = 0x400,
842 .address_callback = handle_registers,
843};
844
3038e353
KH
845MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
846MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
847MODULE_LICENSE("GPL");
848
937f6879 849static const u32 vendor_textual_descriptor[] = {
3038e353 850 /* textual descriptor leaf () */
937f6879 851 0x00060000,
3038e353
KH
852 0x00000000,
853 0x00000000,
854 0x4c696e75, /* L i n u */
855 0x78204669, /* x F i */
856 0x72657769, /* r e w i */
937f6879 857 0x72650000, /* r e */
3038e353
KH
858};
859
937f6879
KH
860static const u32 model_textual_descriptor[] = {
861 /* model descriptor leaf () */
862 0x00030000,
863 0x00000000,
864 0x00000000,
865 0x4a756a75, /* J u j u */
866};
867
868static struct fw_descriptor vendor_id_descriptor = {
869 .length = ARRAY_SIZE(vendor_textual_descriptor),
870 .immediate = 0x03d00d1e,
3038e353 871 .key = 0x81000000,
937f6879
KH
872 .data = vendor_textual_descriptor,
873};
874
875static struct fw_descriptor model_id_descriptor = {
876 .length = ARRAY_SIZE(model_textual_descriptor),
877 .immediate = 0x17000001,
878 .key = 0x81000000,
879 .data = model_textual_descriptor,
3038e353
KH
880};
881
3038e353
KH
882static int __init fw_core_init(void)
883{
884 int retval;
885
886 retval = bus_register(&fw_bus_type);
887 if (retval < 0)
888 return retval;
889
a3aca3da
KH
890 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
891 if (fw_cdev_major < 0) {
892 bus_unregister(&fw_bus_type);
893 return fw_cdev_major;
894 }
895
473d28c7
KH
896 retval = fw_core_add_address_handler(&topology_map,
897 &topology_map_region);
898 BUG_ON(retval < 0);
899
d60d7f1d
KH
900 retval = fw_core_add_address_handler(&registers,
901 &registers_region);
902 BUG_ON(retval < 0);
903
3038e353 904 /* Add the vendor textual descriptor. */
937f6879
KH
905 retval = fw_core_add_descriptor(&vendor_id_descriptor);
906 BUG_ON(retval < 0);
907 retval = fw_core_add_descriptor(&model_id_descriptor);
3038e353
KH
908 BUG_ON(retval < 0);
909
910 return 0;
911}
912
913static void __exit fw_core_cleanup(void)
914{
a3aca3da 915 unregister_chrdev(fw_cdev_major, "firewire");
3038e353
KH
916 bus_unregister(&fw_bus_type);
917}
918
919module_init(fw_core_init);
920module_exit(fw_core_cleanup);