Commit | Line | Data |
---|---|---|
c781c06d | 1 | /* |
3038e353 KH |
2 | * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net> |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify | |
5 | * it under the terms of the GNU General Public License as published by | |
6 | * the Free Software Foundation; either version 2 of the License, or | |
7 | * (at your option) any later version. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software Foundation, | |
16 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
17 | */ | |
18 | ||
687198bb SR |
19 | #ifndef __fw_transaction_h |
20 | #define __fw_transaction_h | |
3038e353 | 21 | |
459f7923 | 22 | #include <linux/completion.h> |
3038e353 | 23 | #include <linux/device.h> |
9aad8125 | 24 | #include <linux/dma-mapping.h> |
4c5a443e | 25 | #include <linux/firewire-constants.h> |
459f7923 | 26 | #include <linux/kref.h> |
2147ef20 SR |
27 | #include <linux/list.h> |
28 | #include <linux/spinlock_types.h> | |
29 | #include <linux/timer.h> | |
1d1dc5e8 | 30 | #include <linux/types.h> |
2147ef20 | 31 | #include <linux/workqueue.h> |
3038e353 | 32 | |
93c4cceb | 33 | #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4) |
3038e353 KH |
34 | #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0) |
35 | #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0) | |
36 | #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0) | |
37 | #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4) | |
38 | #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0) | |
39 | ||
3038e353 KH |
40 | #define LOCAL_BUS 0xffc0 |
41 | ||
5e20c282 SR |
42 | #define SELFID_PORT_CHILD 0x3 |
43 | #define SELFID_PORT_PARENT 0x2 | |
44 | #define SELFID_PORT_NCONN 0x1 | |
45 | #define SELFID_PORT_NONE 0x0 | |
3038e353 KH |
46 | |
47 | #define PHY_PACKET_CONFIG 0x0 | |
48 | #define PHY_PACKET_LINK_ON 0x1 | |
49 | #define PHY_PACKET_SELF_ID 0x2 | |
50 | ||
ecab4133 MB |
51 | /* Bit fields _within_ the PHY registers. */ |
52 | #define PHY_LINK_ACTIVE 0x80 | |
53 | #define PHY_CONTENDER 0x40 | |
54 | #define PHY_BUS_RESET 0x40 | |
55 | #define PHY_BUS_SHORT_RESET 0x40 | |
56 | ||
93c4cceb KH |
57 | #define CSR_REGISTER_BASE 0xfffff0000000ULL |
58 | ||
59 | /* register offsets relative to CSR_REGISTER_BASE */ | |
60 | #define CSR_STATE_CLEAR 0x0 | |
61 | #define CSR_STATE_SET 0x4 | |
62 | #define CSR_NODE_IDS 0x8 | |
63 | #define CSR_RESET_START 0xc | |
64 | #define CSR_SPLIT_TIMEOUT_HI 0x18 | |
65 | #define CSR_SPLIT_TIMEOUT_LO 0x1c | |
66 | #define CSR_CYCLE_TIME 0x200 | |
67 | #define CSR_BUS_TIME 0x204 | |
68 | #define CSR_BUSY_TIMEOUT 0x210 | |
69 | #define CSR_BUS_MANAGER_ID 0x21c | |
70 | #define CSR_BANDWIDTH_AVAILABLE 0x220 | |
71 | #define CSR_CHANNELS_AVAILABLE 0x224 | |
72 | #define CSR_CHANNELS_AVAILABLE_HI 0x224 | |
73 | #define CSR_CHANNELS_AVAILABLE_LO 0x228 | |
74 | #define CSR_BROADCAST_CHANNEL 0x234 | |
75 | #define CSR_CONFIG_ROM 0x400 | |
76 | #define CSR_CONFIG_ROM_END 0x800 | |
77 | #define CSR_FCP_COMMAND 0xB00 | |
78 | #define CSR_FCP_RESPONSE 0xD00 | |
79 | #define CSR_FCP_END 0xF00 | |
80 | #define CSR_TOPOLOGY_MAP 0x1000 | |
81 | #define CSR_TOPOLOGY_MAP_END 0x1400 | |
82 | #define CSR_SPEED_MAP 0x2000 | |
83 | #define CSR_SPEED_MAP_END 0x3000 | |
84 | ||
e534fe16 SR |
85 | #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31) |
86 | #define BROADCAST_CHANNEL_VALID (1 << 30) | |
87 | ||
3038e353 KH |
88 | #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args) |
89 | #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args) | |
3038e353 KH |
90 | |
91 | static inline void | |
92 | fw_memcpy_from_be32(void *_dst, void *_src, size_t size) | |
93 | { | |
efbf390a SR |
94 | u32 *dst = _dst; |
95 | __be32 *src = _src; | |
3038e353 KH |
96 | int i; |
97 | ||
98 | for (i = 0; i < size / 4; i++) | |
efbf390a | 99 | dst[i] = be32_to_cpu(src[i]); |
3038e353 KH |
100 | } |
101 | ||
102 | static inline void | |
103 | fw_memcpy_to_be32(void *_dst, void *_src, size_t size) | |
104 | { | |
105 | fw_memcpy_from_be32(_dst, _src, size); | |
106 | } | |
107 | ||
108 | struct fw_card; | |
109 | struct fw_packet; | |
110 | struct fw_node; | |
111 | struct fw_request; | |
112 | ||
113 | struct fw_descriptor { | |
114 | struct list_head link; | |
115 | size_t length; | |
937f6879 | 116 | u32 immediate; |
3038e353 | 117 | u32 key; |
21ebcd12 | 118 | const u32 *data; |
3038e353 KH |
119 | }; |
120 | ||
a98e2719 KH |
121 | int fw_core_add_descriptor(struct fw_descriptor *desc); |
122 | void fw_core_remove_descriptor(struct fw_descriptor *desc); | |
3038e353 | 123 | |
a98e2719 KH |
124 | typedef void (*fw_packet_callback_t)(struct fw_packet *packet, |
125 | struct fw_card *card, int status); | |
3038e353 KH |
126 | |
127 | typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode, | |
128 | void *data, | |
129 | size_t length, | |
130 | void *callback_data); | |
131 | ||
9c9bdf4d SR |
132 | /* |
133 | * Important note: The callback must guarantee that either fw_send_response() | |
134 | * or kfree() is called on the @request. | |
135 | */ | |
3038e353 KH |
136 | typedef void (*fw_address_callback_t)(struct fw_card *card, |
137 | struct fw_request *request, | |
138 | int tcode, int destination, int source, | |
139 | int generation, int speed, | |
140 | unsigned long long offset, | |
141 | void *data, size_t length, | |
142 | void *callback_data); | |
143 | ||
144 | typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle, | |
145 | int node_id, int generation, | |
146 | u32 *self_ids, | |
147 | int self_id_count, | |
148 | void *callback_data); | |
149 | ||
150 | struct fw_packet { | |
5e20c282 SR |
151 | int speed; |
152 | int generation; | |
153 | u32 header[4]; | |
154 | size_t header_length; | |
155 | void *payload; | |
156 | size_t payload_length; | |
1d1dc5e8 | 157 | dma_addr_t payload_bus; |
5e20c282 SR |
158 | u32 timestamp; |
159 | ||
c781c06d KH |
160 | /* |
161 | * This callback is called when the packet transmission has | |
5e20c282 SR |
162 | * completed; for successful transmission, the status code is |
163 | * the ack received from the destination, otherwise it's a | |
164 | * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO. | |
165 | * The callback can be called from tasklet context and thus | |
166 | * must never block. | |
167 | */ | |
168 | fw_packet_callback_t callback; | |
2639a6fb | 169 | int ack; |
5e20c282 | 170 | struct list_head link; |
f319b6a0 | 171 | void *driver_data; |
3038e353 KH |
172 | }; |
173 | ||
174 | struct fw_transaction { | |
5e20c282 SR |
175 | int node_id; /* The generation is implied; it is always the current. */ |
176 | int tlabel; | |
177 | int timestamp; | |
178 | struct list_head link; | |
3038e353 | 179 | |
5e20c282 | 180 | struct fw_packet packet; |
3038e353 | 181 | |
c781c06d KH |
182 | /* |
183 | * The data passed to the callback is valid only during the | |
184 | * callback. | |
185 | */ | |
5e20c282 SR |
186 | fw_transaction_callback_t callback; |
187 | void *callback_data; | |
3038e353 KH |
188 | }; |
189 | ||
95688e97 | 190 | static inline struct fw_packet * |
3038e353 KH |
191 | fw_packet(struct list_head *l) |
192 | { | |
a98e2719 | 193 | return list_entry(l, struct fw_packet, link); |
3038e353 KH |
194 | } |
195 | ||
196 | struct fw_address_handler { | |
5e20c282 SR |
197 | u64 offset; |
198 | size_t length; | |
199 | fw_address_callback_t address_callback; | |
200 | void *callback_data; | |
201 | struct list_head link; | |
3038e353 KH |
202 | }; |
203 | ||
204 | ||
205 | struct fw_address_region { | |
206 | u64 start; | |
207 | u64 end; | |
208 | }; | |
209 | ||
21ebcd12 | 210 | extern const struct fw_address_region fw_high_memory_region; |
3038e353 KH |
211 | |
212 | int fw_core_add_address_handler(struct fw_address_handler *handler, | |
21ebcd12 | 213 | const struct fw_address_region *region); |
3038e353 | 214 | void fw_core_remove_address_handler(struct fw_address_handler *handler); |
93c4cceb KH |
215 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
216 | int rcode, void *payload, size_t length); | |
3038e353 KH |
217 | void fw_send_response(struct fw_card *card, |
218 | struct fw_request *request, int rcode); | |
219 | ||
220 | extern struct bus_type fw_bus_type; | |
221 | ||
222 | struct fw_card { | |
21ebcd12 | 223 | const struct fw_card_driver *driver; |
3038e353 | 224 | struct device *device; |
459f7923 SR |
225 | struct kref kref; |
226 | struct completion done; | |
3038e353 | 227 | |
5e20c282 SR |
228 | int node_id; |
229 | int generation; | |
5e20c282 SR |
230 | int current_tlabel, tlabel_mask; |
231 | struct list_head transaction_list; | |
3038e353 | 232 | struct timer_list flush_timer; |
931c4834 | 233 | unsigned long reset_jiffies; |
3038e353 | 234 | |
5e20c282 | 235 | unsigned long long guid; |
25659f71 | 236 | unsigned max_receive; |
3038e353 KH |
237 | int link_speed; |
238 | int config_rom_generation; | |
239 | ||
c781c06d KH |
240 | /* |
241 | * We need to store up to 4 self ID for a maximum of 63 | |
242 | * devices plus 3 words for the topology map header. | |
243 | */ | |
5e20c282 | 244 | int self_id_count; |
473d28c7 | 245 | u32 topology_map[252 + 3]; |
e534fe16 | 246 | u32 broadcast_channel; |
3038e353 KH |
247 | |
248 | spinlock_t lock; /* Take this lock when handling the lists in | |
249 | * this struct. */ | |
250 | struct fw_node *local_node; | |
251 | struct fw_node *root_node; | |
252 | struct fw_node *irm_node; | |
4f9740d4 | 253 | u8 color; /* must be u8 to match the definition in struct fw_node */ |
83db801c | 254 | int gap_count; |
24d40125 | 255 | bool beta_repeaters_present; |
3038e353 KH |
256 | |
257 | int index; | |
258 | ||
3038e353 | 259 | struct list_head link; |
19a15b93 | 260 | |
931c4834 | 261 | /* Work struct for BM duties. */ |
19a15b93 | 262 | struct delayed_work work; |
931c4834 KH |
263 | int bm_retries; |
264 | int bm_generation; | |
3038e353 KH |
265 | }; |
266 | ||
459f7923 SR |
267 | static inline struct fw_card *fw_card_get(struct fw_card *card) |
268 | { | |
269 | kref_get(&card->kref); | |
270 | ||
271 | return card; | |
272 | } | |
273 | ||
274 | void fw_card_release(struct kref *kref); | |
275 | ||
276 | static inline void fw_card_put(struct fw_card *card) | |
277 | { | |
278 | kref_put(&card->kref, fw_card_release); | |
279 | } | |
280 | ||
c781c06d KH |
281 | /* |
282 | * The iso packet format allows for an immediate header/payload part | |
3038e353 KH |
283 | * stored in 'header' immediately after the packet info plus an |
284 | * indirect payload part that is pointer to by the 'payload' field. | |
285 | * Applications can use one or the other or both to implement simple | |
286 | * low-bandwidth streaming (e.g. audio) or more advanced | |
c781c06d KH |
287 | * scatter-gather streaming (e.g. assembling video frame automatically). |
288 | */ | |
3038e353 KH |
289 | |
290 | struct fw_iso_packet { | |
5e20c282 | 291 | u16 payload_length; /* Length of indirect payload. */ |
3038e353 KH |
292 | u32 interrupt : 1; /* Generate interrupt on this packet */ |
293 | u32 skip : 1; /* Set to not send packet at all. */ | |
294 | u32 tag : 2; | |
295 | u32 sy : 4; | |
296 | u32 header_length : 8; /* Length of immediate header. */ | |
5e20c282 | 297 | u32 header[0]; |
3038e353 KH |
298 | }; |
299 | ||
300 | #define FW_ISO_CONTEXT_TRANSMIT 0 | |
301 | #define FW_ISO_CONTEXT_RECEIVE 1 | |
302 | ||
98b6cbe8 KH |
303 | #define FW_ISO_CONTEXT_MATCH_TAG0 1 |
304 | #define FW_ISO_CONTEXT_MATCH_TAG1 2 | |
305 | #define FW_ISO_CONTEXT_MATCH_TAG2 4 | |
306 | #define FW_ISO_CONTEXT_MATCH_TAG3 8 | |
307 | #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15 | |
308 | ||
3038e353 KH |
309 | struct fw_iso_context; |
310 | ||
a98e2719 KH |
311 | typedef void (*fw_iso_callback_t)(struct fw_iso_context *context, |
312 | u32 cycle, | |
313 | size_t header_length, | |
314 | void *header, | |
315 | void *data); | |
3038e353 | 316 | |
c781c06d KH |
317 | /* |
318 | * An iso buffer is just a set of pages mapped for DMA in the | |
9aad8125 KH |
319 | * specified direction. Since the pages are to be used for DMA, they |
320 | * are not mapped into the kernel virtual address space. We store the | |
321 | * DMA address in the page private. The helper function | |
c781c06d KH |
322 | * fw_iso_buffer_map() will map the pages into a given vma. |
323 | */ | |
9aad8125 KH |
324 | |
325 | struct fw_iso_buffer { | |
326 | enum dma_data_direction direction; | |
327 | struct page **pages; | |
328 | int page_count; | |
329 | }; | |
330 | ||
3038e353 KH |
331 | struct fw_iso_context { |
332 | struct fw_card *card; | |
333 | int type; | |
334 | int channel; | |
335 | int speed; | |
295e3feb | 336 | size_t header_size; |
3038e353 KH |
337 | fw_iso_callback_t callback; |
338 | void *callback_data; | |
3038e353 KH |
339 | }; |
340 | ||
9aad8125 KH |
341 | int |
342 | fw_iso_buffer_init(struct fw_iso_buffer *buffer, | |
343 | struct fw_card *card, | |
344 | int page_count, | |
345 | enum dma_data_direction direction); | |
346 | int | |
347 | fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma); | |
348 | void | |
349 | fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card); | |
350 | ||
3038e353 | 351 | struct fw_iso_context * |
21efb3cf | 352 | fw_iso_context_create(struct fw_card *card, int type, |
eb0306ea | 353 | int channel, int speed, size_t header_size, |
295e3feb | 354 | fw_iso_callback_t callback, void *callback_data); |
9aad8125 | 355 | |
3038e353 KH |
356 | void |
357 | fw_iso_context_destroy(struct fw_iso_context *ctx); | |
358 | ||
3038e353 KH |
359 | int |
360 | fw_iso_context_queue(struct fw_iso_context *ctx, | |
9aad8125 KH |
361 | struct fw_iso_packet *packet, |
362 | struct fw_iso_buffer *buffer, | |
363 | unsigned long payload); | |
3038e353 KH |
364 | |
365 | int | |
eb0306ea KH |
366 | fw_iso_context_start(struct fw_iso_context *ctx, |
367 | int cycle, int sync, int tags); | |
3038e353 | 368 | |
b8295668 KH |
369 | int |
370 | fw_iso_context_stop(struct fw_iso_context *ctx); | |
371 | ||
3038e353 | 372 | struct fw_card_driver { |
c781c06d KH |
373 | /* |
374 | * Enable the given card with the given initial config rom. | |
5e20c282 SR |
375 | * This function is expected to activate the card, and either |
376 | * enable the PHY or set the link_on bit and initiate a bus | |
c781c06d KH |
377 | * reset. |
378 | */ | |
a98e2719 | 379 | int (*enable)(struct fw_card *card, u32 *config_rom, size_t length); |
3038e353 | 380 | |
a98e2719 KH |
381 | int (*update_phy_reg)(struct fw_card *card, int address, |
382 | int clear_bits, int set_bits); | |
3038e353 | 383 | |
c781c06d KH |
384 | /* |
385 | * Update the config rom for an enabled card. This function | |
5e20c282 | 386 | * should change the config rom that is presented on the bus |
c781c06d KH |
387 | * an initiate a bus reset. |
388 | */ | |
a98e2719 KH |
389 | int (*set_config_rom)(struct fw_card *card, |
390 | u32 *config_rom, size_t length); | |
3038e353 | 391 | |
a98e2719 KH |
392 | void (*send_request)(struct fw_card *card, struct fw_packet *packet); |
393 | void (*send_response)(struct fw_card *card, struct fw_packet *packet); | |
730c32f5 | 394 | /* Calling cancel is valid once a packet has been submitted. */ |
a98e2719 | 395 | int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet); |
3038e353 | 396 | |
c781c06d KH |
397 | /* |
398 | * Allow the specified node ID to do direct DMA out and in of | |
3038e353 KH |
399 | * host memory. The card will disable this for all node when |
400 | * a bus reset happens, so driver need to reenable this after | |
401 | * bus reset. Returns 0 on success, -ENODEV if the card | |
402 | * doesn't support this, -ESTALE if the generation doesn't | |
c781c06d KH |
403 | * match. |
404 | */ | |
a98e2719 KH |
405 | int (*enable_phys_dma)(struct fw_card *card, |
406 | int node_id, int generation); | |
3038e353 | 407 | |
a98e2719 | 408 | u64 (*get_bus_time)(struct fw_card *card); |
d60d7f1d | 409 | |
3038e353 | 410 | struct fw_iso_context * |
eb0306ea | 411 | (*allocate_iso_context)(struct fw_card *card, |
d2746dc1 | 412 | int type, size_t header_size); |
3038e353 KH |
413 | void (*free_iso_context)(struct fw_iso_context *ctx); |
414 | ||
eb0306ea KH |
415 | int (*start_iso)(struct fw_iso_context *ctx, |
416 | s32 cycle, u32 sync, u32 tags); | |
3038e353 KH |
417 | |
418 | int (*queue_iso)(struct fw_iso_context *ctx, | |
9aad8125 KH |
419 | struct fw_iso_packet *packet, |
420 | struct fw_iso_buffer *buffer, | |
421 | unsigned long payload); | |
b8295668 KH |
422 | |
423 | int (*stop_iso)(struct fw_iso_context *ctx); | |
3038e353 KH |
424 | }; |
425 | ||
426 | int | |
427 | fw_core_initiate_bus_reset(struct fw_card *card, int short_reset); | |
428 | ||
429 | void | |
430 | fw_send_request(struct fw_card *card, struct fw_transaction *t, | |
1e119fa9 JF |
431 | int tcode, int destination_id, int generation, int speed, |
432 | unsigned long long offset, void *data, size_t length, | |
3038e353 KH |
433 | fw_transaction_callback_t callback, void *callback_data); |
434 | ||
1e119fa9 JF |
435 | int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, |
436 | int generation, int speed, unsigned long long offset, | |
437 | void *data, size_t length); | |
438 | ||
730c32f5 KH |
439 | int fw_cancel_transaction(struct fw_card *card, |
440 | struct fw_transaction *transaction); | |
441 | ||
3038e353 KH |
442 | void fw_flush_transactions(struct fw_card *card); |
443 | ||
83db801c KH |
444 | void fw_send_phy_config(struct fw_card *card, |
445 | int node_id, int generation, int gap_count); | |
3038e353 | 446 | |
c781c06d KH |
447 | /* |
448 | * Called by the topology code to inform the device code of node | |
449 | * activity; found, lost, or updated nodes. | |
450 | */ | |
3038e353 KH |
451 | void |
452 | fw_node_event(struct fw_card *card, struct fw_node *node, int event); | |
453 | ||
454 | /* API used by card level drivers */ | |
455 | ||
3038e353 | 456 | void |
21ebcd12 | 457 | fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver, |
3038e353 KH |
458 | struct device *device); |
459 | int | |
460 | fw_card_add(struct fw_card *card, | |
461 | u32 max_receive, u32 link_speed, u64 guid); | |
462 | ||
463 | void | |
464 | fw_core_remove_card(struct fw_card *card); | |
465 | ||
466 | void | |
467 | fw_core_handle_bus_reset(struct fw_card *card, | |
468 | int node_id, int generation, | |
469 | int self_id_count, u32 *self_ids); | |
470 | void | |
2639a6fb | 471 | fw_core_handle_request(struct fw_card *card, struct fw_packet *request); |
3038e353 | 472 | |
2639a6fb KH |
473 | void |
474 | fw_core_handle_response(struct fw_card *card, struct fw_packet *packet); | |
3038e353 | 475 | |
687198bb | 476 | #endif /* __fw_transaction_h */ |