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