blob: 3e1cb12e43cd13f3b8777af28f78c94f7bfb03d0 [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * Core IEEE1394 transaction logic
Kristian Høgsberg3038e352006-12-19 19:58:27 -05003 *
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"
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050035#include "fw-device.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050036
Kristian Høgsberga77754a2007-05-07 20:33:35 -040037#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)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050047
Kristian Høgsberga77754a2007-05-07 20:33:35 -040048#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)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050056
Kristian Høgsberga77754a2007-05-07 20:33:35 -040057#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)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050060
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050061static int
62close_transaction(struct fw_transaction *transaction,
63 struct fw_card *card, int rcode,
64 u32 *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050065{
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050066 struct fw_transaction *t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050067 unsigned long flags;
68
69 spin_lock_irqsave(&card->lock, flags);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050070 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 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -050077 spin_unlock_irqrestore(&card->lock, flags);
78
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050079 if (&t->link != &card->transaction_list) {
80 t->callback(card, rcode, payload, length, t->callback_data);
81 return 0;
82 }
83
84 return -ENOENT;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050085}
86
Kristian Høgsbergc781c062007-05-07 20:33:32 -040087/*
88 * Only valid for transactions that are potentially pending (ie have
89 * been sent).
90 */
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050091int
92fw_cancel_transaction(struct fw_card *card,
93 struct fw_transaction *transaction)
94{
Kristian Høgsbergc781c062007-05-07 20:33:32 -040095 /*
96 * Cancel the packet transmission if it's still queued. That
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050097 * will call the packet transmission callback which cancels
Kristian Høgsbergc781c062007-05-07 20:33:32 -040098 * the transaction.
99 */
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500100
101 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
102 return 0;
103
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400104 /*
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 */
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500108
109 return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0);
110}
111EXPORT_SYMBOL(fw_cancel_transaction);
112
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500113static 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:
Kristian Høgsberge5f49c32007-01-26 00:38:34 -0500133 close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0);
134 break;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500135 case ACK_TYPE_ERROR:
Kristian Høgsberge5f49c32007-01-26 00:38:34 -0500136 close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500137 break;
138 default:
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400139 /*
140 * In this case the ack is really a juju specific
141 * rcode, so just forward that to the callback.
142 */
Kristian Høgsberge5f49c32007-01-26 00:38:34 -0500143 close_transaction(t, card, status, NULL, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500144 break;
145 }
146}
147
Adrian Bunk95688e92007-01-22 19:17:37 +0100148static void
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500149fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500150 int node_id, int source_id, int generation, int speed,
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500151 unsigned long long offset, void *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500152{
153 int ext_tcode;
154
155 if (tcode > 0x10) {
156 ext_tcode = tcode - 0x10;
157 tcode = TCODE_LOCK_REQUEST;
158 } else
159 ext_tcode = 0;
160
161 packet->header[0] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400162 HEADER_RETRY(RETRY_X) |
163 HEADER_TLABEL(tlabel) |
164 HEADER_TCODE(tcode) |
165 HEADER_DESTINATION(node_id);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500166 packet->header[1] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400167 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500168 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] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400181 HEADER_DATA_LENGTH(length) |
182 HEADER_EXTENDED_TCODE(ext_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500183 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] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400195 HEADER_DATA_LENGTH(length) |
196 HEADER_EXTENDED_TCODE(ext_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500197 packet->header_length = 16;
198 packet->payload_length = 0;
199 break;
200 }
201
202 packet->speed = speed;
203 packet->generation = generation;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500204 packet->ack = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500205}
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
231 * TCODE_LOCK_REQUEST directly, insted use TCODE_LOCK_MASK_SWAP
232 * etc. to specify tcode and ext_tcode.
Stefan Richter907293d2007-01-23 21:11:43 +0100233 * @param node_id the destination node ID (bus ID and PHY ID concatenated)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500234 * @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;
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500251 int tlabel, source;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500252
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400253 /*
254 * Bump the flush timer up 100ms first of all so we
255 * don't race with a flush timer callback.
256 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500257
258 mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10));
259
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400260 /*
261 * Allocate tlabel from the bitmap and put the transaction on
262 * the list while holding the card spinlock.
263 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500264
265 spin_lock_irqsave(&card->lock, flags);
266
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500267 source = card->node_id;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500268 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
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500288 fw_fill_request(&t->packet, tcode, t->tlabel,
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500289 node_id, source, generation,
290 speed, offset, payload, length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500291 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
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400308 packet = kzalloc(sizeof(*packet), GFP_ATOMIC);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500309 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
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500323void fw_send_phy_config(struct fw_card *card,
324 int node_id, int generation, int gap_count)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500325{
326 u32 q;
327
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400328 q = PHY_IDENTIFIER(PHY_PACKET_CONFIG) |
329 PHY_CONFIG_ROOT_ID(node_id) |
330 PHY_CONFIG_GAP_COUNT(gap_count);
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500331
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500332 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
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500347 list_for_each_entry_safe(t, next, &list, link) {
348 card->driver->cancel_packet(card, &t->packet);
349
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400350 /*
351 * At this point cancel_packet will never call the
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500352 * transaction callback, since we just took all the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400353 * transactions out of the list. So do it here.
354 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500355 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500356 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500357}
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
Stefan Richter21ebcd12007-01-14 15:29:07 +0100392const struct fw_address_region fw_low_memory_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100393 { .start = 0x000000000000ULL, .end = 0x000100000000ULL, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100394const struct fw_address_region fw_high_memory_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100395 { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100396const struct fw_address_region fw_private_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100397 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100398const struct fw_address_region fw_csr_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100399 { .start = 0xfffff0000000ULL, .end = 0xfffff0000800ULL, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100400const struct fw_address_region fw_unit_space_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100401 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500402EXPORT_SYMBOL(fw_low_memory_region);
403EXPORT_SYMBOL(fw_high_memory_region);
404EXPORT_SYMBOL(fw_private_region);
405EXPORT_SYMBOL(fw_csr_region);
406EXPORT_SYMBOL(fw_unit_space_region);
407
408/**
409 * Allocate a range of addresses in the node space of the OHCI
410 * controller. When a request is received that falls within the
411 * specified address range, the specified callback is invoked. The
412 * parameters passed to the callback give the details of the
413 * particular request
414 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500415int
416fw_core_add_address_handler(struct fw_address_handler *handler,
Stefan Richter21ebcd12007-01-14 15:29:07 +0100417 const struct fw_address_region *region)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500418{
419 struct fw_address_handler *other;
420 unsigned long flags;
421 int ret = -EBUSY;
422
423 spin_lock_irqsave(&address_handler_lock, flags);
424
425 handler->offset = region->start;
426 while (handler->offset + handler->length <= region->end) {
427 other =
428 lookup_overlapping_address_handler(&address_handler_list,
429 handler->offset,
430 handler->length);
431 if (other != NULL) {
432 handler->offset += other->length;
433 } else {
434 list_add_tail(&handler->link, &address_handler_list);
435 ret = 0;
436 break;
437 }
438 }
439
440 spin_unlock_irqrestore(&address_handler_lock, flags);
441
442 return ret;
443}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500444EXPORT_SYMBOL(fw_core_add_address_handler);
445
446/**
447 * Deallocate a range of addresses allocated with fw_allocate. This
448 * will call the associated callback one last time with a the special
449 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
450 * callback data. For convenience, the callback parameters offset and
451 * length are set to the start and the length respectively for the
452 * deallocated region, payload is set to NULL.
453 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500454void fw_core_remove_address_handler(struct fw_address_handler *handler)
455{
456 unsigned long flags;
457
458 spin_lock_irqsave(&address_handler_lock, flags);
459 list_del(&handler->link);
460 spin_unlock_irqrestore(&address_handler_lock, flags);
461}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500462EXPORT_SYMBOL(fw_core_remove_address_handler);
463
464struct fw_request {
465 struct fw_packet response;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500466 u32 request_header[4];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500467 int ack;
468 u32 length;
469 u32 data[0];
470};
471
472static void
473free_response_callback(struct fw_packet *packet,
474 struct fw_card *card, int status)
475{
476 struct fw_request *request;
477
478 request = container_of(packet, struct fw_request, response);
479 kfree(request);
480}
481
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500482void
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500483fw_fill_response(struct fw_packet *response, u32 *request_header,
484 int rcode, void *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500485{
486 int tcode, tlabel, extended_tcode, source, destination;
487
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400488 tcode = HEADER_GET_TCODE(request_header[0]);
489 tlabel = HEADER_GET_TLABEL(request_header[0]);
490 source = HEADER_GET_DESTINATION(request_header[0]);
491 destination = HEADER_GET_SOURCE(request_header[1]);
492 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500493
494 response->header[0] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400495 HEADER_RETRY(RETRY_1) |
496 HEADER_TLABEL(tlabel) |
497 HEADER_DESTINATION(destination);
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500498 response->header[1] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400499 HEADER_SOURCE(source) |
500 HEADER_RCODE(rcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500501 response->header[2] = 0;
502
503 switch (tcode) {
504 case TCODE_WRITE_QUADLET_REQUEST:
505 case TCODE_WRITE_BLOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400506 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500507 response->header_length = 12;
508 response->payload_length = 0;
509 break;
510
511 case TCODE_READ_QUADLET_REQUEST:
512 response->header[0] |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400513 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500514 if (payload != NULL)
515 response->header[3] = *(u32 *)payload;
516 else
517 response->header[3] = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500518 response->header_length = 16;
519 response->payload_length = 0;
520 break;
521
522 case TCODE_READ_BLOCK_REQUEST:
523 case TCODE_LOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400524 response->header[0] |= HEADER_TCODE(tcode + 2);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500525 response->header[3] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400526 HEADER_DATA_LENGTH(length) |
527 HEADER_EXTENDED_TCODE(extended_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500528 response->header_length = 16;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500529 response->payload = payload;
530 response->payload_length = length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500531 break;
532
533 default:
534 BUG();
535 return;
536 }
537}
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500538EXPORT_SYMBOL(fw_fill_response);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500539
540static struct fw_request *
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500541allocate_request(struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500542{
543 struct fw_request *request;
544 u32 *data, length;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500545 int request_tcode, t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500546
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400547 request_tcode = HEADER_GET_TCODE(p->header[0]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500548 switch (request_tcode) {
549 case TCODE_WRITE_QUADLET_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500550 data = &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500551 length = 4;
552 break;
553
554 case TCODE_WRITE_BLOCK_REQUEST:
555 case TCODE_LOCK_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500556 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400557 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500558 break;
559
560 case TCODE_READ_QUADLET_REQUEST:
561 data = NULL;
562 length = 4;
563 break;
564
565 case TCODE_READ_BLOCK_REQUEST:
566 data = NULL;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400567 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500568 break;
569
570 default:
571 BUG();
572 return NULL;
573 }
574
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400575 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500576 if (request == NULL)
577 return NULL;
578
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500579 t = (p->timestamp & 0x1fff) + 4000;
580 if (t >= 8000)
581 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
582 else
583 t = (p->timestamp & ~0x1fff) + t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500584
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500585 request->response.speed = p->speed;
586 request->response.timestamp = t;
587 request->response.generation = p->generation;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500588 request->response.ack = 0;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500589 request->response.callback = free_response_callback;
590 request->ack = p->ack;
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500591 request->length = length;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500592 if (data)
Kristian Høgsberg6e2e8422007-02-16 17:34:37 -0500593 memcpy(request->data, data, length);
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500594
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400595 memcpy(request->request_header, p->header, sizeof(p->header));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500596
597 return request;
598}
599
600void
601fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
602{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400603 /*
604 * Broadcast packets are reported as ACK_COMPLETE, so this
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500605 * check is sufficient to ensure we don't send response to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400606 * broadcast packets or posted writes.
607 */
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200608 if (request->ack != ACK_PENDING) {
609 kfree(request);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500610 return;
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200611 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500612
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500613 if (rcode == RCODE_COMPLETE)
614 fw_fill_response(&request->response, request->request_header,
615 rcode, request->data, request->length);
616 else
617 fw_fill_response(&request->response, request->request_header,
618 rcode, NULL, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500619
620 card->driver->send_response(card, &request->response);
621}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500622EXPORT_SYMBOL(fw_send_response);
623
624void
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500625fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500626{
627 struct fw_address_handler *handler;
628 struct fw_request *request;
629 unsigned long long offset;
630 unsigned long flags;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500631 int tcode, destination, source;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500632
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500633 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500634 return;
635
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500636 request = allocate_request(p);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500637 if (request == NULL) {
638 /* FIXME: send statically allocated busy packet. */
639 return;
640 }
641
642 offset =
643 ((unsigned long long)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400644 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
645 tcode = HEADER_GET_TCODE(p->header[0]);
646 destination = HEADER_GET_DESTINATION(p->header[0]);
647 source = HEADER_GET_SOURCE(p->header[0]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500648
649 spin_lock_irqsave(&address_handler_lock, flags);
650 handler = lookup_enclosing_address_handler(&address_handler_list,
651 offset, request->length);
652 spin_unlock_irqrestore(&address_handler_lock, flags);
653
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400654 /*
655 * FIXME: lookup the fw_node corresponding to the sender of
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500656 * this request and pass that to the address handler instead
657 * of the node ID. We may also want to move the address
658 * allocations to fw_node so we only do this callback if the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400659 * upper layers registered it for this node.
660 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500661
662 if (handler == NULL)
663 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
664 else
665 handler->address_callback(card, request,
666 tcode, destination, source,
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500667 p->generation, p->speed, offset,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500668 request->data, request->length,
669 handler->callback_data);
670}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500671EXPORT_SYMBOL(fw_core_handle_request);
672
673void
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500674fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500675{
676 struct fw_transaction *t;
677 unsigned long flags;
678 u32 *data;
679 size_t data_length;
680 int tcode, tlabel, destination, source, rcode;
681
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400682 tcode = HEADER_GET_TCODE(p->header[0]);
683 tlabel = HEADER_GET_TLABEL(p->header[0]);
684 destination = HEADER_GET_DESTINATION(p->header[0]);
685 source = HEADER_GET_SOURCE(p->header[1]);
686 rcode = HEADER_GET_RCODE(p->header[1]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500687
688 spin_lock_irqsave(&card->lock, flags);
689 list_for_each_entry(t, &card->transaction_list, link) {
690 if (t->node_id == source && t->tlabel == tlabel) {
691 list_del(&t->link);
692 card->tlabel_mask &= ~(1 << t->tlabel);
693 break;
694 }
695 }
696 spin_unlock_irqrestore(&card->lock, flags);
697
698 if (&t->link == &card->transaction_list) {
Kristian Høgsberg32b46092007-02-06 14:49:30 -0500699 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
700 source, tlabel);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500701 return;
702 }
703
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400704 /*
705 * FIXME: sanity check packet, is length correct, does tcodes
706 * and addresses match.
707 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500708
709 switch (tcode) {
710 case TCODE_READ_QUADLET_RESPONSE:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500711 data = (u32 *) &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500712 data_length = 4;
713 break;
714
715 case TCODE_WRITE_RESPONSE:
716 data = NULL;
717 data_length = 0;
718 break;
719
720 case TCODE_READ_BLOCK_RESPONSE:
721 case TCODE_LOCK_RESPONSE:
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500722 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400723 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500724 break;
725
726 default:
727 /* Should never happen, this is just to shut up gcc. */
728 data = NULL;
729 data_length = 0;
730 break;
731 }
732
733 t->callback(card, rcode, data, data_length, t->callback_data);
734}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500735EXPORT_SYMBOL(fw_core_handle_response);
736
Stefan Richterae579882007-08-02 20:34:17 +0200737static const struct fw_address_region topology_map_region =
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500738 { .start = 0xfffff0001000ull, .end = 0xfffff0001400ull, };
739
740static void
741handle_topology_map(struct fw_card *card, struct fw_request *request,
742 int tcode, int destination, int source,
743 int generation, int speed,
744 unsigned long long offset,
745 void *payload, size_t length, void *callback_data)
746{
747 int i, start, end;
748 u32 *map;
749
750 if (!TCODE_IS_READ_REQUEST(tcode)) {
751 fw_send_response(card, request, RCODE_TYPE_ERROR);
752 return;
753 }
754
755 if ((offset & 3) > 0 || (length & 3) > 0) {
756 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
757 return;
758 }
759
760 start = (offset - topology_map_region.start) / 4;
761 end = start + length / 4;
762 map = payload;
763
764 for (i = 0; i < length / 4; i++)
765 map[i] = cpu_to_be32(card->topology_map[start + i]);
766
767 fw_send_response(card, request, RCODE_COMPLETE);
768}
769
770static struct fw_address_handler topology_map = {
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500771 .length = 0x200,
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500772 .address_callback = handle_topology_map,
773};
774
Stefan Richterae579882007-08-02 20:34:17 +0200775static const struct fw_address_region registers_region =
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500776 { .start = 0xfffff0000000ull, .end = 0xfffff0000400ull, };
777
778static void
779handle_registers(struct fw_card *card, struct fw_request *request,
780 int tcode, int destination, int source,
781 int generation, int speed,
782 unsigned long long offset,
783 void *payload, size_t length, void *callback_data)
784{
785 int reg = offset - CSR_REGISTER_BASE;
786 unsigned long long bus_time;
787 __be32 *data = payload;
788
789 switch (reg) {
790 case CSR_CYCLE_TIME:
791 case CSR_BUS_TIME:
792 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
793 fw_send_response(card, request, RCODE_TYPE_ERROR);
794 break;
795 }
796
797 bus_time = card->driver->get_bus_time(card);
798 if (reg == CSR_CYCLE_TIME)
799 *data = cpu_to_be32(bus_time);
800 else
801 *data = cpu_to_be32(bus_time >> 25);
802 fw_send_response(card, request, RCODE_COMPLETE);
803 break;
804
805 case CSR_BUS_MANAGER_ID:
806 case CSR_BANDWIDTH_AVAILABLE:
807 case CSR_CHANNELS_AVAILABLE_HI:
808 case CSR_CHANNELS_AVAILABLE_LO:
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400809 /*
810 * FIXME: these are handled by the OHCI hardware and
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500811 * the stack never sees these request. If we add
812 * support for a new type of controller that doesn't
813 * handle this in hardware we need to deal with these
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400814 * transactions.
815 */
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500816 BUG();
817 break;
818
819 case CSR_BUSY_TIMEOUT:
820 /* FIXME: Implement this. */
821 default:
822 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
823 break;
824 }
825}
826
827static struct fw_address_handler registers = {
828 .length = 0x400,
829 .address_callback = handle_registers,
830};
831
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500832MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
833MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
834MODULE_LICENSE("GPL");
835
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500836static const u32 vendor_textual_descriptor[] = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500837 /* textual descriptor leaf () */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500838 0x00060000,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500839 0x00000000,
840 0x00000000,
841 0x4c696e75, /* L i n u */
842 0x78204669, /* x F i */
843 0x72657769, /* r e w i */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500844 0x72650000, /* r e */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500845};
846
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500847static const u32 model_textual_descriptor[] = {
848 /* model descriptor leaf () */
849 0x00030000,
850 0x00000000,
851 0x00000000,
852 0x4a756a75, /* J u j u */
853};
854
855static struct fw_descriptor vendor_id_descriptor = {
856 .length = ARRAY_SIZE(vendor_textual_descriptor),
857 .immediate = 0x03d00d1e,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500858 .key = 0x81000000,
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500859 .data = vendor_textual_descriptor,
860};
861
862static struct fw_descriptor model_id_descriptor = {
863 .length = ARRAY_SIZE(model_textual_descriptor),
864 .immediate = 0x17000001,
865 .key = 0x81000000,
866 .data = model_textual_descriptor,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500867};
868
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500869static int __init fw_core_init(void)
870{
871 int retval;
872
873 retval = bus_register(&fw_bus_type);
874 if (retval < 0)
875 return retval;
876
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500877 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
878 if (fw_cdev_major < 0) {
879 bus_unregister(&fw_bus_type);
880 return fw_cdev_major;
881 }
882
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500883 retval = fw_core_add_address_handler(&topology_map,
884 &topology_map_region);
885 BUG_ON(retval < 0);
886
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500887 retval = fw_core_add_address_handler(&registers,
888 &registers_region);
889 BUG_ON(retval < 0);
890
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500891 /* Add the vendor textual descriptor. */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500892 retval = fw_core_add_descriptor(&vendor_id_descriptor);
893 BUG_ON(retval < 0);
894 retval = fw_core_add_descriptor(&model_id_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500895 BUG_ON(retval < 0);
896
897 return 0;
898}
899
900static void __exit fw_core_cleanup(void)
901{
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500902 unregister_chrdev(fw_cdev_major, "firewire");
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500903 bus_unregister(&fw_bus_type);
904}
905
906module_init(fw_core_init);
907module_exit(fw_core_cleanup);