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 | ||
e8ca9702 | 21 | #include <linux/bug.h> |
2a0a2590 | 22 | #include <linux/completion.h> |
e8ca9702 SR |
23 | #include <linux/device.h> |
24 | #include <linux/errno.h> | |
77c9a5da | 25 | #include <linux/firewire.h> |
e8ca9702 SR |
26 | #include <linux/firewire-constants.h> |
27 | #include <linux/fs.h> | |
28 | #include <linux/init.h> | |
d6053e08 | 29 | #include <linux/idr.h> |
e8ca9702 | 30 | #include <linux/jiffies.h> |
3038e353 | 31 | #include <linux/kernel.h> |
3038e353 | 32 | #include <linux/list.h> |
e8ca9702 SR |
33 | #include <linux/module.h> |
34 | #include <linux/slab.h> | |
35 | #include <linux/spinlock.h> | |
36 | #include <linux/string.h> | |
37 | #include <linux/timer.h> | |
38 | #include <linux/types.h> | |
6ea9e7bb | 39 | #include <linux/workqueue.h> |
e8ca9702 SR |
40 | |
41 | #include <asm/byteorder.h> | |
3038e353 | 42 | |
77c9a5da | 43 | #include "core.h" |
3038e353 | 44 | |
a77754a7 KH |
45 | #define HEADER_PRI(pri) ((pri) << 0) |
46 | #define HEADER_TCODE(tcode) ((tcode) << 4) | |
47 | #define HEADER_RETRY(retry) ((retry) << 8) | |
48 | #define HEADER_TLABEL(tlabel) ((tlabel) << 10) | |
49 | #define HEADER_DESTINATION(destination) ((destination) << 16) | |
50 | #define HEADER_SOURCE(source) ((source) << 16) | |
51 | #define HEADER_RCODE(rcode) ((rcode) << 12) | |
52 | #define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0) | |
53 | #define HEADER_DATA_LENGTH(length) ((length) << 16) | |
54 | #define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0) | |
55 | ||
56 | #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f) | |
57 | #define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f) | |
58 | #define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f) | |
59 | #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff) | |
60 | #define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff) | |
61 | #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff) | |
62 | #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff) | |
63 | #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff) | |
64 | ||
a7ea6782 SR |
65 | #define HEADER_DESTINATION_IS_BROADCAST(q) \ |
66 | (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f)) | |
67 | ||
77c9a5da SR |
68 | #define PHY_PACKET_CONFIG 0x0 |
69 | #define PHY_PACKET_LINK_ON 0x1 | |
70 | #define PHY_PACKET_SELF_ID 0x2 | |
71 | ||
a77754a7 KH |
72 | #define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22)) |
73 | #define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23)) | |
74 | #define PHY_IDENTIFIER(id) ((id) << 30) | |
3038e353 | 75 | |
410cf2bd CL |
76 | /* returns 0 if the split timeout handler is already running */ |
77 | static int try_cancel_split_timeout(struct fw_transaction *t) | |
78 | { | |
79 | if (t->is_split_transaction) | |
80 | return del_timer(&t->split_timeout_timer); | |
81 | else | |
82 | return 1; | |
83 | } | |
84 | ||
53dca511 | 85 | static int close_transaction(struct fw_transaction *transaction, |
a38a00fd | 86 | struct fw_card *card, int rcode) |
3038e353 | 87 | { |
730c32f5 | 88 | struct fw_transaction *t; |
3038e353 KH |
89 | unsigned long flags; |
90 | ||
91 | spin_lock_irqsave(&card->lock, flags); | |
730c32f5 KH |
92 | list_for_each_entry(t, &card->transaction_list, link) { |
93 | if (t == transaction) { | |
410cf2bd | 94 | if (!try_cancel_split_timeout(t)) { |
2222bcb7 CL |
95 | spin_unlock_irqrestore(&card->lock, flags); |
96 | goto timed_out; | |
97 | } | |
5c40cbfe | 98 | list_del_init(&t->link); |
1e626fdc | 99 | card->tlabel_mask &= ~(1ULL << t->tlabel); |
730c32f5 KH |
100 | break; |
101 | } | |
102 | } | |
3038e353 KH |
103 | spin_unlock_irqrestore(&card->lock, flags); |
104 | ||
730c32f5 | 105 | if (&t->link != &card->transaction_list) { |
a38a00fd | 106 | t->callback(card, rcode, NULL, 0, t->callback_data); |
730c32f5 KH |
107 | return 0; |
108 | } | |
109 | ||
2222bcb7 | 110 | timed_out: |
730c32f5 | 111 | return -ENOENT; |
3038e353 KH |
112 | } |
113 | ||
c781c06d KH |
114 | /* |
115 | * Only valid for transactions that are potentially pending (ie have | |
116 | * been sent). | |
117 | */ | |
53dca511 SR |
118 | int fw_cancel_transaction(struct fw_card *card, |
119 | struct fw_transaction *transaction) | |
730c32f5 | 120 | { |
c781c06d KH |
121 | /* |
122 | * Cancel the packet transmission if it's still queued. That | |
730c32f5 | 123 | * will call the packet transmission callback which cancels |
c781c06d KH |
124 | * the transaction. |
125 | */ | |
730c32f5 KH |
126 | |
127 | if (card->driver->cancel_packet(card, &transaction->packet) == 0) | |
128 | return 0; | |
129 | ||
c781c06d KH |
130 | /* |
131 | * If the request packet has already been sent, we need to see | |
132 | * if the transaction is still pending and remove it in that case. | |
133 | */ | |
730c32f5 | 134 | |
a38a00fd | 135 | return close_transaction(transaction, card, RCODE_CANCELLED); |
730c32f5 KH |
136 | } |
137 | EXPORT_SYMBOL(fw_cancel_transaction); | |
138 | ||
5c40cbfe CL |
139 | static void split_transaction_timeout_callback(unsigned long data) |
140 | { | |
141 | struct fw_transaction *t = (struct fw_transaction *)data; | |
142 | struct fw_card *card = t->card; | |
143 | unsigned long flags; | |
144 | ||
145 | spin_lock_irqsave(&card->lock, flags); | |
146 | if (list_empty(&t->link)) { | |
147 | spin_unlock_irqrestore(&card->lock, flags); | |
148 | return; | |
149 | } | |
150 | list_del(&t->link); | |
151 | card->tlabel_mask &= ~(1ULL << t->tlabel); | |
152 | spin_unlock_irqrestore(&card->lock, flags); | |
153 | ||
5c40cbfe CL |
154 | t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data); |
155 | } | |
156 | ||
410cf2bd CL |
157 | static void start_split_transaction_timeout(struct fw_transaction *t, |
158 | struct fw_card *card) | |
159 | { | |
160 | unsigned long flags; | |
161 | ||
162 | spin_lock_irqsave(&card->lock, flags); | |
163 | ||
164 | if (list_empty(&t->link) || WARN_ON(t->is_split_transaction)) { | |
165 | spin_unlock_irqrestore(&card->lock, flags); | |
166 | return; | |
167 | } | |
168 | ||
169 | t->is_split_transaction = true; | |
170 | mod_timer(&t->split_timeout_timer, | |
171 | jiffies + card->split_timeout_jiffies); | |
172 | ||
173 | spin_unlock_irqrestore(&card->lock, flags); | |
174 | } | |
175 | ||
53dca511 SR |
176 | static void transmit_complete_callback(struct fw_packet *packet, |
177 | struct fw_card *card, int status) | |
3038e353 KH |
178 | { |
179 | struct fw_transaction *t = | |
180 | container_of(packet, struct fw_transaction, packet); | |
181 | ||
182 | switch (status) { | |
183 | case ACK_COMPLETE: | |
a38a00fd | 184 | close_transaction(t, card, RCODE_COMPLETE); |
3038e353 KH |
185 | break; |
186 | case ACK_PENDING: | |
410cf2bd | 187 | start_split_transaction_timeout(t, card); |
3038e353 KH |
188 | break; |
189 | case ACK_BUSY_X: | |
190 | case ACK_BUSY_A: | |
191 | case ACK_BUSY_B: | |
a38a00fd | 192 | close_transaction(t, card, RCODE_BUSY); |
3038e353 KH |
193 | break; |
194 | case ACK_DATA_ERROR: | |
a38a00fd | 195 | close_transaction(t, card, RCODE_DATA_ERROR); |
e5f49c3b | 196 | break; |
3038e353 | 197 | case ACK_TYPE_ERROR: |
a38a00fd | 198 | close_transaction(t, card, RCODE_TYPE_ERROR); |
3038e353 KH |
199 | break; |
200 | default: | |
c781c06d KH |
201 | /* |
202 | * In this case the ack is really a juju specific | |
203 | * rcode, so just forward that to the callback. | |
204 | */ | |
a38a00fd | 205 | close_transaction(t, card, status); |
3038e353 KH |
206 | break; |
207 | } | |
208 | } | |
209 | ||
53dca511 | 210 | static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel, |
b9549bc6 | 211 | int destination_id, int source_id, int generation, int speed, |
36bfe49d | 212 | unsigned long long offset, void *payload, size_t length) |
3038e353 KH |
213 | { |
214 | int ext_tcode; | |
215 | ||
18e9b10f SR |
216 | if (tcode == TCODE_STREAM_DATA) { |
217 | packet->header[0] = | |
218 | HEADER_DATA_LENGTH(length) | | |
219 | destination_id | | |
220 | HEADER_TCODE(TCODE_STREAM_DATA); | |
221 | packet->header_length = 4; | |
222 | packet->payload = payload; | |
223 | packet->payload_length = length; | |
224 | ||
225 | goto common; | |
226 | } | |
227 | ||
3038e353 | 228 | if (tcode > 0x10) { |
8f9f963e | 229 | ext_tcode = tcode & ~0x10; |
3038e353 KH |
230 | tcode = TCODE_LOCK_REQUEST; |
231 | } else | |
232 | ext_tcode = 0; | |
233 | ||
234 | packet->header[0] = | |
a77754a7 KH |
235 | HEADER_RETRY(RETRY_X) | |
236 | HEADER_TLABEL(tlabel) | | |
237 | HEADER_TCODE(tcode) | | |
b9549bc6 | 238 | HEADER_DESTINATION(destination_id); |
3038e353 | 239 | packet->header[1] = |
a77754a7 | 240 | HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id); |
3038e353 KH |
241 | packet->header[2] = |
242 | offset; | |
243 | ||
244 | switch (tcode) { | |
245 | case TCODE_WRITE_QUADLET_REQUEST: | |
246 | packet->header[3] = *(u32 *)payload; | |
247 | packet->header_length = 16; | |
248 | packet->payload_length = 0; | |
249 | break; | |
250 | ||
251 | case TCODE_LOCK_REQUEST: | |
252 | case TCODE_WRITE_BLOCK_REQUEST: | |
253 | packet->header[3] = | |
a77754a7 KH |
254 | HEADER_DATA_LENGTH(length) | |
255 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
256 | packet->header_length = 16; |
257 | packet->payload = payload; | |
258 | packet->payload_length = length; | |
259 | break; | |
260 | ||
261 | case TCODE_READ_QUADLET_REQUEST: | |
262 | packet->header_length = 12; | |
263 | packet->payload_length = 0; | |
264 | break; | |
265 | ||
266 | case TCODE_READ_BLOCK_REQUEST: | |
267 | packet->header[3] = | |
a77754a7 KH |
268 | HEADER_DATA_LENGTH(length) | |
269 | HEADER_EXTENDED_TCODE(ext_tcode); | |
3038e353 KH |
270 | packet->header_length = 16; |
271 | packet->payload_length = 0; | |
272 | break; | |
5b189bf3 SR |
273 | |
274 | default: | |
5878730b | 275 | WARN(1, "wrong tcode %d\n", tcode); |
3038e353 | 276 | } |
18e9b10f | 277 | common: |
3038e353 KH |
278 | packet->speed = speed; |
279 | packet->generation = generation; | |
730c32f5 | 280 | packet->ack = 0; |
19593ffd | 281 | packet->payload_mapped = false; |
3038e353 KH |
282 | } |
283 | ||
7906054f CL |
284 | static int allocate_tlabel(struct fw_card *card) |
285 | { | |
286 | int tlabel; | |
287 | ||
288 | tlabel = card->current_tlabel; | |
289 | while (card->tlabel_mask & (1ULL << tlabel)) { | |
290 | tlabel = (tlabel + 1) & 0x3f; | |
291 | if (tlabel == card->current_tlabel) | |
292 | return -EBUSY; | |
293 | } | |
294 | ||
295 | card->current_tlabel = (tlabel + 1) & 0x3f; | |
296 | card->tlabel_mask |= 1ULL << tlabel; | |
297 | ||
298 | return tlabel; | |
299 | } | |
300 | ||
3038e353 | 301 | /** |
656b7afd SR |
302 | * fw_send_request() - submit a request packet for transmission |
303 | * @card: interface to send the request at | |
304 | * @t: transaction instance to which the request belongs | |
305 | * @tcode: transaction code | |
306 | * @destination_id: destination node ID, consisting of bus_ID and phy_ID | |
307 | * @generation: bus generation in which request and response are valid | |
308 | * @speed: transmission speed | |
309 | * @offset: 48bit wide offset into destination's address space | |
310 | * @payload: data payload for the request subaction | |
311 | * @length: length of the payload, in bytes | |
312 | * @callback: function to be called when the transaction is completed | |
313 | * @callback_data: data to be passed to the transaction completion callback | |
3038e353 | 314 | * |
656b7afd SR |
315 | * Submit a request packet into the asynchronous request transmission queue. |
316 | * Can be called from atomic context. If you prefer a blocking API, use | |
317 | * fw_run_transaction() in a context that can sleep. | |
3038e353 | 318 | * |
656b7afd SR |
319 | * In case of lock requests, specify one of the firewire-core specific %TCODE_ |
320 | * constants instead of %TCODE_LOCK_REQUEST in @tcode. | |
3038e353 | 321 | * |
656b7afd SR |
322 | * Make sure that the value in @destination_id is not older than the one in |
323 | * @generation. Otherwise the request is in danger to be sent to a wrong node. | |
3038e353 | 324 | * |
656b7afd | 325 | * In case of asynchronous stream packets i.e. %TCODE_STREAM_DATA, the caller |
18e9b10f | 326 | * needs to synthesize @destination_id with fw_stream_packet_destination_id(). |
656b7afd SR |
327 | * It will contain tag, channel, and sy data instead of a node ID then. |
328 | * | |
329 | * The payload buffer at @data is going to be DMA-mapped except in case of | |
f30e6d3e SR |
330 | * @length <= 8 or of local (loopback) requests. Hence make sure that the |
331 | * buffer complies with the restrictions of the streaming DMA mapping API. | |
656b7afd SR |
332 | * @payload must not be freed before the @callback is called. |
333 | * | |
334 | * In case of request types without payload, @data is NULL and @length is 0. | |
335 | * | |
336 | * After the transaction is completed successfully or unsuccessfully, the | |
337 | * @callback will be called. Among its parameters is the response code which | |
338 | * is either one of the rcodes per IEEE 1394 or, in case of internal errors, | |
18d0cdfd SR |
339 | * the firewire-core specific %RCODE_SEND_ERROR. The other firewire-core |
340 | * specific rcodes (%RCODE_CANCELLED, %RCODE_BUSY, %RCODE_GENERATION, | |
341 | * %RCODE_NO_ACK) denote transaction timeout, busy responder, stale request | |
342 | * generation, or missing ACK respectively. | |
656b7afd SR |
343 | * |
344 | * Note some timing corner cases: fw_send_request() may complete much earlier | |
345 | * than when the request packet actually hits the wire. On the other hand, | |
346 | * transaction completion and hence execution of @callback may happen even | |
347 | * before fw_send_request() returns. | |
3038e353 | 348 | */ |
53dca511 SR |
349 | void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode, |
350 | int destination_id, int generation, int speed, | |
351 | unsigned long long offset, void *payload, size_t length, | |
352 | fw_transaction_callback_t callback, void *callback_data) | |
3038e353 KH |
353 | { |
354 | unsigned long flags; | |
b9549bc6 | 355 | int tlabel; |
3038e353 | 356 | |
c781c06d KH |
357 | /* |
358 | * Allocate tlabel from the bitmap and put the transaction on | |
359 | * the list while holding the card spinlock. | |
360 | */ | |
3038e353 KH |
361 | |
362 | spin_lock_irqsave(&card->lock, flags); | |
363 | ||
7906054f CL |
364 | tlabel = allocate_tlabel(card); |
365 | if (tlabel < 0) { | |
3038e353 KH |
366 | spin_unlock_irqrestore(&card->lock, flags); |
367 | callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data); | |
368 | return; | |
369 | } | |
370 | ||
1e119fa9 | 371 | t->node_id = destination_id; |
3038e353 | 372 | t->tlabel = tlabel; |
5c40cbfe | 373 | t->card = card; |
410cf2bd | 374 | t->is_split_transaction = false; |
5c40cbfe CL |
375 | setup_timer(&t->split_timeout_timer, |
376 | split_transaction_timeout_callback, (unsigned long)t); | |
3038e353 KH |
377 | t->callback = callback; |
378 | t->callback_data = callback_data; | |
379 | ||
1e119fa9 JF |
380 | fw_fill_request(&t->packet, tcode, t->tlabel, |
381 | destination_id, card->node_id, generation, | |
382 | speed, offset, payload, length); | |
3038e353 KH |
383 | t->packet.callback = transmit_complete_callback; |
384 | ||
e9aeb46c SR |
385 | list_add_tail(&t->link, &card->transaction_list); |
386 | ||
387 | spin_unlock_irqrestore(&card->lock, flags); | |
388 | ||
3038e353 KH |
389 | card->driver->send_request(card, &t->packet); |
390 | } | |
391 | EXPORT_SYMBOL(fw_send_request); | |
392 | ||
1e119fa9 JF |
393 | struct transaction_callback_data { |
394 | struct completion done; | |
395 | void *payload; | |
396 | int rcode; | |
397 | }; | |
398 | ||
399 | static void transaction_callback(struct fw_card *card, int rcode, | |
400 | void *payload, size_t length, void *data) | |
401 | { | |
402 | struct transaction_callback_data *d = data; | |
403 | ||
404 | if (rcode == RCODE_COMPLETE) | |
405 | memcpy(d->payload, payload, length); | |
406 | d->rcode = rcode; | |
407 | complete(&d->done); | |
408 | } | |
409 | ||
410 | /** | |
656b7afd | 411 | * fw_run_transaction() - send request and sleep until transaction is completed |
1e119fa9 | 412 | * |
656b7afd SR |
413 | * Returns the RCODE. See fw_send_request() for parameter documentation. |
414 | * Unlike fw_send_request(), @data points to the payload of the request or/and | |
f30e6d3e SR |
415 | * to the payload of the response. DMA mapping restrictions apply to outbound |
416 | * request payloads of >= 8 bytes but not to inbound response payloads. | |
1e119fa9 JF |
417 | */ |
418 | int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, | |
53dca511 | 419 | int generation, int speed, unsigned long long offset, |
ba27e1f7 | 420 | void *payload, size_t length) |
1e119fa9 JF |
421 | { |
422 | struct transaction_callback_data d; | |
423 | struct fw_transaction t; | |
424 | ||
5c40cbfe | 425 | init_timer_on_stack(&t.split_timeout_timer); |
1e119fa9 | 426 | init_completion(&d.done); |
ba27e1f7 | 427 | d.payload = payload; |
1e119fa9 | 428 | fw_send_request(card, &t, tcode, destination_id, generation, speed, |
ba27e1f7 | 429 | offset, payload, length, transaction_callback, &d); |
1e119fa9 | 430 | wait_for_completion(&d.done); |
5c40cbfe | 431 | destroy_timer_on_stack(&t.split_timeout_timer); |
1e119fa9 JF |
432 | |
433 | return d.rcode; | |
434 | } | |
435 | EXPORT_SYMBOL(fw_run_transaction); | |
436 | ||
c0220d68 SR |
437 | static DEFINE_MUTEX(phy_config_mutex); |
438 | static DECLARE_COMPLETION(phy_config_done); | |
ae1e5355 SR |
439 | |
440 | static void transmit_phy_packet_callback(struct fw_packet *packet, | |
441 | struct fw_card *card, int status) | |
3038e353 | 442 | { |
c0220d68 | 443 | complete(&phy_config_done); |
3038e353 KH |
444 | } |
445 | ||
c0220d68 | 446 | static struct fw_packet phy_config_packet = { |
5b06db16 CL |
447 | .header_length = 12, |
448 | .header[0] = TCODE_LINK_INTERNAL << 4, | |
c0220d68 SR |
449 | .payload_length = 0, |
450 | .speed = SCODE_100, | |
451 | .callback = transmit_phy_packet_callback, | |
452 | }; | |
453 | ||
83db801c KH |
454 | void fw_send_phy_config(struct fw_card *card, |
455 | int node_id, int generation, int gap_count) | |
3038e353 | 456 | { |
ae1e5355 | 457 | long timeout = DIV_ROUND_UP(HZ, 10); |
02d37bed SR |
458 | u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG); |
459 | ||
460 | if (node_id != FW_PHY_CONFIG_NO_NODE_ID) | |
461 | data |= PHY_CONFIG_ROOT_ID(node_id); | |
462 | ||
463 | if (gap_count == FW_PHY_CONFIG_CURRENT_GAP_COUNT) { | |
464 | gap_count = card->driver->read_phy_reg(card, 1); | |
465 | if (gap_count < 0) | |
466 | return; | |
467 | ||
468 | gap_count &= 63; | |
469 | if (gap_count == 63) | |
470 | return; | |
471 | } | |
472 | data |= PHY_CONFIG_GAP_COUNT(gap_count); | |
2a0a2590 | 473 | |
c0220d68 SR |
474 | mutex_lock(&phy_config_mutex); |
475 | ||
5b06db16 CL |
476 | phy_config_packet.header[1] = data; |
477 | phy_config_packet.header[2] = ~data; | |
c0220d68 SR |
478 | phy_config_packet.generation = generation; |
479 | INIT_COMPLETION(phy_config_done); | |
480 | ||
481 | card->driver->send_request(card, &phy_config_packet); | |
482 | wait_for_completion_timeout(&phy_config_done, timeout); | |
ae1e5355 | 483 | |
c0220d68 | 484 | mutex_unlock(&phy_config_mutex); |
3038e353 KH |
485 | } |
486 | ||
53dca511 SR |
487 | static struct fw_address_handler *lookup_overlapping_address_handler( |
488 | struct list_head *list, unsigned long long offset, size_t length) | |
3038e353 KH |
489 | { |
490 | struct fw_address_handler *handler; | |
491 | ||
492 | list_for_each_entry(handler, list, link) { | |
493 | if (handler->offset < offset + length && | |
494 | offset < handler->offset + handler->length) | |
495 | return handler; | |
496 | } | |
497 | ||
498 | return NULL; | |
499 | } | |
500 | ||
db5d247a CL |
501 | static bool is_enclosing_handler(struct fw_address_handler *handler, |
502 | unsigned long long offset, size_t length) | |
503 | { | |
504 | return handler->offset <= offset && | |
505 | offset + length <= handler->offset + handler->length; | |
506 | } | |
507 | ||
53dca511 SR |
508 | static struct fw_address_handler *lookup_enclosing_address_handler( |
509 | struct list_head *list, unsigned long long offset, size_t length) | |
3038e353 KH |
510 | { |
511 | struct fw_address_handler *handler; | |
512 | ||
513 | list_for_each_entry(handler, list, link) { | |
db5d247a | 514 | if (is_enclosing_handler(handler, offset, length)) |
3038e353 KH |
515 | return handler; |
516 | } | |
517 | ||
518 | return NULL; | |
519 | } | |
520 | ||
521 | static DEFINE_SPINLOCK(address_handler_lock); | |
522 | static LIST_HEAD(address_handler_list); | |
523 | ||
21ebcd12 | 524 | const struct fw_address_region fw_high_memory_region = |
5af4e5ea | 525 | { .start = 0x000100000000ULL, .end = 0xffffe0000000ULL, }; |
db8be076 AB |
526 | EXPORT_SYMBOL(fw_high_memory_region); |
527 | ||
f07d42ac | 528 | static const struct fw_address_region low_memory_region = |
db8be076 | 529 | { .start = 0x000000000000ULL, .end = 0x000100000000ULL, }; |
f07d42ac CL |
530 | |
531 | #if 0 | |
21ebcd12 | 532 | const struct fw_address_region fw_private_region = |
5af4e5ea | 533 | { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, }; |
21ebcd12 | 534 | const struct fw_address_region fw_csr_region = |
cca60977 JW |
535 | { .start = CSR_REGISTER_BASE, |
536 | .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, }; | |
21ebcd12 | 537 | const struct fw_address_region fw_unit_space_region = |
5af4e5ea | 538 | { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, }; |
db8be076 | 539 | #endif /* 0 */ |
3038e353 | 540 | |
db5d247a CL |
541 | static bool is_in_fcp_region(u64 offset, size_t length) |
542 | { | |
543 | return offset >= (CSR_REGISTER_BASE | CSR_FCP_COMMAND) && | |
544 | offset + length <= (CSR_REGISTER_BASE | CSR_FCP_END); | |
545 | } | |
546 | ||
3038e353 | 547 | /** |
656b7afd SR |
548 | * fw_core_add_address_handler() - register for incoming requests |
549 | * @handler: callback | |
550 | * @region: region in the IEEE 1212 node space address range | |
3e0b5f0d SR |
551 | * |
552 | * region->start, ->end, and handler->length have to be quadlet-aligned. | |
553 | * | |
554 | * When a request is received that falls within the specified address range, | |
555 | * the specified callback is invoked. The parameters passed to the callback | |
556 | * give the details of the particular request. | |
1415d918 SR |
557 | * |
558 | * Return value: 0 on success, non-zero otherwise. | |
db5d247a | 559 | * |
1415d918 SR |
560 | * The start offset of the handler's address region is determined by |
561 | * fw_core_add_address_handler() and is returned in handler->offset. | |
db5d247a CL |
562 | * |
563 | * Address allocations are exclusive, except for the FCP registers. | |
3038e353 | 564 | */ |
53dca511 SR |
565 | int fw_core_add_address_handler(struct fw_address_handler *handler, |
566 | const struct fw_address_region *region) | |
3038e353 KH |
567 | { |
568 | struct fw_address_handler *other; | |
3038e353 KH |
569 | int ret = -EBUSY; |
570 | ||
3e0b5f0d | 571 | if (region->start & 0xffff000000000003ULL || |
3e0b5f0d | 572 | region->start >= region->end || |
0c9ae701 | 573 | region->end > 0x0001000000000000ULL || |
3e0b5f0d SR |
574 | handler->length & 3 || |
575 | handler->length == 0) | |
576 | return -EINVAL; | |
577 | ||
ea102d0e | 578 | spin_lock_bh(&address_handler_lock); |
3038e353 | 579 | |
3e0b5f0d | 580 | handler->offset = region->start; |
3038e353 | 581 | while (handler->offset + handler->length <= region->end) { |
db5d247a CL |
582 | if (is_in_fcp_region(handler->offset, handler->length)) |
583 | other = NULL; | |
584 | else | |
585 | other = lookup_overlapping_address_handler | |
586 | (&address_handler_list, | |
587 | handler->offset, handler->length); | |
3038e353 | 588 | if (other != NULL) { |
3e0b5f0d | 589 | handler->offset += other->length; |
3038e353 KH |
590 | } else { |
591 | list_add_tail(&handler->link, &address_handler_list); | |
592 | ret = 0; | |
593 | break; | |
594 | } | |
595 | } | |
596 | ||
ea102d0e | 597 | spin_unlock_bh(&address_handler_lock); |
3038e353 KH |
598 | |
599 | return ret; | |
600 | } | |
3038e353 KH |
601 | EXPORT_SYMBOL(fw_core_add_address_handler); |
602 | ||
603 | /** | |
656b7afd | 604 | * fw_core_remove_address_handler() - unregister an address handler |
90963f1c SR |
605 | * |
606 | * When fw_core_remove_address_handler() returns, @handler->callback() is | |
607 | * guaranteed to not run on any CPU anymore. | |
3038e353 | 608 | */ |
3038e353 KH |
609 | void fw_core_remove_address_handler(struct fw_address_handler *handler) |
610 | { | |
ea102d0e | 611 | spin_lock_bh(&address_handler_lock); |
3038e353 | 612 | list_del(&handler->link); |
ea102d0e | 613 | spin_unlock_bh(&address_handler_lock); |
3038e353 | 614 | } |
3038e353 KH |
615 | EXPORT_SYMBOL(fw_core_remove_address_handler); |
616 | ||
617 | struct fw_request { | |
618 | struct fw_packet response; | |
36bfe49d | 619 | u32 request_header[4]; |
3038e353 KH |
620 | int ack; |
621 | u32 length; | |
622 | u32 data[0]; | |
623 | }; | |
624 | ||
53dca511 SR |
625 | static void free_response_callback(struct fw_packet *packet, |
626 | struct fw_card *card, int status) | |
3038e353 KH |
627 | { |
628 | struct fw_request *request; | |
629 | ||
630 | request = container_of(packet, struct fw_request, response); | |
631 | kfree(request); | |
632 | } | |
633 | ||
a10c0ce7 CL |
634 | int fw_get_response_length(struct fw_request *r) |
635 | { | |
636 | int tcode, ext_tcode, data_length; | |
637 | ||
638 | tcode = HEADER_GET_TCODE(r->request_header[0]); | |
639 | ||
640 | switch (tcode) { | |
641 | case TCODE_WRITE_QUADLET_REQUEST: | |
642 | case TCODE_WRITE_BLOCK_REQUEST: | |
643 | return 0; | |
644 | ||
645 | case TCODE_READ_QUADLET_REQUEST: | |
646 | return 4; | |
647 | ||
648 | case TCODE_READ_BLOCK_REQUEST: | |
649 | data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]); | |
650 | return data_length; | |
651 | ||
652 | case TCODE_LOCK_REQUEST: | |
653 | ext_tcode = HEADER_GET_EXTENDED_TCODE(r->request_header[3]); | |
654 | data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]); | |
655 | switch (ext_tcode) { | |
656 | case EXTCODE_FETCH_ADD: | |
657 | case EXTCODE_LITTLE_ADD: | |
658 | return data_length; | |
659 | default: | |
660 | return data_length / 2; | |
661 | } | |
662 | ||
663 | default: | |
5878730b | 664 | WARN(1, "wrong tcode %d\n", tcode); |
a10c0ce7 CL |
665 | return 0; |
666 | } | |
667 | } | |
668 | ||
53dca511 SR |
669 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
670 | int rcode, void *payload, size_t length) | |
3038e353 KH |
671 | { |
672 | int tcode, tlabel, extended_tcode, source, destination; | |
673 | ||
a77754a7 KH |
674 | tcode = HEADER_GET_TCODE(request_header[0]); |
675 | tlabel = HEADER_GET_TLABEL(request_header[0]); | |
676 | source = HEADER_GET_DESTINATION(request_header[0]); | |
677 | destination = HEADER_GET_SOURCE(request_header[1]); | |
678 | extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]); | |
3038e353 KH |
679 | |
680 | response->header[0] = | |
a77754a7 KH |
681 | HEADER_RETRY(RETRY_1) | |
682 | HEADER_TLABEL(tlabel) | | |
683 | HEADER_DESTINATION(destination); | |
36bfe49d | 684 | response->header[1] = |
a77754a7 KH |
685 | HEADER_SOURCE(source) | |
686 | HEADER_RCODE(rcode); | |
3038e353 KH |
687 | response->header[2] = 0; |
688 | ||
689 | switch (tcode) { | |
690 | case TCODE_WRITE_QUADLET_REQUEST: | |
691 | case TCODE_WRITE_BLOCK_REQUEST: | |
a77754a7 | 692 | response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE); |
3038e353 KH |
693 | response->header_length = 12; |
694 | response->payload_length = 0; | |
695 | break; | |
696 | ||
697 | case TCODE_READ_QUADLET_REQUEST: | |
698 | response->header[0] |= | |
a77754a7 | 699 | HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE); |
93c4cceb KH |
700 | if (payload != NULL) |
701 | response->header[3] = *(u32 *)payload; | |
702 | else | |
703 | response->header[3] = 0; | |
3038e353 KH |
704 | response->header_length = 16; |
705 | response->payload_length = 0; | |
706 | break; | |
707 | ||
708 | case TCODE_READ_BLOCK_REQUEST: | |
709 | case TCODE_LOCK_REQUEST: | |
a77754a7 | 710 | response->header[0] |= HEADER_TCODE(tcode + 2); |
3038e353 | 711 | response->header[3] = |
a77754a7 KH |
712 | HEADER_DATA_LENGTH(length) | |
713 | HEADER_EXTENDED_TCODE(extended_tcode); | |
3038e353 | 714 | response->header_length = 16; |
36bfe49d KH |
715 | response->payload = payload; |
716 | response->payload_length = length; | |
3038e353 KH |
717 | break; |
718 | ||
719 | default: | |
5878730b | 720 | WARN(1, "wrong tcode %d\n", tcode); |
3038e353 | 721 | } |
1d1dc5e8 | 722 | |
19593ffd | 723 | response->payload_mapped = false; |
3038e353 | 724 | } |
93c4cceb | 725 | EXPORT_SYMBOL(fw_fill_response); |
3038e353 | 726 | |
8e4b50f9 CL |
727 | static u32 compute_split_timeout_timestamp(struct fw_card *card, |
728 | u32 request_timestamp) | |
729 | { | |
730 | unsigned int cycles; | |
731 | u32 timestamp; | |
732 | ||
733 | cycles = card->split_timeout_cycles; | |
734 | cycles += request_timestamp & 0x1fff; | |
735 | ||
736 | timestamp = request_timestamp & ~0x1fff; | |
737 | timestamp += (cycles / 8000) << 13; | |
738 | timestamp |= cycles % 8000; | |
739 | ||
740 | return timestamp; | |
741 | } | |
742 | ||
743 | static struct fw_request *allocate_request(struct fw_card *card, | |
744 | struct fw_packet *p) | |
3038e353 KH |
745 | { |
746 | struct fw_request *request; | |
747 | u32 *data, length; | |
8e4b50f9 | 748 | int request_tcode; |
3038e353 | 749 | |
a77754a7 | 750 | request_tcode = HEADER_GET_TCODE(p->header[0]); |
3038e353 KH |
751 | switch (request_tcode) { |
752 | case TCODE_WRITE_QUADLET_REQUEST: | |
2639a6fb | 753 | data = &p->header[3]; |
3038e353 KH |
754 | length = 4; |
755 | break; | |
756 | ||
757 | case TCODE_WRITE_BLOCK_REQUEST: | |
758 | case TCODE_LOCK_REQUEST: | |
2639a6fb | 759 | data = p->payload; |
a77754a7 | 760 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
761 | break; |
762 | ||
763 | case TCODE_READ_QUADLET_REQUEST: | |
764 | data = NULL; | |
765 | length = 4; | |
766 | break; | |
767 | ||
768 | case TCODE_READ_BLOCK_REQUEST: | |
769 | data = NULL; | |
a77754a7 | 770 | length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
771 | break; |
772 | ||
773 | default: | |
26b4950d | 774 | fw_notice(card, "ERROR - corrupt request received - %08x %08x %08x\n", |
0bf607c5 | 775 | p->header[0], p->header[1], p->header[2]); |
3038e353 KH |
776 | return NULL; |
777 | } | |
778 | ||
2d826cc5 | 779 | request = kmalloc(sizeof(*request) + length, GFP_ATOMIC); |
3038e353 KH |
780 | if (request == NULL) |
781 | return NULL; | |
782 | ||
2639a6fb | 783 | request->response.speed = p->speed; |
8e4b50f9 CL |
784 | request->response.timestamp = |
785 | compute_split_timeout_timestamp(card, p->timestamp); | |
2639a6fb | 786 | request->response.generation = p->generation; |
730c32f5 | 787 | request->response.ack = 0; |
3038e353 | 788 | request->response.callback = free_response_callback; |
2639a6fb | 789 | request->ack = p->ack; |
93c4cceb | 790 | request->length = length; |
3038e353 | 791 | if (data) |
6e2e8424 | 792 | memcpy(request->data, data, length); |
3038e353 | 793 | |
2d826cc5 | 794 | memcpy(request->request_header, p->header, sizeof(p->header)); |
3038e353 KH |
795 | |
796 | return request; | |
797 | } | |
798 | ||
53dca511 SR |
799 | void fw_send_response(struct fw_card *card, |
800 | struct fw_request *request, int rcode) | |
3038e353 | 801 | { |
db5d247a CL |
802 | if (WARN_ONCE(!request, "invalid for FCP address handlers")) |
803 | return; | |
804 | ||
a7ea6782 SR |
805 | /* unified transaction or broadcast transaction: don't respond */ |
806 | if (request->ack != ACK_PENDING || | |
807 | HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) { | |
9c9bdf4d | 808 | kfree(request); |
3038e353 | 809 | return; |
9c9bdf4d | 810 | } |
3038e353 | 811 | |
36bfe49d KH |
812 | if (rcode == RCODE_COMPLETE) |
813 | fw_fill_response(&request->response, request->request_header, | |
a10c0ce7 CL |
814 | rcode, request->data, |
815 | fw_get_response_length(request)); | |
36bfe49d KH |
816 | else |
817 | fw_fill_response(&request->response, request->request_header, | |
818 | rcode, NULL, 0); | |
3038e353 KH |
819 | |
820 | card->driver->send_response(card, &request->response); | |
821 | } | |
3038e353 KH |
822 | EXPORT_SYMBOL(fw_send_response); |
823 | ||
253d9237 CB |
824 | /** |
825 | * fw_get_request_speed() - returns speed at which the @request was received | |
826 | */ | |
827 | int fw_get_request_speed(struct fw_request *request) | |
828 | { | |
829 | return request->response.speed; | |
830 | } | |
831 | EXPORT_SYMBOL(fw_get_request_speed); | |
832 | ||
db5d247a CL |
833 | static void handle_exclusive_region_request(struct fw_card *card, |
834 | struct fw_packet *p, | |
835 | struct fw_request *request, | |
836 | unsigned long long offset) | |
3038e353 KH |
837 | { |
838 | struct fw_address_handler *handler; | |
2639a6fb | 839 | int tcode, destination, source; |
3038e353 | 840 | |
a77754a7 | 841 | destination = HEADER_GET_DESTINATION(p->header[0]); |
478b233e | 842 | source = HEADER_GET_SOURCE(p->header[1]); |
c82f91f2 JF |
843 | tcode = HEADER_GET_TCODE(p->header[0]); |
844 | if (tcode == TCODE_LOCK_REQUEST) | |
845 | tcode = 0x10 + HEADER_GET_EXTENDED_TCODE(p->header[3]); | |
3038e353 | 846 | |
ea102d0e | 847 | spin_lock_bh(&address_handler_lock); |
3038e353 KH |
848 | handler = lookup_enclosing_address_handler(&address_handler_list, |
849 | offset, request->length); | |
90963f1c | 850 | if (handler) |
3038e353 KH |
851 | handler->address_callback(card, request, |
852 | tcode, destination, source, | |
33e553fe | 853 | p->generation, offset, |
3038e353 KH |
854 | request->data, request->length, |
855 | handler->callback_data); | |
ea102d0e | 856 | spin_unlock_bh(&address_handler_lock); |
90963f1c SR |
857 | |
858 | if (!handler) | |
859 | fw_send_response(card, request, RCODE_ADDRESS_ERROR); | |
3038e353 | 860 | } |
db5d247a CL |
861 | |
862 | static void handle_fcp_region_request(struct fw_card *card, | |
863 | struct fw_packet *p, | |
864 | struct fw_request *request, | |
865 | unsigned long long offset) | |
866 | { | |
867 | struct fw_address_handler *handler; | |
db5d247a CL |
868 | int tcode, destination, source; |
869 | ||
870 | if ((offset != (CSR_REGISTER_BASE | CSR_FCP_COMMAND) && | |
871 | offset != (CSR_REGISTER_BASE | CSR_FCP_RESPONSE)) || | |
872 | request->length > 0x200) { | |
873 | fw_send_response(card, request, RCODE_ADDRESS_ERROR); | |
874 | ||
875 | return; | |
876 | } | |
877 | ||
878 | tcode = HEADER_GET_TCODE(p->header[0]); | |
879 | destination = HEADER_GET_DESTINATION(p->header[0]); | |
880 | source = HEADER_GET_SOURCE(p->header[1]); | |
881 | ||
882 | if (tcode != TCODE_WRITE_QUADLET_REQUEST && | |
883 | tcode != TCODE_WRITE_BLOCK_REQUEST) { | |
884 | fw_send_response(card, request, RCODE_TYPE_ERROR); | |
885 | ||
886 | return; | |
887 | } | |
888 | ||
ea102d0e | 889 | spin_lock_bh(&address_handler_lock); |
db5d247a CL |
890 | list_for_each_entry(handler, &address_handler_list, link) { |
891 | if (is_enclosing_handler(handler, offset, request->length)) | |
892 | handler->address_callback(card, NULL, tcode, | |
893 | destination, source, | |
33e553fe SR |
894 | p->generation, offset, |
895 | request->data, | |
db5d247a CL |
896 | request->length, |
897 | handler->callback_data); | |
898 | } | |
ea102d0e | 899 | spin_unlock_bh(&address_handler_lock); |
db5d247a CL |
900 | |
901 | fw_send_response(card, request, RCODE_COMPLETE); | |
902 | } | |
903 | ||
904 | void fw_core_handle_request(struct fw_card *card, struct fw_packet *p) | |
905 | { | |
906 | struct fw_request *request; | |
907 | unsigned long long offset; | |
908 | ||
909 | if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE) | |
910 | return; | |
911 | ||
bf54e146 SR |
912 | if (TCODE_IS_LINK_INTERNAL(HEADER_GET_TCODE(p->header[0]))) { |
913 | fw_cdev_handle_phy_packet(card, p); | |
914 | return; | |
915 | } | |
916 | ||
8e4b50f9 | 917 | request = allocate_request(card, p); |
db5d247a CL |
918 | if (request == NULL) { |
919 | /* FIXME: send statically allocated busy packet. */ | |
920 | return; | |
921 | } | |
922 | ||
923 | offset = ((u64)HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) | | |
924 | p->header[2]; | |
925 | ||
926 | if (!is_in_fcp_region(offset, request->length)) | |
927 | handle_exclusive_region_request(card, p, request, offset); | |
928 | else | |
929 | handle_fcp_region_request(card, p, request, offset); | |
930 | ||
931 | } | |
3038e353 KH |
932 | EXPORT_SYMBOL(fw_core_handle_request); |
933 | ||
53dca511 | 934 | void fw_core_handle_response(struct fw_card *card, struct fw_packet *p) |
3038e353 KH |
935 | { |
936 | struct fw_transaction *t; | |
937 | unsigned long flags; | |
938 | u32 *data; | |
939 | size_t data_length; | |
ae86e81e | 940 | int tcode, tlabel, source, rcode; |
3038e353 | 941 | |
ae86e81e SR |
942 | tcode = HEADER_GET_TCODE(p->header[0]); |
943 | tlabel = HEADER_GET_TLABEL(p->header[0]); | |
944 | source = HEADER_GET_SOURCE(p->header[1]); | |
945 | rcode = HEADER_GET_RCODE(p->header[1]); | |
3038e353 KH |
946 | |
947 | spin_lock_irqsave(&card->lock, flags); | |
948 | list_for_each_entry(t, &card->transaction_list, link) { | |
949 | if (t->node_id == source && t->tlabel == tlabel) { | |
410cf2bd | 950 | if (!try_cancel_split_timeout(t)) { |
2222bcb7 CL |
951 | spin_unlock_irqrestore(&card->lock, flags); |
952 | goto timed_out; | |
953 | } | |
5c40cbfe | 954 | list_del_init(&t->link); |
753a8970 | 955 | card->tlabel_mask &= ~(1ULL << t->tlabel); |
3038e353 KH |
956 | break; |
957 | } | |
958 | } | |
959 | spin_unlock_irqrestore(&card->lock, flags); | |
960 | ||
961 | if (&t->link == &card->transaction_list) { | |
2222bcb7 | 962 | timed_out: |
26b4950d | 963 | fw_notice(card, "unsolicited response (source %x, tlabel %x)\n", |
32b46093 | 964 | source, tlabel); |
3038e353 KH |
965 | return; |
966 | } | |
967 | ||
c781c06d KH |
968 | /* |
969 | * FIXME: sanity check packet, is length correct, does tcodes | |
970 | * and addresses match. | |
971 | */ | |
3038e353 KH |
972 | |
973 | switch (tcode) { | |
974 | case TCODE_READ_QUADLET_RESPONSE: | |
2639a6fb | 975 | data = (u32 *) &p->header[3]; |
3038e353 KH |
976 | data_length = 4; |
977 | break; | |
978 | ||
979 | case TCODE_WRITE_RESPONSE: | |
980 | data = NULL; | |
981 | data_length = 0; | |
982 | break; | |
983 | ||
984 | case TCODE_READ_BLOCK_RESPONSE: | |
985 | case TCODE_LOCK_RESPONSE: | |
93c4cceb | 986 | data = p->payload; |
a77754a7 | 987 | data_length = HEADER_GET_DATA_LENGTH(p->header[3]); |
3038e353 KH |
988 | break; |
989 | ||
990 | default: | |
991 | /* Should never happen, this is just to shut up gcc. */ | |
992 | data = NULL; | |
993 | data_length = 0; | |
994 | break; | |
995 | } | |
996 | ||
10a4c735 SR |
997 | /* |
998 | * The response handler may be executed while the request handler | |
999 | * is still pending. Cancel the request handler. | |
1000 | */ | |
1001 | card->driver->cancel_packet(card, &t->packet); | |
1002 | ||
3038e353 KH |
1003 | t->callback(card, rcode, data, data_length, t->callback_data); |
1004 | } | |
3038e353 KH |
1005 | EXPORT_SYMBOL(fw_core_handle_response); |
1006 | ||
7bdbff67 CL |
1007 | /** |
1008 | * fw_rcode_string - convert a firewire result code to an error description | |
1009 | * @rcode: the result code | |
1010 | */ | |
1011 | const char *fw_rcode_string(int rcode) | |
1012 | { | |
1013 | static const char *const names[] = { | |
1014 | [RCODE_COMPLETE] = "no error", | |
1015 | [RCODE_CONFLICT_ERROR] = "conflict error", | |
1016 | [RCODE_DATA_ERROR] = "data error", | |
1017 | [RCODE_TYPE_ERROR] = "type error", | |
1018 | [RCODE_ADDRESS_ERROR] = "address error", | |
1019 | [RCODE_SEND_ERROR] = "send error", | |
1020 | [RCODE_CANCELLED] = "timeout", | |
1021 | [RCODE_BUSY] = "busy", | |
1022 | [RCODE_GENERATION] = "bus reset", | |
1023 | [RCODE_NO_ACK] = "no ack", | |
1024 | }; | |
1025 | ||
1026 | if ((unsigned int)rcode < ARRAY_SIZE(names) && names[rcode]) | |
1027 | return names[rcode]; | |
1028 | else | |
1029 | return "unknown"; | |
1030 | } | |
1031 | EXPORT_SYMBOL(fw_rcode_string); | |
1032 | ||
ae57988f | 1033 | static const struct fw_address_region topology_map_region = |
cca60977 JW |
1034 | { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP, |
1035 | .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, }; | |
473d28c7 | 1036 | |
53dca511 SR |
1037 | static void handle_topology_map(struct fw_card *card, struct fw_request *request, |
1038 | int tcode, int destination, int source, int generation, | |
33e553fe SR |
1039 | unsigned long long offset, void *payload, size_t length, |
1040 | void *callback_data) | |
473d28c7 | 1041 | { |
cb7c96da | 1042 | int start; |
473d28c7 KH |
1043 | |
1044 | if (!TCODE_IS_READ_REQUEST(tcode)) { | |
1045 | fw_send_response(card, request, RCODE_TYPE_ERROR); | |
1046 | return; | |
1047 | } | |
1048 | ||
1049 | if ((offset & 3) > 0 || (length & 3) > 0) { | |
1050 | fw_send_response(card, request, RCODE_ADDRESS_ERROR); | |
1051 | return; | |
1052 | } | |
1053 | ||
1054 | start = (offset - topology_map_region.start) / 4; | |
cb7c96da | 1055 | memcpy(payload, &card->topology_map[start], length); |
473d28c7 KH |
1056 | |
1057 | fw_send_response(card, request, RCODE_COMPLETE); | |
1058 | } | |
1059 | ||
1060 | static struct fw_address_handler topology_map = { | |
85cb9b68 | 1061 | .length = 0x400, |
473d28c7 KH |
1062 | .address_callback = handle_topology_map, |
1063 | }; | |
1064 | ||
ae57988f | 1065 | static const struct fw_address_region registers_region = |
cca60977 JW |
1066 | { .start = CSR_REGISTER_BASE, |
1067 | .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, }; | |
d60d7f1d | 1068 | |
8e4b50f9 CL |
1069 | static void update_split_timeout(struct fw_card *card) |
1070 | { | |
1071 | unsigned int cycles; | |
1072 | ||
1073 | cycles = card->split_timeout_hi * 8000 + (card->split_timeout_lo >> 19); | |
1074 | ||
4ec4a67a SR |
1075 | /* minimum per IEEE 1394, maximum which doesn't overflow OHCI */ |
1076 | cycles = clamp(cycles, 800u, 3u * 8000u); | |
8e4b50f9 CL |
1077 | |
1078 | card->split_timeout_cycles = cycles; | |
1079 | card->split_timeout_jiffies = DIV_ROUND_UP(cycles * HZ, 8000); | |
1080 | } | |
1081 | ||
53dca511 SR |
1082 | static void handle_registers(struct fw_card *card, struct fw_request *request, |
1083 | int tcode, int destination, int source, int generation, | |
33e553fe SR |
1084 | unsigned long long offset, void *payload, size_t length, |
1085 | void *callback_data) | |
d60d7f1d | 1086 | { |
15f0d833 | 1087 | int reg = offset & ~CSR_REGISTER_BASE; |
d60d7f1d | 1088 | __be32 *data = payload; |
e534fe16 | 1089 | int rcode = RCODE_COMPLETE; |
8e4b50f9 | 1090 | unsigned long flags; |
d60d7f1d KH |
1091 | |
1092 | switch (reg) { | |
b384cf18 SR |
1093 | case CSR_PRIORITY_BUDGET: |
1094 | if (!card->priority_budget_implemented) { | |
1095 | rcode = RCODE_ADDRESS_ERROR; | |
1096 | break; | |
1097 | } | |
1098 | /* else fall through */ | |
3e07ec0e | 1099 | |
506f1a31 | 1100 | case CSR_NODE_IDS: |
65b2742a SR |
1101 | /* |
1102 | * per IEEE 1394-2008 8.3.22.3, not IEEE 1394.1-2004 3.2.8 | |
1103 | * and 9.6, but interoperable with IEEE 1394.1-2004 bridges | |
1104 | */ | |
b384cf18 SR |
1105 | /* fall through */ |
1106 | ||
1107 | case CSR_STATE_CLEAR: | |
1108 | case CSR_STATE_SET: | |
1109 | case CSR_CYCLE_TIME: | |
1110 | case CSR_BUS_TIME: | |
1111 | case CSR_BUSY_TIMEOUT: | |
506f1a31 | 1112 | if (tcode == TCODE_READ_QUADLET_REQUEST) |
0fcff4e3 | 1113 | *data = cpu_to_be32(card->driver->read_csr(card, reg)); |
506f1a31 | 1114 | else if (tcode == TCODE_WRITE_QUADLET_REQUEST) |
0fcff4e3 | 1115 | card->driver->write_csr(card, reg, be32_to_cpu(*data)); |
506f1a31 CL |
1116 | else |
1117 | rcode = RCODE_TYPE_ERROR; | |
1118 | break; | |
1119 | ||
446eba0d | 1120 | case CSR_RESET_START: |
7e0e314f | 1121 | if (tcode == TCODE_WRITE_QUADLET_REQUEST) |
0fcff4e3 SR |
1122 | card->driver->write_csr(card, CSR_STATE_CLEAR, |
1123 | CSR_STATE_BIT_ABDICATE); | |
7e0e314f | 1124 | else |
446eba0d CL |
1125 | rcode = RCODE_TYPE_ERROR; |
1126 | break; | |
1127 | ||
8e4b50f9 CL |
1128 | case CSR_SPLIT_TIMEOUT_HI: |
1129 | if (tcode == TCODE_READ_QUADLET_REQUEST) { | |
1130 | *data = cpu_to_be32(card->split_timeout_hi); | |
1131 | } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) { | |
1132 | spin_lock_irqsave(&card->lock, flags); | |
1133 | card->split_timeout_hi = be32_to_cpu(*data) & 7; | |
1134 | update_split_timeout(card); | |
1135 | spin_unlock_irqrestore(&card->lock, flags); | |
1136 | } else { | |
1137 | rcode = RCODE_TYPE_ERROR; | |
1138 | } | |
1139 | break; | |
1140 | ||
1141 | case CSR_SPLIT_TIMEOUT_LO: | |
1142 | if (tcode == TCODE_READ_QUADLET_REQUEST) { | |
1143 | *data = cpu_to_be32(card->split_timeout_lo); | |
1144 | } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) { | |
1145 | spin_lock_irqsave(&card->lock, flags); | |
1146 | card->split_timeout_lo = | |
1147 | be32_to_cpu(*data) & 0xfff80000; | |
1148 | update_split_timeout(card); | |
1149 | spin_unlock_irqrestore(&card->lock, flags); | |
1150 | } else { | |
1151 | rcode = RCODE_TYPE_ERROR; | |
1152 | } | |
1153 | break; | |
1154 | ||
3d1f46eb CL |
1155 | case CSR_MAINT_UTILITY: |
1156 | if (tcode == TCODE_READ_QUADLET_REQUEST) | |
1157 | *data = card->maint_utility_register; | |
1158 | else if (tcode == TCODE_WRITE_QUADLET_REQUEST) | |
1159 | card->maint_utility_register = *data; | |
1160 | else | |
1161 | rcode = RCODE_TYPE_ERROR; | |
1162 | break; | |
1163 | ||
e534fe16 SR |
1164 | case CSR_BROADCAST_CHANNEL: |
1165 | if (tcode == TCODE_READ_QUADLET_REQUEST) | |
1166 | *data = cpu_to_be32(card->broadcast_channel); | |
1167 | else if (tcode == TCODE_WRITE_QUADLET_REQUEST) | |
1168 | card->broadcast_channel = | |
1169 | (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) | | |
1170 | BROADCAST_CHANNEL_INITIAL; | |
1171 | else | |
1172 | rcode = RCODE_TYPE_ERROR; | |
d60d7f1d KH |
1173 | break; |
1174 | ||
1175 | case CSR_BUS_MANAGER_ID: | |
1176 | case CSR_BANDWIDTH_AVAILABLE: | |
1177 | case CSR_CHANNELS_AVAILABLE_HI: | |
1178 | case CSR_CHANNELS_AVAILABLE_LO: | |
c781c06d KH |
1179 | /* |
1180 | * FIXME: these are handled by the OHCI hardware and | |
d60d7f1d KH |
1181 | * the stack never sees these request. If we add |
1182 | * support for a new type of controller that doesn't | |
1183 | * handle this in hardware we need to deal with these | |
c781c06d KH |
1184 | * transactions. |
1185 | */ | |
d60d7f1d KH |
1186 | BUG(); |
1187 | break; | |
1188 | ||
d60d7f1d | 1189 | default: |
e534fe16 | 1190 | rcode = RCODE_ADDRESS_ERROR; |
d60d7f1d KH |
1191 | break; |
1192 | } | |
e534fe16 SR |
1193 | |
1194 | fw_send_response(card, request, rcode); | |
d60d7f1d KH |
1195 | } |
1196 | ||
1197 | static struct fw_address_handler registers = { | |
1198 | .length = 0x400, | |
1199 | .address_callback = handle_registers, | |
1200 | }; | |
1201 | ||
f07d42ac CL |
1202 | static void handle_low_memory(struct fw_card *card, struct fw_request *request, |
1203 | int tcode, int destination, int source, int generation, | |
1204 | unsigned long long offset, void *payload, size_t length, | |
1205 | void *callback_data) | |
1206 | { | |
1207 | /* | |
1208 | * This catches requests not handled by the physical DMA unit, | |
1209 | * i.e., wrong transaction types or unauthorized source nodes. | |
1210 | */ | |
1211 | fw_send_response(card, request, RCODE_TYPE_ERROR); | |
1212 | } | |
1213 | ||
1214 | static struct fw_address_handler low_memory = { | |
1215 | .length = 0x000100000000ULL, | |
1216 | .address_callback = handle_low_memory, | |
1217 | }; | |
1218 | ||
3038e353 KH |
1219 | MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>"); |
1220 | MODULE_DESCRIPTION("Core IEEE1394 transaction logic"); | |
1221 | MODULE_LICENSE("GPL"); | |
1222 | ||
937f6879 | 1223 | static const u32 vendor_textual_descriptor[] = { |
3038e353 | 1224 | /* textual descriptor leaf () */ |
937f6879 | 1225 | 0x00060000, |
3038e353 KH |
1226 | 0x00000000, |
1227 | 0x00000000, | |
1228 | 0x4c696e75, /* L i n u */ | |
1229 | 0x78204669, /* x F i */ | |
1230 | 0x72657769, /* r e w i */ | |
937f6879 | 1231 | 0x72650000, /* r e */ |
3038e353 KH |
1232 | }; |
1233 | ||
937f6879 KH |
1234 | static const u32 model_textual_descriptor[] = { |
1235 | /* model descriptor leaf () */ | |
1236 | 0x00030000, | |
1237 | 0x00000000, | |
1238 | 0x00000000, | |
1239 | 0x4a756a75, /* J u j u */ | |
1240 | }; | |
1241 | ||
1242 | static struct fw_descriptor vendor_id_descriptor = { | |
1243 | .length = ARRAY_SIZE(vendor_textual_descriptor), | |
1244 | .immediate = 0x03d00d1e, | |
3038e353 | 1245 | .key = 0x81000000, |
937f6879 KH |
1246 | .data = vendor_textual_descriptor, |
1247 | }; | |
1248 | ||
1249 | static struct fw_descriptor model_id_descriptor = { | |
1250 | .length = ARRAY_SIZE(model_textual_descriptor), | |
1251 | .immediate = 0x17000001, | |
1252 | .key = 0x81000000, | |
1253 | .data = model_textual_descriptor, | |
3038e353 KH |
1254 | }; |
1255 | ||
3038e353 KH |
1256 | static int __init fw_core_init(void) |
1257 | { | |
2dbd7d7e | 1258 | int ret; |
3038e353 | 1259 | |
105e53f8 SR |
1260 | fw_workqueue = alloc_workqueue("firewire", |
1261 | WQ_NON_REENTRANT | WQ_MEM_RECLAIM, 0); | |
1262 | if (!fw_workqueue) | |
6ea9e7bb SR |
1263 | return -ENOMEM; |
1264 | ||
2dbd7d7e | 1265 | ret = bus_register(&fw_bus_type); |
6ea9e7bb | 1266 | if (ret < 0) { |
105e53f8 | 1267 | destroy_workqueue(fw_workqueue); |
2dbd7d7e | 1268 | return ret; |
6ea9e7bb | 1269 | } |
3038e353 | 1270 | |
a3aca3da KH |
1271 | fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops); |
1272 | if (fw_cdev_major < 0) { | |
1273 | bus_unregister(&fw_bus_type); | |
105e53f8 | 1274 | destroy_workqueue(fw_workqueue); |
a3aca3da KH |
1275 | return fw_cdev_major; |
1276 | } | |
1277 | ||
c490a6de SR |
1278 | fw_core_add_address_handler(&topology_map, &topology_map_region); |
1279 | fw_core_add_address_handler(®isters, ®isters_region); | |
f07d42ac | 1280 | fw_core_add_address_handler(&low_memory, &low_memory_region); |
c490a6de SR |
1281 | fw_core_add_descriptor(&vendor_id_descriptor); |
1282 | fw_core_add_descriptor(&model_id_descriptor); | |
3038e353 KH |
1283 | |
1284 | return 0; | |
1285 | } | |
1286 | ||
1287 | static void __exit fw_core_cleanup(void) | |
1288 | { | |
a3aca3da | 1289 | unregister_chrdev(fw_cdev_major, "firewire"); |
3038e353 | 1290 | bus_unregister(&fw_bus_type); |
105e53f8 | 1291 | destroy_workqueue(fw_workqueue); |
d6053e08 | 1292 | idr_destroy(&fw_device_idr); |
3038e353 KH |
1293 | } |
1294 | ||
1295 | module_init(fw_core_init); | |
1296 | module_exit(fw_core_cleanup); |