1#ifndef _LINUX_FIREWIRE_H
2#define _LINUX_FIREWIRE_H
3
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>
16
17#include <linux/atomic.h>
18#include <asm/byteorder.h>
19
20#define CSR_REGISTER_BASE 0xfffff0000000ULL
21
22
23#define CSR_STATE_CLEAR 0x0
24#define CSR_STATE_SET 0x4
25#define CSR_NODE_IDS 0x8
26#define CSR_RESET_START 0xc
27#define CSR_SPLIT_TIMEOUT_HI 0x18
28#define CSR_SPLIT_TIMEOUT_LO 0x1c
29#define CSR_CYCLE_TIME 0x200
30#define CSR_BUS_TIME 0x204
31#define CSR_BUSY_TIMEOUT 0x210
32#define CSR_PRIORITY_BUDGET 0x218
33#define CSR_BUS_MANAGER_ID 0x21c
34#define CSR_BANDWIDTH_AVAILABLE 0x220
35#define CSR_CHANNELS_AVAILABLE 0x224
36#define CSR_CHANNELS_AVAILABLE_HI 0x224
37#define CSR_CHANNELS_AVAILABLE_LO 0x228
38#define CSR_MAINT_UTILITY 0x230
39#define CSR_BROADCAST_CHANNEL 0x234
40#define CSR_CONFIG_ROM 0x400
41#define CSR_CONFIG_ROM_END 0x800
42#define CSR_OMPR 0x900
43#define CSR_OPCR(i) (0x904 + (i) * 4)
44#define CSR_IMPR 0x980
45#define CSR_IPCR(i) (0x984 + (i) * 4)
46#define CSR_FCP_COMMAND 0xB00
47#define CSR_FCP_RESPONSE 0xD00
48#define CSR_FCP_END 0xF00
49#define CSR_TOPOLOGY_MAP 0x1000
50#define CSR_TOPOLOGY_MAP_END 0x1400
51#define CSR_SPEED_MAP 0x2000
52#define CSR_SPEED_MAP_END 0x3000
53
54#define CSR_OFFSET 0x40
55#define CSR_LEAF 0x80
56#define CSR_DIRECTORY 0xc0
57
58#define CSR_DESCRIPTOR 0x01
59#define CSR_VENDOR 0x03
60#define CSR_HARDWARE_VERSION 0x04
61#define CSR_UNIT 0x11
62#define CSR_SPECIFIER_ID 0x12
63#define CSR_VERSION 0x13
64#define CSR_DEPENDENT_INFO 0x14
65#define CSR_MODEL 0x17
66#define CSR_DIRECTORY_ID 0x20
67
68struct fw_csr_iterator {
69 const u32 *p;
70 const u32 *end;
71};
72
73void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p);
74int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
75int fw_csr_string(const u32 *directory, int key, char *buf, size_t size);
76
77extern struct bus_type fw_bus_type;
78
79struct fw_card_driver;
80struct fw_node;
81
82struct fw_card {
83 const struct fw_card_driver *driver;
84 struct device *device;
85 struct kref kref;
86 struct completion done;
87
88 int node_id;
89 int generation;
90 int current_tlabel;
91 u64 tlabel_mask;
92 struct list_head transaction_list;
93 u64 reset_jiffies;
94
95 u32 split_timeout_hi;
96 u32 split_timeout_lo;
97 unsigned int split_timeout_cycles;
98 unsigned int split_timeout_jiffies;
99
100 unsigned long long guid;
101 unsigned max_receive;
102 int link_speed;
103 int config_rom_generation;
104
105 spinlock_t lock;
106
107 struct fw_node *local_node;
108 struct fw_node *root_node;
109 struct fw_node *irm_node;
110 u8 color;
111 int gap_count;
112 bool beta_repeaters_present;
113
114 int index;
115 struct list_head link;
116
117 struct list_head phy_receiver_list;
118
119 struct delayed_work br_work;
120 bool br_short;
121
122 struct delayed_work bm_work;
123 int bm_retries;
124 int bm_generation;
125 int bm_node_id;
126 bool bm_abdicate;
127
128 bool priority_budget_implemented;
129 bool broadcast_channel_auto_allocated;
130
131 bool broadcast_channel_allocated;
132 u32 broadcast_channel;
133 __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
134
135 __be32 maint_utility_register;
136};
137
138static inline struct fw_card *fw_card_get(struct fw_card *card)
139{
140 kref_get(&card->kref);
141
142 return card;
143}
144
145void fw_card_release(struct kref *kref);
146
147static inline void fw_card_put(struct fw_card *card)
148{
149 kref_put(&card->kref, fw_card_release);
150}
151
152struct fw_attribute_group {
153 struct attribute_group *groups[2];
154 struct attribute_group group;
155 struct attribute *attrs[13];
156};
157
158enum fw_device_state {
159 FW_DEVICE_INITIALIZING,
160 FW_DEVICE_RUNNING,
161 FW_DEVICE_GONE,
162 FW_DEVICE_SHUTDOWN,
163};
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182struct fw_device {
183 atomic_t state;
184 struct fw_node *node;
185 int node_id;
186 int generation;
187 unsigned max_speed;
188 struct fw_card *card;
189 struct device device;
190
191 struct mutex client_list_mutex;
192 struct list_head client_list;
193
194 const u32 *config_rom;
195 size_t config_rom_length;
196 int config_rom_retries;
197 unsigned is_local:1;
198 unsigned max_rec:4;
199 unsigned cmc:1;
200 unsigned irmc:1;
201 unsigned bc_implemented:2;
202
203 struct delayed_work work;
204 struct fw_attribute_group attribute_group;
205};
206
207static inline struct fw_device *fw_device(struct device *dev)
208{
209 return container_of(dev, struct fw_device, device);
210}
211
212static inline int fw_device_is_shutdown(struct fw_device *device)
213{
214 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
215}
216
217int fw_device_enable_phys_dma(struct fw_device *device);
218
219
220
221
222struct fw_unit {
223 struct device device;
224 const u32 *directory;
225 struct fw_attribute_group attribute_group;
226};
227
228static inline struct fw_unit *fw_unit(struct device *dev)
229{
230 return container_of(dev, struct fw_unit, device);
231}
232
233static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
234{
235 get_device(&unit->device);
236
237 return unit;
238}
239
240static inline void fw_unit_put(struct fw_unit *unit)
241{
242 put_device(&unit->device);
243}
244
245static inline struct fw_device *fw_parent_device(struct fw_unit *unit)
246{
247 return fw_device(unit->device.parent);
248}
249
250struct ieee1394_device_id;
251
252struct fw_driver {
253 struct device_driver driver;
254 int (*probe)(struct fw_unit *unit, const struct ieee1394_device_id *id);
255
256 void (*update)(struct fw_unit *unit);
257 void (*remove)(struct fw_unit *unit);
258 const struct ieee1394_device_id *id_table;
259};
260
261struct fw_packet;
262struct fw_request;
263
264typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
265 struct fw_card *card, int status);
266typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
267 void *data, size_t length,
268 void *callback_data);
269
270
271
272
273
274
275
276
277
278
279
280
281typedef void (*fw_address_callback_t)(struct fw_card *card,
282 struct fw_request *request,
283 int tcode, int destination, int source,
284 int generation,
285 unsigned long long offset,
286 void *data, size_t length,
287 void *callback_data);
288
289struct fw_packet {
290 int speed;
291 int generation;
292 u32 header[4];
293 size_t header_length;
294 void *payload;
295 size_t payload_length;
296 dma_addr_t payload_bus;
297 bool payload_mapped;
298 u32 timestamp;
299
300
301
302
303
304
305
306
307
308 fw_packet_callback_t callback;
309 int ack;
310 struct list_head link;
311 void *driver_data;
312};
313
314struct fw_transaction {
315 int node_id;
316 int tlabel;
317 struct list_head link;
318 struct fw_card *card;
319 bool is_split_transaction;
320 struct timer_list split_timeout_timer;
321
322 struct fw_packet packet;
323
324
325
326
327
328 fw_transaction_callback_t callback;
329 void *callback_data;
330};
331
332struct fw_address_handler {
333 u64 offset;
334 u64 length;
335 fw_address_callback_t address_callback;
336 void *callback_data;
337 struct list_head link;
338};
339
340struct fw_address_region {
341 u64 start;
342 u64 end;
343};
344
345extern const struct fw_address_region fw_high_memory_region;
346
347int fw_core_add_address_handler(struct fw_address_handler *handler,
348 const struct fw_address_region *region);
349void fw_core_remove_address_handler(struct fw_address_handler *handler);
350void fw_send_response(struct fw_card *card,
351 struct fw_request *request, int rcode);
352int fw_get_request_speed(struct fw_request *request);
353void fw_send_request(struct fw_card *card, struct fw_transaction *t,
354 int tcode, int destination_id, int generation, int speed,
355 unsigned long long offset, void *payload, size_t length,
356 fw_transaction_callback_t callback, void *callback_data);
357int fw_cancel_transaction(struct fw_card *card,
358 struct fw_transaction *transaction);
359int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
360 int generation, int speed, unsigned long long offset,
361 void *payload, size_t length);
362const char *fw_rcode_string(int rcode);
363
364static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
365{
366 return tag << 14 | channel << 8 | sy;
367}
368
369struct fw_descriptor {
370 struct list_head link;
371 size_t length;
372 u32 immediate;
373 u32 key;
374 const u32 *data;
375};
376
377int fw_core_add_descriptor(struct fw_descriptor *desc);
378void fw_core_remove_descriptor(struct fw_descriptor *desc);
379
380
381
382
383
384
385
386
387
388struct fw_iso_packet {
389 u16 payload_length;
390 u32 interrupt:1;
391 u32 skip:1;
392
393 u32 tag:2;
394 u32 sy:4;
395 u32 header_length:8;
396 u32 header[0];
397};
398
399#define FW_ISO_CONTEXT_TRANSMIT 0
400#define FW_ISO_CONTEXT_RECEIVE 1
401#define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2
402
403#define FW_ISO_CONTEXT_MATCH_TAG0 1
404#define FW_ISO_CONTEXT_MATCH_TAG1 2
405#define FW_ISO_CONTEXT_MATCH_TAG2 4
406#define FW_ISO_CONTEXT_MATCH_TAG3 8
407#define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
408
409
410
411
412
413
414
415
416struct fw_iso_buffer {
417 enum dma_data_direction direction;
418 struct page **pages;
419 int page_count;
420 int page_count_mapped;
421};
422
423int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
424 int page_count, enum dma_data_direction direction);
425void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
426size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed);
427
428struct fw_iso_context;
429typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
430 u32 cycle, size_t header_length,
431 void *header, void *data);
432typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context,
433 dma_addr_t completed, void *data);
434struct fw_iso_context {
435 struct fw_card *card;
436 int type;
437 int channel;
438 int speed;
439 bool drop_overflow_headers;
440 size_t header_size;
441 union {
442 fw_iso_callback_t sc;
443 fw_iso_mc_callback_t mc;
444 } callback;
445 void *callback_data;
446};
447
448struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
449 int type, int channel, int speed, size_t header_size,
450 fw_iso_callback_t callback, void *callback_data);
451int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels);
452int fw_iso_context_queue(struct fw_iso_context *ctx,
453 struct fw_iso_packet *packet,
454 struct fw_iso_buffer *buffer,
455 unsigned long payload);
456void fw_iso_context_queue_flush(struct fw_iso_context *ctx);
457int fw_iso_context_flush_completions(struct fw_iso_context *ctx);
458int fw_iso_context_start(struct fw_iso_context *ctx,
459 int cycle, int sync, int tags);
460int fw_iso_context_stop(struct fw_iso_context *ctx);
461void fw_iso_context_destroy(struct fw_iso_context *ctx);
462void fw_iso_resource_manage(struct fw_card *card, int generation,
463 u64 channels_mask, int *channel, int *bandwidth,
464 bool allocate);
465
466extern struct workqueue_struct *fw_workqueue;
467
468#endif
469