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