1 /* -*- c-basic-offset: 8 -*-
3 * fw-device-cdev.h -- Char device interface.
5 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
25 #include <linux/ioctl.h>
26 #include <linux/types.h>
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
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
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
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
64 #define SCODE_1600 0x4
65 #define SCODE_3200 0x5
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
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. */
77 struct fw_cdev_event_common {
82 struct fw_cdev_event_bus_reset {
93 struct fw_cdev_event_response {
101 struct fw_cdev_event_request {
111 struct fw_cdev_event_iso_interrupt {
115 __u32 header_length; /* Length in bytes of following headers. */
119 union 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;
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)
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)
141 /* FW_CDEV_VERSION History
143 * 1 Feb 18, 2007: Initial version.
145 #define FW_CDEV_VERSION 1
147 struct 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. */
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
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. */
170 __u64 bus_reset_closure;
172 /* The index of the card this devices belongs to. */
176 struct fw_cdev_send_request {
185 struct fw_cdev_send_response {
192 struct fw_cdev_allocate {
199 struct fw_cdev_deallocate {
203 #define FW_CDEV_LONG_RESET 0
204 #define FW_CDEV_SHORT_RESET 1
206 struct fw_cdev_initiate_bus_reset {
210 struct fw_cdev_add_descriptor {
218 struct fw_cdev_remove_descriptor {
222 #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
223 #define FW_CDEV_ISO_CONTEXT_RECEIVE 1
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
231 struct fw_cdev_create_iso_context {
240 struct 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. */
246 __u32 header_length : 8; /* Length of immediate header. */
250 struct fw_cdev_queue_iso {
257 struct fw_cdev_start_iso {
264 struct fw_cdev_stop_iso {
268 #endif /* __fw_cdev_h */