aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/firewire/fw-transaction.h
diff options
context:
space:
mode:
authorKristian Høgsberg <krh@redhat.com>2006-12-19 19:58:27 -0500
committerStefan Richter <stefanr@s5r6.in-berlin.de>2007-03-09 16:02:33 -0500
commit3038e353cfaf548eb94f02b172b9dbe412abd24c (patch)
tree70e50c20e117e2dacb7cd810d00fe595e60d26ce /drivers/firewire/fw-transaction.h
parent08e15e81a40e3241ce93b4a43886f3abda184aa6 (diff)
firewire: Add core firewire stack.
Signed-off-by: Kristian Høgsberg <krh@redhat.com> Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Diffstat (limited to 'drivers/firewire/fw-transaction.h')
-rw-r--r--drivers/firewire/fw-transaction.h422
1 files changed, 422 insertions, 0 deletions
diff --git a/drivers/firewire/fw-transaction.h b/drivers/firewire/fw-transaction.h
new file mode 100644
index 000000000000..149ef1652acf
--- /dev/null
+++ b/drivers/firewire/fw-transaction.h
@@ -0,0 +1,422 @@
1/* -*- c-basic-offset: 8 -*-
2 *
3 * fw-transaction.h - Header for IEEE1394 transaction logic
4 *
5 * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 */
21
22#ifndef __fw_core_h
23#define __fw_core_h
24
25#include <linux/device.h>
26#include <linux/timer.h>
27#include <linux/interrupt.h>
28#include <linux/list.h>
29#include <linux/fs.h>
30
31#define TCODE_WRITE_QUADLET_REQUEST 0
32#define TCODE_WRITE_BLOCK_REQUEST 1
33#define TCODE_WRITE_RESPONSE 2
34#define TCODE_READ_QUADLET_REQUEST 4
35#define TCODE_READ_BLOCK_REQUEST 5
36#define TCODE_READ_QUADLET_RESPONSE 6
37#define TCODE_READ_BLOCK_RESPONSE 7
38#define TCODE_CYCLE_START 8
39#define TCODE_LOCK_REQUEST 9
40#define TCODE_STREAM_DATA 10
41#define TCODE_LOCK_RESPONSE 11
42
43#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
44#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
45#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
46#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
47#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
48
49/* Juju specific tcodes */
50#define TCODE_DEALLOCATE 0x10
51#define TCODE_LOCK_MASK_SWAP 0x11
52#define TCODE_LOCK_COMPARE_SWAP 0x12
53#define TCODE_LOCK_FETCH_ADD 0x13
54#define TCODE_LOCK_LITTLE_ADD 0x14
55#define TCODE_LOCK_BOUNDED_ADD 0x15
56#define TCODE_LOCK_WRAP_ADD 0x16
57#define TCODE_LOCK_VENDOR_SPECIFIC 0x17
58
59#define SCODE_100 0x0
60#define SCODE_200 0x1
61#define SCODE_400 0x2
62#define SCODE_BETA 0x3
63
64#define EXTCODE_MASK_SWAP 0x1
65#define EXTCODE_COMPARE_SWAP 0x2
66#define EXTCODE_FETCH_ADD 0x3
67#define EXTCODE_LITTLE_ADD 0x4
68#define EXTCODE_BOUNDED_ADD 0x5
69#define EXTCODE_WRAP_ADD 0x6
70
71#define ACK_COMPLETE 0x1
72#define ACK_PENDING 0x2
73#define ACK_BUSY_X 0x4
74#define ACK_BUSY_A 0x5
75#define ACK_BUSY_B 0x6
76#define ACK_DATA_ERROR 0xd
77#define ACK_TYPE_ERROR 0xe
78
79#define RCODE_COMPLETE 0x0
80#define RCODE_CONFLICT_ERROR 0x4
81#define RCODE_DATA_ERROR 0x5
82#define RCODE_TYPE_ERROR 0x6
83#define RCODE_ADDRESS_ERROR 0x7
84
85/* Juju specific rcodes */
86#define RCODE_SEND_ERROR 0x10
87#define RCODE_CANCELLED 0x11
88#define RCODE_BUSY 0x12
89
90#define RETRY_1 0x00
91#define RETRY_X 0x01
92#define RETRY_A 0x02
93#define RETRY_B 0x03
94
95#define LOCAL_BUS 0xffc0
96
97#define SELFID_PORT_CHILD 0x3
98#define SELFID_PORT_PARENT 0x2
99#define SELFID_PORT_NCONN 0x1
100#define SELFID_PORT_NONE 0x0
101
102#define PHY_PACKET_CONFIG 0x0
103#define PHY_PACKET_LINK_ON 0x1
104#define PHY_PACKET_SELF_ID 0x2
105
106#define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
107#define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
108#define fw_debug(s, args...) printk(KERN_DEBUG KBUILD_MODNAME ": " s, ## args)
109
110static inline void
111fw_memcpy_from_be32(void *_dst, void *_src, size_t size)
112{
113 u32 *dst = _dst;
114 u32 *src = _src;
115 int i;
116
117 for (i = 0; i < size / 4; i++)
118 dst[i] = cpu_to_be32(src[i]);
119}
120
121static inline void
122fw_memcpy_to_be32(void *_dst, void *_src, size_t size)
123{
124 fw_memcpy_from_be32(_dst, _src, size);
125}
126
127struct fw_card;
128struct fw_packet;
129struct fw_node;
130struct fw_request;
131
132struct fw_descriptor {
133 struct list_head link;
134 size_t length;
135 u32 key;
136 u32 *data;
137};
138
139int fw_core_add_descriptor (struct fw_descriptor *desc);
140void fw_core_remove_descriptor (struct fw_descriptor *desc);
141
142typedef void (*fw_packet_callback_t) (struct fw_packet *packet,
143 struct fw_card *card, int status);
144
145typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
146 void *data,
147 size_t length,
148 void *callback_data);
149
150typedef void (*fw_address_callback_t)(struct fw_card *card,
151 struct fw_request *request,
152 int tcode, int destination, int source,
153 int generation, int speed,
154 unsigned long long offset,
155 void *data, size_t length,
156 void *callback_data);
157
158typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle,
159 int node_id, int generation,
160 u32 *self_ids,
161 int self_id_count,
162 void *callback_data);
163
164struct fw_packet {
165 int speed;
166 int generation;
167 u32 header[4];
168 size_t header_length;
169 void *payload;
170 size_t payload_length;
171 u32 timestamp;
172
173 dma_addr_t payload_bus;
174
175 /* This callback is called when the packet transmission has
176 * completed; for successful transmission, the status code is
177 * the ack received from the destination, otherwise it's a
178 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
179 * The callback can be called from tasklet context and thus
180 * must never block.
181 */
182 fw_packet_callback_t callback;
183 int status;
184 struct list_head link;
185};
186
187struct fw_transaction {
188 int node_id; /* The generation is implied; it is always the current. */
189 int tlabel;
190 int timestamp;
191 struct list_head link;
192
193 struct fw_packet packet;
194
195 /* The data passed to the callback is valid only during the
196 * callback. */
197 fw_transaction_callback_t callback;
198 void *callback_data;
199};
200
201extern inline struct fw_packet *
202fw_packet(struct list_head *l)
203{
204 return list_entry (l, struct fw_packet, link);
205}
206
207struct fw_address_handler {
208 u64 offset;
209 size_t length;
210 fw_address_callback_t address_callback;
211 void *callback_data;
212 struct list_head link;
213};
214
215
216struct fw_address_region {
217 u64 start;
218 u64 end;
219};
220
221extern struct fw_address_region fw_low_memory_region;
222extern struct fw_address_region fw_high_memory_region;
223extern struct fw_address_region fw_private_region;
224extern struct fw_address_region fw_csr_region;
225extern struct fw_address_region fw_unit_space_region;
226
227int fw_core_add_address_handler(struct fw_address_handler *handler,
228 struct fw_address_region *region);
229void fw_core_remove_address_handler(struct fw_address_handler *handler);
230void fw_send_response(struct fw_card *card,
231 struct fw_request *request, int rcode);
232
233extern struct bus_type fw_bus_type;
234
235struct fw_card {
236 struct fw_card_driver *driver;
237 struct device *device;
238
239 int node_id;
240 int generation;
241 /* This is the generation used for timestamping incoming requests. */
242 int request_generation;
243 int current_tlabel, tlabel_mask;
244 struct list_head transaction_list;
245 struct timer_list flush_timer;
246
247 unsigned long long guid;
248 int max_receive;
249 int link_speed;
250 int config_rom_generation;
251
252 /* We need to store up to 4 self ID for a maximum of 63 devices. */
253 int self_id_count;
254 u32 self_ids[252];
255
256 spinlock_t lock; /* Take this lock when handling the lists in
257 * this struct. */
258 struct fw_node *local_node;
259 struct fw_node *root_node;
260 struct fw_node *irm_node;
261 int color;
262
263 int index;
264
265 struct device card_device;
266
267 struct list_head link;
268};
269
270struct fw_card *fw_card_get(struct fw_card *card);
271void fw_card_put(struct fw_card *card);
272
273/* The iso packet format allows for an immediate header/payload part
274 * stored in 'header' immediately after the packet info plus an
275 * indirect payload part that is pointer to by the 'payload' field.
276 * Applications can use one or the other or both to implement simple
277 * low-bandwidth streaming (e.g. audio) or more advanced
278 * scatter-gather streaming (e.g. assembling video frame automatically). */
279
280struct fw_iso_packet {
281 u16 payload_length; /* Length of indirect payload. */
282 u32 interrupt : 1; /* Generate interrupt on this packet */
283 u32 skip : 1; /* Set to not send packet at all. */
284 u32 tag : 2;
285 u32 sy : 4;
286 u32 header_length : 8; /* Length of immediate header. */
287 u32 header[0];
288};
289
290#define FW_ISO_CONTEXT_TRANSMIT 0
291#define FW_ISO_CONTEXT_RECEIVE 1
292
293struct fw_iso_context;
294
295typedef void (*fw_iso_callback_t) (struct fw_iso_context *context,
296 int status, u32 cycle, void *data);
297
298struct fw_iso_context {
299 struct fw_card *card;
300 int type;
301 int channel;
302 int speed;
303 fw_iso_callback_t callback;
304 void *callback_data;
305
306 void *buffer;
307 size_t buffer_size;
308 dma_addr_t *pages;
309 int page_count;
310};
311
312struct fw_iso_context *
313fw_iso_context_create(struct fw_card *card, int type,
314 size_t buffer_size,
315 fw_iso_callback_t callback,
316 void *callback_data);
317
318void
319fw_iso_context_destroy(struct fw_iso_context *ctx);
320
321void
322fw_iso_context_start(struct fw_iso_context *ctx,
323 int channel, int speed, int cycle);
324
325int
326fw_iso_context_queue(struct fw_iso_context *ctx,
327 struct fw_iso_packet *packet, void *payload);
328
329int
330fw_iso_context_send(struct fw_iso_context *ctx,
331 int channel, int speed, int cycle);
332
333struct fw_card_driver {
334 const char *name;
335
336 /* Enable the given card with the given initial config rom.
337 * This function is expected to activate the card, and either
338 * enable the PHY or set the link_on bit and initiate a bus
339 * reset. */
340 int (*enable) (struct fw_card *card, u32 *config_rom, size_t length);
341
342 int (*update_phy_reg) (struct fw_card *card, int address,
343 int clear_bits, int set_bits);
344
345 /* Update the config rom for an enabled card. This function
346 * should change the config rom that is presented on the bus
347 * an initiate a bus reset. */
348 int (*set_config_rom) (struct fw_card *card,
349 u32 *config_rom, size_t length);
350
351 void (*send_request) (struct fw_card *card, struct fw_packet *packet);
352 void (*send_response) (struct fw_card *card, struct fw_packet *packet);
353
354 /* Allow the specified node ID to do direct DMA out and in of
355 * host memory. The card will disable this for all node when
356 * a bus reset happens, so driver need to reenable this after
357 * bus reset. Returns 0 on success, -ENODEV if the card
358 * doesn't support this, -ESTALE if the generation doesn't
359 * match. */
360 int (*enable_phys_dma) (struct fw_card *card,
361 int node_id, int generation);
362
363 struct fw_iso_context *
364 (*allocate_iso_context)(struct fw_card *card, int type);
365 void (*free_iso_context)(struct fw_iso_context *ctx);
366
367 int (*send_iso)(struct fw_iso_context *ctx, s32 cycle);
368
369 int (*queue_iso)(struct fw_iso_context *ctx,
370 struct fw_iso_packet *packet, void *payload);
371};
372
373int
374fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
375
376void
377fw_send_request(struct fw_card *card, struct fw_transaction *t,
378 int tcode, int node_id, int generation, int speed,
379 unsigned long long offset,
380 void *data, size_t length,
381 fw_transaction_callback_t callback, void *callback_data);
382
383void fw_flush_transactions(struct fw_card *card);
384
385void
386fw_send_force_root(struct fw_card *card, int node_id, int generation);
387
388/* Called by the topology code to inform the device code of node
389 * activity; found, lost, or updated nodes */
390void
391fw_node_event(struct fw_card *card, struct fw_node *node, int event);
392
393/* API used by card level drivers */
394
395/* Do we need phy speed here also? If we add more args, maybe we
396 should go back to struct fw_card_info. */
397void
398fw_card_initialize(struct fw_card *card, struct fw_card_driver *driver,
399 struct device *device);
400int
401fw_card_add(struct fw_card *card,
402 u32 max_receive, u32 link_speed, u64 guid);
403
404void
405fw_core_remove_card(struct fw_card *card);
406
407void
408fw_core_handle_bus_reset(struct fw_card *card,
409 int node_id, int generation,
410 int self_id_count, u32 *self_ids);
411void
412fw_core_handle_request(struct fw_card *card,
413 int speed, int ack, int timestamp,
414 int generation,
415 u32 length, u32 *payload);
416void
417fw_core_handle_response(struct fw_card *card,
418 int speed, int ack, int timestamp,
419 u32 length, u32 *payload);
420
421
422#endif /* __fw_core_h */