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