Commit | Line | Data |
---|---|---|
c781c06d KH |
1 | /* |
2 | * Core IEEE1394 transaction logic | |
3038e353 KH |
3 | * |
4 | * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net> | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software Foundation, | |
18 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
19 | */ | |
20 | ||
21 | #include <linux/kernel.h> | |
22 | #include <linux/module.h> | |
23 | #include <linux/init.h> | |
24 | #include <linux/interrupt.h> | |
25 | #include <linux/pci.h> | |
26 | #include <linux/delay.h> | |
27 | #include <linux/poll.h> | |
28 | #include <linux/list.h> | |
29 | #include <linux/kthread.h> | |
30 | #include <asm/uaccess.h> | |
31 | #include <asm/semaphore.h> | |
32 | ||
33 | #include "fw-transaction.h" | |
34 | #include "fw-topology.h" | |
19a15b93 | 35 | #include "fw-device.h" |
3038e353 | 36 | |
a77754a7 KH |
37 | #define HEADER_PRI(pri) ((pri) << 0) |
38 | #define HEADER_TCODE(tcode) ((tcode) << 4) | |
39 | #define HEADER_RETRY(retry) ((retry) << 8) | |
40 | #define HEADER_TLABEL(tlabel) ((tlabel) << 10) | |
41 | #define HEADER_DESTINATION(destination) ((destination) << 16) | |
42 | #define HEADER_SOURCE(source) ((source) << 16) | |
43 | #define HEADER_RCODE(rcode) ((rcode) << 12) | |
44 | #define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0) | |
45 | #define HEADER_DATA_LENGTH(length) ((length) << 16) | |
46 | #define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0) | |
47 | ||
48 | #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f) | |
49 | #define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f) | |
50 | #define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f) | |
51 | #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff) | |
52 | #define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff) | |
53 | #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff) | |
54 | #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff) | |
55 | #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff) | |
56 | ||
57 | #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22)) | |
58 | #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23)) | |
59 | #define PHY_IDENTIFIER(id) ((id) << 30) | |
3038e353 | 60 | |
730c32f5 KH |
61 | static int |
62 | close_transaction(struct fw_transaction *transaction, | |
63 | struct fw_card *card, int rcode, | |
64 | u32 *payload, size_t length) | |
3038e353 | 65 | { |
730c32f5 | 66 | struct fw_transaction *t; |
3038e353 KH |
67 | unsigned long flags; |
68 | ||
69 | spin_lock_irqsave(&card->lock, flags); | |
730c32f5 KH |
70 | list_for_each_entry(t, &card->transaction_list, link) { |
71 | if (t == transaction) { | |
72 | list_del(&t->link); | |
73 | card->tlabel_mask &= ~(1 << t->tlabel); | |
74 | break; | |
75 | } | |
76 | } | |
3038e353 KH |
77 | spin_unlock_irqrestore(&card->lock, flags); |
78 | ||
730c32f5 KH |
79 | if (&t->link != &card->transaction_list) { |
80 | t->callback(card, rcode, payload, length, t->callback_data); | |
81 | return 0; | |
82 | } | |
83 | ||
84 | return -ENOENT; | |
3038e353 KH |
85 | } |
86 | ||
c781c06d KH |
87 | /* |
88 | * Only valid for transactions that are potentially pending (ie have | |
89 | * been sent). | |
90 | */ | |
730c32f5 KH |
91 | int |
92 | fw_cancel_transaction(struct fw_card *card, | |
93 | struct fw_transaction *transaction) | |
94 | { | |
c781c06d KH |
95 | /* |
96 | * Cancel the packet transmission if it's still queued. That | |
730c32f5 | 97 | * will call the packet transmission callback which cancels |
c781c06d KH |
98 | * the transaction. |
99 | */ | |
730c32f5 KH |
100 | |
101 | if (card->driver->cancel_packet(card, &transaction->packet) == 0) | |
102 | return 0; | |
103 | ||
c781c06d KH |
104 | /* |
105 | * If the request packet has already been sent, we need to see | |
106 | * if the transaction is still pending and remove it in that case. | |
107 | */ | |
730c32f5 KH |
108 | |
109 | return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0); | |
110 | } | |
111 | EXPORT_SYMBOL(fw_cancel_transaction); | |
112 | ||
3038e353 KH |
113 | static void |
114 | transmit_complete_callback(struct fw_packet *packet, | |
115 | struct fw_card *card, int status) | |
116 | { | |
117 | struct fw_transaction *t = | |
118 | container_of(packet, struct fw_transaction, packet); | |
119 | ||
120 | switch (status) { | |
121 | case ACK_COMPLETE: | |
122 | close_transaction(t, card, RCODE_COMPLETE, NULL, 0); | |
123 | break; | |
124 | case ACK_PENDING: | |
125 | t->timestamp = packet->timestamp; | |
126 | break; | |
127 | case ACK_BUSY_X: | |
128 | case ACK_BUSY_A: | |
129 | case ACK_BUSY_B: | |
130 | close_transaction(t, card, RCODE_BUSY, NULL, 0); | |
131 | break; | |
132 | case ACK_DATA_ERROR: | |
e5f49c3b KH |
133 | close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0); |
134 | break; | |
3038e353 | 135 | case ACK_TYPE_ERROR: |
e5f49c3b | 136 | close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0); |
3038e353 KH |
137 | break; |
138 | default: | |
c781c06d KH |
139 | /* |
140 | * In this case the ack is really a juju specific | |
141 | * rcode, so just forward that to the callback. | |
142 | */ | |
e5f49c3b | 143 | close_transaction(t, card, status, NULL, 0); |
3038e353 KH |
144 | break; |
145 | } | |
146 | } | |
147 | ||
95688e97 | 148 | static void |
36bfe49d | 149 | fw_fill_request(struct fw_packet *packet, int tcode, int tlabel, |
473d28c7 | 150 | int node_id, int source_id, int generation, int speed, |
36bfe49d | 151 | unsigned long long offset, void *payload, size_t length) |
3038e353 KH |
152 | { |
153 | int ext_tcode; | |
154 | ||
155 | if (tcode > 0x10) { | |
156 | ext_tcode = tcode - 0x10; | |
157 | tcode = TCODE_LOCK_REQUEST; | |
158 | } else | |
159 | ext_tcode = 0; | |
160 | ||
161 | packet->header[0] = | |
a77754a7 KH |
162 | HEADER_RETRY(RETRY_X) | |
163 | HEADER_TLABEL(tlabel) | | |
164 | HEADER_TCODE(tcode) | | |
165 | HEADER_DESTINATION(node_id); | |
3038e353 | 166 | packet->header[1] = |
a77754a7 | 167 | HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id); |
3038e353 KH |
168 | packet->header[2] = |
169 | offset; | |
170 | ||
171 | switch (tcode) { | |
172 | case TCODE_WRITE_QUADLET_REQUEST: | |
173 | packet->header[3] = *(u32 *)payload; | |
174 | packet->header_length = 16; | |
175 | packet->payload_length = 0; | |
176 | break; | |
177 | ||
178 | case TCODE_LOCK_REQUEST: | |
179 | case TCODE_WRITE_BLOCK_REQUEST: | |
180 | packet->header[3] = | |
a77754a7 KH |
181 | HEADER_DATA_LENGTH(length) | |
182 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
183 | packet->header_length = 16; |
184 | packet->payload = payload; | |
185 | packet->payload_length = length; | |
186 | break; | |
187 | ||
188 | case TCODE_READ_QUADLET_REQUEST: | |
189 | packet->header_length = 12; | |
190 | packet->payload_length = 0; | |
191 | break; | |
192 | ||
193 | case TCODE_READ_BLOCK_REQUEST: | |
194 | packet->header[3] = | |
a77754a7 KH |
195 | HEADER_DATA_LENGTH(length) | |
196 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
197 | packet->header_length = 16; |
198 | packet->payload_length = 0; | |
199 | break; | |
200 | } | |
201 | ||
202 | packet->speed = speed; | |
203 | packet->generation = generation; | |
730c32f5 | 204 | packet->ack = 0; |
3038e353 KH |
205 | } |
206 | ||
207 | /** | |
208 | * This function provides low-level access to the IEEE1394 transaction | |
209 | * logic. Most C programs would use either fw_read(), fw_write() or | |
210 | * fw_lock() instead - those function are convenience wrappers for | |
211 | * this function. The fw_send_request() function is primarily | |
212 | * provided as a flexible, one-stop entry point for languages bindings | |
213 | * and protocol bindings. | |
214 | * | |
215 | * FIXME: Document this function further, in particular the possible | |
216 | * values for rcode in the callback. In short, we map ACK_COMPLETE to | |
217 | * RCODE_COMPLETE, internal errors set errno and set rcode to | |
218 | * RCODE_SEND_ERROR (which is out of range for standard ieee1394 | |
219 | * rcodes). All other rcodes are forwarded unchanged. For all | |
220 | * errors, payload is NULL, length is 0. | |
221 | * | |
222 | * Can not expect the callback to be called before the function | |
223 | * returns, though this does happen in some cases (ACK_COMPLETE and | |
224 | * errors). | |
225 | * | |
226 | * The payload is only used for write requests and must not be freed | |
227 | * until the callback has been called. | |
228 | * | |
229 | * @param card the card from which to send the request | |
230 | * @param tcode the tcode for this transaction. Do not use | |
231 | * TCODE_LOCK_REQUEST directly, insted use TCODE_LOCK_MASK_SWAP | |
232 | * etc. to specify tcode and ext_tcode. | |
907293d7 | 233 | * @param node_id the destination node ID (bus ID and PHY ID concatenated) |
3038e353 KH |
234 | * @param generation the generation for which node_id is valid |
235 | * @param speed the speed to use for sending the request | |
236 | * @param offset the 48 bit offset on the destination node | |
237 | * @param payload the data payload for the request subaction | |
238 | * @param length the length in bytes of the data to read | |
239 | * @param callback function to be called when the transaction is completed | |
240 | * @param callback_data pointer to arbitrary data, which will be | |
241 | * passed to the callback | |
242 | */ | |
243 | void | |
244 | fw_send_request(struct fw_card *card, struct fw_transaction *t, | |
245 | int tcode, int node_id, int generation, int speed, | |
246 | unsigned long long offset, | |
247 | void *payload, size_t length, | |
248 | fw_transaction_callback_t callback, void *callback_data) | |
249 | { | |
250 | unsigned long flags; | |
473d28c7 | 251 | int tlabel, source; |
3038e353 | 252 | |
c781c06d KH |
253 | /* |
254 | * Bump the flush timer up 100ms first of all so we | |
255 | * don't race with a flush timer callback. | |
256 | */ | |
3038e353 KH |
257 | |
258 | mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10)); | |
259 | ||
c781c06d KH |
260 | /* |
261 | * Allocate tlabel from the bitmap and put the transaction on | |
262 | * the list while holding the card spinlock. | |
263 | */ | |
3038e353 KH |
264 | |
265 | spin_lock_irqsave(&card->lock, flags); | |
266 | ||
473d28c7 | 267 | source = card->node_id; |
3038e353 KH |
268 | tlabel = card->current_tlabel; |
269 | if (card->tlabel_mask & (1 << tlabel)) { | |
270 | spin_unlock_irqrestore(&card->lock, flags); | |
271 | callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data); | |
272 | return; | |
273 | } | |
274 | ||
275 | card->current_tlabel = (card->current_tlabel + 1) & 0x1f; | |
276 | card->tlabel_mask |= (1 << tlabel); | |
277 | ||
278 | list_add_tail(&t->link, &card->transaction_list); | |
279 | ||
280 | spin_unlock_irqrestore(&card->lock, flags); | |
281 | ||
282 | /* Initialize rest of transaction, fill out packet and send it. */ | |
283 | t->node_id = node_id; | |
284 | t->tlabel = tlabel; | |
285 | t->callback = callback; | |
286 | t->callback_data = callback_data; | |
287 | ||
36bfe49d | 288 | fw_fill_request(&t->packet, tcode, t->tlabel, |
473d28c7 KH |
289 | node_id, source, generation, |
290 | speed, offset, payload, length); | |
3038e353 KH |
291 | t->packet.callback = transmit_complete_callback; |
292 | ||
293 | card->driver->send_request(card, &t->packet); | |
294 | } | |
295 | EXPORT_SYMBOL(fw_send_request); | |
296 | ||
297 | static void | |
298 | transmit_phy_packet_callback(struct fw_packet *packet, | |
299 | struct fw_card *card, int status) | |
300 | { | |
301 | kfree(packet); | |
302 | } | |
303 | ||
304 | static void send_phy_packet(struct fw_card *card, u32 data, int generation) | |
305 | { | |
306 | struct fw_packet *packet; | |
307 | ||
2d826cc5 | 308 | packet = kzalloc(sizeof(*packet), GFP_ATOMIC); |
3038e353 KH |
309 | if (packet == NULL) |
310 | return; | |
311 | ||
312 | packet->header[0] = data; | |
313 | packet->header[1] = ~data; | |
314 | packet->header_length = 8; | |
315 | packet->payload_length = 0; | |
316 | packet->speed = SCODE_100; | |
317 | packet->generation = generation; | |
318 | packet->callback = transmit_phy_packet_callback; | |
319 | ||
320 | card->driver->send_request(card, packet); | |
321 | } | |
322 | ||
83db801c KH |
323 | void fw_send_phy_config(struct fw_card *card, |
324 | int node_id, int generation, int gap_count) | |
3038e353 KH |
325 | { |
326 | u32 q; | |
327 | ||
a77754a7 KH |
328 | q = PHY_IDENTIFIER(PHY_PACKET_CONFIG) | |
329 | PHY_CONFIG_ROOT_ID(node_id) | | |
330 | PHY_CONFIG_GAP_COUNT(gap_count); | |
83db801c | 331 | |
3038e353 KH |
332 | send_phy_packet(card, q, generation); |
333 | } | |
334 | ||
335 | void fw_flush_transactions(struct fw_card *card) | |
336 | { | |
337 | struct fw_transaction *t, *next; | |
338 | struct list_head list; | |
339 | unsigned long flags; | |
340 | ||
341 | INIT_LIST_HEAD(&list); | |
342 | spin_lock_irqsave(&card->lock, flags); | |
343 | list_splice_init(&card->transaction_list, &list); | |
344 | card->tlabel_mask = 0; | |
345 | spin_unlock_irqrestore(&card->lock, flags); | |
346 | ||
730c32f5 KH |
347 | list_for_each_entry_safe(t, next, &list, link) { |
348 | card->driver->cancel_packet(card, &t->packet); | |
349 | ||
c781c06d KH |
350 | /* |
351 | * At this point cancel_packet will never call the | |
730c32f5 | 352 | * transaction callback, since we just took all the |
c781c06d KH |
353 | * transactions out of the list. So do it here. |
354 | */ | |
3038e353 | 355 | t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data); |
730c32f5 | 356 | } |
3038e353 KH |
357 | } |
358 | ||
359 | static struct fw_address_handler * | |
360 | lookup_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 | ||
374 | static struct fw_address_handler * | |
375 | lookup_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 | ||
389 | static DEFINE_SPINLOCK(address_handler_lock); | |
390 | static LIST_HEAD(address_handler_list); | |
391 | ||
21ebcd12 | 392 | const struct fw_address_region fw_low_memory_region = |
5af4e5ea | 393 | { .start = 0x000000000000ULL, .end = 0x000100000000ULL, }; |
21ebcd12 | 394 | const struct fw_address_region fw_high_memory_region = |
5af4e5ea | 395 | { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, }; |
21ebcd12 | 396 | const struct fw_address_region fw_private_region = |
5af4e5ea | 397 | { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, }; |
21ebcd12 | 398 | const struct fw_address_region fw_csr_region = |
5af4e5ea | 399 | { .start = 0xfffff0000000ULL, .end = 0xfffff0000800ULL, }; |
21ebcd12 | 400 | const struct fw_address_region fw_unit_space_region = |
5af4e5ea | 401 | { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, }; |
3038e353 KH |
402 | EXPORT_SYMBOL(fw_low_memory_region); |
403 | EXPORT_SYMBOL(fw_high_memory_region); | |
404 | EXPORT_SYMBOL(fw_private_region); | |
405 | EXPORT_SYMBOL(fw_csr_region); | |
406 | EXPORT_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 | */ | |
3038e353 KH |
415 | int |
416 | fw_core_add_address_handler(struct fw_address_handler *handler, | |
21ebcd12 | 417 | const struct fw_address_region *region) |
3038e353 KH |
418 | { |
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 | } | |
3038e353 KH |
444 | EXPORT_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 | */ | |
3038e353 KH |
454 | void 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 | } | |
3038e353 KH |
462 | EXPORT_SYMBOL(fw_core_remove_address_handler); |
463 | ||
464 | struct fw_request { | |
465 | struct fw_packet response; | |
36bfe49d | 466 | u32 request_header[4]; |
3038e353 KH |
467 | int ack; |
468 | u32 length; | |
469 | u32 data[0]; | |
470 | }; | |
471 | ||
472 | static void | |
473 | free_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 | ||
93c4cceb | 482 | void |
36bfe49d KH |
483 | fw_fill_response(struct fw_packet *response, u32 *request_header, |
484 | int rcode, void *payload, size_t length) | |
3038e353 KH |
485 | { |
486 | int tcode, tlabel, extended_tcode, source, destination; | |
487 | ||
a77754a7 KH |
488 | 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]); | |
3038e353 KH |
493 | |
494 | response->header[0] = | |
a77754a7 KH |
495 | HEADER_RETRY(RETRY_1) | |
496 | HEADER_TLABEL(tlabel) | | |
497 | HEADER_DESTINATION(destination); | |
36bfe49d | 498 | response->header[1] = |
a77754a7 KH |
499 | HEADER_SOURCE(source) | |
500 | HEADER_RCODE(rcode); | |
3038e353 KH |
501 | response->header[2] = 0; |
502 | ||
503 | switch (tcode) { | |
504 | case TCODE_WRITE_QUADLET_REQUEST: | |
505 | case TCODE_WRITE_BLOCK_REQUEST: | |
a77754a7 | 506 | response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE); |
3038e353 KH |
507 | response->header_length = 12; |
508 | response->payload_length = 0; | |
509 | break; | |
510 | ||
511 | case TCODE_READ_QUADLET_REQUEST: | |
512 | response->header[0] |= | |
a77754a7 | 513 | HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE); |
93c4cceb KH |
514 | if (payload != NULL) |
515 | response->header[3] = *(u32 *)payload; | |
516 | else | |
517 | response->header[3] = 0; | |
3038e353 KH |
518 | response->header_length = 16; |
519 | response->payload_length = 0; | |
520 | break; | |
521 | ||
522 | case TCODE_READ_BLOCK_REQUEST: | |
523 | case TCODE_LOCK_REQUEST: | |
a77754a7 | 524 | response->header[0] |= HEADER_TCODE(tcode + 2); |
3038e353 | 525 | response->header[3] = |
a77754a7 KH |
526 | HEADER_DATA_LENGTH(length) | |
527 | HEADER_EXTENDED_TCODE(extended_tcode); | |
3038e353 | 528 | response->header_length = 16; |
36bfe49d KH |
529 | response->payload = payload; |
530 | response->payload_length = length; | |
3038e353 KH |
531 | break; |
532 | ||
533 | default: | |
534 | BUG(); | |
535 | return; | |
536 | } | |
537 | } | |
93c4cceb | 538 | EXPORT_SYMBOL(fw_fill_response); |
3038e353 KH |
539 | |
540 | static struct fw_request * | |
2639a6fb | 541 | allocate_request(struct fw_packet *p) |
3038e353 KH |
542 | { |
543 | struct fw_request *request; | |
544 | u32 *data, length; | |
2639a6fb | 545 | int request_tcode, t; |
3038e353 | 546 | |
a77754a7 | 547 | request_tcode = HEADER_GET_TCODE(p->header[0]); |
3038e353 KH |
548 | switch (request_tcode) { |
549 | case TCODE_WRITE_QUADLET_REQUEST: | |
2639a6fb | 550 | data = &p->header[3]; |
3038e353 KH |
551 | length = 4; |
552 | break; | |
553 | ||
554 | case TCODE_WRITE_BLOCK_REQUEST: | |
555 | case TCODE_LOCK_REQUEST: | |
2639a6fb | 556 | data = p->payload; |
a77754a7 | 557 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
558 | 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; | |
a77754a7 | 567 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
568 | break; |
569 | ||
570 | default: | |
571 | BUG(); | |
572 | return NULL; | |
573 | } | |
574 | ||
2d826cc5 | 575 | request = kmalloc(sizeof(*request) + length, GFP_ATOMIC); |
3038e353 KH |
576 | if (request == NULL) |
577 | return NULL; | |
578 | ||
2639a6fb KH |
579 | 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; | |
584 | ||
585 | request->response.speed = p->speed; | |
586 | request->response.timestamp = t; | |
587 | request->response.generation = p->generation; | |
730c32f5 | 588 | request->response.ack = 0; |
3038e353 | 589 | request->response.callback = free_response_callback; |
2639a6fb | 590 | request->ack = p->ack; |
93c4cceb | 591 | request->length = length; |
3038e353 | 592 | if (data) |
6e2e8424 | 593 | memcpy(request->data, data, length); |
3038e353 | 594 | |
2d826cc5 | 595 | memcpy(request->request_header, p->header, sizeof(p->header)); |
3038e353 KH |
596 | |
597 | return request; | |
598 | } | |
599 | ||
600 | void | |
601 | fw_send_response(struct fw_card *card, struct fw_request *request, int rcode) | |
602 | { | |
c781c06d KH |
603 | /* |
604 | * Broadcast packets are reported as ACK_COMPLETE, so this | |
3038e353 | 605 | * check is sufficient to ensure we don't send response to |
c781c06d KH |
606 | * broadcast packets or posted writes. |
607 | */ | |
9c9bdf4d SR |
608 | if (request->ack != ACK_PENDING) { |
609 | kfree(request); | |
3038e353 | 610 | return; |
9c9bdf4d | 611 | } |
3038e353 | 612 | |
36bfe49d KH |
613 | 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); | |
3038e353 KH |
619 | |
620 | card->driver->send_response(card, &request->response); | |
621 | } | |
3038e353 KH |
622 | EXPORT_SYMBOL(fw_send_response); |
623 | ||
624 | void | |
2639a6fb | 625 | fw_core_handle_request(struct fw_card *card, struct fw_packet *p) |
3038e353 KH |
626 | { |
627 | struct fw_address_handler *handler; | |
628 | struct fw_request *request; | |
629 | unsigned long long offset; | |
630 | unsigned long flags; | |
2639a6fb | 631 | int tcode, destination, source; |
3038e353 | 632 | |
2639a6fb | 633 | if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE) |
3038e353 KH |
634 | return; |
635 | ||
2639a6fb | 636 | request = allocate_request(p); |
3038e353 KH |
637 | if (request == NULL) { |
638 | /* FIXME: send statically allocated busy packet. */ | |
639 | return; | |
640 | } | |
641 | ||
642 | offset = | |
643 | ((unsigned long long) | |
a77754a7 KH |
644 | 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]); | |
3038e353 KH |
648 | |
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 | ||
c781c06d KH |
654 | /* |
655 | * FIXME: lookup the fw_node corresponding to the sender of | |
3038e353 KH |
656 | * 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 | |
c781c06d KH |
659 | * upper layers registered it for this node. |
660 | */ | |
3038e353 KH |
661 | |
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, | |
2639a6fb | 667 | p->generation, p->speed, offset, |
3038e353 KH |
668 | request->data, request->length, |
669 | handler->callback_data); | |
670 | } | |
3038e353 KH |
671 | EXPORT_SYMBOL(fw_core_handle_request); |
672 | ||
673 | void | |
2639a6fb | 674 | fw_core_handle_response(struct fw_card *card, struct fw_packet *p) |
3038e353 KH |
675 | { |
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 | ||
a77754a7 KH |
682 | 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]); | |
3038e353 KH |
687 | |
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) { | |
32b46093 KH |
699 | fw_notify("Unsolicited response (source %x, tlabel %x)\n", |
700 | source, tlabel); | |
3038e353 KH |
701 | return; |
702 | } | |
703 | ||
c781c06d KH |
704 | /* |
705 | * FIXME: sanity check packet, is length correct, does tcodes | |
706 | * and addresses match. | |
707 | */ | |
3038e353 KH |
708 | |
709 | switch (tcode) { | |
710 | case TCODE_READ_QUADLET_RESPONSE: | |
2639a6fb | 711 | data = (u32 *) &p->header[3]; |
3038e353 KH |
712 | 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: | |
93c4cceb | 722 | data = p->payload; |
a77754a7 | 723 | data_length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
724 | 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 | } | |
3038e353 KH |
735 | EXPORT_SYMBOL(fw_core_handle_response); |
736 | ||
473d28c7 KH |
737 | const struct fw_address_region topology_map_region = |
738 | { .start = 0xfffff0001000ull, .end = 0xfffff0001400ull, }; | |
739 | ||
740 | static void | |
741 | handle_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 | ||
770 | static struct fw_address_handler topology_map = { | |
d60d7f1d | 771 | .length = 0x200, |
473d28c7 KH |
772 | .address_callback = handle_topology_map, |
773 | }; | |
774 | ||
d60d7f1d KH |
775 | const struct fw_address_region registers_region = |
776 | { .start = 0xfffff0000000ull, .end = 0xfffff0000400ull, }; | |
777 | ||
778 | static void | |
779 | handle_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: | |
c781c06d KH |
809 | /* |
810 | * FIXME: these are handled by the OHCI hardware and | |
d60d7f1d KH |
811 | * 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 | |
c781c06d KH |
814 | * transactions. |
815 | */ | |
d60d7f1d KH |
816 | 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 | ||
827 | static struct fw_address_handler registers = { | |
828 | .length = 0x400, | |
829 | .address_callback = handle_registers, | |
830 | }; | |
831 | ||
3038e353 KH |
832 | MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>"); |
833 | MODULE_DESCRIPTION("Core IEEE1394 transaction logic"); | |
834 | MODULE_LICENSE("GPL"); | |
835 | ||
937f6879 | 836 | static const u32 vendor_textual_descriptor[] = { |
3038e353 | 837 | /* textual descriptor leaf () */ |
937f6879 | 838 | 0x00060000, |
3038e353 KH |
839 | 0x00000000, |
840 | 0x00000000, | |
841 | 0x4c696e75, /* L i n u */ | |
842 | 0x78204669, /* x F i */ | |
843 | 0x72657769, /* r e w i */ | |
937f6879 | 844 | 0x72650000, /* r e */ |
3038e353 KH |
845 | }; |
846 | ||
937f6879 KH |
847 | static const u32 model_textual_descriptor[] = { |
848 | /* model descriptor leaf () */ | |
849 | 0x00030000, | |
850 | 0x00000000, | |
851 | 0x00000000, | |
852 | 0x4a756a75, /* J u j u */ | |
853 | }; | |
854 | ||
855 | static struct fw_descriptor vendor_id_descriptor = { | |
856 | .length = ARRAY_SIZE(vendor_textual_descriptor), | |
857 | .immediate = 0x03d00d1e, | |
3038e353 | 858 | .key = 0x81000000, |
937f6879 KH |
859 | .data = vendor_textual_descriptor, |
860 | }; | |
861 | ||
862 | static struct fw_descriptor model_id_descriptor = { | |
863 | .length = ARRAY_SIZE(model_textual_descriptor), | |
864 | .immediate = 0x17000001, | |
865 | .key = 0x81000000, | |
866 | .data = model_textual_descriptor, | |
3038e353 KH |
867 | }; |
868 | ||
3038e353 KH |
869 | static 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 | ||
a3aca3da KH |
877 | 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 | ||
473d28c7 KH |
883 | retval = fw_core_add_address_handler(&topology_map, |
884 | &topology_map_region); | |
885 | BUG_ON(retval < 0); | |
886 | ||
d60d7f1d KH |
887 | retval = fw_core_add_address_handler(®isters, |
888 | ®isters_region); | |
889 | BUG_ON(retval < 0); | |
890 | ||
3038e353 | 891 | /* Add the vendor textual descriptor. */ |
937f6879 KH |
892 | retval = fw_core_add_descriptor(&vendor_id_descriptor); |
893 | BUG_ON(retval < 0); | |
894 | retval = fw_core_add_descriptor(&model_id_descriptor); | |
3038e353 KH |
895 | BUG_ON(retval < 0); |
896 | ||
897 | return 0; | |
898 | } | |
899 | ||
900 | static void __exit fw_core_cleanup(void) | |
901 | { | |
a3aca3da | 902 | unregister_chrdev(fw_cdev_major, "firewire"); |
3038e353 KH |
903 | bus_unregister(&fw_bus_type); |
904 | } | |
905 | ||
906 | module_init(fw_core_init); | |
907 | module_exit(fw_core_cleanup); |