1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_FIREWIRE_H
3 #define _LINUX_FIREWIRE_H
5 #include <linux/completion.h>
6 #include <linux/device.h>
7 #include <linux/dma-mapping.h>
8 #include <linux/kernel.h>
9 #include <linux/kref.h>
10 #include <linux/list.h>
11 #include <linux/mutex.h>
12 #include <linux/spinlock.h>
13 #include <linux/sysfs.h>
14 #include <linux/timer.h>
15 #include <linux/types.h>
16 #include <linux/workqueue.h>
18 #include <linux/atomic.h>
19 #include <asm/byteorder.h>
21 #define CSR_REGISTER_BASE 0xfffff0000000ULL
23 /* register offsets are relative to CSR_REGISTER_BASE */
24 #define CSR_STATE_CLEAR 0x0
25 #define CSR_STATE_SET 0x4
26 #define CSR_NODE_IDS 0x8
27 #define CSR_RESET_START 0xc
28 #define CSR_SPLIT_TIMEOUT_HI 0x18
29 #define CSR_SPLIT_TIMEOUT_LO 0x1c
30 #define CSR_CYCLE_TIME 0x200
31 #define CSR_BUS_TIME 0x204
32 #define CSR_BUSY_TIMEOUT 0x210
33 #define CSR_PRIORITY_BUDGET 0x218
34 #define CSR_BUS_MANAGER_ID 0x21c
35 #define CSR_BANDWIDTH_AVAILABLE 0x220
36 #define CSR_CHANNELS_AVAILABLE 0x224
37 #define CSR_CHANNELS_AVAILABLE_HI 0x224
38 #define CSR_CHANNELS_AVAILABLE_LO 0x228
39 #define CSR_MAINT_UTILITY 0x230
40 #define CSR_BROADCAST_CHANNEL 0x234
41 #define CSR_CONFIG_ROM 0x400
42 #define CSR_CONFIG_ROM_END 0x800
43 #define CSR_OMPR 0x900
44 #define CSR_OPCR(i) (0x904 + (i) * 4)
45 #define CSR_IMPR 0x980
46 #define CSR_IPCR(i) (0x984 + (i) * 4)
47 #define CSR_FCP_COMMAND 0xB00
48 #define CSR_FCP_RESPONSE 0xD00
49 #define CSR_FCP_END 0xF00
50 #define CSR_TOPOLOGY_MAP 0x1000
51 #define CSR_TOPOLOGY_MAP_END 0x1400
52 #define CSR_SPEED_MAP 0x2000
53 #define CSR_SPEED_MAP_END 0x3000
55 #define CSR_OFFSET 0x40
57 #define CSR_DIRECTORY 0xc0
59 #define CSR_DESCRIPTOR 0x01
60 #define CSR_VENDOR 0x03
61 #define CSR_HARDWARE_VERSION 0x04
63 #define CSR_SPECIFIER_ID 0x12
64 #define CSR_VERSION 0x13
65 #define CSR_DEPENDENT_INFO 0x14
66 #define CSR_MODEL 0x17
67 #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 static inline struct fw_card *fw_card_get(struct fw_card *card)
141 kref_get(&card->kref);
146 void fw_card_release(struct kref *kref);
148 static inline void fw_card_put(struct fw_card *card)
150 kref_put(&card->kref, fw_card_release);
153 int fw_card_read_cycle_time(struct fw_card *card, u32 *cycle_time);
155 struct fw_attribute_group {
156 struct attribute_group *groups[2];
157 struct attribute_group group;
158 struct attribute *attrs[13];
161 enum fw_device_state {
162 FW_DEVICE_INITIALIZING,
169 * Note, fw_device.generation always has to be read before fw_device.node_id.
170 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
171 * to an outdated node_id if the generation was updated in the meantime due
174 * Likewise, fw-core will take care to update .node_id before .generation so
175 * that whenever fw_device.generation is current WRT the actual bus generation,
176 * fw_device.node_id is guaranteed to be current too.
178 * The same applies to fw_device.card->node_id vs. fw_device.generation.
180 * fw_device.config_rom and fw_device.config_rom_length may be accessed during
181 * the lifetime of any fw_unit belonging to the fw_device, before device_del()
182 * was called on the last fw_unit. Alternatively, they may be accessed while
183 * holding fw_device_rwsem.
187 struct fw_node *node;
191 struct fw_card *card;
192 struct device device;
194 struct mutex client_list_mutex;
195 struct list_head client_list;
197 const u32 *config_rom;
198 size_t config_rom_length;
199 int config_rom_retries;
204 unsigned bc_implemented:2;
207 struct delayed_work work;
208 struct fw_attribute_group attribute_group;
211 #define fw_device(dev) container_of_const(dev, struct fw_device, device)
213 static inline int fw_device_is_shutdown(struct fw_device *device)
215 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
218 int fw_device_enable_phys_dma(struct fw_device *device);
221 * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
224 struct device device;
225 const u32 *directory;
226 struct fw_attribute_group attribute_group;
229 #define fw_unit(dev) container_of_const(dev, struct fw_unit, device)
231 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
233 get_device(&unit->device);
238 static inline void fw_unit_put(struct fw_unit *unit)
240 put_device(&unit->device);
243 #define fw_parent_device(unit) fw_device(unit->device.parent)
245 struct ieee1394_device_id;
248 struct device_driver driver;
249 int (*probe)(struct fw_unit *unit, const struct ieee1394_device_id *id);
250 /* Called when the parent device sits through a bus reset. */
251 void (*update)(struct fw_unit *unit);
252 void (*remove)(struct fw_unit *unit);
253 const struct ieee1394_device_id *id_table;
259 typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
260 struct fw_card *card, int status);
261 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
262 void *data, size_t length,
263 void *callback_data);
265 * This callback handles an inbound request subaction. It is called in
266 * RCU read-side context, therefore must not sleep.
268 * The callback should not initiate outbound request subactions directly.
269 * Otherwise there is a danger of recursion of inbound and outbound
270 * transactions from and to the local node.
272 * The callback is responsible that fw_send_response() is called on the @request, except for FCP
273 * registers for which the core takes care of that.
275 typedef void (*fw_address_callback_t)(struct fw_card *card,
276 struct fw_request *request,
277 int tcode, int destination, int source,
279 unsigned long long offset,
280 void *data, size_t length,
281 void *callback_data);
287 size_t header_length;
289 size_t payload_length;
290 dma_addr_t payload_bus;
295 * This callback is called when the packet transmission has completed.
296 * For successful transmission, the status code is the ack received
297 * from the destination. Otherwise it is one of the juju-specific
298 * rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK.
299 * The callback can be called from tasklet context and thus
302 fw_packet_callback_t callback;
304 struct list_head link;
308 struct fw_transaction {
309 int node_id; /* The generation is implied; it is always the current. */
311 struct list_head link;
312 struct fw_card *card;
313 bool is_split_transaction;
314 struct timer_list split_timeout_timer;
316 struct fw_packet packet;
319 * The data passed to the callback is valid only during the
322 fw_transaction_callback_t callback;
326 struct fw_address_handler {
329 fw_address_callback_t address_callback;
331 struct list_head link;
334 struct fw_address_region {
339 extern const struct fw_address_region fw_high_memory_region;
341 int fw_core_add_address_handler(struct fw_address_handler *handler,
342 const struct fw_address_region *region);
343 void fw_core_remove_address_handler(struct fw_address_handler *handler);
344 void fw_send_response(struct fw_card *card,
345 struct fw_request *request, int rcode);
346 int fw_get_request_speed(struct fw_request *request);
347 u32 fw_request_get_timestamp(const struct fw_request *request);
348 void fw_send_request(struct fw_card *card, struct fw_transaction *t,
349 int tcode, int destination_id, int generation, int speed,
350 unsigned long long offset, void *payload, size_t length,
351 fw_transaction_callback_t callback, void *callback_data);
352 int fw_cancel_transaction(struct fw_card *card,
353 struct fw_transaction *transaction);
354 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
355 int generation, int speed, unsigned long long offset,
356 void *payload, size_t length);
357 const char *fw_rcode_string(int rcode);
359 static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
361 return tag << 14 | channel << 8 | sy;
364 void fw_schedule_bus_reset(struct fw_card *card, bool delayed,
367 struct fw_descriptor {
368 struct list_head link;
375 int fw_core_add_descriptor(struct fw_descriptor *desc);
376 void fw_core_remove_descriptor(struct fw_descriptor *desc);
379 * The iso packet format allows for an immediate header/payload part
380 * stored in 'header' immediately after the packet info plus an
381 * indirect payload part that is pointer to by the 'payload' field.
382 * Applications can use one or the other or both to implement simple
383 * low-bandwidth streaming (e.g. audio) or more advanced
384 * scatter-gather streaming (e.g. assembling video frame automatically).
386 struct fw_iso_packet {
387 u16 payload_length; /* Length of indirect payload */
388 u32 interrupt:1; /* Generate interrupt on this packet */
389 u32 skip:1; /* tx: Set to not send packet at all */
390 /* rx: Sync bit, wait for matching sy */
391 u32 tag:2; /* tx: Tag in packet header */
392 u32 sy:4; /* tx: Sy in packet header */
393 u32 header_length:8; /* Length of immediate header */
394 u32 header[0]; /* tx: Top of 1394 isoch. data_block */
397 #define FW_ISO_CONTEXT_TRANSMIT 0
398 #define FW_ISO_CONTEXT_RECEIVE 1
399 #define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2
401 #define FW_ISO_CONTEXT_MATCH_TAG0 1
402 #define FW_ISO_CONTEXT_MATCH_TAG1 2
403 #define FW_ISO_CONTEXT_MATCH_TAG2 4
404 #define FW_ISO_CONTEXT_MATCH_TAG3 8
405 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
408 * An iso buffer is just a set of pages mapped for DMA in the
409 * specified direction. Since the pages are to be used for DMA, they
410 * are not mapped into the kernel virtual address space. We store the
411 * DMA address in the page private. The helper function
412 * fw_iso_buffer_map() will map the pages into a given vma.
414 struct fw_iso_buffer {
415 enum dma_data_direction direction;
418 int page_count_mapped;
421 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
422 int page_count, enum dma_data_direction direction);
423 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
424 size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed);
426 struct fw_iso_context;
427 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
428 u32 cycle, size_t header_length,
429 void *header, void *data);
430 typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context,
431 dma_addr_t completed, void *data);
433 union fw_iso_callback {
434 fw_iso_callback_t sc;
435 fw_iso_mc_callback_t mc;
438 struct fw_iso_context {
439 struct fw_card *card;
443 bool drop_overflow_headers;
445 union fw_iso_callback callback;
449 struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
450 int type, int channel, int speed, size_t header_size,
451 fw_iso_callback_t callback, void *callback_data);
452 int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels);
453 int fw_iso_context_queue(struct fw_iso_context *ctx,
454 struct fw_iso_packet *packet,
455 struct fw_iso_buffer *buffer,
456 unsigned long payload);
457 void fw_iso_context_queue_flush(struct fw_iso_context *ctx);
458 int fw_iso_context_flush_completions(struct fw_iso_context *ctx);
459 int fw_iso_context_start(struct fw_iso_context *ctx,
460 int cycle, int sync, int tags);
461 int fw_iso_context_stop(struct fw_iso_context *ctx);
462 void fw_iso_context_destroy(struct fw_iso_context *ctx);
463 void fw_iso_resource_manage(struct fw_card *card, int generation,
464 u64 channels_mask, int *channel, int *bandwidth,
467 extern struct workqueue_struct *fw_workqueue;
469 #endif /* _LINUX_FIREWIRE_H */