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 | ||
2a0a2590 | 21 | #include <linux/completion.h> |
d6053e08 | 22 | #include <linux/idr.h> |
3038e353 | 23 | #include <linux/kernel.h> |
ae1e5355 | 24 | #include <linux/kref.h> |
3038e353 | 25 | #include <linux/module.h> |
c0220d68 | 26 | #include <linux/mutex.h> |
3038e353 KH |
27 | #include <linux/init.h> |
28 | #include <linux/interrupt.h> | |
29 | #include <linux/pci.h> | |
30 | #include <linux/delay.h> | |
31 | #include <linux/poll.h> | |
32 | #include <linux/list.h> | |
33 | #include <linux/kthread.h> | |
34 | #include <asm/uaccess.h> | |
3038e353 KH |
35 | |
36 | #include "fw-transaction.h" | |
37 | #include "fw-topology.h" | |
19a15b93 | 38 | #include "fw-device.h" |
3038e353 | 39 | |
a77754a7 KH |
40 | #define HEADER_PRI(pri) ((pri) << 0) |
41 | #define HEADER_TCODE(tcode) ((tcode) << 4) | |
42 | #define HEADER_RETRY(retry) ((retry) << 8) | |
43 | #define HEADER_TLABEL(tlabel) ((tlabel) << 10) | |
44 | #define HEADER_DESTINATION(destination) ((destination) << 16) | |
45 | #define HEADER_SOURCE(source) ((source) << 16) | |
46 | #define HEADER_RCODE(rcode) ((rcode) << 12) | |
47 | #define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0) | |
48 | #define HEADER_DATA_LENGTH(length) ((length) << 16) | |
49 | #define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0) | |
50 | ||
51 | #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f) | |
52 | #define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f) | |
53 | #define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f) | |
54 | #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff) | |
55 | #define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff) | |
56 | #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff) | |
57 | #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff) | |
58 | #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff) | |
59 | ||
a7ea6782 SR |
60 | #define HEADER_DESTINATION_IS_BROADCAST(q) \ |
61 | (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f)) | |
62 | ||
a77754a7 KH |
63 | #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22)) |
64 | #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23)) | |
65 | #define PHY_IDENTIFIER(id) ((id) << 30) | |
3038e353 | 66 | |
53dca511 SR |
67 | static int close_transaction(struct fw_transaction *transaction, |
68 | struct fw_card *card, int rcode, | |
69 | u32 *payload, size_t length) | |
3038e353 | 70 | { |
730c32f5 | 71 | struct fw_transaction *t; |
3038e353 KH |
72 | unsigned long flags; |
73 | ||
74 | spin_lock_irqsave(&card->lock, flags); | |
730c32f5 KH |
75 | list_for_each_entry(t, &card->transaction_list, link) { |
76 | if (t == transaction) { | |
77 | list_del(&t->link); | |
78 | card->tlabel_mask &= ~(1 << t->tlabel); | |
79 | break; | |
80 | } | |
81 | } | |
3038e353 KH |
82 | spin_unlock_irqrestore(&card->lock, flags); |
83 | ||
730c32f5 KH |
84 | if (&t->link != &card->transaction_list) { |
85 | t->callback(card, rcode, payload, length, t->callback_data); | |
86 | return 0; | |
87 | } | |
88 | ||
89 | return -ENOENT; | |
3038e353 KH |
90 | } |
91 | ||
c781c06d KH |
92 | /* |
93 | * Only valid for transactions that are potentially pending (ie have | |
94 | * been sent). | |
95 | */ | |
53dca511 SR |
96 | int fw_cancel_transaction(struct fw_card *card, |
97 | struct fw_transaction *transaction) | |
730c32f5 | 98 | { |
c781c06d KH |
99 | /* |
100 | * Cancel the packet transmission if it's still queued. That | |
730c32f5 | 101 | * will call the packet transmission callback which cancels |
c781c06d KH |
102 | * the transaction. |
103 | */ | |
730c32f5 KH |
104 | |
105 | if (card->driver->cancel_packet(card, &transaction->packet) == 0) | |
106 | return 0; | |
107 | ||
c781c06d KH |
108 | /* |
109 | * If the request packet has already been sent, we need to see | |
110 | * if the transaction is still pending and remove it in that case. | |
111 | */ | |
730c32f5 KH |
112 | |
113 | return close_transaction(transaction, card, RCODE_CANCELLED, NULL, 0); | |
114 | } | |
115 | EXPORT_SYMBOL(fw_cancel_transaction); | |
116 | ||
53dca511 SR |
117 | static void transmit_complete_callback(struct fw_packet *packet, |
118 | struct fw_card *card, int status) | |
3038e353 KH |
119 | { |
120 | struct fw_transaction *t = | |
121 | container_of(packet, struct fw_transaction, packet); | |
122 | ||
123 | switch (status) { | |
124 | case ACK_COMPLETE: | |
125 | close_transaction(t, card, RCODE_COMPLETE, NULL, 0); | |
126 | break; | |
127 | case ACK_PENDING: | |
128 | t->timestamp = packet->timestamp; | |
129 | break; | |
130 | case ACK_BUSY_X: | |
131 | case ACK_BUSY_A: | |
132 | case ACK_BUSY_B: | |
133 | close_transaction(t, card, RCODE_BUSY, NULL, 0); | |
134 | break; | |
135 | case ACK_DATA_ERROR: | |
e5f49c3b KH |
136 | close_transaction(t, card, RCODE_DATA_ERROR, NULL, 0); |
137 | break; | |
3038e353 | 138 | case ACK_TYPE_ERROR: |
e5f49c3b | 139 | close_transaction(t, card, RCODE_TYPE_ERROR, NULL, 0); |
3038e353 KH |
140 | break; |
141 | default: | |
c781c06d KH |
142 | /* |
143 | * In this case the ack is really a juju specific | |
144 | * rcode, so just forward that to the callback. | |
145 | */ | |
e5f49c3b | 146 | close_transaction(t, card, status, NULL, 0); |
3038e353 KH |
147 | break; |
148 | } | |
149 | } | |
150 | ||
53dca511 | 151 | static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel, |
b9549bc6 | 152 | int destination_id, int source_id, int generation, int speed, |
36bfe49d | 153 | unsigned long long offset, void *payload, size_t length) |
3038e353 KH |
154 | { |
155 | int ext_tcode; | |
156 | ||
157 | if (tcode > 0x10) { | |
8f9f963e | 158 | ext_tcode = tcode & ~0x10; |
3038e353 KH |
159 | tcode = TCODE_LOCK_REQUEST; |
160 | } else | |
161 | ext_tcode = 0; | |
162 | ||
163 | packet->header[0] = | |
a77754a7 KH |
164 | HEADER_RETRY(RETRY_X) | |
165 | HEADER_TLABEL(tlabel) | | |
166 | HEADER_TCODE(tcode) | | |
b9549bc6 | 167 | HEADER_DESTINATION(destination_id); |
3038e353 | 168 | packet->header[1] = |
a77754a7 | 169 | HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id); |
3038e353 KH |
170 | packet->header[2] = |
171 | offset; | |
172 | ||
173 | switch (tcode) { | |
174 | case TCODE_WRITE_QUADLET_REQUEST: | |
175 | packet->header[3] = *(u32 *)payload; | |
176 | packet->header_length = 16; | |
177 | packet->payload_length = 0; | |
178 | break; | |
179 | ||
180 | case TCODE_LOCK_REQUEST: | |
181 | case TCODE_WRITE_BLOCK_REQUEST: | |
182 | packet->header[3] = | |
a77754a7 KH |
183 | HEADER_DATA_LENGTH(length) | |
184 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
185 | packet->header_length = 16; |
186 | packet->payload = payload; | |
187 | packet->payload_length = length; | |
188 | break; | |
189 | ||
190 | case TCODE_READ_QUADLET_REQUEST: | |
191 | packet->header_length = 12; | |
192 | packet->payload_length = 0; | |
193 | break; | |
194 | ||
195 | case TCODE_READ_BLOCK_REQUEST: | |
196 | packet->header[3] = | |
a77754a7 KH |
197 | HEADER_DATA_LENGTH(length) | |
198 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
199 | packet->header_length = 16; |
200 | packet->payload_length = 0; | |
201 | break; | |
202 | } | |
203 | ||
204 | packet->speed = speed; | |
205 | packet->generation = generation; | |
730c32f5 | 206 | packet->ack = 0; |
1d1dc5e8 | 207 | packet->payload_bus = 0; |
3038e353 KH |
208 | } |
209 | ||
210 | /** | |
211 | * This function provides low-level access to the IEEE1394 transaction | |
212 | * logic. Most C programs would use either fw_read(), fw_write() or | |
213 | * fw_lock() instead - those function are convenience wrappers for | |
214 | * this function. The fw_send_request() function is primarily | |
215 | * provided as a flexible, one-stop entry point for languages bindings | |
216 | * and protocol bindings. | |
217 | * | |
218 | * FIXME: Document this function further, in particular the possible | |
219 | * values for rcode in the callback. In short, we map ACK_COMPLETE to | |
220 | * RCODE_COMPLETE, internal errors set errno and set rcode to | |
221 | * RCODE_SEND_ERROR (which is out of range for standard ieee1394 | |
222 | * rcodes). All other rcodes are forwarded unchanged. For all | |
223 | * errors, payload is NULL, length is 0. | |
224 | * | |
225 | * Can not expect the callback to be called before the function | |
226 | * returns, though this does happen in some cases (ACK_COMPLETE and | |
227 | * errors). | |
228 | * | |
229 | * The payload is only used for write requests and must not be freed | |
230 | * until the callback has been called. | |
231 | * | |
232 | * @param card the card from which to send the request | |
233 | * @param tcode the tcode for this transaction. Do not use | |
dbe7f76d | 234 | * TCODE_LOCK_REQUEST directly, instead use TCODE_LOCK_MASK_SWAP |
3038e353 | 235 | * etc. to specify tcode and ext_tcode. |
907293d7 | 236 | * @param node_id the destination node ID (bus ID and PHY ID concatenated) |
3038e353 KH |
237 | * @param generation the generation for which node_id is valid |
238 | * @param speed the speed to use for sending the request | |
239 | * @param offset the 48 bit offset on the destination node | |
240 | * @param payload the data payload for the request subaction | |
241 | * @param length the length in bytes of the data to read | |
242 | * @param callback function to be called when the transaction is completed | |
243 | * @param callback_data pointer to arbitrary data, which will be | |
244 | * passed to the callback | |
245 | */ | |
53dca511 SR |
246 | void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode, |
247 | int destination_id, int generation, int speed, | |
248 | unsigned long long offset, void *payload, size_t length, | |
249 | fw_transaction_callback_t callback, void *callback_data) | |
3038e353 KH |
250 | { |
251 | unsigned long flags; | |
b9549bc6 | 252 | int tlabel; |
3038e353 | 253 | |
c781c06d KH |
254 | /* |
255 | * Bump the flush timer up 100ms first of all so we | |
256 | * don't race with a flush timer callback. | |
257 | */ | |
3038e353 KH |
258 | |
259 | mod_timer(&card->flush_timer, jiffies + DIV_ROUND_UP(HZ, 10)); | |
260 | ||
c781c06d KH |
261 | /* |
262 | * Allocate tlabel from the bitmap and put the transaction on | |
263 | * the list while holding the card spinlock. | |
264 | */ | |
3038e353 KH |
265 | |
266 | spin_lock_irqsave(&card->lock, flags); | |
267 | ||
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 | ||
1e119fa9 | 278 | t->node_id = destination_id; |
3038e353 KH |
279 | t->tlabel = tlabel; |
280 | t->callback = callback; | |
281 | t->callback_data = callback_data; | |
282 | ||
1e119fa9 JF |
283 | fw_fill_request(&t->packet, tcode, t->tlabel, |
284 | destination_id, card->node_id, generation, | |
285 | speed, offset, payload, length); | |
3038e353 KH |
286 | t->packet.callback = transmit_complete_callback; |
287 | ||
e9aeb46c SR |
288 | list_add_tail(&t->link, &card->transaction_list); |
289 | ||
290 | spin_unlock_irqrestore(&card->lock, flags); | |
291 | ||
3038e353 KH |
292 | card->driver->send_request(card, &t->packet); |
293 | } | |
294 | EXPORT_SYMBOL(fw_send_request); | |
295 | ||
1e119fa9 JF |
296 | struct transaction_callback_data { |
297 | struct completion done; | |
298 | void *payload; | |
299 | int rcode; | |
300 | }; | |
301 | ||
302 | static void transaction_callback(struct fw_card *card, int rcode, | |
303 | void *payload, size_t length, void *data) | |
304 | { | |
305 | struct transaction_callback_data *d = data; | |
306 | ||
307 | if (rcode == RCODE_COMPLETE) | |
308 | memcpy(d->payload, payload, length); | |
309 | d->rcode = rcode; | |
310 | complete(&d->done); | |
311 | } | |
312 | ||
313 | /** | |
314 | * fw_run_transaction - send request and sleep until transaction is completed | |
315 | * | |
316 | * Returns the RCODE. | |
317 | */ | |
318 | int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, | |
53dca511 SR |
319 | int generation, int speed, unsigned long long offset, |
320 | void *data, size_t length) | |
1e119fa9 JF |
321 | { |
322 | struct transaction_callback_data d; | |
323 | struct fw_transaction t; | |
324 | ||
325 | init_completion(&d.done); | |
326 | d.payload = data; | |
327 | fw_send_request(card, &t, tcode, destination_id, generation, speed, | |
328 | offset, data, length, transaction_callback, &d); | |
329 | wait_for_completion(&d.done); | |
330 | ||
331 | return d.rcode; | |
332 | } | |
333 | EXPORT_SYMBOL(fw_run_transaction); | |
334 | ||
c0220d68 SR |
335 | static DEFINE_MUTEX(phy_config_mutex); |
336 | static DECLARE_COMPLETION(phy_config_done); | |
ae1e5355 SR |
337 | |
338 | static void transmit_phy_packet_callback(struct fw_packet *packet, | |
339 | struct fw_card *card, int status) | |
3038e353 | 340 | { |
c0220d68 | 341 | complete(&phy_config_done); |
3038e353 KH |
342 | } |
343 | ||
c0220d68 SR |
344 | static struct fw_packet phy_config_packet = { |
345 | .header_length = 8, | |
346 | .payload_length = 0, | |
347 | .speed = SCODE_100, | |
348 | .callback = transmit_phy_packet_callback, | |
349 | }; | |
350 | ||
83db801c KH |
351 | void fw_send_phy_config(struct fw_card *card, |
352 | int node_id, int generation, int gap_count) | |
3038e353 | 353 | { |
ae1e5355 | 354 | long timeout = DIV_ROUND_UP(HZ, 10); |
2a0a2590 SR |
355 | u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG) | |
356 | PHY_CONFIG_ROOT_ID(node_id) | | |
357 | PHY_CONFIG_GAP_COUNT(gap_count); | |
358 | ||
c0220d68 SR |
359 | mutex_lock(&phy_config_mutex); |
360 | ||
361 | phy_config_packet.header[0] = data; | |
362 | phy_config_packet.header[1] = ~data; | |
363 | phy_config_packet.generation = generation; | |
364 | INIT_COMPLETION(phy_config_done); | |
365 | ||
366 | card->driver->send_request(card, &phy_config_packet); | |
367 | wait_for_completion_timeout(&phy_config_done, timeout); | |
ae1e5355 | 368 | |
c0220d68 | 369 | mutex_unlock(&phy_config_mutex); |
3038e353 KH |
370 | } |
371 | ||
372 | void fw_flush_transactions(struct fw_card *card) | |
373 | { | |
374 | struct fw_transaction *t, *next; | |
375 | struct list_head list; | |
376 | unsigned long flags; | |
377 | ||
378 | INIT_LIST_HEAD(&list); | |
379 | spin_lock_irqsave(&card->lock, flags); | |
380 | list_splice_init(&card->transaction_list, &list); | |
381 | card->tlabel_mask = 0; | |
382 | spin_unlock_irqrestore(&card->lock, flags); | |
383 | ||
730c32f5 KH |
384 | list_for_each_entry_safe(t, next, &list, link) { |
385 | card->driver->cancel_packet(card, &t->packet); | |
386 | ||
c781c06d KH |
387 | /* |
388 | * At this point cancel_packet will never call the | |
730c32f5 | 389 | * transaction callback, since we just took all the |
c781c06d KH |
390 | * transactions out of the list. So do it here. |
391 | */ | |
3038e353 | 392 | t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data); |
730c32f5 | 393 | } |
3038e353 KH |
394 | } |
395 | ||
53dca511 SR |
396 | static struct fw_address_handler *lookup_overlapping_address_handler( |
397 | struct list_head *list, unsigned long long offset, size_t length) | |
3038e353 KH |
398 | { |
399 | struct fw_address_handler *handler; | |
400 | ||
401 | list_for_each_entry(handler, list, link) { | |
402 | if (handler->offset < offset + length && | |
403 | offset < handler->offset + handler->length) | |
404 | return handler; | |
405 | } | |
406 | ||
407 | return NULL; | |
408 | } | |
409 | ||
53dca511 SR |
410 | static struct fw_address_handler *lookup_enclosing_address_handler( |
411 | struct list_head *list, unsigned long long offset, size_t length) | |
3038e353 KH |
412 | { |
413 | struct fw_address_handler *handler; | |
414 | ||
415 | list_for_each_entry(handler, list, link) { | |
416 | if (handler->offset <= offset && | |
417 | offset + length <= handler->offset + handler->length) | |
418 | return handler; | |
419 | } | |
420 | ||
421 | return NULL; | |
422 | } | |
423 | ||
424 | static DEFINE_SPINLOCK(address_handler_lock); | |
425 | static LIST_HEAD(address_handler_list); | |
426 | ||
21ebcd12 | 427 | const struct fw_address_region fw_high_memory_region = |
5af4e5ea | 428 | { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, }; |
db8be076 AB |
429 | EXPORT_SYMBOL(fw_high_memory_region); |
430 | ||
431 | #if 0 | |
432 | const struct fw_address_region fw_low_memory_region = | |
433 | { .start = 0x000000000000ULL, .end = 0x000100000000ULL, }; | |
21ebcd12 | 434 | const struct fw_address_region fw_private_region = |
5af4e5ea | 435 | { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, }; |
21ebcd12 | 436 | const struct fw_address_region fw_csr_region = |
cca60977 JW |
437 | { .start = CSR_REGISTER_BASE, |
438 | .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, }; | |
21ebcd12 | 439 | const struct fw_address_region fw_unit_space_region = |
5af4e5ea | 440 | { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, }; |
db8be076 | 441 | #endif /* 0 */ |
3038e353 KH |
442 | |
443 | /** | |
3e0b5f0d SR |
444 | * fw_core_add_address_handler - register for incoming requests |
445 | * @handler: callback | |
446 | * @region: region in the IEEE 1212 node space address range | |
447 | * | |
448 | * region->start, ->end, and handler->length have to be quadlet-aligned. | |
449 | * | |
450 | * When a request is received that falls within the specified address range, | |
451 | * the specified callback is invoked. The parameters passed to the callback | |
452 | * give the details of the particular request. | |
1415d918 SR |
453 | * |
454 | * Return value: 0 on success, non-zero otherwise. | |
455 | * The start offset of the handler's address region is determined by | |
456 | * fw_core_add_address_handler() and is returned in handler->offset. | |
3038e353 | 457 | */ |
53dca511 SR |
458 | int fw_core_add_address_handler(struct fw_address_handler *handler, |
459 | const struct fw_address_region *region) | |
3038e353 KH |
460 | { |
461 | struct fw_address_handler *other; | |
462 | unsigned long flags; | |
463 | int ret = -EBUSY; | |
464 | ||
3e0b5f0d SR |
465 | if (region->start & 0xffff000000000003ULL || |
466 | region->end & 0xffff000000000003ULL || | |
467 | region->start >= region->end || | |
468 | handler->length & 3 || | |
469 | handler->length == 0) | |
470 | return -EINVAL; | |
471 | ||
3038e353 KH |
472 | spin_lock_irqsave(&address_handler_lock, flags); |
473 | ||
3e0b5f0d | 474 | handler->offset = region->start; |
3038e353 KH |
475 | while (handler->offset + handler->length <= region->end) { |
476 | other = | |
477 | lookup_overlapping_address_handler(&address_handler_list, | |
478 | handler->offset, | |
479 | handler->length); | |
480 | if (other != NULL) { | |
3e0b5f0d | 481 | handler->offset += other->length; |
3038e353 KH |
482 | } else { |
483 | list_add_tail(&handler->link, &address_handler_list); | |
484 | ret = 0; | |
485 | break; | |
486 | } | |
487 | } | |
488 | ||
489 | spin_unlock_irqrestore(&address_handler_lock, flags); | |
490 | ||
491 | return ret; | |
492 | } | |
3038e353 KH |
493 | EXPORT_SYMBOL(fw_core_add_address_handler); |
494 | ||
495 | /** | |
44be21b6 | 496 | * fw_core_remove_address_handler - unregister an address handler |
3038e353 | 497 | */ |
3038e353 KH |
498 | void fw_core_remove_address_handler(struct fw_address_handler *handler) |
499 | { | |
500 | unsigned long flags; | |
501 | ||
502 | spin_lock_irqsave(&address_handler_lock, flags); | |
503 | list_del(&handler->link); | |
504 | spin_unlock_irqrestore(&address_handler_lock, flags); | |
505 | } | |
3038e353 KH |
506 | EXPORT_SYMBOL(fw_core_remove_address_handler); |
507 | ||
508 | struct fw_request { | |
509 | struct fw_packet response; | |
36bfe49d | 510 | u32 request_header[4]; |
3038e353 KH |
511 | int ack; |
512 | u32 length; | |
513 | u32 data[0]; | |
514 | }; | |
515 | ||
53dca511 SR |
516 | static void free_response_callback(struct fw_packet *packet, |
517 | struct fw_card *card, int status) | |
3038e353 KH |
518 | { |
519 | struct fw_request *request; | |
520 | ||
521 | request = container_of(packet, struct fw_request, response); | |
522 | kfree(request); | |
523 | } | |
524 | ||
53dca511 SR |
525 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
526 | int rcode, void *payload, size_t length) | |
3038e353 KH |
527 | { |
528 | int tcode, tlabel, extended_tcode, source, destination; | |
529 | ||
a77754a7 KH |
530 | tcode = HEADER_GET_TCODE(request_header[0]); |
531 | tlabel = HEADER_GET_TLABEL(request_header[0]); | |
532 | source = HEADER_GET_DESTINATION(request_header[0]); | |
533 | destination = HEADER_GET_SOURCE(request_header[1]); | |
534 | extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]); | |
3038e353 KH |
535 | |
536 | response->header[0] = | |
a77754a7 KH |
537 | HEADER_RETRY(RETRY_1) | |
538 | HEADER_TLABEL(tlabel) | | |
539 | HEADER_DESTINATION(destination); | |
36bfe49d | 540 | response->header[1] = |
a77754a7 KH |
541 | HEADER_SOURCE(source) | |
542 | HEADER_RCODE(rcode); | |
3038e353 KH |
543 | response->header[2] = 0; |
544 | ||
545 | switch (tcode) { | |
546 | case TCODE_WRITE_QUADLET_REQUEST: | |
547 | case TCODE_WRITE_BLOCK_REQUEST: | |
a77754a7 | 548 | response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE); |
3038e353 KH |
549 | response->header_length = 12; |
550 | response->payload_length = 0; | |
551 | break; | |
552 | ||
553 | case TCODE_READ_QUADLET_REQUEST: | |
554 | response->header[0] |= | |
a77754a7 | 555 | HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE); |
93c4cceb KH |
556 | if (payload != NULL) |
557 | response->header[3] = *(u32 *)payload; | |
558 | else | |
559 | response->header[3] = 0; | |
3038e353 KH |
560 | response->header_length = 16; |
561 | response->payload_length = 0; | |
562 | break; | |
563 | ||
564 | case TCODE_READ_BLOCK_REQUEST: | |
565 | case TCODE_LOCK_REQUEST: | |
a77754a7 | 566 | response->header[0] |= HEADER_TCODE(tcode + 2); |
3038e353 | 567 | response->header[3] = |
a77754a7 KH |
568 | HEADER_DATA_LENGTH(length) | |
569 | HEADER_EXTENDED_TCODE(extended_tcode); | |
3038e353 | 570 | response->header_length = 16; |
36bfe49d KH |
571 | response->payload = payload; |
572 | response->payload_length = length; | |
3038e353 KH |
573 | break; |
574 | ||
575 | default: | |
576 | BUG(); | |
577 | return; | |
578 | } | |
1d1dc5e8 SR |
579 | |
580 | response->payload_bus = 0; | |
3038e353 | 581 | } |
93c4cceb | 582 | EXPORT_SYMBOL(fw_fill_response); |
3038e353 | 583 | |
53dca511 | 584 | static struct fw_request *allocate_request(struct fw_packet *p) |
3038e353 KH |
585 | { |
586 | struct fw_request *request; | |
587 | u32 *data, length; | |
2639a6fb | 588 | int request_tcode, t; |
3038e353 | 589 | |
a77754a7 | 590 | request_tcode = HEADER_GET_TCODE(p->header[0]); |
3038e353 KH |
591 | switch (request_tcode) { |
592 | case TCODE_WRITE_QUADLET_REQUEST: | |
2639a6fb | 593 | data = &p->header[3]; |
3038e353 KH |
594 | length = 4; |
595 | break; | |
596 | ||
597 | case TCODE_WRITE_BLOCK_REQUEST: | |
598 | case TCODE_LOCK_REQUEST: | |
2639a6fb | 599 | data = p->payload; |
a77754a7 | 600 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
601 | break; |
602 | ||
603 | case TCODE_READ_QUADLET_REQUEST: | |
604 | data = NULL; | |
605 | length = 4; | |
606 | break; | |
607 | ||
608 | case TCODE_READ_BLOCK_REQUEST: | |
609 | data = NULL; | |
a77754a7 | 610 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
611 | break; |
612 | ||
613 | default: | |
0bf607c5 SR |
614 | fw_error("ERROR - corrupt request received - %08x %08x %08x\n", |
615 | p->header[0], p->header[1], p->header[2]); | |
3038e353 KH |
616 | return NULL; |
617 | } | |
618 | ||
2d826cc5 | 619 | request = kmalloc(sizeof(*request) + length, GFP_ATOMIC); |
3038e353 KH |
620 | if (request == NULL) |
621 | return NULL; | |
622 | ||
2639a6fb KH |
623 | t = (p->timestamp & 0x1fff) + 4000; |
624 | if (t >= 8000) | |
625 | t = (p->timestamp & ~0x1fff) + 0x2000 + t - 8000; | |
626 | else | |
627 | t = (p->timestamp & ~0x1fff) + t; | |
628 | ||
629 | request->response.speed = p->speed; | |
630 | request->response.timestamp = t; | |
631 | request->response.generation = p->generation; | |
730c32f5 | 632 | request->response.ack = 0; |
3038e353 | 633 | request->response.callback = free_response_callback; |
2639a6fb | 634 | request->ack = p->ack; |
93c4cceb | 635 | request->length = length; |
3038e353 | 636 | if (data) |
6e2e8424 | 637 | memcpy(request->data, data, length); |
3038e353 | 638 | |
2d826cc5 | 639 | memcpy(request->request_header, p->header, sizeof(p->header)); |
3038e353 KH |
640 | |
641 | return request; | |
642 | } | |
643 | ||
53dca511 SR |
644 | void fw_send_response(struct fw_card *card, |
645 | struct fw_request *request, int rcode) | |
3038e353 | 646 | { |
a7ea6782 SR |
647 | /* unified transaction or broadcast transaction: don't respond */ |
648 | if (request->ack != ACK_PENDING || | |
649 | HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) { | |
9c9bdf4d | 650 | kfree(request); |
3038e353 | 651 | return; |
9c9bdf4d | 652 | } |
3038e353 | 653 | |
36bfe49d KH |
654 | if (rcode == RCODE_COMPLETE) |
655 | fw_fill_response(&request->response, request->request_header, | |
656 | rcode, request->data, request->length); | |
657 | else | |
658 | fw_fill_response(&request->response, request->request_header, | |
659 | rcode, NULL, 0); | |
3038e353 KH |
660 | |
661 | card->driver->send_response(card, &request->response); | |
662 | } | |
3038e353 KH |
663 | EXPORT_SYMBOL(fw_send_response); |
664 | ||
53dca511 | 665 | void fw_core_handle_request(struct fw_card *card, struct fw_packet *p) |
3038e353 KH |
666 | { |
667 | struct fw_address_handler *handler; | |
668 | struct fw_request *request; | |
669 | unsigned long long offset; | |
670 | unsigned long flags; | |
2639a6fb | 671 | int tcode, destination, source; |
3038e353 | 672 | |
2639a6fb | 673 | if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE) |
3038e353 KH |
674 | return; |
675 | ||
2639a6fb | 676 | request = allocate_request(p); |
3038e353 KH |
677 | if (request == NULL) { |
678 | /* FIXME: send statically allocated busy packet. */ | |
679 | return; | |
680 | } | |
681 | ||
682 | offset = | |
683 | ((unsigned long long) | |
a77754a7 KH |
684 | HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | p->header[2]; |
685 | tcode = HEADER_GET_TCODE(p->header[0]); | |
686 | destination = HEADER_GET_DESTINATION(p->header[0]); | |
478b233e | 687 | source = HEADER_GET_SOURCE(p->header[1]); |
3038e353 KH |
688 | |
689 | spin_lock_irqsave(&address_handler_lock, flags); | |
690 | handler = lookup_enclosing_address_handler(&address_handler_list, | |
691 | offset, request->length); | |
692 | spin_unlock_irqrestore(&address_handler_lock, flags); | |
693 | ||
c781c06d KH |
694 | /* |
695 | * FIXME: lookup the fw_node corresponding to the sender of | |
3038e353 KH |
696 | * this request and pass that to the address handler instead |
697 | * of the node ID. We may also want to move the address | |
698 | * allocations to fw_node so we only do this callback if the | |
c781c06d KH |
699 | * upper layers registered it for this node. |
700 | */ | |
3038e353 KH |
701 | |
702 | if (handler == NULL) | |
703 | fw_send_response(card, request, RCODE_ADDRESS_ERROR); | |
704 | else | |
705 | handler->address_callback(card, request, | |
706 | tcode, destination, source, | |
2639a6fb | 707 | p->generation, p->speed, offset, |
3038e353 KH |
708 | request->data, request->length, |
709 | handler->callback_data); | |
710 | } | |
3038e353 KH |
711 | EXPORT_SYMBOL(fw_core_handle_request); |
712 | ||
53dca511 | 713 | void fw_core_handle_response(struct fw_card *card, struct fw_packet *p) |
3038e353 KH |
714 | { |
715 | struct fw_transaction *t; | |
716 | unsigned long flags; | |
717 | u32 *data; | |
718 | size_t data_length; | |
719 | int tcode, tlabel, destination, source, rcode; | |
720 | ||
a77754a7 KH |
721 | tcode = HEADER_GET_TCODE(p->header[0]); |
722 | tlabel = HEADER_GET_TLABEL(p->header[0]); | |
723 | destination = HEADER_GET_DESTINATION(p->header[0]); | |
724 | source = HEADER_GET_SOURCE(p->header[1]); | |
725 | rcode = HEADER_GET_RCODE(p->header[1]); | |
3038e353 KH |
726 | |
727 | spin_lock_irqsave(&card->lock, flags); | |
728 | list_for_each_entry(t, &card->transaction_list, link) { | |
729 | if (t->node_id == source && t->tlabel == tlabel) { | |
730 | list_del(&t->link); | |
731 | card->tlabel_mask &= ~(1 << t->tlabel); | |
732 | break; | |
733 | } | |
734 | } | |
735 | spin_unlock_irqrestore(&card->lock, flags); | |
736 | ||
737 | if (&t->link == &card->transaction_list) { | |
32b46093 KH |
738 | fw_notify("Unsolicited response (source %x, tlabel %x)\n", |
739 | source, tlabel); | |
3038e353 KH |
740 | return; |
741 | } | |
742 | ||
c781c06d KH |
743 | /* |
744 | * FIXME: sanity check packet, is length correct, does tcodes | |
745 | * and addresses match. | |
746 | */ | |
3038e353 KH |
747 | |
748 | switch (tcode) { | |
749 | case TCODE_READ_QUADLET_RESPONSE: | |
2639a6fb | 750 | data = (u32 *) &p->header[3]; |
3038e353 KH |
751 | data_length = 4; |
752 | break; | |
753 | ||
754 | case TCODE_WRITE_RESPONSE: | |
755 | data = NULL; | |
756 | data_length = 0; | |
757 | break; | |
758 | ||
759 | case TCODE_READ_BLOCK_RESPONSE: | |
760 | case TCODE_LOCK_RESPONSE: | |
93c4cceb | 761 | data = p->payload; |
a77754a7 | 762 | data_length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
763 | break; |
764 | ||
765 | default: | |
766 | /* Should never happen, this is just to shut up gcc. */ | |
767 | data = NULL; | |
768 | data_length = 0; | |
769 | break; | |
770 | } | |
771 | ||
10a4c735 SR |
772 | /* |
773 | * The response handler may be executed while the request handler | |
774 | * is still pending. Cancel the request handler. | |
775 | */ | |
776 | card->driver->cancel_packet(card, &t->packet); | |
777 | ||
3038e353 KH |
778 | t->callback(card, rcode, data, data_length, t->callback_data); |
779 | } | |
3038e353 KH |
780 | EXPORT_SYMBOL(fw_core_handle_response); |
781 | ||
ae57988f | 782 | static const struct fw_address_region topology_map_region = |
cca60977 JW |
783 | { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP, |
784 | .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, }; | |
473d28c7 | 785 | |
53dca511 SR |
786 | static void handle_topology_map(struct fw_card *card, struct fw_request *request, |
787 | int tcode, int destination, int source, int generation, | |
788 | int speed, unsigned long long offset, | |
789 | void *payload, size_t length, void *callback_data) | |
473d28c7 KH |
790 | { |
791 | int i, start, end; | |
efbf390a | 792 | __be32 *map; |
473d28c7 KH |
793 | |
794 | if (!TCODE_IS_READ_REQUEST(tcode)) { | |
795 | fw_send_response(card, request, RCODE_TYPE_ERROR); | |
796 | return; | |
797 | } | |
798 | ||
799 | if ((offset & 3) > 0 || (length & 3) > 0) { | |
800 | fw_send_response(card, request, RCODE_ADDRESS_ERROR); | |
801 | return; | |
802 | } | |
803 | ||
804 | start = (offset - topology_map_region.start) / 4; | |
805 | end = start + length / 4; | |
806 | map = payload; | |
807 | ||
808 | for (i = 0; i < length / 4; i++) | |
809 | map[i] = cpu_to_be32(card->topology_map[start + i]); | |
810 | ||
811 | fw_send_response(card, request, RCODE_COMPLETE); | |
812 | } | |
813 | ||
814 | static struct fw_address_handler topology_map = { | |
d60d7f1d | 815 | .length = 0x200, |
473d28c7 KH |
816 | .address_callback = handle_topology_map, |
817 | }; | |
818 | ||
ae57988f | 819 | static const struct fw_address_region registers_region = |
cca60977 JW |
820 | { .start = CSR_REGISTER_BASE, |
821 | .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, }; | |
d60d7f1d | 822 | |
53dca511 SR |
823 | static void handle_registers(struct fw_card *card, struct fw_request *request, |
824 | int tcode, int destination, int source, int generation, | |
825 | int speed, unsigned long long offset, | |
826 | void *payload, size_t length, void *callback_data) | |
d60d7f1d | 827 | { |
15f0d833 | 828 | int reg = offset & ~CSR_REGISTER_BASE; |
d60d7f1d KH |
829 | unsigned long long bus_time; |
830 | __be32 *data = payload; | |
e534fe16 | 831 | int rcode = RCODE_COMPLETE; |
d60d7f1d KH |
832 | |
833 | switch (reg) { | |
834 | case CSR_CYCLE_TIME: | |
835 | case CSR_BUS_TIME: | |
836 | if (!TCODE_IS_READ_REQUEST(tcode) || length != 4) { | |
e534fe16 | 837 | rcode = RCODE_TYPE_ERROR; |
d60d7f1d KH |
838 | break; |
839 | } | |
840 | ||
841 | bus_time = card->driver->get_bus_time(card); | |
842 | if (reg == CSR_CYCLE_TIME) | |
843 | *data = cpu_to_be32(bus_time); | |
844 | else | |
845 | *data = cpu_to_be32(bus_time >> 25); | |
e534fe16 SR |
846 | break; |
847 | ||
848 | case CSR_BROADCAST_CHANNEL: | |
849 | if (tcode == TCODE_READ_QUADLET_REQUEST) | |
850 | *data = cpu_to_be32(card->broadcast_channel); | |
851 | else if (tcode == TCODE_WRITE_QUADLET_REQUEST) | |
852 | card->broadcast_channel = | |
853 | (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) | | |
854 | BROADCAST_CHANNEL_INITIAL; | |
855 | else | |
856 | rcode = RCODE_TYPE_ERROR; | |
d60d7f1d KH |
857 | break; |
858 | ||
859 | case CSR_BUS_MANAGER_ID: | |
860 | case CSR_BANDWIDTH_AVAILABLE: | |
861 | case CSR_CHANNELS_AVAILABLE_HI: | |
862 | case CSR_CHANNELS_AVAILABLE_LO: | |
c781c06d KH |
863 | /* |
864 | * FIXME: these are handled by the OHCI hardware and | |
d60d7f1d KH |
865 | * the stack never sees these request. If we add |
866 | * support for a new type of controller that doesn't | |
867 | * handle this in hardware we need to deal with these | |
c781c06d KH |
868 | * transactions. |
869 | */ | |
d60d7f1d KH |
870 | BUG(); |
871 | break; | |
872 | ||
873 | case CSR_BUSY_TIMEOUT: | |
874 | /* FIXME: Implement this. */ | |
e534fe16 | 875 | |
d60d7f1d | 876 | default: |
e534fe16 | 877 | rcode = RCODE_ADDRESS_ERROR; |
d60d7f1d KH |
878 | break; |
879 | } | |
e534fe16 SR |
880 | |
881 | fw_send_response(card, request, rcode); | |
d60d7f1d KH |
882 | } |
883 | ||
884 | static struct fw_address_handler registers = { | |
885 | .length = 0x400, | |
886 | .address_callback = handle_registers, | |
887 | }; | |
888 | ||
3038e353 KH |
889 | MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>"); |
890 | MODULE_DESCRIPTION("Core IEEE1394 transaction logic"); | |
891 | MODULE_LICENSE("GPL"); | |
892 | ||
937f6879 | 893 | static const u32 vendor_textual_descriptor[] = { |
3038e353 | 894 | /* textual descriptor leaf () */ |
937f6879 | 895 | 0x00060000, |
3038e353 KH |
896 | 0x00000000, |
897 | 0x00000000, | |
898 | 0x4c696e75, /* L i n u */ | |
899 | 0x78204669, /* x F i */ | |
900 | 0x72657769, /* r e w i */ | |
937f6879 | 901 | 0x72650000, /* r e */ |
3038e353 KH |
902 | }; |
903 | ||
937f6879 KH |
904 | static const u32 model_textual_descriptor[] = { |
905 | /* model descriptor leaf () */ | |
906 | 0x00030000, | |
907 | 0x00000000, | |
908 | 0x00000000, | |
909 | 0x4a756a75, /* J u j u */ | |
910 | }; | |
911 | ||
912 | static struct fw_descriptor vendor_id_descriptor = { | |
913 | .length = ARRAY_SIZE(vendor_textual_descriptor), | |
914 | .immediate = 0x03d00d1e, | |
3038e353 | 915 | .key = 0x81000000, |
937f6879 KH |
916 | .data = vendor_textual_descriptor, |
917 | }; | |
918 | ||
919 | static struct fw_descriptor model_id_descriptor = { | |
920 | .length = ARRAY_SIZE(model_textual_descriptor), | |
921 | .immediate = 0x17000001, | |
922 | .key = 0x81000000, | |
923 | .data = model_textual_descriptor, | |
3038e353 KH |
924 | }; |
925 | ||
3038e353 KH |
926 | static int __init fw_core_init(void) |
927 | { | |
2dbd7d7e | 928 | int ret; |
3038e353 | 929 | |
2dbd7d7e SR |
930 | ret = bus_register(&fw_bus_type); |
931 | if (ret < 0) | |
932 | return ret; | |
3038e353 | 933 | |
a3aca3da KH |
934 | fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops); |
935 | if (fw_cdev_major < 0) { | |
936 | bus_unregister(&fw_bus_type); | |
937 | return fw_cdev_major; | |
938 | } | |
939 | ||
c490a6de SR |
940 | fw_core_add_address_handler(&topology_map, &topology_map_region); |
941 | fw_core_add_address_handler(®isters, ®isters_region); | |
942 | fw_core_add_descriptor(&vendor_id_descriptor); | |
943 | fw_core_add_descriptor(&model_id_descriptor); | |
3038e353 KH |
944 | |
945 | return 0; | |
946 | } | |
947 | ||
948 | static void __exit fw_core_cleanup(void) | |
949 | { | |
a3aca3da | 950 | unregister_chrdev(fw_cdev_major, "firewire"); |
3038e353 | 951 | bus_unregister(&fw_bus_type); |
d6053e08 | 952 | idr_destroy(&fw_device_idr); |
3038e353 KH |
953 | } |
954 | ||
955 | module_init(fw_core_init); | |
956 | module_exit(fw_core_cleanup); |