1 #ifndef _LINUX_FIREWIRE_H
2 #define _LINUX_FIREWIRE_H
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>
17 #include <asm/atomic.h>
18 #include <asm/byteorder.h>
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)
23 static inline void fw_memcpy_from_be32(void *_dst
, void *_src
, size_t size
)
29 for (i
= 0; i
< size
/ 4; i
++)
30 dst
[i
] = be32_to_cpu(src
[i
]);
33 static inline void fw_memcpy_to_be32(void *_dst
, void *_src
, size_t size
)
35 fw_memcpy_from_be32(_dst
, _src
, size
);
37 #define CSR_REGISTER_BASE 0xfffff0000000ULL
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
65 #define CSR_OFFSET 0x40
67 #define CSR_DIRECTORY 0xc0
69 #define CSR_DESCRIPTOR 0x01
70 #define CSR_VENDOR 0x03
71 #define CSR_HARDWARE_VERSION 0x04
72 #define CSR_NODE_CAPABILITIES 0x0c
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
81 struct fw_csr_iterator
{
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
);
89 extern struct bus_type fw_bus_type
;
91 struct fw_card_driver
;
95 const struct fw_card_driver
*driver
;
96 struct device
*device
;
98 struct completion done
;
104 struct list_head transaction_list
;
105 struct timer_list flush_timer
;
106 unsigned long reset_jiffies
;
108 unsigned long long guid
;
109 unsigned max_receive
;
111 int config_rom_generation
;
113 spinlock_t lock
; /* Take this lock when handling the lists in
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 */
120 bool beta_repeaters_present
;
124 struct list_head link
;
126 /* Work struct for BM duties. */
127 struct delayed_work work
;
131 bool broadcast_channel_allocated
;
132 u32 broadcast_channel
;
133 u32 topology_map
[(CSR_TOPOLOGY_MAP_END
- CSR_TOPOLOGY_MAP
) / 4];
136 static inline struct fw_card
*fw_card_get(struct fw_card
*card
)
138 kref_get(&card
->kref
);
143 void fw_card_release(struct kref
*kref
);
145 static inline void fw_card_put(struct fw_card
*card
)
147 kref_put(&card
->kref
, fw_card_release
);
150 struct fw_attribute_group
{
151 struct attribute_group
*groups
[2];
152 struct attribute_group group
;
153 struct attribute
*attrs
[12];
156 enum fw_device_state
{
157 FW_DEVICE_INITIALIZING
,
164 * Note, fw_device.generation always has to be read before fw_device.node_id.
165 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
166 * to an outdated node_id if the generation was updated in the meantime due
169 * Likewise, fw-core will take care to update .node_id before .generation so
170 * that whenever fw_device.generation is current WRT the actual bus generation,
171 * fw_device.node_id is guaranteed to be current too.
173 * The same applies to fw_device.card->node_id vs. fw_device.generation.
175 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
176 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
177 * was called on the last fw_unit. Alternatively, they may be accessed while
178 * holding fw_device_rwsem.
182 struct fw_node
*node
;
186 struct fw_card
*card
;
187 struct device device
;
189 struct mutex client_list_mutex
;
190 struct list_head client_list
;
193 size_t config_rom_length
;
194 int config_rom_retries
;
199 unsigned bc_implemented
:2;
201 struct delayed_work work
;
202 struct fw_attribute_group attribute_group
;
205 static inline struct fw_device
*fw_device(struct device
*dev
)
207 return container_of(dev
, struct fw_device
, device
);
210 static inline int fw_device_is_shutdown(struct fw_device
*device
)
212 return atomic_read(&device
->state
) == FW_DEVICE_SHUTDOWN
;
215 static inline struct fw_device
*fw_device_get(struct fw_device
*device
)
217 get_device(&device
->device
);
222 static inline void fw_device_put(struct fw_device
*device
)
224 put_device(&device
->device
);
227 int fw_device_enable_phys_dma(struct fw_device
*device
);
230 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
233 struct device device
;
235 struct fw_attribute_group attribute_group
;
238 static inline struct fw_unit
*fw_unit(struct device
*dev
)
240 return container_of(dev
, struct fw_unit
, device
);
243 static inline struct fw_unit
*fw_unit_get(struct fw_unit
*unit
)
245 get_device(&unit
->device
);
250 static inline void fw_unit_put(struct fw_unit
*unit
)
252 put_device(&unit
->device
);
255 static inline struct fw_device
*fw_parent_device(struct fw_unit
*unit
)
257 return fw_device(unit
->device
.parent
);
260 struct ieee1394_device_id
;
263 struct device_driver driver
;
264 /* Called when the parent device sits through a bus reset. */
265 void (*update
)(struct fw_unit
*unit
);
266 const struct ieee1394_device_id
*id_table
;
272 typedef void (*fw_packet_callback_t
)(struct fw_packet
*packet
,
273 struct fw_card
*card
, int status
);
274 typedef void (*fw_transaction_callback_t
)(struct fw_card
*card
, int rcode
,
275 void *data
, size_t length
,
276 void *callback_data
);
278 * Important note: The callback must guarantee that either fw_send_response()
279 * or kfree() is called on the @request.
281 typedef void (*fw_address_callback_t
)(struct fw_card
*card
,
282 struct fw_request
*request
,
283 int tcode
, int destination
, int source
,
284 int generation
, int speed
,
285 unsigned long long offset
,
286 void *data
, size_t length
,
287 void *callback_data
);
293 size_t header_length
;
295 size_t payload_length
;
296 dma_addr_t payload_bus
;
300 * This callback is called when the packet transmission has
301 * completed; for successful transmission, the status code is
302 * the ack received from the destination, otherwise it's a
303 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
304 * The callback can be called from tasklet context and thus
307 fw_packet_callback_t callback
;
309 struct list_head link
;
313 struct fw_transaction
{
314 int node_id
; /* The generation is implied; it is always the current. */
317 struct list_head link
;
319 struct fw_packet packet
;
322 * The data passed to the callback is valid only during the
325 fw_transaction_callback_t callback
;
329 struct fw_address_handler
{
332 fw_address_callback_t address_callback
;
334 struct list_head link
;
337 struct fw_address_region
{
342 extern const struct fw_address_region fw_high_memory_region
;
344 int fw_core_add_address_handler(struct fw_address_handler
*handler
,
345 const struct fw_address_region
*region
);
346 void fw_core_remove_address_handler(struct fw_address_handler
*handler
);
347 void fw_send_response(struct fw_card
*card
,
348 struct fw_request
*request
, int rcode
);
349 void fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
350 int tcode
, int destination_id
, int generation
, int speed
,
351 unsigned long long offset
, void *payload
, size_t length
,
352 fw_transaction_callback_t callback
, void *callback_data
);
353 int fw_cancel_transaction(struct fw_card
*card
,
354 struct fw_transaction
*transaction
);
355 int fw_run_transaction(struct fw_card
*card
, int tcode
, int destination_id
,
356 int generation
, int speed
, unsigned long long offset
,
357 void *payload
, size_t length
);
359 static inline int fw_stream_packet_destination_id(int tag
, int channel
, int sy
)
361 return tag
<< 14 | channel
<< 8 | sy
;
364 struct fw_descriptor
{
365 struct list_head link
;
372 int fw_core_add_descriptor(struct fw_descriptor
*desc
);
373 void fw_core_remove_descriptor(struct fw_descriptor
*desc
);
376 * The iso packet format allows for an immediate header/payload part
377 * stored in 'header' immediately after the packet info plus an
378 * indirect payload part that is pointer to by the 'payload' field.
379 * Applications can use one or the other or both to implement simple
380 * low-bandwidth streaming (e.g. audio) or more advanced
381 * scatter-gather streaming (e.g. assembling video frame automatically).
383 struct fw_iso_packet
{
384 u16 payload_length
; /* Length of indirect payload. */
385 u32 interrupt
:1; /* Generate interrupt on this packet */
386 u32 skip
:1; /* Set to not send packet at all. */
389 u32 header_length
:8; /* Length of immediate header. */
393 #define FW_ISO_CONTEXT_TRANSMIT 0
394 #define FW_ISO_CONTEXT_RECEIVE 1
396 #define FW_ISO_CONTEXT_MATCH_TAG0 1
397 #define FW_ISO_CONTEXT_MATCH_TAG1 2
398 #define FW_ISO_CONTEXT_MATCH_TAG2 4
399 #define FW_ISO_CONTEXT_MATCH_TAG3 8
400 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
403 * An iso buffer is just a set of pages mapped for DMA in the
404 * specified direction. Since the pages are to be used for DMA, they
405 * are not mapped into the kernel virtual address space. We store the
406 * DMA address in the page private. The helper function
407 * fw_iso_buffer_map() will map the pages into a given vma.
409 struct fw_iso_buffer
{
410 enum dma_data_direction direction
;
415 int fw_iso_buffer_init(struct fw_iso_buffer
*buffer
, struct fw_card
*card
,
416 int page_count
, enum dma_data_direction direction
);
417 void fw_iso_buffer_destroy(struct fw_iso_buffer
*buffer
, struct fw_card
*card
);
419 struct fw_iso_context
;
420 typedef void (*fw_iso_callback_t
)(struct fw_iso_context
*context
,
421 u32 cycle
, size_t header_length
,
422 void *header
, void *data
);
423 struct fw_iso_context
{
424 struct fw_card
*card
;
429 fw_iso_callback_t callback
;
433 struct fw_iso_context
*fw_iso_context_create(struct fw_card
*card
,
434 int type
, int channel
, int speed
, size_t header_size
,
435 fw_iso_callback_t callback
, void *callback_data
);
436 int fw_iso_context_queue(struct fw_iso_context
*ctx
,
437 struct fw_iso_packet
*packet
,
438 struct fw_iso_buffer
*buffer
,
439 unsigned long payload
);
440 int fw_iso_context_start(struct fw_iso_context
*ctx
,
441 int cycle
, int sync
, int tags
);
442 int fw_iso_context_stop(struct fw_iso_context
*ctx
);
443 void fw_iso_context_destroy(struct fw_iso_context
*ctx
);
445 #endif /* _LINUX_FIREWIRE_H */