blob: c00d4a9b39e5861980d884823e9d46d41c18a61f [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
Uwe Kleine-Königdbe7f762007-10-20 01:55:04 +0200231 * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500232 * 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
Stefan Richter1415d912007-07-17 02:10:16 +0200413 * particular request.
414 *
415 * Return value: 0 on success, non-zero otherwise.
416 * The start offset of the handler's address region is determined by
417 * fw_core_add_address_handler() and is returned in handler->offset.
418 * The offset is quadlet-aligned.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500419 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500420int
421fw_core_add_address_handler(struct fw_address_handler *handler,
Stefan Richter21ebcd12007-01-14 15:29:07 +0100422 const struct fw_address_region *region)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500423{
424 struct fw_address_handler *other;
425 unsigned long flags;
426 int ret = -EBUSY;
427
428 spin_lock_irqsave(&address_handler_lock, flags);
429
Stefan Richter1415d912007-07-17 02:10:16 +0200430 handler->offset = roundup(region->start, 4);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500431 while (handler->offset + handler->length <= region->end) {
432 other =
433 lookup_overlapping_address_handler(&address_handler_list,
434 handler->offset,
435 handler->length);
436 if (other != NULL) {
Stefan Richter1415d912007-07-17 02:10:16 +0200437 handler->offset =
438 roundup(other->offset + other->length, 4);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500439 } else {
440 list_add_tail(&handler->link, &address_handler_list);
441 ret = 0;
442 break;
443 }
444 }
445
446 spin_unlock_irqrestore(&address_handler_lock, flags);
447
448 return ret;
449}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500450EXPORT_SYMBOL(fw_core_add_address_handler);
451
452/**
453 * Deallocate a range of addresses allocated with fw_allocate. This
454 * will call the associated callback one last time with a the special
455 * tcode TCODE_DEALLOCATE, to let the client destroy the registered
456 * callback data. For convenience, the callback parameters offset and
457 * length are set to the start and the length respectively for the
458 * deallocated region, payload is set to NULL.
459 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500460void fw_core_remove_address_handler(struct fw_address_handler *handler)
461{
462 unsigned long flags;
463
464 spin_lock_irqsave(&address_handler_lock, flags);
465 list_del(&handler->link);
466 spin_unlock_irqrestore(&address_handler_lock, flags);
467}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500468EXPORT_SYMBOL(fw_core_remove_address_handler);
469
470struct fw_request {
471 struct fw_packet response;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500472 u32 request_header[4];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500473 int ack;
474 u32 length;
475 u32 data[0];
476};
477
478static void
479free_response_callback(struct fw_packet *packet,
480 struct fw_card *card, int status)
481{
482 struct fw_request *request;
483
484 request = container_of(packet, struct fw_request, response);
485 kfree(request);
486}
487
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500488void
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500489fw_fill_response(struct fw_packet *response, u32 *request_header,
490 int rcode, void *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500491{
492 int tcode, tlabel, extended_tcode, source, destination;
493
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400494 tcode = HEADER_GET_TCODE(request_header[0]);
495 tlabel = HEADER_GET_TLABEL(request_header[0]);
496 source = HEADER_GET_DESTINATION(request_header[0]);
497 destination = HEADER_GET_SOURCE(request_header[1]);
498 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500499
500 response->header[0] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400501 HEADER_RETRY(RETRY_1) |
502 HEADER_TLABEL(tlabel) |
503 HEADER_DESTINATION(destination);
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500504 response->header[1] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400505 HEADER_SOURCE(source) |
506 HEADER_RCODE(rcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500507 response->header[2] = 0;
508
509 switch (tcode) {
510 case TCODE_WRITE_QUADLET_REQUEST:
511 case TCODE_WRITE_BLOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400512 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500513 response->header_length = 12;
514 response->payload_length = 0;
515 break;
516
517 case TCODE_READ_QUADLET_REQUEST:
518 response->header[0] |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400519 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500520 if (payload != NULL)
521 response->header[3] = *(u32 *)payload;
522 else
523 response->header[3] = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500524 response->header_length = 16;
525 response->payload_length = 0;
526 break;
527
528 case TCODE_READ_BLOCK_REQUEST:
529 case TCODE_LOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400530 response->header[0] |= HEADER_TCODE(tcode + 2);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500531 response->header[3] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400532 HEADER_DATA_LENGTH(length) |
533 HEADER_EXTENDED_TCODE(extended_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500534 response->header_length = 16;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500535 response->payload = payload;
536 response->payload_length = length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500537 break;
538
539 default:
540 BUG();
541 return;
542 }
543}
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500544EXPORT_SYMBOL(fw_fill_response);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500545
546static struct fw_request *
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500547allocate_request(struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500548{
549 struct fw_request *request;
550 u32 *data, length;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500551 int request_tcode, t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500552
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400553 request_tcode = HEADER_GET_TCODE(p->header[0]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500554 switch (request_tcode) {
555 case TCODE_WRITE_QUADLET_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500556 data = &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500557 length = 4;
558 break;
559
560 case TCODE_WRITE_BLOCK_REQUEST:
561 case TCODE_LOCK_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500562 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400563 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500564 break;
565
566 case TCODE_READ_QUADLET_REQUEST:
567 data = NULL;
568 length = 4;
569 break;
570
571 case TCODE_READ_BLOCK_REQUEST:
572 data = NULL;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400573 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500574 break;
575
576 default:
577 BUG();
578 return NULL;
579 }
580
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400581 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500582 if (request == NULL)
583 return NULL;
584
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500585 t = (p->timestamp & 0x1fff) + 4000;
586 if (t >= 8000)
587 t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000;
588 else
589 t = (p->timestamp & ~0x1fff) + t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500590
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500591 request->response.speed = p->speed;
592 request->response.timestamp = t;
593 request->response.generation = p->generation;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500594 request->response.ack = 0;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500595 request->response.callback = free_response_callback;
596 request->ack = p->ack;
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500597 request->length = length;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500598 if (data)
Kristian Høgsberg6e2e8422007-02-16 17:34:37 -0500599 memcpy(request->data, data, length);
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500600
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400601 memcpy(request->request_header, p->header, sizeof(p->header));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500602
603 return request;
604}
605
606void
607fw_send_response(struct fw_card *card, struct fw_request *request, int rcode)
608{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400609 /*
610 * Broadcast packets are reported as ACK_COMPLETE, so this
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500611 * check is sufficient to ensure we don't send response to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400612 * broadcast packets or posted writes.
613 */
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200614 if (request->ack != ACK_PENDING) {
615 kfree(request);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500616 return;
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200617 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500618
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500619 if (rcode == RCODE_COMPLETE)
620 fw_fill_response(&request->response, request->request_header,
621 rcode, request->data, request->length);
622 else
623 fw_fill_response(&request->response, request->request_header,
624 rcode, NULL, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500625
626 card->driver->send_response(card, &request->response);
627}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500628EXPORT_SYMBOL(fw_send_response);
629
630void
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500631fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500632{
633 struct fw_address_handler *handler;
634 struct fw_request *request;
635 unsigned long long offset;
636 unsigned long flags;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500637 int tcode, destination, source;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500638
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500639 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500640 return;
641
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500642 request = allocate_request(p);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500643 if (request == NULL) {
644 /* FIXME: send statically allocated busy packet. */
645 return;
646 }
647
648 offset =
649 ((unsigned long long)
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400650 HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2];
651 tcode = HEADER_GET_TCODE(p->header[0]);
652 destination = HEADER_GET_DESTINATION(p->header[0]);
653 source = HEADER_GET_SOURCE(p->header[0]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500654
655 spin_lock_irqsave(&address_handler_lock, flags);
656 handler = lookup_enclosing_address_handler(&address_handler_list,
657 offset, request->length);
658 spin_unlock_irqrestore(&address_handler_lock, flags);
659
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400660 /*
661 * FIXME: lookup the fw_node corresponding to the sender of
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500662 * this request and pass that to the address handler instead
663 * of the node ID. We may also want to move the address
664 * allocations to fw_node so we only do this callback if the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400665 * upper layers registered it for this node.
666 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500667
668 if (handler == NULL)
669 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
670 else
671 handler->address_callback(card, request,
672 tcode, destination, source,
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500673 p->generation, p->speed, offset,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500674 request->data, request->length,
675 handler->callback_data);
676}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500677EXPORT_SYMBOL(fw_core_handle_request);
678
679void
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500680fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500681{
682 struct fw_transaction *t;
683 unsigned long flags;
684 u32 *data;
685 size_t data_length;
686 int tcode, tlabel, destination, source, rcode;
687
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400688 tcode = HEADER_GET_TCODE(p->header[0]);
689 tlabel = HEADER_GET_TLABEL(p->header[0]);
690 destination = HEADER_GET_DESTINATION(p->header[0]);
691 source = HEADER_GET_SOURCE(p->header[1]);
692 rcode = HEADER_GET_RCODE(p->header[1]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500693
694 spin_lock_irqsave(&card->lock, flags);
695 list_for_each_entry(t, &card->transaction_list, link) {
696 if (t->node_id == source && t->tlabel == tlabel) {
697 list_del(&t->link);
698 card->tlabel_mask &= ~(1 << t->tlabel);
699 break;
700 }
701 }
702 spin_unlock_irqrestore(&card->lock, flags);
703
704 if (&t->link == &card->transaction_list) {
Kristian Høgsberg32b46092007-02-06 14:49:30 -0500705 fw_notify("Unsolicited response (source %x, tlabel %x)\n",
706 source, tlabel);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500707 return;
708 }
709
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400710 /*
711 * FIXME: sanity check packet, is length correct, does tcodes
712 * and addresses match.
713 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500714
715 switch (tcode) {
716 case TCODE_READ_QUADLET_RESPONSE:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500717 data = (u32 *) &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500718 data_length = 4;
719 break;
720
721 case TCODE_WRITE_RESPONSE:
722 data = NULL;
723 data_length = 0;
724 break;
725
726 case TCODE_READ_BLOCK_RESPONSE:
727 case TCODE_LOCK_RESPONSE:
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500728 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400729 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500730 break;
731
732 default:
733 /* Should never happen, this is just to shut up gcc. */
734 data = NULL;
735 data_length = 0;
736 break;
737 }
738
739 t->callback(card, rcode, data, data_length, t->callback_data);
740}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500741EXPORT_SYMBOL(fw_core_handle_response);
742
Stefan Richterae579882007-08-02 20:34:17 +0200743static const struct fw_address_region topology_map_region =
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500744 { .start = 0xfffff0001000ull, .end = 0xfffff0001400ull, };
745
746static void
747handle_topology_map(struct fw_card *card, struct fw_request *request,
748 int tcode, int destination, int source,
749 int generation, int speed,
750 unsigned long long offset,
751 void *payload, size_t length, void *callback_data)
752{
753 int i, start, end;
754 u32 *map;
755
756 if (!TCODE_IS_READ_REQUEST(tcode)) {
757 fw_send_response(card, request, RCODE_TYPE_ERROR);
758 return;
759 }
760
761 if ((offset & 3) > 0 || (length & 3) > 0) {
762 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
763 return;
764 }
765
766 start = (offset - topology_map_region.start) / 4;
767 end = start + length / 4;
768 map = payload;
769
770 for (i = 0; i < length / 4; i++)
771 map[i] = cpu_to_be32(card->topology_map[start + i]);
772
773 fw_send_response(card, request, RCODE_COMPLETE);
774}
775
776static struct fw_address_handler topology_map = {
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500777 .length = 0x200,
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500778 .address_callback = handle_topology_map,
779};
780
Stefan Richterae579882007-08-02 20:34:17 +0200781static const struct fw_address_region registers_region =
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500782 { .start = 0xfffff0000000ull, .end = 0xfffff0000400ull, };
783
784static void
785handle_registers(struct fw_card *card, struct fw_request *request,
786 int tcode, int destination, int source,
787 int generation, int speed,
788 unsigned long long offset,
789 void *payload, size_t length, void *callback_data)
790{
791 int reg = offset - CSR_REGISTER_BASE;
792 unsigned long long bus_time;
793 __be32 *data = payload;
794
795 switch (reg) {
796 case CSR_CYCLE_TIME:
797 case CSR_BUS_TIME:
798 if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) {
799 fw_send_response(card, request, RCODE_TYPE_ERROR);
800 break;
801 }
802
803 bus_time = card->driver->get_bus_time(card);
804 if (reg == CSR_CYCLE_TIME)
805 *data = cpu_to_be32(bus_time);
806 else
807 *data = cpu_to_be32(bus_time >> 25);
808 fw_send_response(card, request, RCODE_COMPLETE);
809 break;
810
811 case CSR_BUS_MANAGER_ID:
812 case CSR_BANDWIDTH_AVAILABLE:
813 case CSR_CHANNELS_AVAILABLE_HI:
814 case CSR_CHANNELS_AVAILABLE_LO:
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400815 /*
816 * FIXME: these are handled by the OHCI hardware and
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500817 * the stack never sees these request. If we add
818 * support for a new type of controller that doesn't
819 * handle this in hardware we need to deal with these
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400820 * transactions.
821 */
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500822 BUG();
823 break;
824
825 case CSR_BUSY_TIMEOUT:
826 /* FIXME: Implement this. */
827 default:
828 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
829 break;
830 }
831}
832
833static struct fw_address_handler registers = {
834 .length = 0x400,
835 .address_callback = handle_registers,
836};
837
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500838MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
839MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
840MODULE_LICENSE("GPL");
841
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500842static const u32 vendor_textual_descriptor[] = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500843 /* textual descriptor leaf () */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500844 0x00060000,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500845 0x00000000,
846 0x00000000,
847 0x4c696e75, /* L i n u */
848 0x78204669, /* x F i */
849 0x72657769, /* r e w i */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500850 0x72650000, /* r e */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500851};
852
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500853static const u32 model_textual_descriptor[] = {
854 /* model descriptor leaf () */
855 0x00030000,
856 0x00000000,
857 0x00000000,
858 0x4a756a75, /* J u j u */
859};
860
861static struct fw_descriptor vendor_id_descriptor = {
862 .length = ARRAY_SIZE(vendor_textual_descriptor),
863 .immediate = 0x03d00d1e,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500864 .key = 0x81000000,
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500865 .data = vendor_textual_descriptor,
866};
867
868static struct fw_descriptor model_id_descriptor = {
869 .length = ARRAY_SIZE(model_textual_descriptor),
870 .immediate = 0x17000001,
871 .key = 0x81000000,
872 .data = model_textual_descriptor,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500873};
874
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500875static int __init fw_core_init(void)
876{
877 int retval;
878
879 retval = bus_register(&fw_bus_type);
880 if (retval < 0)
881 return retval;
882
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500883 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
884 if (fw_cdev_major < 0) {
885 bus_unregister(&fw_bus_type);
886 return fw_cdev_major;
887 }
888
Kristian Høgsberg473d28c2007-03-07 12:12:55 -0500889 retval = fw_core_add_address_handler(&topology_map,
890 &topology_map_region);
891 BUG_ON(retval < 0);
892
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -0500893 retval = fw_core_add_address_handler(&registers,
894 &registers_region);
895 BUG_ON(retval < 0);
896
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500897 /* Add the vendor textual descriptor. */
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500898 retval = fw_core_add_descriptor(&vendor_id_descriptor);
899 BUG_ON(retval < 0);
900 retval = fw_core_add_descriptor(&model_id_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500901 BUG_ON(retval < 0);
902
903 return 0;
904}
905
906static void __exit fw_core_cleanup(void)
907{
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500908 unregister_chrdev(fw_cdev_major, "firewire");
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500909 bus_unregister(&fw_bus_type);
910}
911
912module_init(fw_core_init);
913module_exit(fw_core_cleanup);