Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef _FIREWIRE_CORE_H
2#define _FIREWIRE_CORE_H
3
4#include <linux/fs.h>
5#include <linux/list.h>
6#include <linux/idr.h>
7#include <linux/mm_types.h>
8#include <linux/rwsem.h>
9#include <linux/slab.h>
10#include <linux/types.h>
11
12#include <asm/atomic.h>
13
14struct device;
15struct fw_card;
16struct fw_device;
17struct fw_iso_buffer;
18struct fw_iso_context;
19struct fw_iso_packet;
20struct fw_node;
21struct fw_packet;
22
23
24/* -card */
25
26/* bitfields within the PHY registers */
27#define PHY_LINK_ACTIVE 0x80
28#define PHY_CONTENDER 0x40
29#define PHY_BUS_RESET 0x40
30#define PHY_BUS_SHORT_RESET 0x40
31
32#define BANDWIDTH_AVAILABLE_INITIAL 4915
33#define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31)
34#define BROADCAST_CHANNEL_VALID (1 << 30)
35
36struct fw_card_driver {
37 /*
38 * Enable the given card with the given initial config rom.
39 * This function is expected to activate the card, and either
40 * enable the PHY or set the link_on bit and initiate a bus
41 * reset.
42 */
43 int (*enable)(struct fw_card *card, u32 *config_rom, size_t length);
44
45 int (*update_phy_reg)(struct fw_card *card, int address,
46 int clear_bits, int set_bits);
47
48 /*
49 * Update the config rom for an enabled card. This function
50 * should change the config rom that is presented on the bus
51 * an initiate a bus reset.
52 */
53 int (*set_config_rom)(struct fw_card *card,
54 u32 *config_rom, size_t length);
55
56 void (*send_request)(struct fw_card *card, struct fw_packet *packet);
57 void (*send_response)(struct fw_card *card, struct fw_packet *packet);
58 /* Calling cancel is valid once a packet has been submitted. */
59 int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
60
61 /*
62 * Allow the specified node ID to do direct DMA out and in of
63 * host memory. The card will disable this for all node when
64 * a bus reset happens, so driver need to reenable this after
65 * bus reset. Returns 0 on success, -ENODEV if the card
66 * doesn't support this, -ESTALE if the generation doesn't
67 * match.
68 */
69 int (*enable_phys_dma)(struct fw_card *card,
70 int node_id, int generation);
71
72 u64 (*get_bus_time)(struct fw_card *card);
73
74 struct fw_iso_context *
75 (*allocate_iso_context)(struct fw_card *card,
76 int type, int channel, size_t header_size);
77 void (*free_iso_context)(struct fw_iso_context *ctx);
78
79 int (*start_iso)(struct fw_iso_context *ctx,
80 s32 cycle, u32 sync, u32 tags);
81
82 int (*queue_iso)(struct fw_iso_context *ctx,
83 struct fw_iso_packet *packet,
84 struct fw_iso_buffer *buffer,
85 unsigned long payload);
86
87 int (*stop_iso)(struct fw_iso_context *ctx);
88};
89
90void fw_card_initialize(struct fw_card *card,
91 const struct fw_card_driver *driver, struct device *device);
92int fw_card_add(struct fw_card *card,
93 u32 max_receive, u32 link_speed, u64 guid);
94void fw_core_remove_card(struct fw_card *card);
95int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
96int fw_compute_block_crc(u32 *block);
97void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
98
99
100/* -cdev */
101
102extern const struct file_operations fw_device_ops;
103
104void fw_device_cdev_update(struct fw_device *device);
105void fw_device_cdev_remove(struct fw_device *device);
106
107
108/* -device */
109
110extern struct rw_semaphore fw_device_rwsem;
111extern struct idr fw_device_idr;
112extern int fw_cdev_major;
113
114struct fw_device *fw_device_get_by_devt(dev_t devt);
115int fw_device_set_broadcast_channel(struct device *dev, void *gen);
116void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
117
118
119/* -iso */
120
121int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
122void fw_iso_resource_manage(struct fw_card *card, int generation,
123 u64 channels_mask, int *channel, int *bandwidth, bool allocate);
124
125
126/* -topology */
127
128enum {
129 FW_NODE_CREATED,
130 FW_NODE_UPDATED,
131 FW_NODE_DESTROYED,
132 FW_NODE_LINK_ON,
133 FW_NODE_LINK_OFF,
134 FW_NODE_INITIATED_RESET,
135};
136
137struct fw_node {
138 u16 node_id;
139 u8 color;
140 u8 port_count;
141 u8 link_on:1;
142 u8 initiated_reset:1;
143 u8 b_path:1;
144 u8 phy_speed:2; /* As in the self ID packet. */
145 u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
146 * local node to this node. */
147 u8 max_depth:4; /* Maximum depth to any leaf node */
148 u8 max_hops:4; /* Max hops in this sub tree */
149 atomic_t ref_count;
150
151 /* For serializing node topology into a list. */
152 struct list_head link;
153
154 /* Upper layer specific data. */
155 void *data;
156
157 struct fw_node *ports[0];
158};
159
160static inline struct fw_node *fw_node_get(struct fw_node *node)
161{
162 atomic_inc(&node->ref_count);
163
164 return node;
165}
166
167static inline void fw_node_put(struct fw_node *node)
168{
169 if (atomic_dec_and_test(&node->ref_count))
170 kfree(node);
171}
172
173void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
174 int generation, int self_id_count, u32 *self_ids);
175void fw_destroy_nodes(struct fw_card *card);
176
177/*
178 * Check whether new_generation is the immediate successor of old_generation.
179 * Take counter roll-over at 255 (as per OHCI) into account.
180 */
181static inline bool is_next_generation(int new_generation, int old_generation)
182{
183 return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
184}
185
186
187/* -transaction */
188
189#define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
190#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
191#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
192#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
193#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
194#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
195
196#define LOCAL_BUS 0xffc0
197
198void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
199void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
200void fw_fill_response(struct fw_packet *response, u32 *request_header,
201 int rcode, void *payload, size_t length);
202void fw_flush_transactions(struct fw_card *card);
203void fw_send_phy_config(struct fw_card *card,
204 int node_id, int generation, int gap_count);
205
206#endif /* _FIREWIRE_CORE_H */