1 /* 2 * Char device interface. 3 * 4 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh (at) bitplanet.net> 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the "Software"), 8 * to deal in the Software without restriction, including without limitation 9 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 10 * and/or sell copies of the Software, and to permit persons to whom the 11 * Software is furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice (including the next 14 * paragraph) shall be included in all copies or substantial portions of the 15 * Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 * DEALINGS IN THE SOFTWARE. 24 */ 25 26 #ifndef _LINUX_FIREWIRE_CDEV_H 27 #define _LINUX_FIREWIRE_CDEV_H 28 29 #include <linux/ioctl.h> 30 #include <linux/types.h> 31 #include <linux/firewire-constants.h> 32 33 /* available since kernel version 2.6.22 */ 34 #define FW_CDEV_EVENT_BUS_RESET 0x00 35 #define FW_CDEV_EVENT_RESPONSE 0x01 36 #define FW_CDEV_EVENT_REQUEST 0x02 37 #define FW_CDEV_EVENT_ISO_INTERRUPT 0x03 38 39 /* available since kernel version 2.6.30 */ 40 #define FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED 0x04 41 #define FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED 0x05 42 43 /* available since kernel version 2.6.36 */ 44 #define FW_CDEV_EVENT_REQUEST2 0x06 45 #define FW_CDEV_EVENT_PHY_PACKET_SENT 0x07 46 #define FW_CDEV_EVENT_PHY_PACKET_RECEIVED 0x08 47 #define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 0x09 48 49 /** 50 * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types 51 * @closure: For arbitrary use by userspace 52 * @type: Discriminates the fw_cdev_event_ types 53 * 54 * This struct may be used to access generic members of all fw_cdev_event_ 55 * types regardless of the specific type. 56 * 57 * Data passed in the @closure field for a request will be returned in the 58 * corresponding event. It is big enough to hold a pointer on all platforms. 59 * The ioctl used to set @closure depends on the @type of event. 60 */ 61 struct fw_cdev_event_common { 62 __u64 closure; 63 __u32 type; 64 }; 65 66 /** 67 * struct fw_cdev_event_bus_reset - Sent when a bus reset occurred 68 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_GET_INFO ioctl 69 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_BUS_RESET 70 * @node_id: New node ID of this node 71 * @local_node_id: Node ID of the local node, i.e. of the controller 72 * @bm_node_id: Node ID of the bus manager 73 * @irm_node_id: Node ID of the iso resource manager 74 * @root_node_id: Node ID of the root node 75 * @generation: New bus generation 76 * 77 * This event is sent when the bus the device belongs to goes through a bus 78 * reset. It provides information about the new bus configuration, such as 79 * new node ID for this device, new root ID, and others. 80 * 81 * If @bm_node_id is 0xffff right after bus reset it can be reread by an 82 * %FW_CDEV_IOC_GET_INFO ioctl after bus manager selection was finished. 83 * Kernels with ABI version < 4 do not set @bm_node_id. 84 */ 85 struct fw_cdev_event_bus_reset { 86 __u64 closure; 87 __u32 type; 88 __u32 node_id; 89 __u32 local_node_id; 90 __u32 bm_node_id; 91 __u32 irm_node_id; 92 __u32 root_node_id; 93 __u32 generation; 94 }; 95 96 /** 97 * struct fw_cdev_event_response - Sent when a response packet was received 98 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_SEND_REQUEST 99 * or %FW_CDEV_IOC_SEND_BROADCAST_REQUEST 100 * or %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl 101 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_RESPONSE 102 * @rcode: Response code returned by the remote node 103 * @length: Data length, i.e. the response's payload size in bytes 104 * @data: Payload data, if any 105 * 106 * This event is sent when the stack receives a response to an outgoing request 107 * sent by %FW_CDEV_IOC_SEND_REQUEST ioctl. The payload data for responses 108 * carrying data (read and lock responses) follows immediately and can be 109 * accessed through the @data field. 110 * 111 * The event is also generated after conclusions of transactions that do not 112 * involve response packets. This includes unified write transactions, 113 * broadcast write transactions, and transmission of asynchronous stream 114 * packets. @rcode indicates success or failure of such transmissions. 115 */ 116 struct fw_cdev_event_response { 117 __u64 closure; 118 __u32 type; 119 __u32 rcode; 120 __u32 length; 121 __u32 data[0]; 122 }; 123 124 /** 125 * struct fw_cdev_event_request - Old version of &fw_cdev_event_request2 126 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST 127 * 128 * This event is sent instead of &fw_cdev_event_request2 if the kernel or 129 * the client implements ABI version <= 3. &fw_cdev_event_request lacks 130 * essential information; use &fw_cdev_event_request2 instead. 131 */ 132 struct fw_cdev_event_request { 133 __u64 closure; 134 __u32 type; 135 __u32 tcode; 136 __u64 offset; 137 __u32 handle; 138 __u32 length; 139 __u32 data[0]; 140 }; 141 142 /** 143 * struct fw_cdev_event_request2 - Sent on incoming request to an address region 144 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl 145 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST2 146 * @tcode: Transaction code of the incoming request 147 * @offset: The offset into the 48-bit per-node address space 148 * @source_node_id: Sender node ID 149 * @destination_node_id: Destination node ID 150 * @card: The index of the card from which the request came 151 * @generation: Bus generation in which the request is valid 152 * @handle: Reference to the kernel-side pending request 153 * @length: Data length, i.e. the request's payload size in bytes 154 * @data: Incoming data, if any 155 * 156 * This event is sent when the stack receives an incoming request to an address 157 * region registered using the %FW_CDEV_IOC_ALLOCATE ioctl. The request is 158 * guaranteed to be completely contained in the specified region. Userspace is 159 * responsible for sending the response by %FW_CDEV_IOC_SEND_RESPONSE ioctl, 160 * using the same @handle. 161 * 162 * The payload data for requests carrying data (write and lock requests) 163 * follows immediately and can be accessed through the @data field. 164 * 165 * Unlike &fw_cdev_event_request, @tcode of lock requests is one of the 166 * firewire-core specific %TCODE_LOCK_MASK_SWAP...%TCODE_LOCK_VENDOR_DEPENDENT, 167 * i.e. encodes the extended transaction code. 168 * 169 * @card may differ from &fw_cdev_get_info.card because requests are received 170 * from all cards of the Linux host. @source_node_id, @destination_node_id, and 171 * @generation pertain to that card. Destination node ID and bus generation may 172 * therefore differ from the corresponding fields of the last 173 * &fw_cdev_event_bus_reset. 174 * 175 * @destination_node_id may also differ from the current node ID because of a 176 * non-local bus ID part or in case of a broadcast write request. Note, a 177 * client must call an %FW_CDEV_IOC_SEND_RESPONSE ioctl even in case of a 178 * broadcast write request; the kernel will then release the kernel-side pending 179 * request but will not actually send a response packet. 180 * 181 * In case of a write request to FCP_REQUEST or FCP_RESPONSE, the kernel already 182 * sent a write response immediately after the request was received; in this 183 * case the client must still call an %FW_CDEV_IOC_SEND_RESPONSE ioctl to 184 * release the kernel-side pending request, though another response won't be 185 * sent. 186 * 187 * If the client subsequently needs to initiate requests to the sender node of 188 * an &fw_cdev_event_request2, it needs to use a device file with matching 189 * card index, node ID, and generation for outbound requests. 190 */ 191 struct fw_cdev_event_request2 { 192 __u64 closure; 193 __u32 type; 194 __u32 tcode; 195 __u64 offset; 196 __u32 source_node_id; 197 __u32 destination_node_id; 198 __u32 card; 199 __u32 generation; 200 __u32 handle; 201 __u32 length; 202 __u32 data[0]; 203 }; 204 205 /** 206 * struct fw_cdev_event_iso_interrupt - Sent when an iso packet was completed 207 * @closure: See &fw_cdev_event_common; 208 * set by %FW_CDEV_CREATE_ISO_CONTEXT ioctl 209 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_ISO_INTERRUPT 210 * @cycle: Cycle counter of the interrupt packet 211 * @header_length: Total length of following headers, in bytes 212 * @header: Stripped headers, if any 213 * 214 * This event is sent when the controller has completed an &fw_cdev_iso_packet 215 * with the %FW_CDEV_ISO_INTERRUPT bit set. 216 * 217 * Isochronous transmit events (context type %FW_CDEV_ISO_CONTEXT_TRANSMIT): 218 * 219 * In version 3 and some implementations of version 2 of the ABI, &header_length 220 * is a multiple of 4 and &header contains timestamps of all packets up until 221 * the interrupt packet. The format of the timestamps is as described below for 222 * isochronous reception. In version 1 of the ABI, &header_length was 0. 223 * 224 * Isochronous receive events (context type %FW_CDEV_ISO_CONTEXT_RECEIVE): 225 * 226 * The headers stripped of all packets up until and including the interrupt 227 * packet are returned in the @header field. The amount of header data per 228 * packet is as specified at iso context creation by 229 * &fw_cdev_create_iso_context.header_size. 230 * 231 * Hence, _interrupt.header_length / _context.header_size is the number of 232 * packets received in this interrupt event. The client can now iterate 233 * through the mmap()'ed DMA buffer according to this number of packets and 234 * to the buffer sizes as the client specified in &fw_cdev_queue_iso. 235 * 236 * Since version 2 of this ABI, the portion for each packet in _interrupt.header 237 * consists of the 1394 isochronous packet header, followed by a timestamp 238 * quadlet if &fw_cdev_create_iso_context.header_size > 4, followed by quadlets 239 * from the packet payload if &fw_cdev_create_iso_context.header_size > 8. 240 * 241 * Format of 1394 iso packet header: 16 bits data_length, 2 bits tag, 6 bits 242 * channel, 4 bits tcode, 4 bits sy, in big endian byte order. 243 * data_length is the actual received size of the packet without the four 244 * 1394 iso packet header bytes. 245 * 246 * Format of timestamp: 16 bits invalid, 3 bits cycleSeconds, 13 bits 247 * cycleCount, in big endian byte order. 248 * 249 * In version 1 of the ABI, no timestamp quadlet was inserted; instead, payload 250 * data followed directly after the 1394 is header if header_size > 4. 251 * Behaviour of ver. 1 of this ABI is no longer available since ABI ver. 2. 252 */ 253 struct fw_cdev_event_iso_interrupt { 254 __u64 closure; 255 __u32 type; 256 __u32 cycle; 257 __u32 header_length; 258 __u32 header[0]; 259 }; 260 261 /** 262 * struct fw_cdev_event_iso_interrupt_mc - An iso buffer chunk was completed 263 * @closure: See &fw_cdev_event_common; 264 * set by %FW_CDEV_CREATE_ISO_CONTEXT ioctl 265 * @type: %FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 266 * @completed: Offset into the receive buffer; data before this offset is valid 267 * 268 * This event is sent in multichannel contexts (context type 269 * %FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL) for &fw_cdev_iso_packet buffer 270 * chunks that have the %FW_CDEV_ISO_INTERRUPT bit set. Whether this happens 271 * when a packet is completed and/or when a buffer chunk is completed depends 272 * on the hardware implementation. 273 * 274 * The buffer is continuously filled with the following data, per packet: 275 * - the 1394 iso packet header as described at &fw_cdev_event_iso_interrupt, 276 * but in little endian byte order, 277 * - packet payload (as many bytes as specified in the data_length field of 278 * the 1394 iso packet header) in big endian byte order, 279 * - 0...3 padding bytes as needed to align the following trailer quadlet, 280 * - trailer quadlet, containing the reception timestamp as described at 281 * &fw_cdev_event_iso_interrupt, but in little endian byte order. 282 * 283 * Hence the per-packet size is data_length (rounded up to a multiple of 4) + 8. 284 * When processing the data, stop before a packet that would cross the 285 * @completed offset. 286 * 287 * A packet near the end of a buffer chunk will typically spill over into the 288 * next queued buffer chunk. It is the responsibility of the client to check 289 * for this condition, assemble a broken-up packet from its parts, and not to 290 * re-queue any buffer chunks in which as yet unread packet parts reside. 291 */ 292 struct fw_cdev_event_iso_interrupt_mc { 293 __u64 closure; 294 __u32 type; 295 __u32 completed; 296 }; 297 298 /** 299 * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed 300 * @closure: See &fw_cdev_event_common; 301 * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl 302 * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or 303 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED 304 * @handle: Reference by which an allocated resource can be deallocated 305 * @channel: Isochronous channel which was (de)allocated, if any 306 * @bandwidth: Bandwidth allocation units which were (de)allocated, if any 307 * 308 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event is sent after an isochronous 309 * resource was allocated at the IRM. The client has to check @channel and 310 * @bandwidth for whether the allocation actually succeeded. 311 * 312 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event is sent after an isochronous 313 * resource was deallocated at the IRM. It is also sent when automatic 314 * reallocation after a bus reset failed. 315 * 316 * @channel is <0 if no channel was (de)allocated or if reallocation failed. 317 * @bandwidth is 0 if no bandwidth was (de)allocated or if reallocation failed. 318 */ 319 struct fw_cdev_event_iso_resource { 320 __u64 closure; 321 __u32 type; 322 __u32 handle; 323 __s32 channel; 324 __s32 bandwidth; 325 }; 326 327 /** 328 * struct fw_cdev_event_phy_packet - A PHY packet was transmitted or received 329 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_SEND_PHY_PACKET 330 * or %FW_CDEV_IOC_RECEIVE_PHY_PACKETS ioctl 331 * @type: %FW_CDEV_EVENT_PHY_PACKET_SENT or %..._RECEIVED 332 * @rcode: %RCODE_..., indicates success or failure of transmission 333 * @length: Data length in bytes 334 * @data: Incoming data 335 * 336 * If @type is %FW_CDEV_EVENT_PHY_PACKET_SENT, @length is 0 and @data empty, 337 * except in case of a ping packet: Then, @length is 4, and @data[0] is the 338 * ping time in 49.152MHz clocks if @rcode is %RCODE_COMPLETE. 339 * 340 * If @type is %FW_CDEV_EVENT_PHY_PACKET_RECEIVED, @length is 8 and @data 341 * consists of the two PHY packet quadlets, in host byte order. 342 */ 343 struct fw_cdev_event_phy_packet { 344 __u64 closure; 345 __u32 type; 346 __u32 rcode; 347 __u32 length; 348 __u32 data[0]; 349 }; 350 351 /** 352 * union fw_cdev_event - Convenience union of fw_cdev_event_ types 353 * @common: Valid for all types 354 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET 355 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE 356 * @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST 357 * @request2: Valid if @common.type == %FW_CDEV_EVENT_REQUEST2 358 * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT 359 * @iso_interrupt_mc: Valid if @common.type == 360 * %FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 361 * @iso_resource: Valid if @common.type == 362 * %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or 363 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED 364 * @phy_packet: Valid if @common.type == 365 * %FW_CDEV_EVENT_PHY_PACKET_SENT or 366 * %FW_CDEV_EVENT_PHY_PACKET_RECEIVED 367 * 368 * Convenience union for userspace use. Events could be read(2) into an 369 * appropriately aligned char buffer and then cast to this union for further 370 * processing. Note that for a request, response or iso_interrupt event, 371 * the data[] or header[] may make the size of the full event larger than 372 * sizeof(union fw_cdev_event). Also note that if you attempt to read(2) 373 * an event into a buffer that is not large enough for it, the data that does 374 * not fit will be discarded so that the next read(2) will return a new event. 375 */ 376 union fw_cdev_event { 377 struct fw_cdev_event_common common; 378 struct fw_cdev_event_bus_reset bus_reset; 379 struct fw_cdev_event_response response; 380 struct fw_cdev_event_request request; 381 struct fw_cdev_event_request2 request2; /* added in 2.6.36 */ 382 struct fw_cdev_event_iso_interrupt iso_interrupt; 383 struct fw_cdev_event_iso_interrupt_mc iso_interrupt_mc; /* added in 2.6.36 */ 384 struct fw_cdev_event_iso_resource iso_resource; /* added in 2.6.30 */ 385 struct fw_cdev_event_phy_packet phy_packet; /* added in 2.6.36 */ 386 }; 387 388 /* available since kernel version 2.6.22 */ 389 #define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info) 390 #define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request) 391 #define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate) 392 #define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate) 393 #define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response) 394 #define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset) 395 #define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor) 396 #define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor) 397 #define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context) 398 #define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso) 399 #define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso) 400 #define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso) 401 402 /* available since kernel version 2.6.24 */ 403 #define FW_CDEV_IOC_GET_CYCLE_TIMER _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer) 404 405 /* available since kernel version 2.6.30 */ 406 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource) 407 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE _IOW('#', 0x0e, struct fw_cdev_deallocate) 408 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource) 409 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource) 410 #define FW_CDEV_IOC_GET_SPEED _IO('#', 0x11) /* returns speed code */ 411 #define FW_CDEV_IOC_SEND_BROADCAST_REQUEST _IOW('#', 0x12, struct fw_cdev_send_request) 412 #define FW_CDEV_IOC_SEND_STREAM_PACKET _IOW('#', 0x13, struct fw_cdev_send_stream_packet) 413 414 /* available since kernel version 2.6.34 */ 415 #define FW_CDEV_IOC_GET_CYCLE_TIMER2 _IOWR('#', 0x14, struct fw_cdev_get_cycle_timer2) 416 417 /* available since kernel version 2.6.36 */ 418 #define FW_CDEV_IOC_SEND_PHY_PACKET _IOWR('#', 0x15, struct fw_cdev_send_phy_packet) 419 #define FW_CDEV_IOC_RECEIVE_PHY_PACKETS _IOW('#', 0x16, struct fw_cdev_receive_phy_packets) 420 #define FW_CDEV_IOC_SET_ISO_CHANNELS _IOW('#', 0x17, struct fw_cdev_set_iso_channels) 421 422 /* 423 * ABI version history 424 * 1 (2.6.22) - initial version 425 * (2.6.24) - added %FW_CDEV_IOC_GET_CYCLE_TIMER 426 * 2 (2.6.30) - changed &fw_cdev_event_iso_interrupt.header if 427 * &fw_cdev_create_iso_context.header_size is 8 or more 428 * - added %FW_CDEV_IOC_*_ISO_RESOURCE*, 429 * %FW_CDEV_IOC_GET_SPEED, %FW_CDEV_IOC_SEND_BROADCAST_REQUEST, 430 * %FW_CDEV_IOC_SEND_STREAM_PACKET 431 * (2.6.32) - added time stamp to xmit &fw_cdev_event_iso_interrupt 432 * (2.6.33) - IR has always packet-per-buffer semantics now, not one of 433 * dual-buffer or packet-per-buffer depending on hardware 434 * - shared use and auto-response for FCP registers 435 * 3 (2.6.34) - made &fw_cdev_get_cycle_timer reliable 436 * - added %FW_CDEV_IOC_GET_CYCLE_TIMER2 437 * 4 (2.6.36) - added %FW_CDEV_EVENT_REQUEST2, %FW_CDEV_EVENT_PHY_PACKET_*, 438 * and &fw_cdev_allocate.region_end 439 * - implemented &fw_cdev_event_bus_reset.bm_node_id 440 * - added %FW_CDEV_IOC_SEND_PHY_PACKET, _RECEIVE_PHY_PACKETS 441 * - added %FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL, 442 * %FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL, and 443 * %FW_CDEV_IOC_SET_ISO_CHANNELS 444 */ 445 446 /** 447 * struct fw_cdev_get_info - General purpose information ioctl 448 * @version: The version field is just a running serial number. Both an 449 * input parameter (ABI version implemented by the client) and 450 * output parameter (ABI version implemented by the kernel). 451 * A client shall fill in the ABI @version for which the client 452 * was implemented. This is necessary for forward compatibility. 453 * @rom_length: If @rom is non-zero, up to @rom_length bytes of Configuration 454 * ROM will be copied into that user space address. In either 455 * case, @rom_length is updated with the actual length of the 456 * Configuration ROM. 457 * @rom: If non-zero, address of a buffer to be filled by a copy of the 458 * device's Configuration ROM 459 * @bus_reset: If non-zero, address of a buffer to be filled by a 460 * &struct fw_cdev_event_bus_reset with the current state 461 * of the bus. This does not cause a bus reset to happen. 462 * @bus_reset_closure: Value of &closure in this and subsequent bus reset events 463 * @card: The index of the card this device belongs to 464 * 465 * The %FW_CDEV_IOC_GET_INFO ioctl is usually the very first one which a client 466 * performs right after it opened a /dev/fw* file. 467 * 468 * As a side effect, reception of %FW_CDEV_EVENT_BUS_RESET events to be read(2) 469 * is started by this ioctl. 470 */ 471 struct fw_cdev_get_info { 472 __u32 version; 473 __u32 rom_length; 474 __u64 rom; 475 __u64 bus_reset; 476 __u64 bus_reset_closure; 477 __u32 card; 478 }; 479 480 /** 481 * struct fw_cdev_send_request - Send an asynchronous request packet 482 * @tcode: Transaction code of the request 483 * @length: Length of outgoing payload, in bytes 484 * @offset: 48-bit offset at destination node 485 * @closure: Passed back to userspace in the response event 486 * @data: Userspace pointer to payload 487 * @generation: The bus generation where packet is valid 488 * 489 * Send a request to the device. This ioctl implements all outgoing requests. 490 * Both quadlet and block request specify the payload as a pointer to the data 491 * in the @data field. Once the transaction completes, the kernel writes an 492 * &fw_cdev_event_response event back. The @closure field is passed back to 493 * user space in the response event. 494 */ 495 struct fw_cdev_send_request { 496 __u32 tcode; 497 __u32 length; 498 __u64 offset; 499 __u64 closure; 500 __u64 data; 501 __u32 generation; 502 }; 503 504 /** 505 * struct fw_cdev_send_response - Send an asynchronous response packet 506 * @rcode: Response code as determined by the userspace handler 507 * @length: Length of outgoing payload, in bytes 508 * @data: Userspace pointer to payload 509 * @handle: The handle from the &fw_cdev_event_request 510 * 511 * Send a response to an incoming request. By setting up an address range using 512 * the %FW_CDEV_IOC_ALLOCATE ioctl, userspace can listen for incoming requests. An 513 * incoming request will generate an %FW_CDEV_EVENT_REQUEST, and userspace must 514 * send a reply using this ioctl. The event has a handle to the kernel-side 515 * pending transaction, which should be used with this ioctl. 516 */ 517 struct fw_cdev_send_response { 518 __u32 rcode; 519 __u32 length; 520 __u64 data; 521 __u32 handle; 522 }; 523 524 /** 525 * struct fw_cdev_allocate - Allocate a CSR in an address range 526 * @offset: Start offset of the address range 527 * @closure: To be passed back to userspace in request events 528 * @length: Length of the CSR, in bytes 529 * @handle: Handle to the allocation, written by the kernel 530 * @region_end: First address above the address range (added in ABI v4, 2.6.36) 531 * 532 * Allocate an address range in the 48-bit address space on the local node 533 * (the controller). This allows userspace to listen for requests with an 534 * offset within that address range. Every time when the kernel receives a 535 * request within the range, an &fw_cdev_event_request2 event will be emitted. 536 * (If the kernel or the client implements ABI version <= 3, an 537 * &fw_cdev_event_request will be generated instead.) 538 * 539 * The @closure field is passed back to userspace in these request events. 540 * The @handle field is an out parameter, returning a handle to the allocated 541 * range to be used for later deallocation of the range. 542 * 543 * The address range is allocated on all local nodes. The address allocation 544 * is exclusive except for the FCP command and response registers. If an 545 * exclusive address region is already in use, the ioctl fails with errno set 546 * to %EBUSY. 547 * 548 * If kernel and client implement ABI version >= 4, the kernel looks up a free 549 * spot of size @length inside [@offset..@region_end) and, if found, writes 550 * the start address of the new CSR back in @offset. I.e. @offset is an 551 * in and out parameter. If this automatic placement of a CSR in a bigger 552 * address range is not desired, the client simply needs to set @region_end 553 * = @offset + @length. 554 * 555 * If the kernel or the client implements ABI version <= 3, @region_end is 556 * ignored and effectively assumed to be @offset + @length. 557 * 558 * @region_end is only present in a kernel header >= 2.6.36. If necessary, 559 * this can for example be tested by #ifdef FW_CDEV_EVENT_REQUEST2. 560 */ 561 struct fw_cdev_allocate { 562 __u64 offset; 563 __u64 closure; 564 __u32 length; 565 __u32 handle; 566 __u64 region_end; /* available since kernel version 2.6.36 */ 567 }; 568 569 /** 570 * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource 571 * @handle: Handle to the address range or iso resource, as returned by the 572 * kernel when the range or resource was allocated 573 */ 574 struct fw_cdev_deallocate { 575 __u32 handle; 576 }; 577 578 #define FW_CDEV_LONG_RESET 0 579 #define FW_CDEV_SHORT_RESET 1 580 581 /** 582 * struct fw_cdev_initiate_bus_reset - Initiate a bus reset 583 * @type: %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET 584 * 585 * Initiate a bus reset for the bus this device is on. The bus reset can be 586 * either the original (long) bus reset or the arbitrated (short) bus reset 587 * introduced in 1394a-2000. 588 * 589 * The ioctl returns immediately. A subsequent &fw_cdev_event_bus_reset 590 * indicates when the reset actually happened. Since ABI v4, this may be 591 * considerably later than the ioctl because the kernel ensures a grace period 592 * between subsequent bus resets as per IEEE 1394 bus management specification. 593 */ 594 struct fw_cdev_initiate_bus_reset { 595 __u32 type; 596 }; 597 598 /** 599 * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM 600 * @immediate: If non-zero, immediate key to insert before pointer 601 * @key: Upper 8 bits of root directory pointer 602 * @data: Userspace pointer to contents of descriptor block 603 * @length: Length of descriptor block data, in quadlets 604 * @handle: Handle to the descriptor, written by the kernel 605 * 606 * Add a descriptor block and optionally a preceding immediate key to the local 607 * node's Configuration ROM. 608 * 609 * The @key field specifies the upper 8 bits of the descriptor root directory 610 * pointer and the @data and @length fields specify the contents. The @key 611 * should be of the form 0xXX000000. The offset part of the root directory entry 612 * will be filled in by the kernel. 613 * 614 * If not 0, the @immediate field specifies an immediate key which will be 615 * inserted before the root directory pointer. 616 * 617 * @immediate, @key, and @data array elements are CPU-endian quadlets. 618 * 619 * If successful, the kernel adds the descriptor and writes back a @handle to 620 * the kernel-side object to be used for later removal of the descriptor block 621 * and immediate key. The kernel will also generate a bus reset to signal the 622 * change of the Configuration ROM to other nodes. 623 * 624 * This ioctl affects the Configuration ROMs of all local nodes. 625 * The ioctl only succeeds on device files which represent a local node. 626 */ 627 struct fw_cdev_add_descriptor { 628 __u32 immediate; 629 __u32 key; 630 __u64 data; 631 __u32 length; 632 __u32 handle; 633 }; 634 635 /** 636 * struct fw_cdev_remove_descriptor - Remove contents from the Configuration ROM 637 * @handle: Handle to the descriptor, as returned by the kernel when the 638 * descriptor was added 639 * 640 * Remove a descriptor block and accompanying immediate key from the local 641 * nodes' Configuration ROMs. The kernel will also generate a bus reset to 642 * signal the change of the Configuration ROM to other nodes. 643 */ 644 struct fw_cdev_remove_descriptor { 645 __u32 handle; 646 }; 647 648 #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0 649 #define FW_CDEV_ISO_CONTEXT_RECEIVE 1 650 #define FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2 /* added in 2.6.36 */ 651 652 /** 653 * struct fw_cdev_create_iso_context - Create a context for isochronous I/O 654 * @type: %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE or 655 * %FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL 656 * @header_size: Header size to strip in single-channel reception 657 * @channel: Channel to bind to in single-channel reception or transmission 658 * @speed: Transmission speed 659 * @closure: To be returned in &fw_cdev_event_iso_interrupt or 660 * &fw_cdev_event_iso_interrupt_multichannel 661 * @handle: Handle to context, written back by kernel 662 * 663 * Prior to sending or receiving isochronous I/O, a context must be created. 664 * The context records information about the transmit or receive configuration 665 * and typically maps to an underlying hardware resource. A context is set up 666 * for either sending or receiving. It is bound to a specific isochronous 667 * @channel. 668 * 669 * In case of multichannel reception, @header_size and @channel are ignored 670 * and the channels are selected by %FW_CDEV_IOC_SET_ISO_CHANNELS. 671 * 672 * For %FW_CDEV_ISO_CONTEXT_RECEIVE contexts, @header_size must be at least 4 673 * and must be a multiple of 4. It is ignored in other context types. 674 * 675 * @speed is ignored in receive context types. 676 * 677 * If a context was successfully created, the kernel writes back a handle to the 678 * context, which must be passed in for subsequent operations on that context. 679 * 680 * Limitations: 681 * No more than one iso context can be created per fd. 682 * The total number of contexts that all userspace and kernelspace drivers can 683 * create on a card at a time is a hardware limit, typically 4 or 8 contexts per 684 * direction, and of them at most one multichannel receive context. 685 */ 686 struct fw_cdev_create_iso_context { 687 __u32 type; 688 __u32 header_size; 689 __u32 channel; 690 __u32 speed; 691 __u64 closure; 692 __u32 handle; 693 }; 694 695 /** 696 * struct fw_cdev_set_iso_channels - Select channels in multichannel reception 697 * @channels: Bitmask of channels to listen to 698 * @handle: Handle of the mutichannel receive context 699 * 700 * @channels is the bitwise or of 1ULL << n for each channel n to listen to. 701 * 702 * The ioctl fails with errno %EBUSY if there is already another receive context 703 * on a channel in @channels. In that case, the bitmask of all unoccupied 704 * channels is returned in @channels. 705 */ 706 struct fw_cdev_set_iso_channels { 707 __u64 channels; 708 __u32 handle; 709 }; 710 711 #define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v) 712 #define FW_CDEV_ISO_INTERRUPT (1 << 16) 713 #define FW_CDEV_ISO_SKIP (1 << 17) 714 #define FW_CDEV_ISO_SYNC (1 << 17) 715 #define FW_CDEV_ISO_TAG(v) ((v) << 18) 716 #define FW_CDEV_ISO_SY(v) ((v) << 20) 717 #define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24) 718 719 /** 720 * struct fw_cdev_iso_packet - Isochronous packet 721 * @control: Contains the header length (8 uppermost bits), 722 * the sy field (4 bits), the tag field (2 bits), a sync flag 723 * or a skip flag (1 bit), an interrupt flag (1 bit), and the 724 * payload length (16 lowermost bits) 725 * @header: Header and payload in case of a transmit context. 726 * 727 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues. 728 * Use the FW_CDEV_ISO_ macros to fill in @control. 729 * The @header array is empty in case of receive contexts. 730 * 731 * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT: 732 * 733 * @control.HEADER_LENGTH must be a multiple of 4. It specifies the numbers of 734 * bytes in @header that will be prepended to the packet's payload. These bytes 735 * are copied into the kernel and will not be accessed after the ioctl has 736 * returned. 737 * 738 * The @control.SY and TAG fields are copied to the iso packet header. These 739 * fields are specified by IEEE 1394a and IEC 61883-1. 740 * 741 * The @control.SKIP flag specifies that no packet is to be sent in a frame. 742 * When using this, all other fields except @control.INTERRUPT must be zero. 743 * 744 * When a packet with the @control.INTERRUPT flag set has been completed, an 745 * &fw_cdev_event_iso_interrupt event will be sent. 746 * 747 * Context type %FW_CDEV_ISO_CONTEXT_RECEIVE: 748 * 749 * @control.HEADER_LENGTH must be a multiple of the context's header_size. 750 * If the HEADER_LENGTH is larger than the context's header_size, multiple 751 * packets are queued for this entry. 752 * 753 * The @control.SY and TAG fields are ignored. 754 * 755 * If the @control.SYNC flag is set, the context drops all packets until a 756 * packet with a sy field is received which matches &fw_cdev_start_iso.sync. 757 * 758 * @control.PAYLOAD_LENGTH defines how many payload bytes can be received for 759 * one packet (in addition to payload quadlets that have been defined as headers 760 * and are stripped and returned in the &fw_cdev_event_iso_interrupt structure). 761 * If more bytes are received, the additional bytes are dropped. If less bytes 762 * are received, the remaining bytes in this part of the payload buffer will not 763 * be written to, not even by the next packet. I.e., packets received in 764 * consecutive frames will not necessarily be consecutive in memory. If an 765 * entry has queued multiple packets, the PAYLOAD_LENGTH is divided equally 766 * among them. 767 * 768 * When a packet with the @control.INTERRUPT flag set has been completed, an 769 * &fw_cdev_event_iso_interrupt event will be sent. An entry that has queued 770 * multiple receive packets is completed when its last packet is completed. 771 * 772 * Context type %FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL: 773 * 774 * Here, &fw_cdev_iso_packet would be more aptly named _iso_buffer_chunk since 775 * it specifies a chunk of the mmap()'ed buffer, while the number and alignment 776 * of packets to be placed into the buffer chunk is not known beforehand. 777 * 778 * @control.PAYLOAD_LENGTH is the size of the buffer chunk and specifies room 779 * for header, payload, padding, and trailer bytes of one or more packets. 780 * It must be a multiple of 4. 781 * 782 * @control.HEADER_LENGTH, TAG and SY are ignored. SYNC is treated as described 783 * for single-channel reception. 784 * 785 * When a buffer chunk with the @control.INTERRUPT flag set has been filled 786 * entirely, an &fw_cdev_event_iso_interrupt_mc event will be sent. 787 */ 788 struct fw_cdev_iso_packet { 789 __u32 control; 790 __u32 header[0]; 791 }; 792 793 /** 794 * struct fw_cdev_queue_iso - Queue isochronous packets for I/O 795 * @packets: Userspace pointer to an array of &fw_cdev_iso_packet 796 * @data: Pointer into mmap()'ed payload buffer 797 * @size: Size of the @packets array, in bytes 798 * @handle: Isochronous context handle 799 * 800 * Queue a number of isochronous packets for reception or transmission. 801 * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs, 802 * which describe how to transmit from or receive into a contiguous region 803 * of a mmap()'ed payload buffer. As part of transmit packet descriptors, 804 * a series of headers can be supplied, which will be prepended to the 805 * payload during DMA. 806 * 807 * The kernel may or may not queue all packets, but will write back updated 808 * values of the @packets, @data and @size fields, so the ioctl can be 809 * resubmitted easily. 810 * 811 * In case of a multichannel receive context, @data must be quadlet-aligned 812 * relative to the buffer start. 813 */ 814 struct fw_cdev_queue_iso { 815 __u64 packets; 816 __u64 data; 817 __u32 size; 818 __u32 handle; 819 }; 820 821 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1 822 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2 823 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4 824 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8 825 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15 826 827 /** 828 * struct fw_cdev_start_iso - Start an isochronous transmission or reception 829 * @cycle: Cycle in which to start I/O. If @cycle is greater than or 830 * equal to 0, the I/O will start on that cycle. 831 * @sync: Determines the value to wait for for receive packets that have 832 * the %FW_CDEV_ISO_SYNC bit set 833 * @tags: Tag filter bit mask. Only valid for isochronous reception. 834 * Determines the tag values for which packets will be accepted. 835 * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags. 836 * @handle: Isochronous context handle within which to transmit or receive 837 */ 838 struct fw_cdev_start_iso { 839 __s32 cycle; 840 __u32 sync; 841 __u32 tags; 842 __u32 handle; 843 }; 844 845 /** 846 * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception 847 * @handle: Handle of isochronous context to stop 848 */ 849 struct fw_cdev_stop_iso { 850 __u32 handle; 851 }; 852 853 /** 854 * struct fw_cdev_get_cycle_timer - read cycle timer register 855 * @local_time: system time, in microseconds since the Epoch 856 * @cycle_timer: Cycle Time register contents 857 * 858 * Same as %FW_CDEV_IOC_GET_CYCLE_TIMER2, but fixed to use %CLOCK_REALTIME 859 * and only with microseconds resolution. 860 * 861 * In version 1 and 2 of the ABI, this ioctl returned unreliable (non- 862 * monotonic) @cycle_timer values on certain controllers. 863 */ 864 struct fw_cdev_get_cycle_timer { 865 __u64 local_time; 866 __u32 cycle_timer; 867 }; 868 869 /** 870 * struct fw_cdev_get_cycle_timer2 - read cycle timer register 871 * @tv_sec: system time, seconds 872 * @tv_nsec: system time, sub-seconds part in nanoseconds 873 * @clk_id: input parameter, clock from which to get the system time 874 * @cycle_timer: Cycle Time register contents 875 * 876 * The %FW_CDEV_IOC_GET_CYCLE_TIMER2 ioctl reads the isochronous cycle timer 877 * and also the system clock. This allows to correlate reception time of 878 * isochronous packets with system time. 879 * 880 * @clk_id lets you choose a clock like with POSIX' clock_gettime function. 881 * Supported @clk_id values are POSIX' %CLOCK_REALTIME and %CLOCK_MONOTONIC 882 * and Linux' %CLOCK_MONOTONIC_RAW. 883 * 884 * @cycle_timer consists of 7 bits cycleSeconds, 13 bits cycleCount, and 885 * 12 bits cycleOffset, in host byte order. Cf. the Cycle Time register 886 * per IEEE 1394 or Isochronous Cycle Timer register per OHCI-1394. 887 */ 888 struct fw_cdev_get_cycle_timer2 { 889 __s64 tv_sec; 890 __s32 tv_nsec; 891 __s32 clk_id; 892 __u32 cycle_timer; 893 }; 894 895 /** 896 * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth 897 * @closure: Passed back to userspace in corresponding iso resource events 898 * @channels: Isochronous channels of which one is to be (de)allocated 899 * @bandwidth: Isochronous bandwidth units to be (de)allocated 900 * @handle: Handle to the allocation, written by the kernel (only valid in 901 * case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls) 902 * 903 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an 904 * isochronous channel and/or of isochronous bandwidth at the isochronous 905 * resource manager (IRM). Only one of the channels specified in @channels is 906 * allocated. An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after 907 * communication with the IRM, indicating success or failure in the event data. 908 * The kernel will automatically reallocate the resources after bus resets. 909 * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event 910 * will be sent. The kernel will also automatically deallocate the resources 911 * when the file descriptor is closed. 912 * 913 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate 914 * deallocation of resources which were allocated as described above. 915 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation. 916 * 917 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation 918 * without automatic re- or deallocation. 919 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation, 920 * indicating success or failure in its data. 921 * 922 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like 923 * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed 924 * instead of allocated. 925 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation. 926 * 927 * To summarize, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE allocates iso resources 928 * for the lifetime of the fd or @handle. 929 * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources 930 * for the duration of a bus generation. 931 * 932 * @channels is a host-endian bitfield with the least significant bit 933 * representing channel 0 and the most significant bit representing channel 63: 934 * 1ULL << c for each channel c that is a candidate for (de)allocation. 935 * 936 * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send 937 * one quadlet of data (payload or header data) at speed S1600. 938 */ 939 struct fw_cdev_allocate_iso_resource { 940 __u64 closure; 941 __u64 channels; 942 __u32 bandwidth; 943 __u32 handle; 944 }; 945 946 /** 947 * struct fw_cdev_send_stream_packet - send an asynchronous stream packet 948 * @length: Length of outgoing payload, in bytes 949 * @tag: Data format tag 950 * @channel: Isochronous channel to transmit to 951 * @sy: Synchronization code 952 * @closure: Passed back to userspace in the response event 953 * @data: Userspace pointer to payload 954 * @generation: The bus generation where packet is valid 955 * @speed: Speed to transmit at 956 * 957 * The %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl sends an asynchronous stream packet 958 * to every device which is listening to the specified channel. The kernel 959 * writes an &fw_cdev_event_response event which indicates success or failure of 960 * the transmission. 961 */ 962 struct fw_cdev_send_stream_packet { 963 __u32 length; 964 __u32 tag; 965 __u32 channel; 966 __u32 sy; 967 __u64 closure; 968 __u64 data; 969 __u32 generation; 970 __u32 speed; 971 }; 972 973 /** 974 * struct fw_cdev_send_phy_packet - send a PHY packet 975 * @closure: Passed back to userspace in the PHY-packet-sent event 976 * @data: First and second quadlet of the PHY packet 977 * @generation: The bus generation where packet is valid 978 * 979 * The %FW_CDEV_IOC_SEND_PHY_PACKET ioctl sends a PHY packet to all nodes 980 * on the same card as this device. After transmission, an 981 * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated. 982 * 983 * The payload @data[] shall be specified in host byte order. Usually, 984 * @data[1] needs to be the bitwise inverse of @data[0]. VersaPHY packets 985 * are an exception to this rule. 986 * 987 * The ioctl is only permitted on device files which represent a local node. 988 */ 989 struct fw_cdev_send_phy_packet { 990 __u64 closure; 991 __u32 data[2]; 992 __u32 generation; 993 }; 994 995 /** 996 * struct fw_cdev_receive_phy_packets - start reception of PHY packets 997 * @closure: Passed back to userspace in phy packet events 998 * 999 * This ioctl activates issuing of %FW_CDEV_EVENT_PHY_PACKET_RECEIVED due to 1000 * incoming PHY packets from any node on the same bus as the device. 1001 * 1002 * The ioctl is only permitted on device files which represent a local node. 1003 */ 1004 struct fw_cdev_receive_phy_packets { 1005 __u64 closure; 1006 }; 1007 1008 #define FW_CDEV_VERSION 3 /* Meaningless legacy macro; don't use it. */ 1009 1010 #endif /* _LINUX_FIREWIRE_CDEV_H */ 1011
