blob: c6b3ca3af6df6ce93614d3f6df59986b15fc4fd8 [file] [log] [blame]
Kristian Høgsberg4c5a4432007-05-07 20:33:37 -04001/*
2 * Char device interface.
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05003 *
4 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
Kristian Høgsberg4c5a4432007-05-07 20:33:37 -040021#ifndef _LINUX_FIREWIRE_CDEV_H
22#define _LINUX_FIREWIRE_CDEV_H
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050023
Kristian Høgsberg04dfb8d2007-05-07 20:33:36 -040024#include <linux/ioctl.h>
25#include <linux/types.h>
Kristian Høgsberg4c5a4432007-05-07 20:33:37 -040026#include <linux/firewire-constants.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050027
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +010028#define FW_CDEV_EVENT_BUS_RESET 0x00
29#define FW_CDEV_EVENT_RESPONSE 0x01
30#define FW_CDEV_EVENT_REQUEST 0x02
31#define FW_CDEV_EVENT_ISO_INTERRUPT 0x03
32#define FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED 0x04
33#define FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED 0x05
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050034
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +020035/**
36 * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types
37 * @closure: For arbitrary use by userspace
38 * @type: Discriminates the fw_cdev_event_ types
39 *
40 * This struct may be used to access generic members of all fw_cdev_event_
41 * types regardless of the specific type.
42 *
43 * Data passed in the @closure field for a request will be returned in the
44 * corresponding event. It is big enough to hold a pointer on all platforms.
45 * The ioctl used to set @closure depends on the @type of event.
46 */
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -040047struct fw_cdev_event_common {
48 __u64 closure;
49 __u32 type;
50};
51
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +020052/**
53 * struct fw_cdev_event_bus_reset - Sent when a bus reset occurred
54 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_GET_INFO ioctl
55 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_BUS_RESET
56 * @node_id: New node ID of this node
57 * @local_node_id: Node ID of the local node, i.e. of the controller
58 * @bm_node_id: Node ID of the bus manager
59 * @irm_node_id: Node ID of the iso resource manager
60 * @root_node_id: Node ID of the root node
61 * @generation: New bus generation
62 *
63 * This event is sent when the bus the device belongs to goes through a bus
64 * reset. It provides information about the new bus configuration, such as
65 * new node ID for this device, new root ID, and others.
66 */
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050067struct fw_cdev_event_bus_reset {
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -040068 __u64 closure;
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050069 __u32 type;
70 __u32 node_id;
71 __u32 local_node_id;
72 __u32 bm_node_id;
73 __u32 irm_node_id;
74 __u32 root_node_id;
75 __u32 generation;
76};
77
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +020078/**
79 * struct fw_cdev_event_response - Sent when a response packet was received
80 * @closure: See &fw_cdev_event_common;
81 * set by %FW_CDEV_IOC_SEND_REQUEST ioctl
82 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_RESPONSE
83 * @rcode: Response code returned by the remote node
84 * @length: Data length, i.e. the response's payload size in bytes
85 * @data: Payload data, if any
86 *
87 * This event is sent when the stack receives a response to an outgoing request
88 * sent by %FW_CDEV_IOC_SEND_REQUEST ioctl. The payload data for responses
89 * carrying data (read and lock responses) follows immediately and can be
90 * accessed through the @data field.
91 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050092struct fw_cdev_event_response {
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -040093 __u64 closure;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050094 __u32 type;
95 __u32 rcode;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050096 __u32 length;
97 __u32 data[0];
98};
99
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200100/**
101 * struct fw_cdev_event_request - Sent on incoming request to an address region
102 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl
103 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST
104 * @tcode: Transaction code of the incoming request
105 * @offset: The offset into the 48-bit per-node address space
106 * @handle: Reference to the kernel-side pending request
107 * @length: Data length, i.e. the request's payload size in bytes
108 * @data: Incoming data, if any
109 *
110 * This event is sent when the stack receives an incoming request to an address
111 * region registered using the %FW_CDEV_IOC_ALLOCATE ioctl. The request is
112 * guaranteed to be completely contained in the specified region. Userspace is
113 * responsible for sending the response by %FW_CDEV_IOC_SEND_RESPONSE ioctl,
114 * using the same @handle.
115 *
116 * The payload data for requests carrying data (write and lock requests)
117 * follows immediately and can be accessed through the @data field.
118 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500119struct fw_cdev_event_request {
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400120 __u64 closure;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500121 __u32 type;
122 __u32 tcode;
123 __u64 offset;
Kristian Høgsberg3964a442007-03-27 01:43:41 -0400124 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500125 __u32 length;
126 __u32 data[0];
127};
128
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200129/**
130 * struct fw_cdev_event_iso_interrupt - Sent when an iso packet was completed
131 * @closure: See &fw_cdev_event_common;
132 * set by %FW_CDEV_CREATE_ISO_CONTEXT ioctl
133 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_ISO_INTERRUPT
134 * @cycle: Cycle counter of the interrupt packet
135 * @header_length: Total length of following headers, in bytes
136 * @header: Stripped headers, if any
137 *
138 * This event is sent when the controller has completed an &fw_cdev_iso_packet
139 * with the %FW_CDEV_ISO_INTERRUPT bit set. In the receive case, the headers
140 * stripped of all packets up until and including the interrupt packet are
Stefan Richter77258da2009-01-07 20:14:53 +0100141 * returned in the @header field. The amount of header data per packet is as
142 * specified at iso context creation by &fw_cdev_create_iso_context.header_size.
143 *
144 * In version 1 of this ABI, header data consisted of the 1394 isochronous
145 * packet header, followed by quadlets from the packet payload if
146 * &fw_cdev_create_iso_context.header_size > 4.
147 *
148 * In version 2 of this ABI, header data consist of the 1394 isochronous
149 * packet header, followed by a timestamp quadlet if
150 * &fw_cdev_create_iso_context.header_size > 4, followed by quadlets from the
151 * packet payload if &fw_cdev_create_iso_context.header_size > 8.
152 *
153 * Behaviour of ver. 1 of this ABI is no longer available since ABI ver. 2.
154 *
155 * Format of 1394 iso packet header: 16 bits len, 2 bits tag, 6 bits channel,
156 * 4 bits tcode, 4 bits sy, in big endian byte order. Format of timestamp:
157 * 16 bits invalid, 3 bits cycleSeconds, 13 bits cycleCount, in big endian byte
158 * order.
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200159 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500160struct fw_cdev_event_iso_interrupt {
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400161 __u64 closure;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500162 __u32 type;
163 __u32 cycle;
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200164 __u32 header_length;
Kristian Høgsberg9b32d5f2007-02-16 17:34:44 -0500165 __u32 header[0];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500166};
167
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200168/**
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100169 * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
170 * @closure: See &fw_cdev_event_common;
Stefan Richter1ec3c022009-01-04 16:23:29 +0100171 * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100172 * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
173 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
174 * @handle: Reference by which an allocated resource can be deallocated
175 * @channel: Isochronous channel which was (de)allocated, if any
176 * @bandwidth: Bandwidth allocation units which were (de)allocated, if any
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100177 *
178 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event is sent after an isochronous
179 * resource was allocated at the IRM. The client has to check @channel and
180 * @bandwidth for whether the allocation actually succeeded.
181 *
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100182 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event is sent after an isochronous
183 * resource was deallocated at the IRM. It is also sent when automatic
184 * reallocation after a bus reset failed.
Stefan Richter1ec3c022009-01-04 16:23:29 +0100185 *
186 * @channel is <0 if no channel was (de)allocated or if reallocation failed.
187 * @bandwidth is 0 if no bandwidth was (de)allocated or if reallocation failed.
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100188 */
189struct fw_cdev_event_iso_resource {
190 __u64 closure;
191 __u32 type;
192 __u32 handle;
193 __s32 channel;
194 __s32 bandwidth;
195};
196
197/**
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200198 * union fw_cdev_event - Convenience union of fw_cdev_event_ types
199 * @common: Valid for all types
200 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
201 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
202 * @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST
203 * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100204 * @iso_resource: Valid if @common.type ==
205 * %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
206 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200207 *
Jay Fenlasonbe585c02008-10-01 18:13:20 -0400208 * Convenience union for userspace use. Events could be read(2) into an
209 * appropriately aligned char buffer and then cast to this union for further
210 * processing. Note that for a request, response or iso_interrupt event,
211 * the data[] or header[] may make the size of the full event larger than
212 * sizeof(union fw_cdev_event). Also note that if you attempt to read(2)
213 * an event into a buffer that is not large enough for it, the data that does
214 * not fit will be discarded so that the next read(2) will return a new event.
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200215 */
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400216union fw_cdev_event {
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100217 struct fw_cdev_event_common common;
218 struct fw_cdev_event_bus_reset bus_reset;
219 struct fw_cdev_event_response response;
220 struct fw_cdev_event_request request;
221 struct fw_cdev_event_iso_interrupt iso_interrupt;
222 struct fw_cdev_event_iso_resource iso_resource;
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400223};
224
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100225/* available since kernel version 2.6.22 */
Stefan Richterc8a25902009-03-10 20:59:16 +0100226#define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
227#define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
228#define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
229#define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
230#define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
231#define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
232#define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
233#define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
234#define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
235#define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
236#define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
237#define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100238
239/* available since kernel version 2.6.24 */
Stefan Richterc8a25902009-03-10 20:59:16 +0100240#define FW_CDEV_IOC_GET_CYCLE_TIMER _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500241
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100242/* available since kernel version 2.6.30 */
Stefan Richter1ec3c022009-01-04 16:23:29 +0100243#define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource)
244#define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE _IOW('#', 0x0e, struct fw_cdev_deallocate)
245#define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource)
246#define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource)
Stefan Richterc8a25902009-03-10 20:59:16 +0100247#define FW_CDEV_IOC_GET_SPEED _IO('#', 0x11) /* returns speed code */
Jay Fenlason, Stefan Richteracfe8332009-01-04 16:23:29 +0100248#define FW_CDEV_IOC_SEND_BROADCAST_REQUEST _IOW('#', 0x12, struct fw_cdev_send_request)
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100249#define FW_CDEV_IOC_SEND_STREAM_PACKET _IOW('#', 0x13, struct fw_cdev_send_stream_packet)
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100250
Stefan Richter77258da2009-01-07 20:14:53 +0100251/*
252 * FW_CDEV_VERSION History
253 * 1 (2.6.22) - initial version
254 * 2 (2.6.30) - changed &fw_cdev_event_iso_interrupt.header if
255 * &fw_cdev_create_iso_context.header_size is 8 or more
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500256 */
Stefan Richter77258da2009-01-07 20:14:53 +0100257#define FW_CDEV_VERSION 2
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500258
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200259/**
260 * struct fw_cdev_get_info - General purpose information ioctl
261 * @version: The version field is just a running serial number.
262 * We never break backwards compatibility, but may add more
263 * structs and ioctls in later revisions.
264 * @rom_length: If @rom is non-zero, at most rom_length bytes of configuration
265 * ROM will be copied into that user space address. In either
266 * case, @rom_length is updated with the actual length of the
267 * configuration ROM.
268 * @rom: If non-zero, address of a buffer to be filled by a copy of the
Stefan Richter632321e2009-01-02 12:47:13 +0100269 * device's configuration ROM
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200270 * @bus_reset: If non-zero, address of a buffer to be filled by a
271 * &struct fw_cdev_event_bus_reset with the current state
272 * of the bus. This does not cause a bus reset to happen.
273 * @bus_reset_closure: Value of &closure in this and subsequent bus reset events
274 * @card: The index of the card this device belongs to
275 */
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500276struct fw_cdev_get_info {
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500277 __u32 version;
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500278 __u32 rom_length;
279 __u64 rom;
Kristian Høgsberg344bbc42007-03-07 12:12:43 -0500280 __u64 bus_reset;
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400281 __u64 bus_reset_closure;
Kristian Høgsberge7533502007-03-07 12:12:52 -0500282 __u32 card;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500283};
284
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200285/**
286 * struct fw_cdev_send_request - Send an asynchronous request packet
287 * @tcode: Transaction code of the request
288 * @length: Length of outgoing payload, in bytes
289 * @offset: 48-bit offset at destination node
290 * @closure: Passed back to userspace in the response event
291 * @data: Userspace pointer to payload
292 * @generation: The bus generation where packet is valid
293 *
294 * Send a request to the device. This ioctl implements all outgoing requests.
295 * Both quadlet and block request specify the payload as a pointer to the data
296 * in the @data field. Once the transaction completes, the kernel writes an
Stefan Richterbf8e3352008-12-05 22:43:41 +0100297 * &fw_cdev_event_response event back. The @closure field is passed back to
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200298 * user space in the response event.
299 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500300struct fw_cdev_send_request {
301 __u32 tcode;
302 __u32 length;
303 __u64 offset;
304 __u64 closure;
305 __u64 data;
Kristian Høgsberg97e35272007-03-07 12:12:53 -0500306 __u32 generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500307};
308
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200309/**
310 * struct fw_cdev_send_response - Send an asynchronous response packet
311 * @rcode: Response code as determined by the userspace handler
312 * @length: Length of outgoing payload, in bytes
313 * @data: Userspace pointer to payload
314 * @handle: The handle from the &fw_cdev_event_request
315 *
316 * Send a response to an incoming request. By setting up an address range using
317 * the %FW_CDEV_IOC_ALLOCATE ioctl, userspace can listen for incoming requests. An
318 * incoming request will generate an %FW_CDEV_EVENT_REQUEST, and userspace must
319 * send a reply using this ioctl. The event has a handle to the kernel-side
320 * pending transaction, which should be used with this ioctl.
321 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500322struct fw_cdev_send_response {
323 __u32 rcode;
324 __u32 length;
325 __u64 data;
Kristian Høgsberg3964a442007-03-27 01:43:41 -0400326 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500327};
328
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200329/**
330 * struct fw_cdev_allocate - Allocate a CSR address range
331 * @offset: Start offset of the address range
332 * @closure: To be passed back to userspace in request events
333 * @length: Length of the address range, in bytes
334 * @handle: Handle to the allocation, written by the kernel
335 *
336 * Allocate an address range in the 48-bit address space on the local node
337 * (the controller). This allows userspace to listen for requests with an
338 * offset within that address range. When the kernel receives a request
339 * within the range, an &fw_cdev_event_request event will be written back.
340 * The @closure field is passed back to userspace in the response event.
341 * The @handle field is an out parameter, returning a handle to the allocated
342 * range to be used for later deallocation of the range.
343 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500344struct fw_cdev_allocate {
345 __u64 offset;
346 __u64 closure;
347 __u32 length;
Kristian Høgsberg3964a442007-03-27 01:43:41 -0400348 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500349};
350
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200351/**
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100352 * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource
353 * @handle: Handle to the address range or iso resource, as returned by the
354 * kernel when the range or resource was allocated
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200355 */
Kristian Høgsberg9472316b2007-03-14 17:34:55 -0400356struct fw_cdev_deallocate {
Kristian Høgsberg3964a442007-03-27 01:43:41 -0400357 __u32 handle;
Kristian Høgsberg9472316b2007-03-14 17:34:55 -0400358};
359
Kristian Høgsberg53718422007-03-07 12:12:42 -0500360#define FW_CDEV_LONG_RESET 0
361#define FW_CDEV_SHORT_RESET 1
362
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200363/**
364 * struct fw_cdev_initiate_bus_reset - Initiate a bus reset
365 * @type: %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET
366 *
367 * Initiate a bus reset for the bus this device is on. The bus reset can be
368 * either the original (long) bus reset or the arbitrated (short) bus reset
369 * introduced in 1394a-2000.
370 */
Kristian Høgsberg53718422007-03-07 12:12:42 -0500371struct fw_cdev_initiate_bus_reset {
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200372 __u32 type; /* FW_CDEV_SHORT_RESET or FW_CDEV_LONG_RESET */
Kristian Høgsberg53718422007-03-07 12:12:42 -0500373};
374
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200375/**
376 * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM
377 * @immediate: If non-zero, immediate key to insert before pointer
378 * @key: Upper 8 bits of root directory pointer
379 * @data: Userspace pointer to contents of descriptor block
380 * @length: Length of descriptor block data, in bytes
381 * @handle: Handle to the descriptor, written by the kernel
382 *
383 * Add a descriptor block and optionally a preceding immediate key to the local
384 * node's configuration ROM.
385 *
386 * The @key field specifies the upper 8 bits of the descriptor root directory
387 * pointer and the @data and @length fields specify the contents. The @key
388 * should be of the form 0xXX000000. The offset part of the root directory entry
389 * will be filled in by the kernel.
390 *
391 * If not 0, the @immediate field specifies an immediate key which will be
392 * inserted before the root directory pointer.
393 *
394 * If successful, the kernel adds the descriptor and writes back a handle to the
395 * kernel-side object to be used for later removal of the descriptor block and
396 * immediate key.
Stefan Richterde487da2009-03-10 21:00:23 +0100397 *
398 * This ioctl affects the configuration ROMs of all local nodes.
399 * The ioctl only succeeds on device files which represent a local node.
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200400 */
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200401struct fw_cdev_add_descriptor {
402 __u32 immediate;
403 __u32 key;
404 __u64 data;
405 __u32 length;
406 __u32 handle;
407};
408
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200409/**
410 * struct fw_cdev_remove_descriptor - Remove contents from the configuration ROM
411 * @handle: Handle to the descriptor, as returned by the kernel when the
412 * descriptor was added
413 *
414 * Remove a descriptor block and accompanying immediate key from the local
Stefan Richterde487da2009-03-10 21:00:23 +0100415 * nodes' configuration ROMs.
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200416 */
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200417struct fw_cdev_remove_descriptor {
418 __u32 handle;
419};
420
Kristian Høgsberg295e3fe2007-02-16 17:34:40 -0500421#define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
422#define FW_CDEV_ISO_CONTEXT_RECEIVE 1
423
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200424/**
425 * struct fw_cdev_create_iso_context - Create a context for isochronous IO
426 * @type: %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE
427 * @header_size: Header size to strip for receive contexts
428 * @channel: Channel to bind to
429 * @speed: Speed to transmit at
430 * @closure: To be returned in &fw_cdev_event_iso_interrupt
431 * @handle: Handle to context, written back by kernel
432 *
433 * Prior to sending or receiving isochronous I/O, a context must be created.
434 * The context records information about the transmit or receive configuration
435 * and typically maps to an underlying hardware resource. A context is set up
436 * for either sending or receiving. It is bound to a specific isochronous
437 * channel.
438 *
439 * If a context was successfully created, the kernel writes back a handle to the
440 * context, which must be passed in for subsequent operations on that context.
Stefan Richter77258da2009-01-07 20:14:53 +0100441 *
442 * Note that the effect of a @header_size > 4 depends on
443 * &fw_cdev_get_info.version, as documented at &fw_cdev_event_iso_interrupt.
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200444 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500445struct fw_cdev_create_iso_context {
Kristian Høgsberg295e3fe2007-02-16 17:34:40 -0500446 __u32 type;
447 __u32 header_size;
Kristian Høgsberg21efb3c2007-02-16 17:34:50 -0500448 __u32 channel;
449 __u32 speed;
Kristian Høgsbergabaa5742007-04-30 15:03:14 -0400450 __u64 closure;
451 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500452};
453
Kristian Høgsberg1ca31ae2007-05-31 11:16:43 -0400454#define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v)
455#define FW_CDEV_ISO_INTERRUPT (1 << 16)
456#define FW_CDEV_ISO_SKIP (1 << 17)
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200457#define FW_CDEV_ISO_SYNC (1 << 17)
Kristian Høgsberg1ca31ae2007-05-31 11:16:43 -0400458#define FW_CDEV_ISO_TAG(v) ((v) << 18)
459#define FW_CDEV_ISO_SY(v) ((v) << 20)
460#define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24)
461
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200462/**
463 * struct fw_cdev_iso_packet - Isochronous packet
464 * @control: Contains the header length (8 uppermost bits), the sy field
465 * (4 bits), the tag field (2 bits), a sync flag (1 bit),
466 * a skip flag (1 bit), an interrupt flag (1 bit), and the
467 * payload length (16 lowermost bits)
468 * @header: Header and payload
469 *
470 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues.
471 *
472 * Use the FW_CDEV_ISO_ macros to fill in @control. The sy and tag fields are
473 * specified by IEEE 1394a and IEC 61883.
474 *
475 * FIXME - finish this documentation
476 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500477struct fw_cdev_iso_packet {
Kristian Høgsberg1ca31ae2007-05-31 11:16:43 -0400478 __u32 control;
Stefan Richter5e20c282007-01-21 20:44:09 +0100479 __u32 header[0];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500480};
481
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200482/**
483 * struct fw_cdev_queue_iso - Queue isochronous packets for I/O
484 * @packets: Userspace pointer to packet data
485 * @data: Pointer into mmap()'ed payload buffer
486 * @size: Size of packet data in bytes
487 * @handle: Isochronous context handle
488 *
489 * Queue a number of isochronous packets for reception or transmission.
490 * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs,
491 * which describe how to transmit from or receive into a contiguous region
492 * of a mmap()'ed payload buffer. As part of the packet descriptors,
493 * a series of headers can be supplied, which will be prepended to the
494 * payload during DMA.
495 *
496 * The kernel may or may not queue all packets, but will write back updated
497 * values of the @packets, @data and @size fields, so the ioctl can be
498 * resubmitted easily.
499 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500500struct fw_cdev_queue_iso {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500501 __u64 packets;
502 __u64 data;
Kristian Høgsbergda8ecff2007-03-27 01:43:39 -0400503 __u32 size;
Kristian Høgsbergabaa5742007-04-30 15:03:14 -0400504 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500505};
506
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200507#define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
508#define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
509#define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
510#define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
511#define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
512
513/**
514 * struct fw_cdev_start_iso - Start an isochronous transmission or reception
515 * @cycle: Cycle in which to start I/O. If @cycle is greater than or
516 * equal to 0, the I/O will start on that cycle.
517 * @sync: Determines the value to wait for for receive packets that have
518 * the %FW_CDEV_ISO_SYNC bit set
519 * @tags: Tag filter bit mask. Only valid for isochronous reception.
520 * Determines the tag values for which packets will be accepted.
521 * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags.
522 * @handle: Isochronous context handle within which to transmit or receive
523 */
Kristian Høgsberg69cdb722007-02-16 17:34:41 -0500524struct fw_cdev_start_iso {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500525 __s32 cycle;
Kristian Høgsbergeb0306e2007-03-14 17:34:54 -0400526 __u32 sync;
527 __u32 tags;
Kristian Høgsbergabaa5742007-04-30 15:03:14 -0400528 __u32 handle;
529};
530
Kristian Høgsberg7ada60e2007-06-22 00:20:34 +0200531/**
532 * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception
533 * @handle: Handle of isochronous context to stop
534 */
Kristian Høgsbergabaa5742007-04-30 15:03:14 -0400535struct fw_cdev_stop_iso {
536 __u32 handle;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500537};
538
Stefan Richtera64408b2007-09-29 10:41:58 +0200539/**
540 * struct fw_cdev_get_cycle_timer - read cycle timer register
541 * @local_time: system time, in microseconds since the Epoch
542 * @cycle_timer: isochronous cycle timer, as per OHCI 1.1 clause 5.13
543 *
544 * The %FW_CDEV_IOC_GET_CYCLE_TIMER ioctl reads the isochronous cycle timer
545 * and also the system clock. This allows to express the receive time of an
546 * isochronous packet as a system time with microsecond accuracy.
Stefan Richter77258da2009-01-07 20:14:53 +0100547 *
548 * @cycle_timer consists of 7 bits cycleSeconds, 13 bits cycleCount, and
549 * 12 bits cycleOffset, in host byte order.
Stefan Richtera64408b2007-09-29 10:41:58 +0200550 */
551struct fw_cdev_get_cycle_timer {
552 __u64 local_time;
553 __u32 cycle_timer;
554};
555
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100556/**
Stefan Richter1ec3c022009-01-04 16:23:29 +0100557 * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100558 * @closure: Passed back to userspace in correponding iso resource events
Stefan Richter1ec3c022009-01-04 16:23:29 +0100559 * @channels: Isochronous channels of which one is to be (de)allocated
560 * @bandwidth: Isochronous bandwidth units to be (de)allocated
561 * @handle: Handle to the allocation, written by the kernel (only valid in
562 * case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls)
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100563 *
564 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an
565 * isochronous channel and/or of isochronous bandwidth at the isochronous
566 * resource manager (IRM). Only one of the channels specified in @channels is
567 * allocated. An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after
568 * communication with the IRM, indicating success or failure in the event data.
569 * The kernel will automatically reallocate the resources after bus resets.
570 * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event
571 * will be sent. The kernel will also automatically deallocate the resources
572 * when the file descriptor is closed.
573 *
Stefan Richter1ec3c022009-01-04 16:23:29 +0100574 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate
575 * deallocation of resources which were allocated as described above.
576 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
577 *
578 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation
579 * without automatic re- or deallocation.
580 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation,
581 * indicating success or failure in its data.
582 *
583 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like
584 * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100585 * instead of allocated.
Stefan Richter1ec3c022009-01-04 16:23:29 +0100586 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
587 *
588 * To summarize, %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE allocates iso resources
589 * for the lifetime of the fd or handle.
590 * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources
591 * for the duration of a bus generation.
592 *
Stefan Richter5d9cb7d272009-01-08 23:07:40 +0100593 * @channels is a host-endian bitfield with the least significant bit
594 * representing channel 0 and the most significant bit representing channel 63:
595 * 1ULL << c for each channel c that is a candidate for (de)allocation.
Jay Fenlason, Stefan Richterb1bda4c2009-01-04 16:23:29 +0100596 *
597 * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send
598 * one quadlet of data (payload or header data) at speed S1600.
599 */
600struct fw_cdev_allocate_iso_resource {
601 __u64 closure;
602 __u64 channels;
603 __u32 bandwidth;
604 __u32 handle;
605};
606
Stefan Richter33580a32009-01-04 16:23:29 +0100607/**
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100608 * struct fw_cdev_send_stream_packet - send an asynchronous stream packet
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100609 * @length: Length of outgoing payload, in bytes
610 * @tag: Data format tag
611 * @channel: Isochronous channel to transmit to
612 * @sy: Synchronization code
613 * @closure: Passed back to userspace in the response event
614 * @data: Userspace pointer to payload
615 * @generation: The bus generation where packet is valid
616 * @speed: Speed to transmit at
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100617 *
618 * The %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl sends an asynchronous stream packet
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100619 * to every device which is listening to the specified channel. The kernel
620 * writes an &fw_cdev_event_response event which indicates success or failure of
621 * the transmission.
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100622 */
623struct fw_cdev_send_stream_packet {
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100624 __u32 length;
625 __u32 tag;
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100626 __u32 channel;
627 __u32 sy;
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100628 __u64 closure;
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100629 __u64 data;
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100630 __u32 generation;
631 __u32 speed;
Jay Fenlasonf8c22872009-03-05 19:08:40 +0100632};
633
Kristian Høgsberg4c5a4432007-05-07 20:33:37 -0400634#endif /* _LINUX_FIREWIRE_CDEV_H */