1 #ifndef _LINUX_FIREWIRE_H
2 #define _LINUX_FIREWIRE_H
4 #include <linux/completion.h>
5 #include <linux/dma-mapping.h>
6 #include <linux/kernel.h>
7 #include <linux/kref.h>
8 #include <linux/list.h>
9 #include <linux/mutex.h>
10 #include <linux/spinlock.h>
11 #include <linux/sysfs.h>
12 #include <linux/timer.h>
13 #include <linux/types.h>
14 #include <linux/workqueue.h>
16 #include <linux/atomic.h>
17 #include <asm/byteorder.h>
19 #define CSR_REGISTER_BASE 0xfffff0000000ULL
21 /* register offsets are relative to CSR_REGISTER_BASE */
22 #define CSR_STATE_CLEAR 0x0
23 #define CSR_STATE_SET 0x4
24 #define CSR_NODE_IDS 0x8
25 #define CSR_RESET_START 0xc
26 #define CSR_SPLIT_TIMEOUT_HI 0x18
27 #define CSR_SPLIT_TIMEOUT_LO 0x1c
28 #define CSR_CYCLE_TIME 0x200
29 #define CSR_BUS_TIME 0x204
30 #define CSR_BUSY_TIMEOUT 0x210
31 #define CSR_PRIORITY_BUDGET 0x218
32 #define CSR_BUS_MANAGER_ID 0x21c
33 #define CSR_BANDWIDTH_AVAILABLE 0x220
34 #define CSR_CHANNELS_AVAILABLE 0x224
35 #define CSR_CHANNELS_AVAILABLE_HI 0x224
36 #define CSR_CHANNELS_AVAILABLE_LO 0x228
37 #define CSR_MAINT_UTILITY 0x230
38 #define CSR_BROADCAST_CHANNEL 0x234
39 #define CSR_CONFIG_ROM 0x400
40 #define CSR_CONFIG_ROM_END 0x800
41 #define CSR_OMPR 0x900
42 #define CSR_OPCR(i) (0x904 + (i) * 4)
43 #define CSR_IMPR 0x980
44 #define CSR_IPCR(i) (0x984 + (i) * 4)
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
53 #define CSR_OFFSET 0x40
55 #define CSR_DIRECTORY 0xc0
57 #define CSR_DESCRIPTOR 0x01
58 #define CSR_VENDOR 0x03
59 #define CSR_HARDWARE_VERSION 0x04
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
69 struct fw_csr_iterator
{
74 void fw_csr_iterator_init(struct fw_csr_iterator
*ci
, const u32
*p
);
75 int fw_csr_iterator_next(struct fw_csr_iterator
*ci
, int *key
, int *value
);
76 int fw_csr_string(const u32
*directory
, int key
, char *buf
, size_t size
);
78 extern struct bus_type fw_bus_type
;
80 struct fw_card_driver
;
84 const struct fw_card_driver
*driver
;
85 struct device
*device
;
87 struct completion done
;
93 struct list_head transaction_list
;
98 unsigned int split_timeout_cycles
;
99 unsigned int split_timeout_jiffies
;
101 unsigned long long guid
;
102 unsigned max_receive
;
104 int config_rom_generation
;
106 spinlock_t lock
; /* Take this lock when handling the lists in
108 struct fw_node
*local_node
;
109 struct fw_node
*root_node
;
110 struct fw_node
*irm_node
;
111 u8 color
; /* must be u8 to match the definition in struct fw_node */
113 bool beta_repeaters_present
;
116 struct list_head link
;
118 struct list_head phy_receiver_list
;
120 struct delayed_work br_work
; /* bus reset job */
123 struct delayed_work bm_work
; /* bus manager job */
129 bool priority_budget_implemented
; /* controller feature */
130 bool broadcast_channel_auto_allocated
; /* controller feature */
132 bool broadcast_channel_allocated
;
133 u32 broadcast_channel
;
134 __be32 topology_map
[(CSR_TOPOLOGY_MAP_END
- CSR_TOPOLOGY_MAP
) / 4];
136 __be32 maint_utility_register
;
139 struct fw_attribute_group
{
140 struct attribute_group
*groups
[2];
141 struct attribute_group group
;
142 struct attribute
*attrs
[12];
145 enum fw_device_state
{
146 FW_DEVICE_INITIALIZING
,
153 * Note, fw_device.generation always has to be read before fw_device.node_id.
154 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
155 * to an outdated node_id if the generation was updated in the meantime due
158 * Likewise, fw-core will take care to update .node_id before .generation so
159 * that whenever fw_device.generation is current WRT the actual bus generation,
160 * fw_device.node_id is guaranteed to be current too.
162 * The same applies to fw_device.card->node_id vs. fw_device.generation.
164 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
165 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
166 * was called on the last fw_unit. Alternatively, they may be accessed while
167 * holding fw_device_rwsem.
171 struct fw_node
*node
;
175 struct fw_card
*card
;
176 struct device device
;
178 struct mutex client_list_mutex
;
179 struct list_head client_list
;
181 const u32
*config_rom
;
182 size_t config_rom_length
;
183 int config_rom_retries
;
188 unsigned bc_implemented
:2;
190 struct delayed_work work
;
191 struct fw_attribute_group attribute_group
;
194 static inline struct fw_device
*fw_device(struct device
*dev
)
196 return container_of(dev
, struct fw_device
, device
);
199 static inline int fw_device_is_shutdown(struct fw_device
*device
)
201 return atomic_read(&device
->state
) == FW_DEVICE_SHUTDOWN
;
204 int fw_device_enable_phys_dma(struct fw_device
*device
);
207 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
210 struct device device
;
211 const u32
*directory
;
212 struct fw_attribute_group attribute_group
;
215 static inline struct fw_unit
*fw_unit(struct device
*dev
)
217 return container_of(dev
, struct fw_unit
, device
);
220 static inline struct fw_unit
*fw_unit_get(struct fw_unit
*unit
)
222 get_device(&unit
->device
);
227 static inline void fw_unit_put(struct fw_unit
*unit
)
229 put_device(&unit
->device
);
232 static inline struct fw_device
*fw_parent_device(struct fw_unit
*unit
)
234 return fw_device(unit
->device
.parent
);
237 struct ieee1394_device_id
;
240 struct device_driver driver
;
241 /* Called when the parent device sits through a bus reset. */
242 void (*update
)(struct fw_unit
*unit
);
243 const struct ieee1394_device_id
*id_table
;
249 typedef void (*fw_packet_callback_t
)(struct fw_packet
*packet
,
250 struct fw_card
*card
, int status
);
251 typedef void (*fw_transaction_callback_t
)(struct fw_card
*card
, int rcode
,
252 void *data
, size_t length
,
253 void *callback_data
);
255 * Important note: Except for the FCP registers, the callback must guarantee
256 * that either fw_send_response() or kfree() is called on the @request.
258 typedef void (*fw_address_callback_t
)(struct fw_card
*card
,
259 struct fw_request
*request
,
260 int tcode
, int destination
, int source
,
262 unsigned long long offset
,
263 void *data
, size_t length
,
264 void *callback_data
);
270 size_t header_length
;
272 size_t payload_length
;
273 dma_addr_t payload_bus
;
278 * This callback is called when the packet transmission has completed.
279 * For successful transmission, the status code is the ack received
280 * from the destination. Otherwise it is one of the juju-specific
281 * rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK.
282 * The callback can be called from tasklet context and thus
285 fw_packet_callback_t callback
;
287 struct list_head link
;
291 struct fw_transaction
{
292 int node_id
; /* The generation is implied; it is always the current. */
294 struct list_head link
;
295 struct fw_card
*card
;
296 bool is_split_transaction
;
297 struct timer_list split_timeout_timer
;
299 struct fw_packet packet
;
302 * The data passed to the callback is valid only during the
305 fw_transaction_callback_t callback
;
309 struct fw_address_handler
{
312 fw_address_callback_t address_callback
;
314 struct list_head link
;
317 struct fw_address_region
{
322 extern const struct fw_address_region fw_high_memory_region
;
324 int fw_core_add_address_handler(struct fw_address_handler
*handler
,
325 const struct fw_address_region
*region
);
326 void fw_core_remove_address_handler(struct fw_address_handler
*handler
);
327 void fw_send_response(struct fw_card
*card
,
328 struct fw_request
*request
, int rcode
);
329 void fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
330 int tcode
, int destination_id
, int generation
, int speed
,
331 unsigned long long offset
, void *payload
, size_t length
,
332 fw_transaction_callback_t callback
, void *callback_data
);
333 int fw_cancel_transaction(struct fw_card
*card
,
334 struct fw_transaction
*transaction
);
335 int fw_run_transaction(struct fw_card
*card
, int tcode
, int destination_id
,
336 int generation
, int speed
, unsigned long long offset
,
337 void *payload
, size_t length
);
339 static inline int fw_stream_packet_destination_id(int tag
, int channel
, int sy
)
341 return tag
<< 14 | channel
<< 8 | sy
;
344 struct fw_descriptor
{
345 struct list_head link
;
352 int fw_core_add_descriptor(struct fw_descriptor
*desc
);
353 void fw_core_remove_descriptor(struct fw_descriptor
*desc
);
356 * The iso packet format allows for an immediate header/payload part
357 * stored in 'header' immediately after the packet info plus an
358 * indirect payload part that is pointer to by the 'payload' field.
359 * Applications can use one or the other or both to implement simple
360 * low-bandwidth streaming (e.g. audio) or more advanced
361 * scatter-gather streaming (e.g. assembling video frame automatically).
363 struct fw_iso_packet
{
364 u16 payload_length
; /* Length of indirect payload */
365 u32 interrupt
:1; /* Generate interrupt on this packet */
366 u32 skip
:1; /* tx: Set to not send packet at all */
367 /* rx: Sync bit, wait for matching sy */
368 u32 tag
:2; /* tx: Tag in packet header */
369 u32 sy
:4; /* tx: Sy in packet header */
370 u32 header_length
:8; /* Length of immediate header */
371 u32 header
[0]; /* tx: Top of 1394 isoch. data_block */
374 #define FW_ISO_CONTEXT_TRANSMIT 0
375 #define FW_ISO_CONTEXT_RECEIVE 1
376 #define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2
378 #define FW_ISO_CONTEXT_MATCH_TAG0 1
379 #define FW_ISO_CONTEXT_MATCH_TAG1 2
380 #define FW_ISO_CONTEXT_MATCH_TAG2 4
381 #define FW_ISO_CONTEXT_MATCH_TAG3 8
382 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
385 * An iso buffer is just a set of pages mapped for DMA in the
386 * specified direction. Since the pages are to be used for DMA, they
387 * are not mapped into the kernel virtual address space. We store the
388 * DMA address in the page private. The helper function
389 * fw_iso_buffer_map() will map the pages into a given vma.
391 struct fw_iso_buffer
{
392 enum dma_data_direction direction
;
397 int fw_iso_buffer_init(struct fw_iso_buffer
*buffer
, struct fw_card
*card
,
398 int page_count
, enum dma_data_direction direction
);
399 void fw_iso_buffer_destroy(struct fw_iso_buffer
*buffer
, struct fw_card
*card
);
400 size_t fw_iso_buffer_lookup(struct fw_iso_buffer
*buffer
, dma_addr_t completed
);
402 struct fw_iso_context
;
403 typedef void (*fw_iso_callback_t
)(struct fw_iso_context
*context
,
404 u32 cycle
, size_t header_length
,
405 void *header
, void *data
);
406 typedef void (*fw_iso_mc_callback_t
)(struct fw_iso_context
*context
,
407 dma_addr_t completed
, void *data
);
408 struct fw_iso_context
{
409 struct fw_card
*card
;
415 fw_iso_callback_t sc
;
416 fw_iso_mc_callback_t mc
;
421 struct fw_iso_context
*fw_iso_context_create(struct fw_card
*card
,
422 int type
, int channel
, int speed
, size_t header_size
,
423 fw_iso_callback_t callback
, void *callback_data
);
424 int fw_iso_context_set_channels(struct fw_iso_context
*ctx
, u64
*channels
);
425 int fw_iso_context_queue(struct fw_iso_context
*ctx
,
426 struct fw_iso_packet
*packet
,
427 struct fw_iso_buffer
*buffer
,
428 unsigned long payload
);
429 void fw_iso_context_queue_flush(struct fw_iso_context
*ctx
);
430 int fw_iso_context_flush_completions(struct fw_iso_context
*ctx
);
431 int fw_iso_context_start(struct fw_iso_context
*ctx
,
432 int cycle
, int sync
, int tags
);
433 int fw_iso_context_stop(struct fw_iso_context
*ctx
);
434 void fw_iso_context_destroy(struct fw_iso_context
*ctx
);
435 void fw_iso_resource_manage(struct fw_card
*card
, int generation
,
436 u64 channels_mask
, int *channel
, int *bandwidth
,
439 extern struct workqueue_struct
*fw_workqueue
;
441 #endif /* _LINUX_FIREWIRE_H */