]>
Commit | Line | Data |
---|---|---|
19a15b93 KH |
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 | |
5e20c282 SR |
36 | #define TCODE_LOCK_REQUEST 9 |
37 | #define TCODE_STREAM_DATA 10 | |
38 | #define TCODE_LOCK_RESPONSE 11 | |
19a15b93 | 39 | |
746083d8 KH |
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 | ||
19a15b93 | 48 | #define RCODE_COMPLETE 0x0 |
5e20c282 SR |
49 | #define RCODE_CONFLICT_ERROR 0x4 |
50 | #define RCODE_DATA_ERROR 0x5 | |
51 | #define RCODE_TYPE_ERROR 0x6 | |
52 | #define RCODE_ADDRESS_ERROR 0x7 | |
19a15b93 | 53 | |
7c6e647d KH |
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 | ||
19a15b93 KH |
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 | ||
97bd9efa KH |
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 | |
19a15b93 KH |
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 | ||
97bd9efa KH |
77 | struct fw_cdev_event_bus_reset { |
78 | __u32 type; | |
79 | __u32 node_id; | |
80 | __u32 local_node_id; | |
81 | __u32 bm_node_id; | |
82 | __u32 irm_node_id; | |
83 | __u32 root_node_id; | |
84 | __u32 generation; | |
85 | }; | |
86 | ||
19a15b93 KH |
87 | struct fw_cdev_event_response { |
88 | __u32 type; | |
89 | __u32 rcode; | |
90 | __u64 closure; | |
91 | __u32 length; | |
92 | __u32 data[0]; | |
93 | }; | |
94 | ||
95 | struct fw_cdev_event_request { | |
96 | __u32 type; | |
97 | __u32 tcode; | |
98 | __u64 offset; | |
99 | __u64 closure; | |
100 | __u32 serial; | |
101 | __u32 length; | |
102 | __u32 data[0]; | |
103 | }; | |
104 | ||
105 | struct fw_cdev_event_iso_interrupt { | |
106 | __u32 type; | |
107 | __u32 cycle; | |
108 | __u64 closure; | |
9b32d5f3 KH |
109 | __u32 header_length; /* Length in bytes of following headers. */ |
110 | __u32 header[0]; | |
19a15b93 KH |
111 | }; |
112 | ||
344bbc4d | 113 | #define FW_CDEV_IOC_GET_INFO _IO('#', 0x00) |
19a15b93 KH |
114 | #define FW_CDEV_IOC_SEND_REQUEST _IO('#', 0x01) |
115 | #define FW_CDEV_IOC_ALLOCATE _IO('#', 0x02) | |
9472316b KH |
116 | #define FW_CDEV_IOC_DEALLOCATE _IO('#', 0x03) |
117 | #define FW_CDEV_IOC_SEND_RESPONSE _IO('#', 0x04) | |
118 | #define FW_CDEV_IOC_INITIATE_BUS_RESET _IO('#', 0x05) | |
119 | #define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IO('#', 0x06) | |
120 | #define FW_CDEV_IOC_QUEUE_ISO _IO('#', 0x07) | |
121 | #define FW_CDEV_IOC_START_ISO _IO('#', 0x08) | |
122 | #define FW_CDEV_IOC_STOP_ISO _IO('#', 0x09) | |
19a15b93 | 123 | |
344bbc4d KH |
124 | /* FW_CDEV_VERSION History |
125 | * | |
126 | * 1 Feb 18, 2007: Initial version. | |
127 | */ | |
128 | #define FW_CDEV_VERSION 1 | |
129 | ||
130 | struct fw_cdev_get_info { | |
131 | /* The version field is just a running serial number. We | |
132 | * never break backwards compatibility. Userspace passes in | |
133 | * the version it expects and the kernel passes back the | |
134 | * highest version it can provide. Even if the structs in | |
135 | * this interface are extended in a later version, the kernel | |
136 | * will not copy back more data than what was present in the | |
137 | * interface version userspace expects. */ | |
138 | __u32 version; | |
139 | ||
140 | /* If non-zero, at most rom_length bytes of config rom will be | |
141 | * copied into that user space address. In either case, | |
142 | * rom_length is updated with the actual length of the config | |
143 | * rom. */ | |
144 | __u32 rom_length; | |
145 | __u64 rom; | |
146 | ||
147 | /* If non-zero, a fw_cdev_event_bus_reset struct will be | |
148 | * copied here with the current state of the bus. */ | |
149 | __u64 bus_reset; | |
e7533505 KH |
150 | |
151 | /* The index of the card this devices belongs to. */ | |
152 | __u32 card; | |
19a15b93 KH |
153 | }; |
154 | ||
155 | struct fw_cdev_send_request { | |
156 | __u32 tcode; | |
157 | __u32 length; | |
158 | __u64 offset; | |
159 | __u64 closure; | |
160 | __u64 data; | |
97e35275 | 161 | __u32 generation; |
19a15b93 KH |
162 | }; |
163 | ||
164 | struct fw_cdev_send_response { | |
165 | __u32 rcode; | |
166 | __u32 length; | |
167 | __u64 data; | |
168 | __u32 serial; | |
169 | }; | |
170 | ||
171 | struct fw_cdev_allocate { | |
172 | __u64 offset; | |
173 | __u64 closure; | |
174 | __u32 length; | |
175 | }; | |
176 | ||
9472316b KH |
177 | struct fw_cdev_deallocate { |
178 | __u64 offset; | |
179 | }; | |
180 | ||
5371842b KH |
181 | #define FW_CDEV_LONG_RESET 0 |
182 | #define FW_CDEV_SHORT_RESET 1 | |
183 | ||
184 | struct fw_cdev_initiate_bus_reset { | |
185 | __u32 type; | |
186 | }; | |
187 | ||
295e3feb KH |
188 | #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0 |
189 | #define FW_CDEV_ISO_CONTEXT_RECEIVE 1 | |
190 | ||
98b6cbe8 KH |
191 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1 |
192 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2 | |
193 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4 | |
194 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8 | |
195 | #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15 | |
196 | ||
19a15b93 | 197 | struct fw_cdev_create_iso_context { |
295e3feb KH |
198 | __u32 type; |
199 | __u32 header_size; | |
21efb3cf KH |
200 | __u32 channel; |
201 | __u32 speed; | |
19a15b93 KH |
202 | }; |
203 | ||
204 | struct fw_cdev_iso_packet { | |
5e20c282 | 205 | __u16 payload_length; /* Length of indirect payload. */ |
19a15b93 KH |
206 | __u32 interrupt : 1; /* Generate interrupt on this packet */ |
207 | __u32 skip : 1; /* Set to not send packet at all. */ | |
208 | __u32 tag : 2; | |
209 | __u32 sy : 4; | |
210 | __u32 header_length : 8; /* Length of immediate header. */ | |
5e20c282 | 211 | __u32 header[0]; |
19a15b93 KH |
212 | }; |
213 | ||
214 | struct fw_cdev_queue_iso { | |
215 | __u32 size; | |
216 | __u64 packets; | |
217 | __u64 data; | |
218 | }; | |
219 | ||
69cdb726 | 220 | struct fw_cdev_start_iso { |
19a15b93 | 221 | __s32 cycle; |
eb0306ea KH |
222 | __u32 sync; |
223 | __u32 tags; | |
19a15b93 KH |
224 | }; |
225 | ||
687198bb | 226 | #endif /* __fw_cdev_h */ |