Commit | Line | Data |
---|---|---|
77c9a5da SR |
1 | #ifndef _FIREWIRE_CORE_H |
2 | #define _FIREWIRE_CORE_H | |
3 | ||
26b4950d | 4 | #include <linux/compiler.h> |
21076226 | 5 | #include <linux/device.h> |
0b6c4857 | 6 | #include <linux/dma-mapping.h> |
77c9a5da SR |
7 | #include <linux/fs.h> |
8 | #include <linux/list.h> | |
9 | #include <linux/idr.h> | |
10 | #include <linux/mm_types.h> | |
11 | #include <linux/rwsem.h> | |
12 | #include <linux/slab.h> | |
13 | #include <linux/types.h> | |
14 | ||
60063497 | 15 | #include <linux/atomic.h> |
77c9a5da SR |
16 | |
17 | struct device; | |
18 | struct fw_card; | |
19 | struct fw_device; | |
20 | struct fw_iso_buffer; | |
21 | struct fw_iso_context; | |
22 | struct fw_iso_packet; | |
23 | struct fw_node; | |
24 | struct fw_packet; | |
25 | ||
26 | ||
27 | /* -card */ | |
28 | ||
26b4950d SR |
29 | extern __printf(2, 3) |
30 | void fw_err(const struct fw_card *card, const char *fmt, ...); | |
31 | extern __printf(2, 3) | |
32 | void fw_notice(const struct fw_card *card, const char *fmt, ...); | |
33 | ||
77c9a5da SR |
34 | /* bitfields within the PHY registers */ |
35 | #define PHY_LINK_ACTIVE 0x80 | |
36 | #define PHY_CONTENDER 0x40 | |
37 | #define PHY_BUS_RESET 0x40 | |
925e7a65 | 38 | #define PHY_EXTENDED_REGISTERS 0xe0 |
77c9a5da | 39 | #define PHY_BUS_SHORT_RESET 0x40 |
e7014dad | 40 | #define PHY_INT_STATUS_BITS 0x3c |
925e7a65 CL |
41 | #define PHY_ENABLE_ACCEL 0x02 |
42 | #define PHY_ENABLE_MULTI 0x01 | |
43 | #define PHY_PAGE_SELECT 0xe0 | |
77c9a5da SR |
44 | |
45 | #define BANDWIDTH_AVAILABLE_INITIAL 4915 | |
46 | #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31) | |
47 | #define BROADCAST_CHANNEL_VALID (1 << 30) | |
48 | ||
4ffb7a6a | 49 | #define CSR_STATE_BIT_CMSTR (1 << 8) |
7e0e314f | 50 | #define CSR_STATE_BIT_ABDICATE (1 << 10) |
4ffb7a6a | 51 | |
77c9a5da SR |
52 | struct fw_card_driver { |
53 | /* | |
54 | * Enable the given card with the given initial config rom. | |
55 | * This function is expected to activate the card, and either | |
56 | * enable the PHY or set the link_on bit and initiate a bus | |
57 | * reset. | |
58 | */ | |
8e85973e SR |
59 | int (*enable)(struct fw_card *card, |
60 | const __be32 *config_rom, size_t length); | |
77c9a5da | 61 | |
02d37bed | 62 | int (*read_phy_reg)(struct fw_card *card, int address); |
77c9a5da SR |
63 | int (*update_phy_reg)(struct fw_card *card, int address, |
64 | int clear_bits, int set_bits); | |
65 | ||
66 | /* | |
67 | * Update the config rom for an enabled card. This function | |
68 | * should change the config rom that is presented on the bus | |
8e85973e | 69 | * and initiate a bus reset. |
77c9a5da SR |
70 | */ |
71 | int (*set_config_rom)(struct fw_card *card, | |
8e85973e | 72 | const __be32 *config_rom, size_t length); |
77c9a5da SR |
73 | |
74 | void (*send_request)(struct fw_card *card, struct fw_packet *packet); | |
75 | void (*send_response)(struct fw_card *card, struct fw_packet *packet); | |
76 | /* Calling cancel is valid once a packet has been submitted. */ | |
77 | int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet); | |
78 | ||
79 | /* | |
80 | * Allow the specified node ID to do direct DMA out and in of | |
81 | * host memory. The card will disable this for all node when | |
82 | * a bus reset happens, so driver need to reenable this after | |
83 | * bus reset. Returns 0 on success, -ENODEV if the card | |
84 | * doesn't support this, -ESTALE if the generation doesn't | |
85 | * match. | |
86 | */ | |
87 | int (*enable_phys_dma)(struct fw_card *card, | |
88 | int node_id, int generation); | |
89 | ||
0fcff4e3 SR |
90 | u32 (*read_csr)(struct fw_card *card, int csr_offset); |
91 | void (*write_csr)(struct fw_card *card, int csr_offset, u32 value); | |
77c9a5da SR |
92 | |
93 | struct fw_iso_context * | |
94 | (*allocate_iso_context)(struct fw_card *card, | |
95 | int type, int channel, size_t header_size); | |
96 | void (*free_iso_context)(struct fw_iso_context *ctx); | |
97 | ||
98 | int (*start_iso)(struct fw_iso_context *ctx, | |
99 | s32 cycle, u32 sync, u32 tags); | |
100 | ||
872e330e SR |
101 | int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels); |
102 | ||
77c9a5da SR |
103 | int (*queue_iso)(struct fw_iso_context *ctx, |
104 | struct fw_iso_packet *packet, | |
105 | struct fw_iso_buffer *buffer, | |
106 | unsigned long payload); | |
107 | ||
13882a82 CL |
108 | void (*flush_queue_iso)(struct fw_iso_context *ctx); |
109 | ||
d1bbd209 CL |
110 | int (*flush_iso_completions)(struct fw_iso_context *ctx); |
111 | ||
77c9a5da SR |
112 | int (*stop_iso)(struct fw_iso_context *ctx); |
113 | }; | |
114 | ||
115 | void fw_card_initialize(struct fw_card *card, | |
116 | const struct fw_card_driver *driver, struct device *device); | |
117 | int fw_card_add(struct fw_card *card, | |
118 | u32 max_receive, u32 link_speed, u64 guid); | |
119 | void fw_core_remove_card(struct fw_card *card); | |
cb7c96da | 120 | int fw_compute_block_crc(__be32 *block); |
02d37bed | 121 | void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset); |
77c9a5da SR |
122 | void fw_schedule_bm_work(struct fw_card *card, unsigned long delay); |
123 | ||
18668ff9 SR |
124 | static inline struct fw_card *fw_card_get(struct fw_card *card) |
125 | { | |
126 | kref_get(&card->kref); | |
127 | ||
128 | return card; | |
129 | } | |
130 | ||
131 | void fw_card_release(struct kref *kref); | |
132 | ||
133 | static inline void fw_card_put(struct fw_card *card) | |
134 | { | |
135 | kref_put(&card->kref, fw_card_release); | |
136 | } | |
137 | ||
77c9a5da SR |
138 | |
139 | /* -cdev */ | |
140 | ||
141 | extern const struct file_operations fw_device_ops; | |
142 | ||
143 | void fw_device_cdev_update(struct fw_device *device); | |
144 | void fw_device_cdev_remove(struct fw_device *device); | |
bf54e146 | 145 | void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p); |
77c9a5da SR |
146 | |
147 | ||
148 | /* -device */ | |
149 | ||
150 | extern struct rw_semaphore fw_device_rwsem; | |
151 | extern struct idr fw_device_idr; | |
152 | extern int fw_cdev_major; | |
153 | ||
21076226 SR |
154 | static inline struct fw_device *fw_device_get(struct fw_device *device) |
155 | { | |
156 | get_device(&device->device); | |
157 | ||
158 | return device; | |
159 | } | |
160 | ||
161 | static inline void fw_device_put(struct fw_device *device) | |
162 | { | |
163 | put_device(&device->device); | |
164 | } | |
165 | ||
77c9a5da | 166 | struct fw_device *fw_device_get_by_devt(dev_t devt); |
099d5414 | 167 | int fw_device_set_broadcast_channel(struct device *dev, void *gen); |
77c9a5da SR |
168 | void fw_node_event(struct fw_card *card, struct fw_node *node, int event); |
169 | ||
170 | ||
171 | /* -iso */ | |
172 | ||
0b6c4857 SR |
173 | int fw_iso_buffer_alloc(struct fw_iso_buffer *buffer, int page_count); |
174 | int fw_iso_buffer_map_dma(struct fw_iso_buffer *buffer, struct fw_card *card, | |
175 | enum dma_data_direction direction); | |
176 | int fw_iso_buffer_map_vma(struct fw_iso_buffer *buffer, | |
177 | struct vm_area_struct *vma); | |
77c9a5da SR |
178 | |
179 | ||
180 | /* -topology */ | |
181 | ||
182 | enum { | |
183 | FW_NODE_CREATED, | |
184 | FW_NODE_UPDATED, | |
185 | FW_NODE_DESTROYED, | |
186 | FW_NODE_LINK_ON, | |
187 | FW_NODE_LINK_OFF, | |
188 | FW_NODE_INITIATED_RESET, | |
189 | }; | |
190 | ||
191 | struct fw_node { | |
192 | u16 node_id; | |
193 | u8 color; | |
194 | u8 port_count; | |
195 | u8 link_on:1; | |
196 | u8 initiated_reset:1; | |
197 | u8 b_path:1; | |
198 | u8 phy_speed:2; /* As in the self ID packet. */ | |
199 | u8 max_speed:2; /* Minimum of all phy-speeds on the path from the | |
200 | * local node to this node. */ | |
201 | u8 max_depth:4; /* Maximum depth to any leaf node */ | |
202 | u8 max_hops:4; /* Max hops in this sub tree */ | |
203 | atomic_t ref_count; | |
204 | ||
205 | /* For serializing node topology into a list. */ | |
206 | struct list_head link; | |
207 | ||
208 | /* Upper layer specific data. */ | |
209 | void *data; | |
210 | ||
211 | struct fw_node *ports[0]; | |
212 | }; | |
213 | ||
214 | static inline struct fw_node *fw_node_get(struct fw_node *node) | |
215 | { | |
216 | atomic_inc(&node->ref_count); | |
217 | ||
218 | return node; | |
219 | } | |
220 | ||
221 | static inline void fw_node_put(struct fw_node *node) | |
222 | { | |
223 | if (atomic_dec_and_test(&node->ref_count)) | |
224 | kfree(node); | |
225 | } | |
226 | ||
227 | void fw_core_handle_bus_reset(struct fw_card *card, int node_id, | |
c8a94ded | 228 | int generation, int self_id_count, u32 *self_ids, bool bm_abdicate); |
77c9a5da SR |
229 | void fw_destroy_nodes(struct fw_card *card); |
230 | ||
231 | /* | |
232 | * Check whether new_generation is the immediate successor of old_generation. | |
233 | * Take counter roll-over at 255 (as per OHCI) into account. | |
234 | */ | |
235 | static inline bool is_next_generation(int new_generation, int old_generation) | |
236 | { | |
237 | return (new_generation & 0xff) == ((old_generation + 1) & 0xff); | |
238 | } | |
239 | ||
240 | ||
241 | /* -transaction */ | |
242 | ||
5b06db16 CL |
243 | #define TCODE_LINK_INTERNAL 0xe |
244 | ||
77c9a5da SR |
245 | #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4) |
246 | #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0) | |
5b06db16 | 247 | #define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL) |
77c9a5da SR |
248 | #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0) |
249 | #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0) | |
250 | #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4) | |
251 | #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0) | |
252 | ||
253 | #define LOCAL_BUS 0xffc0 | |
254 | ||
255 | void fw_core_handle_request(struct fw_card *card, struct fw_packet *request); | |
256 | void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet); | |
a10c0ce7 | 257 | int fw_get_response_length(struct fw_request *request); |
77c9a5da SR |
258 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
259 | int rcode, void *payload, size_t length); | |
02d37bed SR |
260 | |
261 | #define FW_PHY_CONFIG_NO_NODE_ID -1 | |
262 | #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1 | |
77c9a5da SR |
263 | void fw_send_phy_config(struct fw_card *card, |
264 | int node_id, int generation, int gap_count); | |
265 | ||
cc550216 SR |
266 | static inline bool is_ping_packet(u32 *data) |
267 | { | |
268 | return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1]; | |
269 | } | |
270 | ||
77c9a5da | 271 | #endif /* _FIREWIRE_CORE_H */ |