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