]> err.no Git - linux-2.6/blob - drivers/firewire/fw-device-cdev.h
firewire: Add a bus reset event type for fw-device-cdev.
[linux-2.6] / drivers / firewire / fw-device-cdev.h
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 SCODE_100                       0x0
55 #define SCODE_200                       0x1
56 #define SCODE_400                       0x2
57 #define SCODE_800                       0x3
58 #define SCODE_1600                      0x4
59 #define SCODE_3200                      0x5
60
61 #define FW_CDEV_EVENT_BUS_RESET         0x00
62 #define FW_CDEV_EVENT_RESPONSE          0x01
63 #define FW_CDEV_EVENT_REQUEST           0x02
64 #define FW_CDEV_EVENT_ISO_INTERRUPT     0x03
65
66 /* The 'closure' fields are for user space to use.  Data passed in the
67  * 'closure' field for a request will be returned in the corresponding
68  * event.  It's a 64-bit type so that it's a fixed size type big
69  * enough to hold a pointer on all platforms. */
70
71 struct fw_cdev_event_bus_reset {
72         __u32 type;
73         __u32 node_id;
74         __u32 local_node_id;
75         __u32 bm_node_id;
76         __u32 irm_node_id;
77         __u32 root_node_id;
78         __u32 generation;
79 };
80
81 struct fw_cdev_event_response {
82         __u32 type;
83         __u32 rcode;
84         __u64 closure;
85         __u32 length;
86         __u32 data[0];
87 };
88
89 struct fw_cdev_event_request {
90         __u32 type;
91         __u32 tcode;
92         __u64 offset;
93         __u64 closure;
94         __u32 serial;
95         __u32 length;
96         __u32 data[0];
97 };
98
99 struct fw_cdev_event_iso_interrupt {
100         __u32 type;
101         __u32 cycle;
102         __u64 closure;
103         __u32 header_length;    /* Length in bytes of following headers. */
104         __u32 header[0];
105 };
106
107 #define FW_CDEV_IOC_GET_CONFIG_ROM      _IOR('#', 0x00, struct fw_cdev_get_config_rom)
108 #define FW_CDEV_IOC_SEND_REQUEST        _IO('#', 0x01)
109 #define FW_CDEV_IOC_ALLOCATE            _IO('#', 0x02)
110 #define FW_CDEV_IOC_SEND_RESPONSE       _IO('#', 0x03)
111 #define FW_CDEV_IOC_CREATE_ISO_CONTEXT  _IO('#', 0x04)
112 #define FW_CDEV_IOC_QUEUE_ISO           _IO('#', 0x05)
113 #define FW_CDEV_IOC_START_ISO           _IO('#', 0x06)
114 #define FW_CDEV_IOC_STOP_ISO            _IO('#', 0x07)
115
116 struct fw_cdev_get_config_rom {
117         __u32 length;
118         __u32 data[256];
119 };
120
121 struct fw_cdev_send_request {
122         __u32 tcode;
123         __u32 length;
124         __u64 offset;
125         __u64 closure;
126         __u64 data;
127 };
128
129 struct fw_cdev_send_response {
130         __u32 rcode;
131         __u32 length;
132         __u64 data;
133         __u32 serial;
134 };
135
136 struct fw_cdev_allocate {
137         __u64 offset;
138         __u64 closure;
139         __u32 length;
140 };
141
142 #define FW_CDEV_ISO_CONTEXT_TRANSMIT    0
143 #define FW_CDEV_ISO_CONTEXT_RECEIVE     1
144
145 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0           1
146 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1           2
147 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2           4
148 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3           8
149 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS      15
150
151 struct fw_cdev_create_iso_context {
152         __u32 type;
153         __u32 header_size;
154         __u32 channel;
155         __u32 speed;
156         __u32 sync;
157         __u32 tags;
158 };
159
160 struct fw_cdev_iso_packet {
161         __u16 payload_length;   /* Length of indirect payload. */
162         __u32 interrupt : 1;    /* Generate interrupt on this packet */
163         __u32 skip : 1;         /* Set to not send packet at all. */
164         __u32 tag : 2;
165         __u32 sy : 4;
166         __u32 header_length : 8;        /* Length of immediate header. */
167         __u32 header[0];
168 };
169
170 struct fw_cdev_queue_iso {
171         __u32 size;
172         __u64 packets;
173         __u64 data;
174 };
175
176 struct fw_cdev_start_iso {
177         __s32 cycle;
178 };
179
180 #endif /* __fw_cdev_h */