blob: a0e67150a729cadbc6782ab70821b2d5981a09ab [file] [log] [blame]
Stefan Richter77c9a5d2009-06-05 16:26:18 +02001#ifndef _LINUX_FIREWIRE_H
2#define _LINUX_FIREWIRE_H
3
4#include <linux/completion.h>
5#include <linux/device.h>
Jay Fenlasonc76acec2009-05-18 13:08:06 -04006#include <linux/dma-mapping.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +02007#include <linux/kernel.h>
8#include <linux/kref.h>
9#include <linux/list.h>
10#include <linux/mutex.h>
11#include <linux/spinlock.h>
12#include <linux/sysfs.h>
13#include <linux/timer.h>
14#include <linux/types.h>
15#include <linux/workqueue.h>
16
17#include <asm/atomic.h>
18#include <asm/byteorder.h>
19
20#define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
21#define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
22
Stefan Richter77c9a5d2009-06-05 16:26:18 +020023#define CSR_REGISTER_BASE 0xfffff0000000ULL
24
25/* register offsets are relative to CSR_REGISTER_BASE */
26#define CSR_STATE_CLEAR 0x0
27#define CSR_STATE_SET 0x4
28#define CSR_NODE_IDS 0x8
29#define CSR_RESET_START 0xc
30#define CSR_SPLIT_TIMEOUT_HI 0x18
31#define CSR_SPLIT_TIMEOUT_LO 0x1c
32#define CSR_CYCLE_TIME 0x200
33#define CSR_BUS_TIME 0x204
34#define CSR_BUSY_TIMEOUT 0x210
35#define CSR_BUS_MANAGER_ID 0x21c
36#define CSR_BANDWIDTH_AVAILABLE 0x220
37#define CSR_CHANNELS_AVAILABLE 0x224
38#define CSR_CHANNELS_AVAILABLE_HI 0x224
39#define CSR_CHANNELS_AVAILABLE_LO 0x228
40#define CSR_BROADCAST_CHANNEL 0x234
41#define CSR_CONFIG_ROM 0x400
42#define CSR_CONFIG_ROM_END 0x800
43#define CSR_FCP_COMMAND 0xB00
44#define CSR_FCP_RESPONSE 0xD00
45#define CSR_FCP_END 0xF00
46#define CSR_TOPOLOGY_MAP 0x1000
47#define CSR_TOPOLOGY_MAP_END 0x1400
48#define CSR_SPEED_MAP 0x2000
49#define CSR_SPEED_MAP_END 0x3000
50
51#define CSR_OFFSET 0x40
52#define CSR_LEAF 0x80
53#define CSR_DIRECTORY 0xc0
54
55#define CSR_DESCRIPTOR 0x01
56#define CSR_VENDOR 0x03
57#define CSR_HARDWARE_VERSION 0x04
58#define CSR_NODE_CAPABILITIES 0x0c
59#define CSR_UNIT 0x11
60#define CSR_SPECIFIER_ID 0x12
61#define CSR_VERSION 0x13
62#define CSR_DEPENDENT_INFO 0x14
63#define CSR_MODEL 0x17
64#define CSR_INSTANCE 0x18
65#define CSR_DIRECTORY_ID 0x20
66
67struct fw_csr_iterator {
68 u32 *p;
69 u32 *end;
70};
71
72void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
73int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
74
75extern struct bus_type fw_bus_type;
76
77struct fw_card_driver;
78struct fw_node;
79
80struct fw_card {
81 const struct fw_card_driver *driver;
82 struct device *device;
83 struct kref kref;
84 struct completion done;
85
86 int node_id;
87 int generation;
Stefan Richter1e626fd2009-06-14 13:23:58 +020088 int current_tlabel;
89 u64 tlabel_mask;
Stefan Richter77c9a5d2009-06-05 16:26:18 +020090 struct list_head transaction_list;
91 struct timer_list flush_timer;
92 unsigned long reset_jiffies;
93
94 unsigned long long guid;
95 unsigned max_receive;
96 int link_speed;
97 int config_rom_generation;
98
99 spinlock_t lock; /* Take this lock when handling the lists in
100 * this struct. */
101 struct fw_node *local_node;
102 struct fw_node *root_node;
103 struct fw_node *irm_node;
104 u8 color; /* must be u8 to match the definition in struct fw_node */
105 int gap_count;
106 bool beta_repeaters_present;
107
108 int index;
109
110 struct list_head link;
111
112 /* Work struct for BM duties. */
113 struct delayed_work work;
114 int bm_retries;
115 int bm_generation;
Stefan Richter6fdc0372009-06-20 13:23:59 +0200116 __be32 bm_transaction_data[2];
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200117
118 bool broadcast_channel_allocated;
119 u32 broadcast_channel;
Stefan Richtercb7c96d2009-10-08 00:42:53 +0200120 __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200121};
122
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200123struct fw_attribute_group {
124 struct attribute_group *groups[2];
125 struct attribute_group group;
126 struct attribute *attrs[12];
127};
128
129enum fw_device_state {
130 FW_DEVICE_INITIALIZING,
131 FW_DEVICE_RUNNING,
132 FW_DEVICE_GONE,
133 FW_DEVICE_SHUTDOWN,
134};
135
136/*
137 * Note, fw_device.generation always has to be read before fw_device.node_id.
138 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
139 * to an outdated node_id if the generation was updated in the meantime due
140 * to a bus reset.
141 *
142 * Likewise, fw-core will take care to update .node_id before .generation so
143 * that whenever fw_device.generation is current WRT the actual bus generation,
144 * fw_device.node_id is guaranteed to be current too.
145 *
146 * The same applies to fw_device.card->node_id vs. fw_device.generation.
147 *
148 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
149 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
150 * was called on the last fw_unit. Alternatively, they may be accessed while
151 * holding fw_device_rwsem.
152 */
153struct fw_device {
154 atomic_t state;
155 struct fw_node *node;
156 int node_id;
157 int generation;
158 unsigned max_speed;
159 struct fw_card *card;
160 struct device device;
161
162 struct mutex client_list_mutex;
163 struct list_head client_list;
164
165 u32 *config_rom;
166 size_t config_rom_length;
167 int config_rom_retries;
168 unsigned is_local:1;
Stefan Richter837ec782009-06-09 23:56:55 +0200169 unsigned max_rec:4;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200170 unsigned cmc:1;
Stefan Richter837ec782009-06-09 23:56:55 +0200171 unsigned irmc:1;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200172 unsigned bc_implemented:2;
173
174 struct delayed_work work;
175 struct fw_attribute_group attribute_group;
176};
177
178static inline struct fw_device *fw_device(struct device *dev)
179{
180 return container_of(dev, struct fw_device, device);
181}
182
183static inline int fw_device_is_shutdown(struct fw_device *device)
184{
185 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
186}
187
188static inline struct fw_device *fw_device_get(struct fw_device *device)
189{
190 get_device(&device->device);
191
192 return device;
193}
194
195static inline void fw_device_put(struct fw_device *device)
196{
197 put_device(&device->device);
198}
199
200int fw_device_enable_phys_dma(struct fw_device *device);
201
202/*
203 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
204 */
205struct fw_unit {
206 struct device device;
207 u32 *directory;
208 struct fw_attribute_group attribute_group;
209};
210
211static inline struct fw_unit *fw_unit(struct device *dev)
212{
213 return container_of(dev, struct fw_unit, device);
214}
215
216static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
217{
218 get_device(&unit->device);
219
220 return unit;
221}
222
223static inline void fw_unit_put(struct fw_unit *unit)
224{
225 put_device(&unit->device);
226}
227
Stefan Richtere5110d02009-06-06 18:35:27 +0200228static inline struct fw_device *fw_parent_device(struct fw_unit *unit)
229{
230 return fw_device(unit->device.parent);
231}
232
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200233struct ieee1394_device_id;
234
235struct fw_driver {
236 struct device_driver driver;
237 /* Called when the parent device sits through a bus reset. */
238 void (*update)(struct fw_unit *unit);
239 const struct ieee1394_device_id *id_table;
240};
241
242struct fw_packet;
243struct fw_request;
244
245typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
246 struct fw_card *card, int status);
247typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
248 void *data, size_t length,
249 void *callback_data);
250/*
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100251 * Important note: Except for the FCP registers, the callback must guarantee
252 * that either fw_send_response() or kfree() is called on the @request.
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200253 */
254typedef void (*fw_address_callback_t)(struct fw_card *card,
255 struct fw_request *request,
256 int tcode, int destination, int source,
257 int generation, int speed,
258 unsigned long long offset,
259 void *data, size_t length,
260 void *callback_data);
261
262struct fw_packet {
263 int speed;
264 int generation;
265 u32 header[4];
266 size_t header_length;
267 void *payload;
268 size_t payload_length;
269 dma_addr_t payload_bus;
Stefan Richter19593ff2009-10-14 20:40:10 +0200270 bool payload_mapped;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200271 u32 timestamp;
272
273 /*
274 * This callback is called when the packet transmission has
275 * completed; for successful transmission, the status code is
276 * the ack received from the destination, otherwise it's a
277 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
278 * The callback can be called from tasklet context and thus
279 * must never block.
280 */
281 fw_packet_callback_t callback;
282 int ack;
283 struct list_head link;
284 void *driver_data;
285};
286
287struct fw_transaction {
288 int node_id; /* The generation is implied; it is always the current. */
289 int tlabel;
290 int timestamp;
291 struct list_head link;
292
293 struct fw_packet packet;
294
295 /*
296 * The data passed to the callback is valid only during the
297 * callback.
298 */
299 fw_transaction_callback_t callback;
300 void *callback_data;
301};
302
303struct fw_address_handler {
304 u64 offset;
305 size_t length;
306 fw_address_callback_t address_callback;
307 void *callback_data;
308 struct list_head link;
309};
310
311struct fw_address_region {
312 u64 start;
313 u64 end;
314};
315
316extern const struct fw_address_region fw_high_memory_region;
317
318int fw_core_add_address_handler(struct fw_address_handler *handler,
319 const struct fw_address_region *region);
320void fw_core_remove_address_handler(struct fw_address_handler *handler);
321void fw_send_response(struct fw_card *card,
322 struct fw_request *request, int rcode);
323void fw_send_request(struct fw_card *card, struct fw_transaction *t,
324 int tcode, int destination_id, int generation, int speed,
325 unsigned long long offset, void *payload, size_t length,
326 fw_transaction_callback_t callback, void *callback_data);
327int fw_cancel_transaction(struct fw_card *card,
328 struct fw_transaction *transaction);
329int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
330 int generation, int speed, unsigned long long offset,
331 void *payload, size_t length);
332
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400333static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
334{
335 return tag << 14 | channel << 8 | sy;
336}
337
338struct fw_descriptor {
339 struct list_head link;
340 size_t length;
341 u32 immediate;
342 u32 key;
343 const u32 *data;
344};
345
346int fw_core_add_descriptor(struct fw_descriptor *desc);
347void fw_core_remove_descriptor(struct fw_descriptor *desc);
348
349/*
350 * The iso packet format allows for an immediate header/payload part
351 * stored in 'header' immediately after the packet info plus an
352 * indirect payload part that is pointer to by the 'payload' field.
353 * Applications can use one or the other or both to implement simple
354 * low-bandwidth streaming (e.g. audio) or more advanced
355 * scatter-gather streaming (e.g. assembling video frame automatically).
356 */
357struct fw_iso_packet {
358 u16 payload_length; /* Length of indirect payload. */
359 u32 interrupt:1; /* Generate interrupt on this packet */
360 u32 skip:1; /* Set to not send packet at all. */
361 u32 tag:2;
362 u32 sy:4;
363 u32 header_length:8; /* Length of immediate header. */
364 u32 header[0];
365};
366
367#define FW_ISO_CONTEXT_TRANSMIT 0
368#define FW_ISO_CONTEXT_RECEIVE 1
369
370#define FW_ISO_CONTEXT_MATCH_TAG0 1
371#define FW_ISO_CONTEXT_MATCH_TAG1 2
372#define FW_ISO_CONTEXT_MATCH_TAG2 4
373#define FW_ISO_CONTEXT_MATCH_TAG3 8
374#define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
375
376/*
377 * An iso buffer is just a set of pages mapped for DMA in the
378 * specified direction. Since the pages are to be used for DMA, they
379 * are not mapped into the kernel virtual address space. We store the
380 * DMA address in the page private. The helper function
381 * fw_iso_buffer_map() will map the pages into a given vma.
382 */
383struct fw_iso_buffer {
384 enum dma_data_direction direction;
385 struct page **pages;
386 int page_count;
387};
388
389int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
390 int page_count, enum dma_data_direction direction);
391void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
392
393struct fw_iso_context;
394typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
395 u32 cycle, size_t header_length,
396 void *header, void *data);
397struct fw_iso_context {
398 struct fw_card *card;
399 int type;
400 int channel;
401 int speed;
402 size_t header_size;
403 fw_iso_callback_t callback;
404 void *callback_data;
405};
406
407struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
408 int type, int channel, int speed, size_t header_size,
409 fw_iso_callback_t callback, void *callback_data);
410int fw_iso_context_queue(struct fw_iso_context *ctx,
411 struct fw_iso_packet *packet,
412 struct fw_iso_buffer *buffer,
413 unsigned long payload);
414int fw_iso_context_start(struct fw_iso_context *ctx,
415 int cycle, int sync, int tags);
416int fw_iso_context_stop(struct fw_iso_context *ctx);
417void fw_iso_context_destroy(struct fw_iso_context *ctx);
418
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200419#endif /* _LINUX_FIREWIRE_H */