Kristian Høgsberg | 4c5a443 | 2007-05-07 20:33:37 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Char device interface. |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 3 | * |
| 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øgsberg | 4c5a443 | 2007-05-07 20:33:37 -0400 | [diff] [blame] | 21 | #ifndef _LINUX_FIREWIRE_CDEV_H |
| 22 | #define _LINUX_FIREWIRE_CDEV_H |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 23 | |
Kristian Høgsberg | 04dfb8d | 2007-05-07 20:33:36 -0400 | [diff] [blame] | 24 | #include <linux/ioctl.h> |
| 25 | #include <linux/types.h> |
Kristian Høgsberg | 4c5a443 | 2007-05-07 20:33:37 -0400 | [diff] [blame] | 26 | #include <linux/firewire-constants.h> |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 27 | |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 28 | #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øgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 34 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 35 | /** |
| 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øgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 47 | struct fw_cdev_event_common { |
| 48 | __u64 closure; |
| 49 | __u32 type; |
| 50 | }; |
| 51 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 52 | /** |
| 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øgsberg | 97bd9ef | 2007-03-07 12:12:41 -0500 | [diff] [blame] | 67 | struct fw_cdev_event_bus_reset { |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 68 | __u64 closure; |
Kristian Høgsberg | 97bd9ef | 2007-03-07 12:12:41 -0500 | [diff] [blame] | 69 | __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øgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 78 | /** |
| 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øgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 92 | struct fw_cdev_event_response { |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 93 | __u64 closure; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 94 | __u32 type; |
| 95 | __u32 rcode; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 96 | __u32 length; |
| 97 | __u32 data[0]; |
| 98 | }; |
| 99 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 100 | /** |
| 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øgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 119 | struct fw_cdev_event_request { |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 120 | __u64 closure; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 121 | __u32 type; |
| 122 | __u32 tcode; |
| 123 | __u64 offset; |
Kristian Høgsberg | 3964a44 | 2007-03-27 01:43:41 -0400 | [diff] [blame] | 124 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 125 | __u32 length; |
| 126 | __u32 data[0]; |
| 127 | }; |
| 128 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 129 | /** |
| 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 Richter | 77258da | 2009-01-07 20:14:53 +0100 | [diff] [blame] | 141 | * 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øgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 159 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 160 | struct fw_cdev_event_iso_interrupt { |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 161 | __u64 closure; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 162 | __u32 type; |
| 163 | __u32 cycle; |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 164 | __u32 header_length; |
Kristian Høgsberg | 9b32d5f | 2007-02-16 17:34:44 -0500 | [diff] [blame] | 165 | __u32 header[0]; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 166 | }; |
| 167 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 168 | /** |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 169 | * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed |
| 170 | * @closure: See &fw_cdev_event_common; |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 171 | * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 172 | * @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 Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 177 | * |
| 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 Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 182 | * 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 Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 185 | * |
| 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 Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 188 | */ |
| 189 | struct 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øgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 198 | * 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 Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 204 | * @iso_resource: Valid if @common.type == |
| 205 | * %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or |
| 206 | * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 207 | * |
Jay Fenlason | be585c0 | 2008-10-01 18:13:20 -0400 | [diff] [blame] | 208 | * 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øgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 215 | */ |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 216 | union fw_cdev_event { |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 217 | 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øgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 223 | }; |
| 224 | |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 225 | /* available since kernel version 2.6.22 */ |
Stefan Richter | c8a2590 | 2009-03-10 20:59:16 +0100 | [diff] [blame] | 226 | #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 Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 238 | |
| 239 | /* available since kernel version 2.6.24 */ |
Stefan Richter | c8a2590 | 2009-03-10 20:59:16 +0100 | [diff] [blame] | 240 | #define FW_CDEV_IOC_GET_CYCLE_TIMER _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer) |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 241 | |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 242 | /* available since kernel version 2.6.30 */ |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 243 | #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 Richter | c8a2590 | 2009-03-10 20:59:16 +0100 | [diff] [blame] | 247 | #define FW_CDEV_IOC_GET_SPEED _IO('#', 0x11) /* returns speed code */ |
Jay Fenlason, Stefan Richter | acfe833 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 248 | #define FW_CDEV_IOC_SEND_BROADCAST_REQUEST _IOW('#', 0x12, struct fw_cdev_send_request) |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 249 | #define FW_CDEV_IOC_SEND_STREAM_PACKET _IOW('#', 0x13, struct fw_cdev_send_stream_packet) |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 250 | |
Stefan Richter | 77258da | 2009-01-07 20:14:53 +0100 | [diff] [blame] | 251 | /* |
| 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øgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 256 | */ |
Stefan Richter | 77258da | 2009-01-07 20:14:53 +0100 | [diff] [blame] | 257 | #define FW_CDEV_VERSION 2 |
Kristian Høgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 258 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 259 | /** |
| 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 Richter | 632321e | 2009-01-02 12:47:13 +0100 | [diff] [blame] | 269 | * device's configuration ROM |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 270 | * @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øgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 276 | struct fw_cdev_get_info { |
Kristian Høgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 277 | __u32 version; |
Kristian Høgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 278 | __u32 rom_length; |
| 279 | __u64 rom; |
Kristian Høgsberg | 344bbc4 | 2007-03-07 12:12:43 -0500 | [diff] [blame] | 280 | __u64 bus_reset; |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 281 | __u64 bus_reset_closure; |
Kristian Høgsberg | e753350 | 2007-03-07 12:12:52 -0500 | [diff] [blame] | 282 | __u32 card; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 283 | }; |
| 284 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 285 | /** |
| 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 Richter | bf8e335 | 2008-12-05 22:43:41 +0100 | [diff] [blame] | 297 | * &fw_cdev_event_response event back. The @closure field is passed back to |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 298 | * user space in the response event. |
| 299 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 300 | struct fw_cdev_send_request { |
| 301 | __u32 tcode; |
| 302 | __u32 length; |
| 303 | __u64 offset; |
| 304 | __u64 closure; |
| 305 | __u64 data; |
Kristian Høgsberg | 97e3527 | 2007-03-07 12:12:53 -0500 | [diff] [blame] | 306 | __u32 generation; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 307 | }; |
| 308 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 309 | /** |
| 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øgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 322 | struct fw_cdev_send_response { |
| 323 | __u32 rcode; |
| 324 | __u32 length; |
| 325 | __u64 data; |
Kristian Høgsberg | 3964a44 | 2007-03-27 01:43:41 -0400 | [diff] [blame] | 326 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 327 | }; |
| 328 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 329 | /** |
| 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. |
Clemens Ladisch | db5d247 | 2009-12-24 12:05:58 +0100 | [diff] [blame] | 343 | * |
| 344 | * The address range is allocated on all local nodes. The address allocation |
| 345 | * is exclusive except for the FCP command and response registers. |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 346 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 347 | struct fw_cdev_allocate { |
| 348 | __u64 offset; |
| 349 | __u64 closure; |
| 350 | __u32 length; |
Kristian Høgsberg | 3964a44 | 2007-03-27 01:43:41 -0400 | [diff] [blame] | 351 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 352 | }; |
| 353 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 354 | /** |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 355 | * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource |
| 356 | * @handle: Handle to the address range or iso resource, as returned by the |
| 357 | * kernel when the range or resource was allocated |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 358 | */ |
Kristian Høgsberg | 9472316 | 2007-03-14 17:34:55 -0400 | [diff] [blame] | 359 | struct fw_cdev_deallocate { |
Kristian Høgsberg | 3964a44 | 2007-03-27 01:43:41 -0400 | [diff] [blame] | 360 | __u32 handle; |
Kristian Høgsberg | 9472316 | 2007-03-14 17:34:55 -0400 | [diff] [blame] | 361 | }; |
| 362 | |
Kristian Høgsberg | 5371842 | 2007-03-07 12:12:42 -0500 | [diff] [blame] | 363 | #define FW_CDEV_LONG_RESET 0 |
| 364 | #define FW_CDEV_SHORT_RESET 1 |
| 365 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 366 | /** |
| 367 | * struct fw_cdev_initiate_bus_reset - Initiate a bus reset |
| 368 | * @type: %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET |
| 369 | * |
| 370 | * Initiate a bus reset for the bus this device is on. The bus reset can be |
| 371 | * either the original (long) bus reset or the arbitrated (short) bus reset |
| 372 | * introduced in 1394a-2000. |
| 373 | */ |
Kristian Høgsberg | 5371842 | 2007-03-07 12:12:42 -0500 | [diff] [blame] | 374 | struct fw_cdev_initiate_bus_reset { |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 375 | __u32 type; /* FW_CDEV_SHORT_RESET or FW_CDEV_LONG_RESET */ |
Kristian Høgsberg | 5371842 | 2007-03-07 12:12:42 -0500 | [diff] [blame] | 376 | }; |
| 377 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 378 | /** |
| 379 | * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM |
| 380 | * @immediate: If non-zero, immediate key to insert before pointer |
| 381 | * @key: Upper 8 bits of root directory pointer |
| 382 | * @data: Userspace pointer to contents of descriptor block |
Stefan Richter | 6d3faf6 | 2010-01-24 14:48:00 +0100 | [diff] [blame] | 383 | * @length: Length of descriptor block data, in quadlets |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 384 | * @handle: Handle to the descriptor, written by the kernel |
| 385 | * |
| 386 | * Add a descriptor block and optionally a preceding immediate key to the local |
| 387 | * node's configuration ROM. |
| 388 | * |
| 389 | * The @key field specifies the upper 8 bits of the descriptor root directory |
| 390 | * pointer and the @data and @length fields specify the contents. The @key |
| 391 | * should be of the form 0xXX000000. The offset part of the root directory entry |
| 392 | * will be filled in by the kernel. |
| 393 | * |
| 394 | * If not 0, the @immediate field specifies an immediate key which will be |
| 395 | * inserted before the root directory pointer. |
| 396 | * |
Stefan Richter | 6d3faf6 | 2010-01-24 14:48:00 +0100 | [diff] [blame] | 397 | * @immediate, @key, and @data array elements are CPU-endian quadlets. |
| 398 | * |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 399 | * If successful, the kernel adds the descriptor and writes back a handle to the |
| 400 | * kernel-side object to be used for later removal of the descriptor block and |
| 401 | * immediate key. |
Stefan Richter | de487da | 2009-03-10 21:00:23 +0100 | [diff] [blame] | 402 | * |
| 403 | * This ioctl affects the configuration ROMs of all local nodes. |
| 404 | * The ioctl only succeeds on device files which represent a local node. |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 405 | */ |
Kristian Høgsberg | 66dea3e | 2007-03-28 21:26:42 +0200 | [diff] [blame] | 406 | struct fw_cdev_add_descriptor { |
| 407 | __u32 immediate; |
| 408 | __u32 key; |
| 409 | __u64 data; |
| 410 | __u32 length; |
| 411 | __u32 handle; |
| 412 | }; |
| 413 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 414 | /** |
| 415 | * struct fw_cdev_remove_descriptor - Remove contents from the configuration ROM |
| 416 | * @handle: Handle to the descriptor, as returned by the kernel when the |
| 417 | * descriptor was added |
| 418 | * |
| 419 | * Remove a descriptor block and accompanying immediate key from the local |
Stefan Richter | de487da | 2009-03-10 21:00:23 +0100 | [diff] [blame] | 420 | * nodes' configuration ROMs. |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 421 | */ |
Kristian Høgsberg | 66dea3e | 2007-03-28 21:26:42 +0200 | [diff] [blame] | 422 | struct fw_cdev_remove_descriptor { |
| 423 | __u32 handle; |
| 424 | }; |
| 425 | |
Kristian Høgsberg | 295e3fe | 2007-02-16 17:34:40 -0500 | [diff] [blame] | 426 | #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0 |
| 427 | #define FW_CDEV_ISO_CONTEXT_RECEIVE 1 |
| 428 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 429 | /** |
| 430 | * struct fw_cdev_create_iso_context - Create a context for isochronous IO |
| 431 | * @type: %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE |
| 432 | * @header_size: Header size to strip for receive contexts |
| 433 | * @channel: Channel to bind to |
| 434 | * @speed: Speed to transmit at |
| 435 | * @closure: To be returned in &fw_cdev_event_iso_interrupt |
| 436 | * @handle: Handle to context, written back by kernel |
| 437 | * |
| 438 | * Prior to sending or receiving isochronous I/O, a context must be created. |
| 439 | * The context records information about the transmit or receive configuration |
| 440 | * and typically maps to an underlying hardware resource. A context is set up |
| 441 | * for either sending or receiving. It is bound to a specific isochronous |
| 442 | * channel. |
| 443 | * |
| 444 | * If a context was successfully created, the kernel writes back a handle to the |
| 445 | * context, which must be passed in for subsequent operations on that context. |
Stefan Richter | 77258da | 2009-01-07 20:14:53 +0100 | [diff] [blame] | 446 | * |
| 447 | * Note that the effect of a @header_size > 4 depends on |
| 448 | * &fw_cdev_get_info.version, as documented at &fw_cdev_event_iso_interrupt. |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 449 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 450 | struct fw_cdev_create_iso_context { |
Kristian Høgsberg | 295e3fe | 2007-02-16 17:34:40 -0500 | [diff] [blame] | 451 | __u32 type; |
| 452 | __u32 header_size; |
Kristian Høgsberg | 21efb3c | 2007-02-16 17:34:50 -0500 | [diff] [blame] | 453 | __u32 channel; |
| 454 | __u32 speed; |
Kristian Høgsberg | abaa574 | 2007-04-30 15:03:14 -0400 | [diff] [blame] | 455 | __u64 closure; |
| 456 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 457 | }; |
| 458 | |
Kristian Høgsberg | 1ca31ae | 2007-05-31 11:16:43 -0400 | [diff] [blame] | 459 | #define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v) |
| 460 | #define FW_CDEV_ISO_INTERRUPT (1 << 16) |
| 461 | #define FW_CDEV_ISO_SKIP (1 << 17) |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 462 | #define FW_CDEV_ISO_SYNC (1 << 17) |
Kristian Høgsberg | 1ca31ae | 2007-05-31 11:16:43 -0400 | [diff] [blame] | 463 | #define FW_CDEV_ISO_TAG(v) ((v) << 18) |
| 464 | #define FW_CDEV_ISO_SY(v) ((v) << 20) |
| 465 | #define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24) |
| 466 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 467 | /** |
| 468 | * struct fw_cdev_iso_packet - Isochronous packet |
| 469 | * @control: Contains the header length (8 uppermost bits), the sy field |
| 470 | * (4 bits), the tag field (2 bits), a sync flag (1 bit), |
| 471 | * a skip flag (1 bit), an interrupt flag (1 bit), and the |
| 472 | * payload length (16 lowermost bits) |
| 473 | * @header: Header and payload |
| 474 | * |
| 475 | * &struct fw_cdev_iso_packet is used to describe isochronous packet queues. |
| 476 | * |
| 477 | * Use the FW_CDEV_ISO_ macros to fill in @control. The sy and tag fields are |
| 478 | * specified by IEEE 1394a and IEC 61883. |
| 479 | * |
| 480 | * FIXME - finish this documentation |
| 481 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 482 | struct fw_cdev_iso_packet { |
Kristian Høgsberg | 1ca31ae | 2007-05-31 11:16:43 -0400 | [diff] [blame] | 483 | __u32 control; |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 484 | __u32 header[0]; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 485 | }; |
| 486 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 487 | /** |
| 488 | * struct fw_cdev_queue_iso - Queue isochronous packets for I/O |
| 489 | * @packets: Userspace pointer to packet data |
| 490 | * @data: Pointer into mmap()'ed payload buffer |
| 491 | * @size: Size of packet data in bytes |
| 492 | * @handle: Isochronous context handle |
| 493 | * |
| 494 | * Queue a number of isochronous packets for reception or transmission. |
| 495 | * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs, |
| 496 | * which describe how to transmit from or receive into a contiguous region |
| 497 | * of a mmap()'ed payload buffer. As part of the packet descriptors, |
| 498 | * a series of headers can be supplied, which will be prepended to the |
| 499 | * payload during DMA. |
| 500 | * |
| 501 | * The kernel may or may not queue all packets, but will write back updated |
| 502 | * values of the @packets, @data and @size fields, so the ioctl can be |
| 503 | * resubmitted easily. |
| 504 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 505 | struct fw_cdev_queue_iso { |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 506 | __u64 packets; |
| 507 | __u64 data; |
Kristian Høgsberg | da8ecff | 2007-03-27 01:43:39 -0400 | [diff] [blame] | 508 | __u32 size; |
Kristian Høgsberg | abaa574 | 2007-04-30 15:03:14 -0400 | [diff] [blame] | 509 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 510 | }; |
| 511 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 512 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1 |
| 513 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2 |
| 514 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4 |
| 515 | #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8 |
| 516 | #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15 |
| 517 | |
| 518 | /** |
| 519 | * struct fw_cdev_start_iso - Start an isochronous transmission or reception |
| 520 | * @cycle: Cycle in which to start I/O. If @cycle is greater than or |
| 521 | * equal to 0, the I/O will start on that cycle. |
| 522 | * @sync: Determines the value to wait for for receive packets that have |
| 523 | * the %FW_CDEV_ISO_SYNC bit set |
| 524 | * @tags: Tag filter bit mask. Only valid for isochronous reception. |
| 525 | * Determines the tag values for which packets will be accepted. |
| 526 | * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags. |
| 527 | * @handle: Isochronous context handle within which to transmit or receive |
| 528 | */ |
Kristian Høgsberg | 69cdb72 | 2007-02-16 17:34:41 -0500 | [diff] [blame] | 529 | struct fw_cdev_start_iso { |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 530 | __s32 cycle; |
Kristian Høgsberg | eb0306e | 2007-03-14 17:34:54 -0400 | [diff] [blame] | 531 | __u32 sync; |
| 532 | __u32 tags; |
Kristian Høgsberg | abaa574 | 2007-04-30 15:03:14 -0400 | [diff] [blame] | 533 | __u32 handle; |
| 534 | }; |
| 535 | |
Kristian Høgsberg | 7ada60e | 2007-06-22 00:20:34 +0200 | [diff] [blame] | 536 | /** |
| 537 | * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception |
| 538 | * @handle: Handle of isochronous context to stop |
| 539 | */ |
Kristian Høgsberg | abaa574 | 2007-04-30 15:03:14 -0400 | [diff] [blame] | 540 | struct fw_cdev_stop_iso { |
| 541 | __u32 handle; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 542 | }; |
| 543 | |
Stefan Richter | a64408b | 2007-09-29 10:41:58 +0200 | [diff] [blame] | 544 | /** |
| 545 | * struct fw_cdev_get_cycle_timer - read cycle timer register |
| 546 | * @local_time: system time, in microseconds since the Epoch |
| 547 | * @cycle_timer: isochronous cycle timer, as per OHCI 1.1 clause 5.13 |
| 548 | * |
| 549 | * The %FW_CDEV_IOC_GET_CYCLE_TIMER ioctl reads the isochronous cycle timer |
| 550 | * and also the system clock. This allows to express the receive time of an |
| 551 | * isochronous packet as a system time with microsecond accuracy. |
Stefan Richter | 77258da | 2009-01-07 20:14:53 +0100 | [diff] [blame] | 552 | * |
| 553 | * @cycle_timer consists of 7 bits cycleSeconds, 13 bits cycleCount, and |
| 554 | * 12 bits cycleOffset, in host byte order. |
Stefan Richter | a64408b | 2007-09-29 10:41:58 +0200 | [diff] [blame] | 555 | */ |
| 556 | struct fw_cdev_get_cycle_timer { |
| 557 | __u64 local_time; |
| 558 | __u32 cycle_timer; |
| 559 | }; |
| 560 | |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 561 | /** |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 562 | * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 563 | * @closure: Passed back to userspace in correponding iso resource events |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 564 | * @channels: Isochronous channels of which one is to be (de)allocated |
| 565 | * @bandwidth: Isochronous bandwidth units to be (de)allocated |
| 566 | * @handle: Handle to the allocation, written by the kernel (only valid in |
| 567 | * case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls) |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 568 | * |
| 569 | * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an |
| 570 | * isochronous channel and/or of isochronous bandwidth at the isochronous |
| 571 | * resource manager (IRM). Only one of the channels specified in @channels is |
| 572 | * allocated. An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after |
| 573 | * communication with the IRM, indicating success or failure in the event data. |
| 574 | * The kernel will automatically reallocate the resources after bus resets. |
| 575 | * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event |
| 576 | * will be sent. The kernel will also automatically deallocate the resources |
| 577 | * when the file descriptor is closed. |
| 578 | * |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 579 | * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate |
| 580 | * deallocation of resources which were allocated as described above. |
| 581 | * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation. |
| 582 | * |
| 583 | * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation |
| 584 | * without automatic re- or deallocation. |
| 585 | * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation, |
| 586 | * indicating success or failure in its data. |
| 587 | * |
| 588 | * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like |
| 589 | * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed |
Stefan Richter | 5d9cb7d27 | 2009-01-08 23:07:40 +0100 | [diff] [blame] | 590 | * instead of allocated. |
Stefan Richter | 1ec3c02 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 591 | * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation. |
| 592 | * |
| 593 | * To summarize, %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE allocates iso resources |
| 594 | * for the lifetime of the fd or handle. |
| 595 | * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources |
| 596 | * for the duration of a bus generation. |
| 597 | * |
Stefan Richter | 5d9cb7d27 | 2009-01-08 23:07:40 +0100 | [diff] [blame] | 598 | * @channels is a host-endian bitfield with the least significant bit |
| 599 | * representing channel 0 and the most significant bit representing channel 63: |
| 600 | * 1ULL << c for each channel c that is a candidate for (de)allocation. |
Jay Fenlason, Stefan Richter | b1bda4c | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 601 | * |
| 602 | * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send |
| 603 | * one quadlet of data (payload or header data) at speed S1600. |
| 604 | */ |
| 605 | struct fw_cdev_allocate_iso_resource { |
| 606 | __u64 closure; |
| 607 | __u64 channels; |
| 608 | __u32 bandwidth; |
| 609 | __u32 handle; |
| 610 | }; |
| 611 | |
Stefan Richter | 33580a3 | 2009-01-04 16:23:29 +0100 | [diff] [blame] | 612 | /** |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 613 | * struct fw_cdev_send_stream_packet - send an asynchronous stream packet |
Stefan Richter | 18e9b10 | 2009-03-10 21:02:21 +0100 | [diff] [blame] | 614 | * @length: Length of outgoing payload, in bytes |
| 615 | * @tag: Data format tag |
| 616 | * @channel: Isochronous channel to transmit to |
| 617 | * @sy: Synchronization code |
| 618 | * @closure: Passed back to userspace in the response event |
| 619 | * @data: Userspace pointer to payload |
| 620 | * @generation: The bus generation where packet is valid |
| 621 | * @speed: Speed to transmit at |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 622 | * |
| 623 | * The %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl sends an asynchronous stream packet |
Stefan Richter | 18e9b10 | 2009-03-10 21:02:21 +0100 | [diff] [blame] | 624 | * to every device which is listening to the specified channel. The kernel |
| 625 | * writes an &fw_cdev_event_response event which indicates success or failure of |
| 626 | * the transmission. |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 627 | */ |
| 628 | struct fw_cdev_send_stream_packet { |
Stefan Richter | 18e9b10 | 2009-03-10 21:02:21 +0100 | [diff] [blame] | 629 | __u32 length; |
| 630 | __u32 tag; |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 631 | __u32 channel; |
| 632 | __u32 sy; |
Stefan Richter | 18e9b10 | 2009-03-10 21:02:21 +0100 | [diff] [blame] | 633 | __u64 closure; |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 634 | __u64 data; |
Stefan Richter | 18e9b10 | 2009-03-10 21:02:21 +0100 | [diff] [blame] | 635 | __u32 generation; |
| 636 | __u32 speed; |
Jay Fenlason | f8c2287 | 2009-03-05 19:08:40 +0100 | [diff] [blame] | 637 | }; |
| 638 | |
Kristian Høgsberg | 4c5a443 | 2007-05-07 20:33:37 -0400 | [diff] [blame] | 639 | #endif /* _LINUX_FIREWIRE_CDEV_H */ |