blob: 72e2b8ac2a5a997b8d055e72d81d7358cddf6dce [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
Stefan Richter77c9a5d2009-06-05 16:26:18 +020058#define CSR_UNIT 0x11
59#define CSR_SPECIFIER_ID 0x12
60#define CSR_VERSION 0x13
61#define CSR_DEPENDENT_INFO 0x14
62#define CSR_MODEL 0x17
Stefan Richter77c9a5d2009-06-05 16:26:18 +020063#define CSR_DIRECTORY_ID 0x20
64
65struct fw_csr_iterator {
Stefan Richter13b302d2009-12-26 01:44:10 +010066 const u32 *p;
67 const u32 *end;
Stefan Richter77c9a5d2009-06-05 16:26:18 +020068};
69
Stefan Richter13b302d2009-12-26 01:44:10 +010070void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p);
Stefan Richter77c9a5d2009-06-05 16:26:18 +020071int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
Stefan Richter13b302d2009-12-26 01:44:10 +010072int fw_csr_string(const u32 *directory, int key, char *buf, size_t size);
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010073
Stefan Richter77c9a5d2009-06-05 16:26:18 +020074extern struct bus_type fw_bus_type;
75
76struct fw_card_driver;
77struct fw_node;
78
79struct fw_card {
80 const struct fw_card_driver *driver;
81 struct device *device;
82 struct kref kref;
83 struct completion done;
84
85 int node_id;
86 int generation;
Stefan Richter1e626fd2009-06-14 13:23:58 +020087 int current_tlabel;
88 u64 tlabel_mask;
Stefan Richter77c9a5d2009-06-05 16:26:18 +020089 struct list_head transaction_list;
Stefan Richter77c9a5d2009-06-05 16:26:18 +020090 unsigned long reset_jiffies;
91
92 unsigned long long guid;
93 unsigned max_receive;
94 int link_speed;
95 int config_rom_generation;
96
97 spinlock_t lock; /* Take this lock when handling the lists in
98 * this struct. */
99 struct fw_node *local_node;
100 struct fw_node *root_node;
101 struct fw_node *irm_node;
102 u8 color; /* must be u8 to match the definition in struct fw_node */
103 int gap_count;
104 bool beta_repeaters_present;
105
106 int index;
107
108 struct list_head link;
109
110 /* Work struct for BM duties. */
111 struct delayed_work work;
112 int bm_retries;
113 int bm_generation;
Stefan Richter6fdc0372009-06-20 13:23:59 +0200114 __be32 bm_transaction_data[2];
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200115
116 bool broadcast_channel_allocated;
117 u32 broadcast_channel;
Stefan Richtercb7c96d2009-10-08 00:42:53 +0200118 __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200119};
120
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200121struct fw_attribute_group {
122 struct attribute_group *groups[2];
123 struct attribute_group group;
124 struct attribute *attrs[12];
125};
126
127enum fw_device_state {
128 FW_DEVICE_INITIALIZING,
129 FW_DEVICE_RUNNING,
130 FW_DEVICE_GONE,
131 FW_DEVICE_SHUTDOWN,
132};
133
134/*
135 * Note, fw_device.generation always has to be read before fw_device.node_id.
136 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
137 * to an outdated node_id if the generation was updated in the meantime due
138 * to a bus reset.
139 *
140 * Likewise, fw-core will take care to update .node_id before .generation so
141 * that whenever fw_device.generation is current WRT the actual bus generation,
142 * fw_device.node_id is guaranteed to be current too.
143 *
144 * The same applies to fw_device.card->node_id vs. fw_device.generation.
145 *
146 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
147 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
148 * was called on the last fw_unit. Alternatively, they may be accessed while
149 * holding fw_device_rwsem.
150 */
151struct fw_device {
152 atomic_t state;
153 struct fw_node *node;
154 int node_id;
155 int generation;
156 unsigned max_speed;
157 struct fw_card *card;
158 struct device device;
159
160 struct mutex client_list_mutex;
161 struct list_head client_list;
162
Stefan Richter13b302d2009-12-26 01:44:10 +0100163 const u32 *config_rom;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200164 size_t config_rom_length;
165 int config_rom_retries;
166 unsigned is_local:1;
Stefan Richter837ec782009-06-09 23:56:55 +0200167 unsigned max_rec:4;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200168 unsigned cmc:1;
Stefan Richter837ec782009-06-09 23:56:55 +0200169 unsigned irmc:1;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200170 unsigned bc_implemented:2;
171
172 struct delayed_work work;
173 struct fw_attribute_group attribute_group;
174};
175
176static inline struct fw_device *fw_device(struct device *dev)
177{
178 return container_of(dev, struct fw_device, device);
179}
180
181static inline int fw_device_is_shutdown(struct fw_device *device)
182{
183 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
184}
185
186static inline struct fw_device *fw_device_get(struct fw_device *device)
187{
188 get_device(&device->device);
189
190 return device;
191}
192
193static inline void fw_device_put(struct fw_device *device)
194{
195 put_device(&device->device);
196}
197
198int fw_device_enable_phys_dma(struct fw_device *device);
199
200/*
201 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
202 */
203struct fw_unit {
204 struct device device;
Stefan Richter13b302d2009-12-26 01:44:10 +0100205 const u32 *directory;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200206 struct fw_attribute_group attribute_group;
207};
208
209static inline struct fw_unit *fw_unit(struct device *dev)
210{
211 return container_of(dev, struct fw_unit, device);
212}
213
214static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
215{
216 get_device(&unit->device);
217
218 return unit;
219}
220
221static inline void fw_unit_put(struct fw_unit *unit)
222{
223 put_device(&unit->device);
224}
225
Stefan Richtere5110d02009-06-06 18:35:27 +0200226static inline struct fw_device *fw_parent_device(struct fw_unit *unit)
227{
228 return fw_device(unit->device.parent);
229}
230
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200231struct ieee1394_device_id;
232
233struct fw_driver {
234 struct device_driver driver;
235 /* Called when the parent device sits through a bus reset. */
236 void (*update)(struct fw_unit *unit);
237 const struct ieee1394_device_id *id_table;
238};
239
240struct fw_packet;
241struct fw_request;
242
243typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
244 struct fw_card *card, int status);
245typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
246 void *data, size_t length,
247 void *callback_data);
248/*
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100249 * Important note: Except for the FCP registers, the callback must guarantee
250 * that either fw_send_response() or kfree() is called on the @request.
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200251 */
252typedef void (*fw_address_callback_t)(struct fw_card *card,
253 struct fw_request *request,
254 int tcode, int destination, int source,
255 int generation, int speed,
256 unsigned long long offset,
257 void *data, size_t length,
258 void *callback_data);
259
260struct fw_packet {
261 int speed;
262 int generation;
263 u32 header[4];
264 size_t header_length;
265 void *payload;
266 size_t payload_length;
267 dma_addr_t payload_bus;
Stefan Richter19593ff2009-10-14 20:40:10 +0200268 bool payload_mapped;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200269 u32 timestamp;
270
271 /*
272 * This callback is called when the packet transmission has
273 * completed; for successful transmission, the status code is
274 * the ack received from the destination, otherwise it's a
275 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
276 * The callback can be called from tasklet context and thus
277 * must never block.
278 */
279 fw_packet_callback_t callback;
280 int ack;
281 struct list_head link;
282 void *driver_data;
283};
284
285struct fw_transaction {
286 int node_id; /* The generation is implied; it is always the current. */
287 int tlabel;
288 int timestamp;
289 struct list_head link;
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200290 struct fw_card *card;
291 struct timer_list split_timeout_timer;
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200292
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 */