]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/firewire/fw-transaction.c
ieee1394: survive a few seconds connection loss
[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 22#include <linux/kernel.h>
ae1e5355 23#include <linux/kref.h>
3038e353 24#include <linux/module.h>
c0220d68 25#include <linux/mutex.h>
3038e353
KH
26#include <linux/init.h>
27#include <linux/interrupt.h>
28#include <linux/pci.h>
29#include <linux/delay.h>
30#include <linux/poll.h>
31#include <linux/list.h>
32#include <linux/kthread.h>
33#include <asm/uaccess.h>
3038e353
KH
34
35#include "fw-transaction.h"
36#include "fw-topology.h"
19a15b93 37#include "fw-device.h"
3038e353 38
a77754a7
KH
39#define HEADER_PRI(pri) ((pri) << 0)
40#define HEADER_TCODE(tcode) ((tcode) << 4)
41#define HEADER_RETRY(retry) ((retry) << 8)
42#define HEADER_TLABEL(tlabel) ((tlabel) << 10)
43#define HEADER_DESTINATION(destination) ((destination) << 16)
44#define HEADER_SOURCE(source) ((source) << 16)
45#define HEADER_RCODE(rcode) ((rcode) << 12)
46#define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0)
47#define HEADER_DATA_LENGTH(length) ((length) << 16)
48#define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0)
49
50#define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
51#define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f)
52#define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f)
53#define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
54#define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff)
55#define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
56#define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
57#define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
58
a7ea6782
SR
59#define HEADER_DESTINATION_IS_BROADCAST(q) \
60 (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))
61
a77754a7
KH
62#define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
63#define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
64#define PHY_IDENTIFIER(id) ((id) << 30)
3038e353 65
730c32f5
KH
66static int
67close_transaction(struct fw_transaction *transaction,
68 struct fw_card *card, int rcode,
69 u32 *payload, size_t length)
3038e353 70{
730c32f5 71 struct fw_transaction *t;
3038e353
KH
72 unsigned long flags;
73
74 spin_lock_irqsave(&card->lock, flags);
730c32f5
KH
75 list_for_each_entry(t, &card->transaction_list, link) {
76 if (t == transaction) {
77 list_del(&t->link);
78 card->tlabel_mask &= ~(1 << t->tlabel);
79 break;
80 }
81 }
3038e353
KH
82 spin_unlock_irqrestore(&card->lock, flags);
83
730c32f5
KH
84 if (&t->link != &card->transaction_list) {
85 t->callback(card, rcode, payload, length, t->callback_data);
86 return 0;
87 }
88
89 return -ENOENT;
3038e353
KH
90}
91
c781c06d
KH
92/*
93 * Only valid for transactions that are potentially pending (ie have
94 * been sent).
95 */
730c32f5
KH
96int
97fw_cancel_transaction(struct fw_card *card,
98 struct fw_transaction *transaction)
99{
c781c06d
KH
100 /*
101 * Cancel the packet transmission if it's still queued. That
730c32f5 102 * will call the packet transmission callback which cancels
c781c06d
KH
103 * the transaction.
104 */
730c32f5
KH
105
106 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
107 return 0;
108
c781c06d
KH
109 /*
110 * If the request packet has already been sent, we need to see
111 * if the transaction is still pending and remove it in that case.
112 */
730c32f5
KH
113
114 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
115}
116EXPORT_SYMBOL(fw_cancel_transaction);
117
3038e353
KH
118static void
119transmit_complete_callback(struct fw_packet *packet,
120 struct fw_card *card, int status)
121{
122 struct fw_transaction *t =
123 container_of(packet, struct fw_transaction, packet);
124
125 switch (status) {
126 case ACK_COMPLETE:
127 close_transaction(t, card, RCODE_COMPLETE, NULL, 0);
128 break;
129 case ACK_PENDING:
130 t->timestamp = packet->timestamp;
131 break;
132 case ACK_BUSY_X:
133 case ACK_BUSY_A:
134 case ACK_BUSY_B:
135 close_transaction(t, card, RCODE_BUSY, NULL, 0);
136 break;
137 case ACK_DATA_ERROR:
e5f49c3b
KH
138 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
139 break;
3038e353 140 case ACK_TYPE_ERROR:
e5f49c3b 141 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
3038e353
KH
142 break;
143 default:
c781c06d
KH
144 /*
145 * In this case the ack is really a juju specific
146 * rcode, so just forward that to the callback.
147 */
e5f49c3b 148 close_transaction(t, card, status, NULL, 0);
3038e353
KH
149 break;
150 }
151}
152
95688e97 153static void
36bfe49d 154fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
b9549bc6 155 int destination_id, int source_id, int generation, int speed,
36bfe49d 156 unsigned long long offset, void *payload, size_t length)
3038e353
KH
157{
158 int ext_tcode;
159
160 if (tcode > 0x10) {
8f9f963e 161 ext_tcode = tcode & ~0x10;
3038e353
KH
162 tcode = TCODE_LOCK_REQUEST;
163 } else
164 ext_tcode = 0;
165
166 packet->header[0] =
a77754a7
KH
167 HEADER_RETRY(RETRY_X) |
168 HEADER_TLABEL(tlabel) |
169 HEADER_TCODE(tcode) |
b9549bc6 170 HEADER_DESTINATION(destination_id);
3038e353 171 packet->header[1] =
a77754a7 172 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
3038e353
KH
173 packet->header[2] =
174 offset;
175
176 switch (tcode) {
177 case TCODE_WRITE_QUADLET_REQUEST:
178 packet->header[3] = *(u32 *)payload;
179 packet->header_length = 16;
180 packet->payload_length = 0;
181 break;
182
183 case TCODE_LOCK_REQUEST:
184 case TCODE_WRITE_BLOCK_REQUEST:
185 packet->header[3] =
a77754a7
KH
186 HEADER_DATA_LENGTH(length) |
187 HEADER_EXTENDED_TCODE(ext_tcode);
3038e353
KH
188 packet->header_length = 16;
189 packet->payload = payload;
190 packet->payload_length = length;
191 break;
192
193 case TCODE_READ_QUADLET_REQUEST:
194 packet->header_length = 12;
195 packet->payload_length = 0;
196 break;
197
198 case TCODE_READ_BLOCK_REQUEST:
199 packet->header[3] =
a77754a7
KH
200 HEADER_DATA_LENGTH(length) |
201 HEADER_EXTENDED_TCODE(ext_tcode);
3038e353
KH
202 packet->header_length = 16;
203 packet->payload_length = 0;
204 break;
205 }
206
207 packet->speed = speed;
208 packet->generation = generation;
730c32f5 209 packet->ack = 0;
3038e353
KH
210}
211
212/**
213 * This function provides low-level access to the IEEE1394 transaction
214 * logic. Most C programs would use either fw_read(), fw_write() or
215 * fw_lock() instead - those function are convenience wrappers for
216 * this function. The fw_send_request() function is primarily
217 * provided as a flexible, one-stop entry point for languages bindings
218 * and protocol bindings.
219 *
220 * FIXME: Document this function further, in particular the possible
221 * values for rcode in the callback. In short, we map ACK_COMPLETE to
222 * RCODE_COMPLETE, internal errors set errno and set rcode to
223 * RCODE_SEND_ERROR (which is out of range for standard ieee1394
224 * rcodes). All other rcodes are forwarded unchanged. For all
225 * errors, payload is NULL, length is 0.
226 *
227 * Can not expect the callback to be called before the function
228 * returns, though this does happen in some cases (ACK_COMPLETE and
229 * errors).
230 *
231 * The payload is only used for write requests and must not be freed
232 * until the callback has been called.
233 *
234 * @param card the card from which to send the request
235 * @param tcode the tcode for this transaction. Do not use
dbe7f76d 236 * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
3038e353 237 * etc. to specify tcode and ext_tcode.
907293d7 238 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
3038e353
KH
239 * @param generation the generation for which node_id is valid
240 * @param speed the speed to use for sending the request
241 * @param offset the 48 bit offset on the destination node
242 * @param payload the data payload for the request subaction
243 * @param length the length in bytes of the data to read
244 * @param callback function to be called when the transaction is completed
245 * @param callback_data pointer to arbitrary data, which will be
246 * passed to the callback
247 */
248void
249fw_send_request(struct fw_card *card, struct fw_transaction *t,
250 int tcode, int node_id, int generation, int speed,
251 unsigned long long offset,
252 void *payload, size_t length,
253 fw_transaction_callback_t callback, void *callback_data)
254{
255 unsigned long flags;
b9549bc6 256 int tlabel;
3038e353 257
c781c06d
KH
258 /*
259 * Bump the flush timer up 100ms first of all so we
260 * don't race with a flush timer callback.
261 */
3038e353
KH
262
263 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
264
c781c06d
KH
265 /*
266 * Allocate tlabel from the bitmap and put the transaction on
267 * the list while holding the card spinlock.
268 */
3038e353
KH
269
270 spin_lock_irqsave(&card->lock, flags);
271
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);
276 return;
277 }
278
279 card->current_tlabel = (card->current_tlabel + 1) & 0x1f;
280 card->tlabel_mask |= (1 << tlabel);
281
3038e353
KH
282 t->node_id = node_id;
283 t->tlabel = tlabel;
284 t->callback = callback;
285 t->callback_data = callback_data;
286
b9549bc6
SR
287 fw_fill_request(&t->packet, tcode, t->tlabel, node_id, card->node_id,
288 generation, speed, offset, payload, length);
3038e353
KH
289 t->packet.callback = transmit_complete_callback;
290
e9aeb46c
SR
291 list_add_tail(&t->link, &card->transaction_list);
292
293 spin_unlock_irqrestore(&card->lock, flags);
294
3038e353
KH
295 card->driver->send_request(card, &t->packet);
296}
297EXPORT_SYMBOL(fw_send_request);
298
c0220d68
SR
299static DEFINE_MUTEX(phy_config_mutex);
300static DECLARE_COMPLETION(phy_config_done);
ae1e5355
SR
301
302static void transmit_phy_packet_callback(struct fw_packet *packet,
303 struct fw_card *card, int status)
3038e353 304{
c0220d68 305 complete(&phy_config_done);
3038e353
KH
306}
307
c0220d68
SR
308static struct fw_packet phy_config_packet = {
309 .header_length = 8,
310 .payload_length = 0,
311 .speed = SCODE_100,
312 .callback = transmit_phy_packet_callback,
313};
314
83db801c
KH
315void fw_send_phy_config(struct fw_card *card,
316 int node_id, int generation, int gap_count)
3038e353 317{
ae1e5355 318 long timeout = DIV_ROUND_UP(HZ, 10);
2a0a2590
SR
319 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
320 PHY_CONFIG_ROOT_ID(node_id) |
321 PHY_CONFIG_GAP_COUNT(gap_count);
322
c0220d68
SR
323 mutex_lock(&phy_config_mutex);
324
325 phy_config_packet.header[0] = data;
326 phy_config_packet.header[1] = ~data;
327 phy_config_packet.generation = generation;
328 INIT_COMPLETION(phy_config_done);
329
330 card->driver->send_request(card, &phy_config_packet);
331 wait_for_completion_timeout(&phy_config_done, timeout);
ae1e5355 332
c0220d68 333 mutex_unlock(&phy_config_mutex);
3038e353
KH
334}
335
336void fw_flush_transactions(struct fw_card *card)
337{
338 struct fw_transaction *t, *next;
339 struct list_head list;
340 unsigned long flags;
341
342 INIT_LIST_HEAD(&list);
343 spin_lock_irqsave(&card->lock, flags);
344 list_splice_init(&card->transaction_list, &list);
345 card->tlabel_mask = 0;
346 spin_unlock_irqrestore(&card->lock, flags);
347
730c32f5
KH
348 list_for_each_entry_safe(t, next, &list, link) {
349 card->driver->cancel_packet(card, &t->packet);
350
c781c06d
KH
351 /*
352 * At this point cancel_packet will never call the
730c32f5 353 * transaction callback, since we just took all the
c781c06d
KH
354 * transactions out of the list. So do it here.
355 */
3038e353 356 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
730c32f5 357 }
3038e353
KH
358}
359
360static struct fw_address_handler *
361lookup_overlapping_address_handler(struct list_head *list,
362 unsigned long long offset, size_t length)
363{
364 struct fw_address_handler *handler;
365
366 list_for_each_entry(handler, list, link) {
367 if (handler->offset < offset + length &&
368 offset < handler->offset + handler->length)
369 return handler;
370 }
371
372 return NULL;
373}
374
375static struct fw_address_handler *
376lookup_enclosing_address_handler(struct list_head *list,
377 unsigned long long offset, size_t length)
378{
379 struct fw_address_handler *handler;
380
381 list_for_each_entry(handler, list, link) {
382 if (handler->offset <= offset &&
383 offset + length <= handler->offset + handler->length)
384 return handler;
385 }
386
387 return NULL;
388}
389
390static DEFINE_SPINLOCK(address_handler_lock);
391static LIST_HEAD(address_handler_list);
392
21ebcd12 393const struct fw_address_region fw_high_memory_region =
5af4e5ea 394 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
db8be076
AB
395EXPORT_SYMBOL(fw_high_memory_region);
396
397#if 0
398const struct fw_address_region fw_low_memory_region =
399 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
21ebcd12 400const struct fw_address_region fw_private_region =
5af4e5ea 401 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
21ebcd12 402const struct fw_address_region fw_csr_region =
cca60977
JW
403 { .start = CSR_REGISTER_BASE,
404 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
21ebcd12 405const struct fw_address_region fw_unit_space_region =
5af4e5ea 406 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
db8be076 407#endif /* 0 */
3038e353
KH
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:
0bf607c5
SR
578 fw_error("ERROR - corrupt request received - %08x %08x %08x\n",
579 p->header[0], p->header[1], p->header[2]);
3038e353
KH
580 return NULL;
581 }
582
2d826cc5 583 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
3038e353
KH
584 if (request == NULL)
585 return NULL;
586
2639a6fb
KH
587 t = (p->timestamp & 0x1fff) + 4000;
588 if (t >= 8000)
589 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
590 else
591 t = (p->timestamp & ~0x1fff) + t;
592
593 request->response.speed = p->speed;
594 request->response.timestamp = t;
595 request->response.generation = p->generation;
730c32f5 596 request->response.ack = 0;
3038e353 597 request->response.callback = free_response_callback;
2639a6fb 598 request->ack = p->ack;
93c4cceb 599 request->length = length;
3038e353 600 if (data)
6e2e8424 601 memcpy(request->data, data, length);
3038e353 602
2d826cc5 603 memcpy(request->request_header, p->header, sizeof(p->header));
3038e353
KH
604
605 return request;
606}
607
608void
609fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
610{
a7ea6782
SR
611 /* unified transaction or broadcast transaction: don't respond */
612 if (request->ack != ACK_PENDING ||
613 HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
9c9bdf4d 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;
e534fe16 801 int rcode = RCODE_COMPLETE;
d60d7f1d
KH
802
803 switch (reg) {
804 case CSR_CYCLE_TIME:
805 case CSR_BUS_TIME:
806 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
e534fe16 807 rcode = RCODE_TYPE_ERROR;
d60d7f1d
KH
808 break;
809 }
810
811 bus_time = card->driver->get_bus_time(card);
812 if (reg == CSR_CYCLE_TIME)
813 *data = cpu_to_be32(bus_time);
814 else
815 *data = cpu_to_be32(bus_time >> 25);
e534fe16
SR
816 break;
817
818 case CSR_BROADCAST_CHANNEL:
819 if (tcode == TCODE_READ_QUADLET_REQUEST)
820 *data = cpu_to_be32(card->broadcast_channel);
821 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
822 card->broadcast_channel =
823 (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
824 BROADCAST_CHANNEL_INITIAL;
825 else
826 rcode = RCODE_TYPE_ERROR;
d60d7f1d
KH
827 break;
828
829 case CSR_BUS_MANAGER_ID:
830 case CSR_BANDWIDTH_AVAILABLE:
831 case CSR_CHANNELS_AVAILABLE_HI:
832 case CSR_CHANNELS_AVAILABLE_LO:
c781c06d
KH
833 /*
834 * FIXME: these are handled by the OHCI hardware and
d60d7f1d
KH
835 * the stack never sees these request. If we add
836 * support for a new type of controller that doesn't
837 * handle this in hardware we need to deal with these
c781c06d
KH
838 * transactions.
839 */
d60d7f1d
KH
840 BUG();
841 break;
842
843 case CSR_BUSY_TIMEOUT:
844 /* FIXME: Implement this. */
e534fe16 845
d60d7f1d 846 default:
e534fe16 847 rcode = RCODE_ADDRESS_ERROR;
d60d7f1d
KH
848 break;
849 }
e534fe16
SR
850
851 fw_send_response(card, request, rcode);
d60d7f1d
KH
852}
853
854static struct fw_address_handler registers = {
855 .length = 0x400,
856 .address_callback = handle_registers,
857};
858
3038e353
KH
859MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
860MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
861MODULE_LICENSE("GPL");
862
937f6879 863static const u32 vendor_textual_descriptor[] = {
3038e353 864 /* textual descriptor leaf () */
937f6879 865 0x00060000,
3038e353
KH
866 0x00000000,
867 0x00000000,
868 0x4c696e75, /* L i n u */
869 0x78204669, /* x F i */
870 0x72657769, /* r e w i */
937f6879 871 0x72650000, /* r e */
3038e353
KH
872};
873
937f6879
KH
874static const u32 model_textual_descriptor[] = {
875 /* model descriptor leaf () */
876 0x00030000,
877 0x00000000,
878 0x00000000,
879 0x4a756a75, /* J u j u */
880};
881
882static struct fw_descriptor vendor_id_descriptor = {
883 .length = ARRAY_SIZE(vendor_textual_descriptor),
884 .immediate = 0x03d00d1e,
3038e353 885 .key = 0x81000000,
937f6879
KH
886 .data = vendor_textual_descriptor,
887};
888
889static struct fw_descriptor model_id_descriptor = {
890 .length = ARRAY_SIZE(model_textual_descriptor),
891 .immediate = 0x17000001,
892 .key = 0x81000000,
893 .data = model_textual_descriptor,
3038e353
KH
894};
895
3038e353
KH
896static int __init fw_core_init(void)
897{
898 int retval;
899
900 retval = bus_register(&fw_bus_type);
901 if (retval < 0)
902 return retval;
903
a3aca3da
KH
904 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
905 if (fw_cdev_major < 0) {
906 bus_unregister(&fw_bus_type);
907 return fw_cdev_major;
908 }
909
473d28c7
KH
910 retval = fw_core_add_address_handler(&topology_map,
911 &topology_map_region);
912 BUG_ON(retval < 0);
913
d60d7f1d
KH
914 retval = fw_core_add_address_handler(&registers,
915 &registers_region);
916 BUG_ON(retval < 0);
917
3038e353 918 /* Add the vendor textual descriptor. */
937f6879
KH
919 retval = fw_core_add_descriptor(&vendor_id_descriptor);
920 BUG_ON(retval < 0);
921 retval = fw_core_add_descriptor(&model_id_descriptor);
3038e353
KH
922 BUG_ON(retval < 0);
923
924 return 0;
925}
926
927static void __exit fw_core_cleanup(void)
928{
a3aca3da 929 unregister_chrdev(fw_cdev_major, "firewire");
3038e353
KH
930 bus_unregister(&fw_bus_type);
931}
932
933module_init(fw_core_init);
934module_exit(fw_core_cleanup);