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