aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorKristian Høgsberg <krh@redhat.com>2007-04-30 15:03:15 -0400
committerStefan Richter <stefanr@s5r6.in-berlin.de>2007-04-30 17:08:13 -0400
commit9640d3d775aa325650c8fcdf49127542f77b2156 (patch)
treed63b8ddb07cb86af44401339c5ed92f736f294d6 /include
parentabaa5743e340c23922d92c9a5a6753ea3ae71e58 (diff)
firewire: Rename fw-device-cdev.c to fw-cdev.c and move header to include/linux.
Signed-off-by: Kristian Høgsberg <krh@redhat.com> Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Diffstat (limited to 'include')
-rw-r--r--include/linux/firewire-cdev.h268
1 files changed, 268 insertions, 0 deletions
diff --git a/include/linux/firewire-cdev.h b/include/linux/firewire-cdev.h
new file mode 100644
index 000000000000..026c768e3bf1
--- /dev/null
+++ b/include/linux/firewire-cdev.h
@@ -0,0 +1,268 @@
1/* -*- c-basic-offset: 8 -*-
2 *
3 * fw-device-cdev.h -- Char device interface.
4 *
5 * Copyright (C) 2005-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_cdev_h
23#define __fw_cdev_h
24
25#include <asm/ioctl.h>
26#include <asm/types.h>
27
28#define TCODE_WRITE_QUADLET_REQUEST 0
29#define TCODE_WRITE_BLOCK_REQUEST 1
30#define TCODE_WRITE_RESPONSE 2
31#define TCODE_READ_QUADLET_REQUEST 4
32#define TCODE_READ_BLOCK_REQUEST 5
33#define TCODE_READ_QUADLET_RESPONSE 6
34#define TCODE_READ_BLOCK_RESPONSE 7
35#define TCODE_CYCLE_START 8
36#define TCODE_LOCK_REQUEST 9
37#define TCODE_STREAM_DATA 10
38#define TCODE_LOCK_RESPONSE 11
39
40#define TCODE_LOCK_MASK_SWAP 0x11
41#define TCODE_LOCK_COMPARE_SWAP 0x12
42#define TCODE_LOCK_FETCH_ADD 0x13
43#define TCODE_LOCK_LITTLE_ADD 0x14
44#define TCODE_LOCK_BOUNDED_ADD 0x15
45#define TCODE_LOCK_WRAP_ADD 0x16
46#define TCODE_LOCK_VENDOR_DEPENDENT 0x17
47
48#define RCODE_COMPLETE 0x0
49#define RCODE_CONFLICT_ERROR 0x4
50#define RCODE_DATA_ERROR 0x5
51#define RCODE_TYPE_ERROR 0x6
52#define RCODE_ADDRESS_ERROR 0x7
53
54#define RCODE_SEND_ERROR 0x10
55#define RCODE_CANCELLED 0x11
56#define RCODE_BUSY 0x12
57#define RCODE_GENERATION 0x13
58#define RCODE_NO_ACK 0x14
59
60#define SCODE_100 0x0
61#define SCODE_200 0x1
62#define SCODE_400 0x2
63#define SCODE_800 0x3
64#define SCODE_1600 0x4
65#define SCODE_3200 0x5
66
67#define FW_CDEV_EVENT_BUS_RESET 0x00
68#define FW_CDEV_EVENT_RESPONSE 0x01
69#define FW_CDEV_EVENT_REQUEST 0x02
70#define FW_CDEV_EVENT_ISO_INTERRUPT 0x03
71
72/* The 'closure' fields are for user space to use. Data passed in the
73 * 'closure' field for a request will be returned in the corresponding
74 * event. It's a 64-bit type so that it's a fixed size type big
75 * enough to hold a pointer on all platforms. */
76
77struct fw_cdev_event_common {
78 __u64 closure;
79 __u32 type;
80};
81
82struct fw_cdev_event_bus_reset {
83 __u64 closure;
84 __u32 type;
85 __u32 node_id;
86 __u32 local_node_id;
87 __u32 bm_node_id;
88 __u32 irm_node_id;
89 __u32 root_node_id;
90 __u32 generation;
91};
92
93struct fw_cdev_event_response {
94 __u64 closure;
95 __u32 type;
96 __u32 rcode;
97 __u32 length;
98 __u32 data[0];
99};
100
101struct fw_cdev_event_request {
102 __u64 closure;
103 __u32 type;
104 __u32 tcode;
105 __u64 offset;
106 __u32 handle;
107 __u32 length;
108 __u32 data[0];
109};
110
111struct fw_cdev_event_iso_interrupt {
112 __u64 closure;
113 __u32 type;
114 __u32 cycle;
115 __u32 header_length; /* Length in bytes of following headers. */
116 __u32 header[0];
117};
118
119union fw_cdev_event {
120 struct fw_cdev_event_common common;
121 struct fw_cdev_event_bus_reset bus_reset;
122 struct fw_cdev_event_response response;
123 struct fw_cdev_event_request request;
124 struct fw_cdev_event_iso_interrupt iso_interrupt;
125};
126
127#define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
128#define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
129#define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
130#define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
131#define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
132#define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
133#define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
134#define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
135
136#define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
137#define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
138#define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
139#define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
140
141/* FW_CDEV_VERSION History
142 *
143 * 1 Feb 18, 2007: Initial version.
144 */
145#define FW_CDEV_VERSION 1
146
147struct fw_cdev_get_info {
148 /* The version field is just a running serial number. We
149 * never break backwards compatibility. Userspace passes in
150 * the version it expects and the kernel passes back the
151 * highest version it can provide. Even if the structs in
152 * this interface are extended in a later version, the kernel
153 * will not copy back more data than what was present in the
154 * interface version userspace expects. */
155 __u32 version;
156
157 /* If non-zero, at most rom_length bytes of config rom will be
158 * copied into that user space address. In either case,
159 * rom_length is updated with the actual length of the config
160 * rom. */
161 __u32 rom_length;
162 __u64 rom;
163
164 /* If non-zero, a fw_cdev_event_bus_reset struct will be
165 * copied here with the current state of the bus. This does
166 * not cause a bus reset to happen. The value of closure in
167 * this and sub-sequent bus reset events is set to
168 * bus_reset_closure. */
169 __u64 bus_reset;
170 __u64 bus_reset_closure;
171
172 /* The index of the card this devices belongs to. */
173 __u32 card;
174};
175
176struct fw_cdev_send_request {
177 __u32 tcode;
178 __u32 length;
179 __u64 offset;
180 __u64 closure;
181 __u64 data;
182 __u32 generation;
183};
184
185struct fw_cdev_send_response {
186 __u32 rcode;
187 __u32 length;
188 __u64 data;
189 __u32 handle;
190};
191
192struct fw_cdev_allocate {
193 __u64 offset;
194 __u64 closure;
195 __u32 length;
196 __u32 handle;
197};
198
199struct fw_cdev_deallocate {
200 __u32 handle;
201};
202
203#define FW_CDEV_LONG_RESET 0
204#define FW_CDEV_SHORT_RESET 1
205
206struct fw_cdev_initiate_bus_reset {
207 __u32 type;
208};
209
210struct fw_cdev_add_descriptor {
211 __u32 immediate;
212 __u32 key;
213 __u64 data;
214 __u32 length;
215 __u32 handle;
216};
217
218struct fw_cdev_remove_descriptor {
219 __u32 handle;
220};
221
222#define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
223#define FW_CDEV_ISO_CONTEXT_RECEIVE 1
224
225#define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
226#define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
227#define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
228#define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
229#define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
230
231struct fw_cdev_create_iso_context {
232 __u32 type;
233 __u32 header_size;
234 __u32 channel;
235 __u32 speed;
236 __u64 closure;
237 __u32 handle;
238};
239
240struct fw_cdev_iso_packet {
241 __u16 payload_length; /* Length of indirect payload. */
242 __u32 interrupt : 1; /* Generate interrupt on this packet */
243 __u32 skip : 1; /* Set to not send packet at all. */
244 __u32 tag : 2;
245 __u32 sy : 4;
246 __u32 header_length : 8; /* Length of immediate header. */
247 __u32 header[0];
248};
249
250struct fw_cdev_queue_iso {
251 __u64 packets;
252 __u64 data;
253 __u32 size;
254 __u32 handle;
255};
256
257struct fw_cdev_start_iso {
258 __s32 cycle;
259 __u32 sync;
260 __u32 tags;
261 __u32 handle;
262};
263
264struct fw_cdev_stop_iso {
265 __u32 handle;
266};
267
268#endif /* __fw_cdev_h */