]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/firewire/fw-transaction.c
firewire: replace more hex values with defined csr constants
[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
21#include <linux/kernel.h>
22#include <linux/module.h>
23#include <linux/init.h>
24#include <linux/interrupt.h>
25#include <linux/pci.h>
26#include <linux/delay.h>
27#include <linux/poll.h>
28#include <linux/list.h>
29#include <linux/kthread.h>
30#include <asm/uaccess.h>
31#include <asm/semaphore.h>
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
297static void
298transmit_phy_packet_callback(struct fw_packet *packet,
299 struct fw_card *card, int status)
300{
301 kfree(packet);
302}
303
304static void send_phy_packet(struct fw_card *card, u32 data, int generation)
305{
306 struct fw_packet *packet;
307
2d826cc5 308 packet = kzalloc(sizeof(*packet), GFP_ATOMIC);
3038e353
KH
309 if (packet == NULL)
310 return;
311
312 packet->header[0] = data;
313 packet->header[1] = ~data;
314 packet->header_length = 8;
315 packet->payload_length = 0;
316 packet->speed = SCODE_100;
317 packet->generation = generation;
318 packet->callback = transmit_phy_packet_callback;
319
320 card->driver->send_request(card, packet);
321}
322
83db801c
KH
323void fw_send_phy_config(struct fw_card *card,
324 int node_id, int generation, int gap_count)
3038e353
KH
325{
326 u32 q;
327
a77754a7
KH
328 q = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
329 PHY_CONFIG_ROOT_ID(node_id) |
330 PHY_CONFIG_GAP_COUNT(gap_count);
83db801c 331
3038e353
KH
332 send_phy_packet(card, q, generation);
333}
334
335void fw_flush_transactions(struct fw_card *card)
336{
337 struct fw_transaction *t, *next;
338 struct list_head list;
339 unsigned long flags;
340
341 INIT_LIST_HEAD(&list);
342 spin_lock_irqsave(&card->lock, flags);
343 list_splice_init(&card->transaction_list, &list);
344 card->tlabel_mask = 0;
345 spin_unlock_irqrestore(&card->lock, flags);
346
730c32f5
KH
347 list_for_each_entry_safe(t, next, &list, link) {
348 card->driver->cancel_packet(card, &t->packet);
349
c781c06d
KH
350 /*
351 * At this point cancel_packet will never call the
730c32f5 352 * transaction callback, since we just took all the
c781c06d
KH
353 * transactions out of the list. So do it here.
354 */
3038e353 355 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
730c32f5 356 }
3038e353
KH
357}
358
359static struct fw_address_handler *
360lookup_overlapping_address_handler(struct list_head *list,
361 unsigned long long offset, size_t length)
362{
363 struct fw_address_handler *handler;
364
365 list_for_each_entry(handler, list, link) {
366 if (handler->offset < offset + length &&
367 offset < handler->offset + handler->length)
368 return handler;
369 }
370
371 return NULL;
372}
373
374static struct fw_address_handler *
375lookup_enclosing_address_handler(struct list_head *list,
376 unsigned long long offset, size_t length)
377{
378 struct fw_address_handler *handler;
379
380 list_for_each_entry(handler, list, link) {
381 if (handler->offset <= offset &&
382 offset + length <= handler->offset + handler->length)
383 return handler;
384 }
385
386 return NULL;
387}
388
389static DEFINE_SPINLOCK(address_handler_lock);
390static LIST_HEAD(address_handler_list);
391
21ebcd12 392const struct fw_address_region fw_low_memory_region =
5af4e5ea 393 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
21ebcd12 394const struct fw_address_region fw_high_memory_region =
5af4e5ea 395 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
21ebcd12 396const struct fw_address_region fw_private_region =
5af4e5ea 397 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
21ebcd12 398const struct fw_address_region fw_csr_region =
cca60977
JW
399 { .start = CSR_REGISTER_BASE,
400 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
21ebcd12 401const struct fw_address_region fw_unit_space_region =
5af4e5ea 402 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
3038e353
KH
403EXPORT_SYMBOL(fw_low_memory_region);
404EXPORT_SYMBOL(fw_high_memory_region);
405EXPORT_SYMBOL(fw_private_region);
406EXPORT_SYMBOL(fw_csr_region);
407EXPORT_SYMBOL(fw_unit_space_region);
408
409/**
410 * Allocate a range of addresses in the node space of the OHCI
411 * controller. When a request is received that falls within the
412 * specified address range, the specified callback is invoked. The
413 * parameters passed to the callback give the details of the
1415d918
SR
414 * particular request.
415 *
416 * Return value: 0 on success, non-zero otherwise.
417 * The start offset of the handler's address region is determined by
418 * fw_core_add_address_handler() and is returned in handler->offset.
419 * The offset is quadlet-aligned.
3038e353 420 */
3038e353
KH
421int
422fw_core_add_address_handler(struct fw_address_handler *handler,
21ebcd12 423 const struct fw_address_region *region)
3038e353
KH
424{
425 struct fw_address_handler *other;
426 unsigned long flags;
427 int ret = -EBUSY;
428
429 spin_lock_irqsave(&address_handler_lock, flags);
430
1415d918 431 handler->offset = roundup(region->start, 4);
3038e353
KH
432 while (handler->offset + handler->length <= region->end) {
433 other =
434 lookup_overlapping_address_handler(&address_handler_list,
435 handler->offset,
436 handler->length);
437 if (other != NULL) {
1415d918
SR
438 handler->offset =
439 roundup(other->offset + other->length, 4);
3038e353
KH
440 } else {
441 list_add_tail(&handler->link, &address_handler_list);
442 ret = 0;
443 break;
444 }
445 }
446
447 spin_unlock_irqrestore(&address_handler_lock, flags);
448
449 return ret;
450}
3038e353
KH
451EXPORT_SYMBOL(fw_core_add_address_handler);
452
453/**
454 * Deallocate a range of addresses allocated with fw_allocate. This
455 * will call the associated callback one last time with a the special
456 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
457 * callback data. For convenience, the callback parameters offset and
458 * length are set to the start and the length respectively for the
459 * deallocated region, payload is set to NULL.
460 */
3038e353
KH
461void fw_core_remove_address_handler(struct fw_address_handler *handler)
462{
463 unsigned long flags;
464
465 spin_lock_irqsave(&address_handler_lock, flags);
466 list_del(&handler->link);
467 spin_unlock_irqrestore(&address_handler_lock, flags);
468}
3038e353
KH
469EXPORT_SYMBOL(fw_core_remove_address_handler);
470
471struct fw_request {
472 struct fw_packet response;
36bfe49d 473 u32 request_header[4];
3038e353
KH
474 int ack;
475 u32 length;
476 u32 data[0];
477};
478
479static void
480free_response_callback(struct fw_packet *packet,
481 struct fw_card *card, int status)
482{
483 struct fw_request *request;
484
485 request = container_of(packet, struct fw_request, response);
486 kfree(request);
487}
488
93c4cceb 489void
36bfe49d
KH
490fw_fill_response(struct fw_packet *response, u32 *request_header,
491 int rcode, void *payload, size_t length)
3038e353
KH
492{
493 int tcode, tlabel, extended_tcode, source, destination;
494
a77754a7
KH
495 tcode = HEADER_GET_TCODE(request_header[0]);
496 tlabel = HEADER_GET_TLABEL(request_header[0]);
497 source = HEADER_GET_DESTINATION(request_header[0]);
498 destination = HEADER_GET_SOURCE(request_header[1]);
499 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
3038e353
KH
500
501 response->header[0] =
a77754a7
KH
502 HEADER_RETRY(RETRY_1) |
503 HEADER_TLABEL(tlabel) |
504 HEADER_DESTINATION(destination);
36bfe49d 505 response->header[1] =
a77754a7
KH
506 HEADER_SOURCE(source) |
507 HEADER_RCODE(rcode);
3038e353
KH
508 response->header[2] = 0;
509
510 switch (tcode) {
511 case TCODE_WRITE_QUADLET_REQUEST:
512 case TCODE_WRITE_BLOCK_REQUEST:
a77754a7 513 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
3038e353
KH
514 response->header_length = 12;
515 response->payload_length = 0;
516 break;
517
518 case TCODE_READ_QUADLET_REQUEST:
519 response->header[0] |=
a77754a7 520 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
93c4cceb
KH
521 if (payload != NULL)
522 response->header[3] = *(u32 *)payload;
523 else
524 response->header[3] = 0;
3038e353
KH
525 response->header_length = 16;
526 response->payload_length = 0;
527 break;
528
529 case TCODE_READ_BLOCK_REQUEST:
530 case TCODE_LOCK_REQUEST:
a77754a7 531 response->header[0] |= HEADER_TCODE(tcode + 2);
3038e353 532 response->header[3] =
a77754a7
KH
533 HEADER_DATA_LENGTH(length) |
534 HEADER_EXTENDED_TCODE(extended_tcode);
3038e353 535 response->header_length = 16;
36bfe49d
KH
536 response->payload = payload;
537 response->payload_length = length;
3038e353
KH
538 break;
539
540 default:
541 BUG();
542 return;
543 }
544}
93c4cceb 545EXPORT_SYMBOL(fw_fill_response);
3038e353
KH
546
547static struct fw_request *
2639a6fb 548allocate_request(struct fw_packet *p)
3038e353
KH
549{
550 struct fw_request *request;
551 u32 *data, length;
2639a6fb 552 int request_tcode, t;
3038e353 553
a77754a7 554 request_tcode = HEADER_GET_TCODE(p->header[0]);
3038e353
KH
555 switch (request_tcode) {
556 case TCODE_WRITE_QUADLET_REQUEST:
2639a6fb 557 data = &p->header[3];
3038e353
KH
558 length = 4;
559 break;
560
561 case TCODE_WRITE_BLOCK_REQUEST:
562 case TCODE_LOCK_REQUEST:
2639a6fb 563 data = p->payload;
a77754a7 564 length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
565 break;
566
567 case TCODE_READ_QUADLET_REQUEST:
568 data = NULL;
569 length = 4;
570 break;
571
572 case TCODE_READ_BLOCK_REQUEST:
573 data = NULL;
a77754a7 574 length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
575 break;
576
577 default:
578 BUG();
579 return NULL;
580 }
581
2d826cc5 582 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
3038e353
KH
583 if (request == NULL)
584 return NULL;
585
2639a6fb
KH
586 t = (p->timestamp & 0x1fff) + 4000;
587 if (t >= 8000)
588 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
589 else
590 t = (p->timestamp & ~0x1fff) + t;
591
592 request->response.speed = p->speed;
593 request->response.timestamp = t;
594 request->response.generation = p->generation;
730c32f5 595 request->response.ack = 0;
3038e353 596 request->response.callback = free_response_callback;
2639a6fb 597 request->ack = p->ack;
93c4cceb 598 request->length = length;
3038e353 599 if (data)
6e2e8424 600 memcpy(request->data, data, length);
3038e353 601
2d826cc5 602 memcpy(request->request_header, p->header, sizeof(p->header));
3038e353
KH
603
604 return request;
605}
606
607void
608fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
609{
c781c06d
KH
610 /*
611 * Broadcast packets are reported as ACK_COMPLETE, so this
3038e353 612 * check is sufficient to ensure we don't send response to
c781c06d
KH
613 * broadcast packets or posted writes.
614 */
9c9bdf4d
SR
615 if (request->ack != ACK_PENDING) {
616 kfree(request);
3038e353 617 return;
9c9bdf4d 618 }
3038e353 619
36bfe49d
KH
620 if (rcode == RCODE_COMPLETE)
621 fw_fill_response(&request->response, request->request_header,
622 rcode, request->data, request->length);
623 else
624 fw_fill_response(&request->response, request->request_header,
625 rcode, NULL, 0);
3038e353
KH
626
627 card->driver->send_response(card, &request->response);
628}
3038e353
KH
629EXPORT_SYMBOL(fw_send_response);
630
631void
2639a6fb 632fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
3038e353
KH
633{
634 struct fw_address_handler *handler;
635 struct fw_request *request;
636 unsigned long long offset;
637 unsigned long flags;
2639a6fb 638 int tcode, destination, source;
3038e353 639
2639a6fb 640 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
3038e353
KH
641 return;
642
2639a6fb 643 request = allocate_request(p);
3038e353
KH
644 if (request == NULL) {
645 /* FIXME: send statically allocated busy packet. */
646 return;
647 }
648
649 offset =
650 ((unsigned long long)
a77754a7
KH
651 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
652 tcode = HEADER_GET_TCODE(p->header[0]);
653 destination = HEADER_GET_DESTINATION(p->header[0]);
478b233e 654 source = HEADER_GET_SOURCE(p->header[1]);
3038e353
KH
655
656 spin_lock_irqsave(&address_handler_lock, flags);
657 handler = lookup_enclosing_address_handler(&address_handler_list,
658 offset, request->length);
659 spin_unlock_irqrestore(&address_handler_lock, flags);
660
c781c06d
KH
661 /*
662 * FIXME: lookup the fw_node corresponding to the sender of
3038e353
KH
663 * this request and pass that to the address handler instead
664 * of the node ID. We may also want to move the address
665 * allocations to fw_node so we only do this callback if the
c781c06d
KH
666 * upper layers registered it for this node.
667 */
3038e353
KH
668
669 if (handler == NULL)
670 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
671 else
672 handler->address_callback(card, request,
673 tcode, destination, source,
2639a6fb 674 p->generation, p->speed, offset,
3038e353
KH
675 request->data, request->length,
676 handler->callback_data);
677}
3038e353
KH
678EXPORT_SYMBOL(fw_core_handle_request);
679
680void
2639a6fb 681fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
3038e353
KH
682{
683 struct fw_transaction *t;
684 unsigned long flags;
685 u32 *data;
686 size_t data_length;
687 int tcode, tlabel, destination, source, rcode;
688
a77754a7
KH
689 tcode = HEADER_GET_TCODE(p->header[0]);
690 tlabel = HEADER_GET_TLABEL(p->header[0]);
691 destination = HEADER_GET_DESTINATION(p->header[0]);
692 source = HEADER_GET_SOURCE(p->header[1]);
693 rcode = HEADER_GET_RCODE(p->header[1]);
3038e353
KH
694
695 spin_lock_irqsave(&card->lock, flags);
696 list_for_each_entry(t, &card->transaction_list, link) {
697 if (t->node_id == source && t->tlabel == tlabel) {
698 list_del(&t->link);
699 card->tlabel_mask &= ~(1 << t->tlabel);
700 break;
701 }
702 }
703 spin_unlock_irqrestore(&card->lock, flags);
704
705 if (&t->link == &card->transaction_list) {
32b46093
KH
706 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
707 source, tlabel);
3038e353
KH
708 return;
709 }
710
c781c06d
KH
711 /*
712 * FIXME: sanity check packet, is length correct, does tcodes
713 * and addresses match.
714 */
3038e353
KH
715
716 switch (tcode) {
717 case TCODE_READ_QUADLET_RESPONSE:
2639a6fb 718 data = (u32 *) &p->header[3];
3038e353
KH
719 data_length = 4;
720 break;
721
722 case TCODE_WRITE_RESPONSE:
723 data = NULL;
724 data_length = 0;
725 break;
726
727 case TCODE_READ_BLOCK_RESPONSE:
728 case TCODE_LOCK_RESPONSE:
93c4cceb 729 data = p->payload;
a77754a7 730 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
3038e353
KH
731 break;
732
733 default:
734 /* Should never happen, this is just to shut up gcc. */
735 data = NULL;
736 data_length = 0;
737 break;
738 }
739
10a4c735
SR
740 /*
741 * The response handler may be executed while the request handler
742 * is still pending. Cancel the request handler.
743 */
744 card->driver->cancel_packet(card, &t->packet);
745
3038e353
KH
746 t->callback(card, rcode, data, data_length, t->callback_data);
747}
3038e353
KH
748EXPORT_SYMBOL(fw_core_handle_response);
749
ae57988f 750static const struct fw_address_region topology_map_region =
cca60977
JW
751 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
752 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
473d28c7
KH
753
754static void
755handle_topology_map(struct fw_card *card, struct fw_request *request,
756 int tcode, int destination, int source,
757 int generation, int speed,
758 unsigned long long offset,
759 void *payload, size_t length, void *callback_data)
760{
761 int i, start, end;
efbf390a 762 __be32 *map;
473d28c7
KH
763
764 if (!TCODE_IS_READ_REQUEST(tcode)) {
765 fw_send_response(card, request, RCODE_TYPE_ERROR);
766 return;
767 }
768
769 if ((offset & 3) > 0 || (length & 3) > 0) {
770 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
771 return;
772 }
773
774 start = (offset - topology_map_region.start) / 4;
775 end = start + length / 4;
776 map = payload;
777
778 for (i = 0; i < length / 4; i++)
779 map[i] = cpu_to_be32(card->topology_map[start + i]);
780
781 fw_send_response(card, request, RCODE_COMPLETE);
782}
783
784static struct fw_address_handler topology_map = {
d60d7f1d 785 .length = 0x200,
473d28c7
KH
786 .address_callback = handle_topology_map,
787};
788
ae57988f 789static const struct fw_address_region registers_region =
cca60977
JW
790 { .start = CSR_REGISTER_BASE,
791 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
d60d7f1d
KH
792
793static void
794handle_registers(struct fw_card *card, struct fw_request *request,
795 int tcode, int destination, int source,
796 int generation, int speed,
797 unsigned long long offset,
798 void *payload, size_t length, void *callback_data)
799{
800 int reg = offset - CSR_REGISTER_BASE;
801 unsigned long long bus_time;
802 __be32 *data = payload;
803
804 switch (reg) {
805 case CSR_CYCLE_TIME:
806 case CSR_BUS_TIME:
807 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
808 fw_send_response(card, request, RCODE_TYPE_ERROR);
809 break;
810 }
811
812 bus_time = card->driver->get_bus_time(card);
813 if (reg == CSR_CYCLE_TIME)
814 *data = cpu_to_be32(bus_time);
815 else
816 *data = cpu_to_be32(bus_time >> 25);
817 fw_send_response(card, request, RCODE_COMPLETE);
818 break;
819
820 case CSR_BUS_MANAGER_ID:
821 case CSR_BANDWIDTH_AVAILABLE:
822 case CSR_CHANNELS_AVAILABLE_HI:
823 case CSR_CHANNELS_AVAILABLE_LO:
c781c06d
KH
824 /*
825 * FIXME: these are handled by the OHCI hardware and
d60d7f1d
KH
826 * the stack never sees these request. If we add
827 * support for a new type of controller that doesn't
828 * handle this in hardware we need to deal with these
c781c06d
KH
829 * transactions.
830 */
d60d7f1d
KH
831 BUG();
832 break;
833
834 case CSR_BUSY_TIMEOUT:
835 /* FIXME: Implement this. */
836 default:
837 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
838 break;
839 }
840}
841
842static struct fw_address_handler registers = {
843 .length = 0x400,
844 .address_callback = handle_registers,
845};
846
3038e353
KH
847MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
848MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
849MODULE_LICENSE("GPL");
850
937f6879 851static const u32 vendor_textual_descriptor[] = {
3038e353 852 /* textual descriptor leaf () */
937f6879 853 0x00060000,
3038e353
KH
854 0x00000000,
855 0x00000000,
856 0x4c696e75, /* L i n u */
857 0x78204669, /* x F i */
858 0x72657769, /* r e w i */
937f6879 859 0x72650000, /* r e */
3038e353
KH
860};
861
937f6879
KH
862static const u32 model_textual_descriptor[] = {
863 /* model descriptor leaf () */
864 0x00030000,
865 0x00000000,
866 0x00000000,
867 0x4a756a75, /* J u j u */
868};
869
870static struct fw_descriptor vendor_id_descriptor = {
871 .length = ARRAY_SIZE(vendor_textual_descriptor),
872 .immediate = 0x03d00d1e,
3038e353 873 .key = 0x81000000,
937f6879
KH
874 .data = vendor_textual_descriptor,
875};
876
877static struct fw_descriptor model_id_descriptor = {
878 .length = ARRAY_SIZE(model_textual_descriptor),
879 .immediate = 0x17000001,
880 .key = 0x81000000,
881 .data = model_textual_descriptor,
3038e353
KH
882};
883
3038e353
KH
884static int __init fw_core_init(void)
885{
886 int retval;
887
888 retval = bus_register(&fw_bus_type);
889 if (retval < 0)
890 return retval;
891
a3aca3da
KH
892 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
893 if (fw_cdev_major < 0) {
894 bus_unregister(&fw_bus_type);
895 return fw_cdev_major;
896 }
897
473d28c7
KH
898 retval = fw_core_add_address_handler(&topology_map,
899 &topology_map_region);
900 BUG_ON(retval < 0);
901
d60d7f1d
KH
902 retval = fw_core_add_address_handler(&registers,
903 &registers_region);
904 BUG_ON(retval < 0);
905
3038e353 906 /* Add the vendor textual descriptor. */
937f6879
KH
907 retval = fw_core_add_descriptor(&vendor_id_descriptor);
908 BUG_ON(retval < 0);
909 retval = fw_core_add_descriptor(&model_id_descriptor);
3038e353
KH
910 BUG_ON(retval < 0);
911
912 return 0;
913}
914
915static void __exit fw_core_cleanup(void)
916{
a3aca3da 917 unregister_chrdev(fw_cdev_major, "firewire");
3038e353
KH
918 bus_unregister(&fw_bus_type);
919}
920
921module_init(fw_core_init);
922module_exit(fw_core_cleanup);