Blame view

include/linux/firewire.h 12.4 KB
77c9a5daa   Stefan Richter   firewire: reorgan...
1
2
3
4
5
  #ifndef _LINUX_FIREWIRE_H
  #define _LINUX_FIREWIRE_H
  
  #include <linux/completion.h>
  #include <linux/device.h>
c76acec6d   Jay Fenlason   firewire: add IPv...
6
  #include <linux/dma-mapping.h>
77c9a5daa   Stefan Richter   firewire: reorgan...
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  #include <linux/kernel.h>
  #include <linux/kref.h>
  #include <linux/list.h>
  #include <linux/mutex.h>
  #include <linux/spinlock.h>
  #include <linux/sysfs.h>
  #include <linux/timer.h>
  #include <linux/types.h>
  #include <linux/workqueue.h>
  
  #include <asm/atomic.h>
  #include <asm/byteorder.h>
  
  #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
  #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
77c9a5daa   Stefan Richter   firewire: reorgan...
22
23
24
25
26
27
28
29
30
31
32
33
  #define CSR_REGISTER_BASE		0xfffff0000000ULL
  
  /* register offsets are relative to CSR_REGISTER_BASE */
  #define CSR_STATE_CLEAR			0x0
  #define CSR_STATE_SET			0x4
  #define CSR_NODE_IDS			0x8
  #define CSR_RESET_START			0xc
  #define CSR_SPLIT_TIMEOUT_HI		0x18
  #define CSR_SPLIT_TIMEOUT_LO		0x1c
  #define CSR_CYCLE_TIME			0x200
  #define CSR_BUS_TIME			0x204
  #define CSR_BUSY_TIMEOUT		0x210
a1a1132bd   Clemens Ladisch   firewire: add CSR...
34
  #define CSR_PRIORITY_BUDGET		0x218
77c9a5daa   Stefan Richter   firewire: reorgan...
35
36
37
38
39
  #define CSR_BUS_MANAGER_ID		0x21c
  #define CSR_BANDWIDTH_AVAILABLE		0x220
  #define CSR_CHANNELS_AVAILABLE		0x224
  #define CSR_CHANNELS_AVAILABLE_HI	0x224
  #define CSR_CHANNELS_AVAILABLE_LO	0x228
3d1f46eb6   Clemens Ladisch   firewire: core: a...
40
  #define CSR_MAINT_UTILITY		0x230
77c9a5daa   Stefan Richter   firewire: reorgan...
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
  #define CSR_BROADCAST_CHANNEL		0x234
  #define CSR_CONFIG_ROM			0x400
  #define CSR_CONFIG_ROM_END		0x800
  #define CSR_FCP_COMMAND			0xB00
  #define CSR_FCP_RESPONSE		0xD00
  #define CSR_FCP_END			0xF00
  #define CSR_TOPOLOGY_MAP		0x1000
  #define CSR_TOPOLOGY_MAP_END		0x1400
  #define CSR_SPEED_MAP			0x2000
  #define CSR_SPEED_MAP_END		0x3000
  
  #define CSR_OFFSET		0x40
  #define CSR_LEAF		0x80
  #define CSR_DIRECTORY		0xc0
  
  #define CSR_DESCRIPTOR		0x01
  #define CSR_VENDOR		0x03
  #define CSR_HARDWARE_VERSION	0x04
77c9a5daa   Stefan Richter   firewire: reorgan...
59
60
61
62
63
  #define CSR_UNIT		0x11
  #define CSR_SPECIFIER_ID	0x12
  #define CSR_VERSION		0x13
  #define CSR_DEPENDENT_INFO	0x14
  #define CSR_MODEL		0x17
77c9a5daa   Stefan Richter   firewire: reorgan...
64
65
66
  #define CSR_DIRECTORY_ID	0x20
  
  struct fw_csr_iterator {
13b302d0a   Stefan Richter   firewire: qualify...
67
68
  	const u32 *p;
  	const u32 *end;
77c9a5daa   Stefan Richter   firewire: reorgan...
69
  };
13b302d0a   Stefan Richter   firewire: qualify...
70
  void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p);
77c9a5daa   Stefan Richter   firewire: reorgan...
71
  int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
13b302d0a   Stefan Richter   firewire: qualify...
72
  int fw_csr_string(const u32 *directory, int key, char *buf, size_t size);
1f8fef7b3   Clemens Ladisch   firewire: add fw_...
73

77c9a5daa   Stefan Richter   firewire: reorgan...
74
75
76
77
78
79
80
81
82
83
84
85
86
  extern struct bus_type fw_bus_type;
  
  struct fw_card_driver;
  struct fw_node;
  
  struct fw_card {
  	const struct fw_card_driver *driver;
  	struct device *device;
  	struct kref kref;
  	struct completion done;
  
  	int node_id;
  	int generation;
1e626fdce   Stefan Richter   firewire: core: u...
87
88
  	int current_tlabel;
  	u64 tlabel_mask;
77c9a5daa   Stefan Richter   firewire: reorgan...
89
  	struct list_head transaction_list;
77c9a5daa   Stefan Richter   firewire: reorgan...
90
  	unsigned long reset_jiffies;
8e4b50f94   Clemens Ladisch   firewire: core: a...
91
92
93
94
  	u32 split_timeout_hi;
  	u32 split_timeout_lo;
  	unsigned int split_timeout_cycles;
  	unsigned int split_timeout_jiffies;
77c9a5daa   Stefan Richter   firewire: reorgan...
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
  	unsigned long long guid;
  	unsigned max_receive;
  	int link_speed;
  	int config_rom_generation;
  
  	spinlock_t lock; /* Take this lock when handling the lists in
  			  * this struct. */
  	struct fw_node *local_node;
  	struct fw_node *root_node;
  	struct fw_node *irm_node;
  	u8 color; /* must be u8 to match the definition in struct fw_node */
  	int gap_count;
  	bool beta_repeaters_present;
  
  	int index;
77c9a5daa   Stefan Richter   firewire: reorgan...
110
  	struct list_head link;
bf54e1462   Stefan Richter   firewire: cdev: a...
111
  	struct list_head phy_receiver_list;
02d37bed1   Stefan Richter   firewire: core: i...
112
113
114
115
  	struct delayed_work br_work; /* bus reset job */
  	bool br_short;
  
  	struct delayed_work bm_work; /* bus manager job */
77c9a5daa   Stefan Richter   firewire: reorgan...
116
117
  	int bm_retries;
  	int bm_generation;
6fdc03709   Stefan Richter   firewire: core: d...
118
  	__be32 bm_transaction_data[2];
250b2b6dd   Stefan Richter   firewire: cdev: f...
119
  	int bm_node_id;
c8a94ded5   Stefan Richter   firewire: normali...
120
  	bool bm_abdicate;
77c9a5daa   Stefan Richter   firewire: reorgan...
121

db3c9cc10   Stefan Richter   firewire: replace...
122
123
  	bool priority_budget_implemented;	/* controller feature */
  	bool broadcast_channel_auto_allocated;	/* controller feature */
77c9a5daa   Stefan Richter   firewire: reorgan...
124
125
  	bool broadcast_channel_allocated;
  	u32 broadcast_channel;
cb7c96da3   Stefan Richter   firewire: core: o...
126
  	__be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
3d1f46eb6   Clemens Ladisch   firewire: core: a...
127
128
  
  	__be32 maint_utility_register;
77c9a5daa   Stefan Richter   firewire: reorgan...
129
  };
77c9a5daa   Stefan Richter   firewire: reorgan...
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  struct fw_attribute_group {
  	struct attribute_group *groups[2];
  	struct attribute_group group;
  	struct attribute *attrs[12];
  };
  
  enum fw_device_state {
  	FW_DEVICE_INITIALIZING,
  	FW_DEVICE_RUNNING,
  	FW_DEVICE_GONE,
  	FW_DEVICE_SHUTDOWN,
  };
  
  /*
   * Note, fw_device.generation always has to be read before fw_device.node_id.
   * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
   * to an outdated node_id if the generation was updated in the meantime due
   * to a bus reset.
   *
   * Likewise, fw-core will take care to update .node_id before .generation so
   * that whenever fw_device.generation is current WRT the actual bus generation,
   * fw_device.node_id is guaranteed to be current too.
   *
   * The same applies to fw_device.card->node_id vs. fw_device.generation.
   *
   * fw_device.config_rom and fw_device.config_rom_length may be accessed during
   * the lifetime of any fw_unit belonging to the fw_device, before device_del()
   * was called on the last fw_unit.  Alternatively, they may be accessed while
   * holding fw_device_rwsem.
   */
  struct fw_device {
  	atomic_t state;
  	struct fw_node *node;
  	int node_id;
  	int generation;
  	unsigned max_speed;
  	struct fw_card *card;
  	struct device device;
  
  	struct mutex client_list_mutex;
  	struct list_head client_list;
13b302d0a   Stefan Richter   firewire: qualify...
171
  	const u32 *config_rom;
77c9a5daa   Stefan Richter   firewire: reorgan...
172
173
174
  	size_t config_rom_length;
  	int config_rom_retries;
  	unsigned is_local:1;
837ec787d   Stefan Richter   firewire: core: d...
175
  	unsigned max_rec:4;
77c9a5daa   Stefan Richter   firewire: reorgan...
176
  	unsigned cmc:1;
837ec787d   Stefan Richter   firewire: core: d...
177
  	unsigned irmc:1;
77c9a5daa   Stefan Richter   firewire: reorgan...
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  	unsigned bc_implemented:2;
  
  	struct delayed_work work;
  	struct fw_attribute_group attribute_group;
  };
  
  static inline struct fw_device *fw_device(struct device *dev)
  {
  	return container_of(dev, struct fw_device, device);
  }
  
  static inline int fw_device_is_shutdown(struct fw_device *device)
  {
  	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
  }
  
  static inline struct fw_device *fw_device_get(struct fw_device *device)
  {
  	get_device(&device->device);
  
  	return device;
  }
  
  static inline void fw_device_put(struct fw_device *device)
  {
  	put_device(&device->device);
  }
  
  int fw_device_enable_phys_dma(struct fw_device *device);
  
  /*
   * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
   */
  struct fw_unit {
  	struct device device;
13b302d0a   Stefan Richter   firewire: qualify...
213
  	const u32 *directory;
77c9a5daa   Stefan Richter   firewire: reorgan...
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
  	struct fw_attribute_group attribute_group;
  };
  
  static inline struct fw_unit *fw_unit(struct device *dev)
  {
  	return container_of(dev, struct fw_unit, device);
  }
  
  static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
  {
  	get_device(&unit->device);
  
  	return unit;
  }
  
  static inline void fw_unit_put(struct fw_unit *unit)
  {
  	put_device(&unit->device);
  }
e5110d011   Stefan Richter   firewire: add par...
233
234
235
236
  static inline struct fw_device *fw_parent_device(struct fw_unit *unit)
  {
  	return fw_device(unit->device.parent);
  }
77c9a5daa   Stefan Richter   firewire: reorgan...
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
  struct ieee1394_device_id;
  
  struct fw_driver {
  	struct device_driver driver;
  	/* Called when the parent device sits through a bus reset. */
  	void (*update)(struct fw_unit *unit);
  	const struct ieee1394_device_id *id_table;
  };
  
  struct fw_packet;
  struct fw_request;
  
  typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
  				     struct fw_card *card, int status);
  typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
  					  void *data, size_t length,
  					  void *callback_data);
  /*
db5d247ae   Clemens Ladisch   firewire: fix use...
255
256
   * Important note:  Except for the FCP registers, the callback must guarantee
   * that either fw_send_response() or kfree() is called on the @request.
77c9a5daa   Stefan Richter   firewire: reorgan...
257
258
259
260
   */
  typedef void (*fw_address_callback_t)(struct fw_card *card,
  				      struct fw_request *request,
  				      int tcode, int destination, int source,
33e553fe2   Stefan Richter   firewire: remove ...
261
  				      int generation,
77c9a5daa   Stefan Richter   firewire: reorgan...
262
263
264
265
266
267
268
269
270
271
272
273
  				      unsigned long long offset,
  				      void *data, size_t length,
  				      void *callback_data);
  
  struct fw_packet {
  	int speed;
  	int generation;
  	u32 header[4];
  	size_t header_length;
  	void *payload;
  	size_t payload_length;
  	dma_addr_t payload_bus;
19593ffdb   Stefan Richter   firewire: ohci: 0...
274
  	bool payload_mapped;
77c9a5daa   Stefan Richter   firewire: reorgan...
275
276
277
  	u32 timestamp;
  
  	/*
18d0cdfd1   Stefan Richter   firewire: normali...
278
279
280
281
  	 * This callback is called when the packet transmission has completed.
  	 * For successful transmission, the status code is the ack received
  	 * from the destination.  Otherwise it is one of the juju-specific
  	 * rcodes:  RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK.
77c9a5daa   Stefan Richter   firewire: reorgan...
282
283
284
285
286
287
288
289
290
291
292
293
  	 * The callback can be called from tasklet context and thus
  	 * must never block.
  	 */
  	fw_packet_callback_t callback;
  	int ack;
  	struct list_head link;
  	void *driver_data;
  };
  
  struct fw_transaction {
  	int node_id; /* The generation is implied; it is always the current. */
  	int tlabel;
77c9a5daa   Stefan Richter   firewire: reorgan...
294
  	struct list_head link;
5c40cbfef   Clemens Ladisch   firewire: core: u...
295
  	struct fw_card *card;
410cf2bd3   Clemens Ladisch   firewire: use spl...
296
  	bool is_split_transaction;
5c40cbfef   Clemens Ladisch   firewire: core: u...
297
  	struct timer_list split_timeout_timer;
77c9a5daa   Stefan Richter   firewire: reorgan...
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
  
  	struct fw_packet packet;
  
  	/*
  	 * The data passed to the callback is valid only during the
  	 * callback.
  	 */
  	fw_transaction_callback_t callback;
  	void *callback_data;
  };
  
  struct fw_address_handler {
  	u64 offset;
  	size_t length;
  	fw_address_callback_t address_callback;
  	void *callback_data;
  	struct list_head link;
  };
  
  struct fw_address_region {
  	u64 start;
  	u64 end;
  };
  
  extern const struct fw_address_region fw_high_memory_region;
  
  int fw_core_add_address_handler(struct fw_address_handler *handler,
  				const struct fw_address_region *region);
  void fw_core_remove_address_handler(struct fw_address_handler *handler);
  void fw_send_response(struct fw_card *card,
  		      struct fw_request *request, int rcode);
  void fw_send_request(struct fw_card *card, struct fw_transaction *t,
  		     int tcode, int destination_id, int generation, int speed,
  		     unsigned long long offset, void *payload, size_t length,
  		     fw_transaction_callback_t callback, void *callback_data);
  int fw_cancel_transaction(struct fw_card *card,
  			  struct fw_transaction *transaction);
  int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
  		       int generation, int speed, unsigned long long offset,
  		       void *payload, size_t length);
c76acec6d   Jay Fenlason   firewire: add IPv...
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
  static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
  {
  	return tag << 14 | channel << 8 | sy;
  }
  
  struct fw_descriptor {
  	struct list_head link;
  	size_t length;
  	u32 immediate;
  	u32 key;
  	const u32 *data;
  };
  
  int fw_core_add_descriptor(struct fw_descriptor *desc);
  void fw_core_remove_descriptor(struct fw_descriptor *desc);
  
  /*
   * The iso packet format allows for an immediate header/payload part
   * stored in 'header' immediately after the packet info plus an
   * indirect payload part that is pointer to by the 'payload' field.
   * Applications can use one or the other or both to implement simple
   * low-bandwidth streaming (e.g. audio) or more advanced
   * scatter-gather streaming (e.g. assembling video frame automatically).
   */
  struct fw_iso_packet {
872e330e3   Stefan Richter   firewire: add iso...
363
364
365
366
367
368
369
370
  	u16 payload_length;	/* Length of indirect payload		*/
  	u32 interrupt:1;	/* Generate interrupt on this packet	*/
  	u32 skip:1;		/* tx: Set to not send packet at all	*/
  				/* rx: Sync bit, wait for matching sy	*/
  	u32 tag:2;		/* tx: Tag in packet header		*/
  	u32 sy:4;		/* tx: Sy in packet header		*/
  	u32 header_length:8;	/* Length of immediate header		*/
  	u32 header[0];		/* tx: Top of 1394 isoch. data_block	*/
c76acec6d   Jay Fenlason   firewire: add IPv...
371
  };
872e330e3   Stefan Richter   firewire: add iso...
372
373
374
  #define FW_ISO_CONTEXT_TRANSMIT			0
  #define FW_ISO_CONTEXT_RECEIVE			1
  #define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL	2
c76acec6d   Jay Fenlason   firewire: add IPv...
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
  
  #define FW_ISO_CONTEXT_MATCH_TAG0	 1
  #define FW_ISO_CONTEXT_MATCH_TAG1	 2
  #define FW_ISO_CONTEXT_MATCH_TAG2	 4
  #define FW_ISO_CONTEXT_MATCH_TAG3	 8
  #define FW_ISO_CONTEXT_MATCH_ALL_TAGS	15
  
  /*
   * An iso buffer is just a set of pages mapped for DMA in the
   * specified direction.  Since the pages are to be used for DMA, they
   * are not mapped into the kernel virtual address space.  We store the
   * DMA address in the page private. The helper function
   * fw_iso_buffer_map() will map the pages into a given vma.
   */
  struct fw_iso_buffer {
  	enum dma_data_direction direction;
  	struct page **pages;
  	int page_count;
  };
  
  int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
  		       int page_count, enum dma_data_direction direction);
  void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
872e330e3   Stefan Richter   firewire: add iso...
398
  size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed);
c76acec6d   Jay Fenlason   firewire: add IPv...
399
400
401
402
403
  
  struct fw_iso_context;
  typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
  				  u32 cycle, size_t header_length,
  				  void *header, void *data);
872e330e3   Stefan Richter   firewire: add iso...
404
405
  typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context,
  				     dma_addr_t completed, void *data);
c76acec6d   Jay Fenlason   firewire: add IPv...
406
407
408
409
410
411
  struct fw_iso_context {
  	struct fw_card *card;
  	int type;
  	int channel;
  	int speed;
  	size_t header_size;
872e330e3   Stefan Richter   firewire: add iso...
412
413
414
415
  	union {
  		fw_iso_callback_t sc;
  		fw_iso_mc_callback_t mc;
  	} callback;
c76acec6d   Jay Fenlason   firewire: add IPv...
416
417
418
419
420
421
  	void *callback_data;
  };
  
  struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
  		int type, int channel, int speed, size_t header_size,
  		fw_iso_callback_t callback, void *callback_data);
872e330e3   Stefan Richter   firewire: add iso...
422
  int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels);
c76acec6d   Jay Fenlason   firewire: add IPv...
423
424
425
426
427
428
429
430
  int fw_iso_context_queue(struct fw_iso_context *ctx,
  			 struct fw_iso_packet *packet,
  			 struct fw_iso_buffer *buffer,
  			 unsigned long payload);
  int fw_iso_context_start(struct fw_iso_context *ctx,
  			 int cycle, int sync, int tags);
  int fw_iso_context_stop(struct fw_iso_context *ctx);
  void fw_iso_context_destroy(struct fw_iso_context *ctx);
77c9a5daa   Stefan Richter   firewire: reorgan...
431
  #endif /* _LINUX_FIREWIRE_H */