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