include/linux/firewire-cdev.h

   1 /*
   2  * Char device interface.
   3  *
   4  * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef _LINUX_FIREWIRE_CDEV_H
  22 #define _LINUX_FIREWIRE_CDEV_H
  23
  24 #include <linux/ioctl.h>
  25 #include <linux/types.h>
  26 #include <linux/firewire-constants.h>
  27
  28 #define FW_CDEV_EVENT_BUS_RESET                 0x00
  29 #define FW_CDEV_EVENT_RESPONSE                  0x01
  30 #define FW_CDEV_EVENT_REQUEST                   0x02
  31 #define FW_CDEV_EVENT_ISO_INTERRUPT             0x03
  32 #define FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED    0x04
  33 #define FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED  0x05
  34
  35 /**
  36  * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types
  37  * @closure:    For arbitrary use by userspace
  38  * @type:       Discriminates the fw_cdev_event_ types
  39  *
  40  * This struct may be used to access generic members of all fw_cdev_event_
  41  * types regardless of the specific type.
  42  *
  43  * Data passed in the @closure field for a request will be returned in the
  44  * corresponding event.  It is big enough to hold a pointer on all platforms.
  45  * The ioctl used to set @closure depends on the @type of event.
  46  */
  47 struct fw_cdev_event_common {
  48         __u64 closure;
  49         __u32 type;
  50 };
  51
  52 /**
  53  * struct fw_cdev_event_bus_reset - Sent when a bus reset occurred
  54  * @closure:    See &fw_cdev_event_common; set by %FW_CDEV_IOC_GET_INFO ioctl
  55  * @type:       See &fw_cdev_event_common; always %FW_CDEV_EVENT_BUS_RESET
  56  * @node_id:       New node ID of this node
  57  * @local_node_id: Node ID of the local node, i.e. of the controller
  58  * @bm_node_id:    Node ID of the bus manager
  59  * @irm_node_id:   Node ID of the iso resource manager
  60  * @root_node_id:  Node ID of the root node
  61  * @generation:    New bus generation
  62  *
  63  * This event is sent when the bus the device belongs to goes through a bus
  64  * reset.  It provides information about the new bus configuration, such as
  65  * new node ID for this device, new root ID, and others.
  66  */
  67 struct fw_cdev_event_bus_reset {
  68         __u64 closure;
  69         __u32 type;
  70         __u32 node_id;
  71         __u32 local_node_id;
  72         __u32 bm_node_id;
  73         __u32 irm_node_id;
  74         __u32 root_node_id;
  75         __u32 generation;
  76 };
  77
  78 /**
  79  * struct fw_cdev_event_response - Sent when a response packet was received
  80  * @closure:    See &fw_cdev_event_common;
  81  *              set by %FW_CDEV_IOC_SEND_REQUEST ioctl
  82  * @type:       See &fw_cdev_event_common; always %FW_CDEV_EVENT_RESPONSE
  83  * @rcode:      Response code returned by the remote node
  84  * @length:     Data length, i.e. the response's payload size in bytes
  85  * @data:       Payload data, if any
  86  *
  87  * This event is sent when the stack receives a response to an outgoing request
  88  * sent by %FW_CDEV_IOC_SEND_REQUEST ioctl.  The payload data for responses
  89  * carrying data (read and lock responses) follows immediately and can be
  90  * accessed through the @data field.
  91  */
  92 struct fw_cdev_event_response {
  93         __u64 closure;
  94         __u32 type;
  95         __u32 rcode;
  96         __u32 length;
  97         __u32 data[0];
  98 };
  99
 100 /**
 101  * struct fw_cdev_event_request - Sent on incoming request to an address region
 102  * @closure:    See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl
 103  * @type:       See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST
 104  * @tcode:      Transaction code of the incoming request
 105  * @offset:     The offset into the 48-bit per-node address space
 106  * @handle:     Reference to the kernel-side pending request
 107  * @length:     Data length, i.e. the request's payload size in bytes
 108  * @data:       Incoming data, if any
 109  *
 110  * This event is sent when the stack receives an incoming request to an address
 111  * region registered using the %FW_CDEV_IOC_ALLOCATE ioctl.  The request is
 112  * guaranteed to be completely contained in the specified region.  Userspace is
 113  * responsible for sending the response by %FW_CDEV_IOC_SEND_RESPONSE ioctl,
 114  * using the same @handle.
 115  *
 116  * The payload data for requests carrying data (write and lock requests)
 117  * follows immediately and can be accessed through the @data field.
 118  */
 119 struct fw_cdev_event_request {
 120         __u64 closure;
 121         __u32 type;
 122         __u32 tcode;
 123         __u64 offset;
 124         __u32 handle;
 125         __u32 length;
 126         __u32 data[0];
 127 };
 128
 129 /**
 130  * struct fw_cdev_event_iso_interrupt - Sent when an iso packet was completed
 131  * @closure:    See &fw_cdev_event_common;
 132  *              set by %FW_CDEV_CREATE_ISO_CONTEXT ioctl
 133  * @type:       See &fw_cdev_event_common; always %FW_CDEV_EVENT_ISO_INTERRUPT
 134  * @cycle:      Cycle counter of the interrupt packet
 135  * @header_length: Total length of following headers, in bytes
 136  * @header:     Stripped headers, if any
 137  *
 138  * This event is sent when the controller has completed an &fw_cdev_iso_packet
 139  * with the %FW_CDEV_ISO_INTERRUPT bit set.  In the receive case, the headers
 140  * stripped of all packets up until and including the interrupt packet are
 141  * returned in the @header field.
 142  */
 143 struct fw_cdev_event_iso_interrupt {
 144         __u64 closure;
 145         __u32 type;
 146         __u32 cycle;
 147         __u32 header_length;
 148         __u32 header[0];
 149 };
 150
 151 /**
 152  * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
 153  * @closure:    See &fw_cdev_event_common;
 154  *              set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
 155  * @type:       %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
 156  *              %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
 157  * @handle:     Reference by which an allocated resource can be deallocated
 158  * @channel:    Isochronous channel which was (de)allocated, if any
 159  * @bandwidth:  Bandwidth allocation units which were (de)allocated, if any
 160  * @channels_available:  Last known availability of channels
 161  * @bandwidth_available: Last known availability of bandwidth
 162  *
 163  * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event is sent after an isochronous
 164  * resource was allocated at the IRM.  The client has to check @channel and
 165  * @bandwidth for whether the allocation actually succeeded.
 166  *
 167  * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event is sent after an isochronous
 168  * resource was deallocated at the IRM.  It is also sent when automatic
 169  * reallocation after a bus reset failed.
 170  *
 171  * @channel is <0 if no channel was (de)allocated or if reallocation failed.
 172  * @bandwidth is 0 if no bandwidth was (de)allocated or if reallocation failed.
 173  */
 174 struct fw_cdev_event_iso_resource {
 175         __u64 closure;
 176         __u32 type;
 177         __u32 handle;
 178         __s32 channel;
 179         __s32 bandwidth;
 180 };
 181
 182 /**
 183  * union fw_cdev_event - Convenience union of fw_cdev_event_ types
 184  * @common:        Valid for all types
 185  * @bus_reset:     Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
 186  * @response:      Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
 187  * @request:       Valid if @common.type == %FW_CDEV_EVENT_REQUEST
 188  * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT
 189  * @iso_resource:  Valid if @common.type ==
 190  *                              %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
 191  *                              %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
 192  *
 193  * Convenience union for userspace use.  Events could be read(2) into an
 194  * appropriately aligned char buffer and then cast to this union for further
 195  * processing.  Note that for a request, response or iso_interrupt event,
 196  * the data[] or header[] may make the size of the full event larger than
 197  * sizeof(union fw_cdev_event).  Also note that if you attempt to read(2)
 198  * an event into a buffer that is not large enough for it, the data that does
 199  * not fit will be discarded so that the next read(2) will return a new event.
 200  */
 201 union fw_cdev_event {
 202         struct fw_cdev_event_common             common;
 203         struct fw_cdev_event_bus_reset          bus_reset;
 204         struct fw_cdev_event_response           response;
 205         struct fw_cdev_event_request            request;
 206         struct fw_cdev_event_iso_interrupt      iso_interrupt;
 207         struct fw_cdev_event_iso_resource       iso_resource;
 208 };
 209
 210 /* available since kernel version 2.6.22 */
 211 #define FW_CDEV_IOC_GET_INFO            _IOWR('#', 0x00, struct fw_cdev_get_info)
 212 #define FW_CDEV_IOC_SEND_REQUEST        _IOW('#', 0x01, struct fw_cdev_send_request)
 213 #define FW_CDEV_IOC_ALLOCATE            _IOWR('#', 0x02, struct fw_cdev_allocate)
 214 #define FW_CDEV_IOC_DEALLOCATE          _IOW('#', 0x03, struct fw_cdev_deallocate)
 215 #define FW_CDEV_IOC_SEND_RESPONSE       _IOW('#', 0x04, struct fw_cdev_send_response)
 216 #define FW_CDEV_IOC_INITIATE_BUS_RESET  _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
 217 #define FW_CDEV_IOC_ADD_DESCRIPTOR      _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
 218 #define FW_CDEV_IOC_REMOVE_DESCRIPTOR   _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
 219 #define FW_CDEV_IOC_CREATE_ISO_CONTEXT  _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
 220 #define FW_CDEV_IOC_QUEUE_ISO           _IOWR('#', 0x09, struct fw_cdev_queue_iso)
 221 #define FW_CDEV_IOC_START_ISO           _IOW('#', 0x0a, struct fw_cdev_start_iso)
 222 #define FW_CDEV_IOC_STOP_ISO            _IOW('#', 0x0b, struct fw_cdev_stop_iso)
 223
 224 /* available since kernel version 2.6.24 */
 225 #define FW_CDEV_IOC_GET_CYCLE_TIMER     _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer)
 226
 227 /* available since kernel version 2.6.30 */
 228 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE       _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource)
 229 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE      _IOW('#', 0x0e, struct fw_cdev_deallocate)
 230 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE   _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource)
 231 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource)
 232
 233 /* FW_CDEV_VERSION History
 234  *
 235  * 1    Feb 18, 2007:  Initial version.
 236  */
 237 #define FW_CDEV_VERSION         1
 238
 239 /**
 240  * struct fw_cdev_get_info - General purpose information ioctl
 241  * @version:    The version field is just a running serial number.
 242  *              We never break backwards compatibility, but may add more
 243  *              structs and ioctls in later revisions.
 244  * @rom_length: If @rom is non-zero, at most rom_length bytes of configuration
 245  *              ROM will be copied into that user space address.  In either
 246  *              case, @rom_length is updated with the actual length of the
 247  *              configuration ROM.
 248  * @rom:        If non-zero, address of a buffer to be filled by a copy of the
 249  *              device's configuration ROM
 250  * @bus_reset:  If non-zero, address of a buffer to be filled by a
 251  *              &struct fw_cdev_event_bus_reset with the current state
 252  *              of the bus.  This does not cause a bus reset to happen.
 253  * @bus_reset_closure: Value of &closure in this and subsequent bus reset events
 254  * @card:       The index of the card this device belongs to
 255  */
 256 struct fw_cdev_get_info {
 257         __u32 version;
 258         __u32 rom_length;
 259         __u64 rom;
 260         __u64 bus_reset;
 261         __u64 bus_reset_closure;
 262         __u32 card;
 263 };
 264
 265 /**
 266  * struct fw_cdev_send_request - Send an asynchronous request packet
 267  * @tcode:      Transaction code of the request
 268  * @length:     Length of outgoing payload, in bytes
 269  * @offset:     48-bit offset at destination node
 270  * @closure:    Passed back to userspace in the response event
 271  * @data:       Userspace pointer to payload
 272  * @generation: The bus generation where packet is valid
 273  *
 274  * Send a request to the device.  This ioctl implements all outgoing requests.
 275  * Both quadlet and block request specify the payload as a pointer to the data
 276  * in the @data field.  Once the transaction completes, the kernel writes an
 277  * &fw_cdev_event_response event back.  The @closure field is passed back to
 278  * user space in the response event.
 279  */
 280 struct fw_cdev_send_request {
 281         __u32 tcode;
 282         __u32 length;
 283         __u64 offset;
 284         __u64 closure;
 285         __u64 data;
 286         __u32 generation;
 287 };
 288
 289 /**
 290  * struct fw_cdev_send_response - Send an asynchronous response packet
 291  * @rcode:      Response code as determined by the userspace handler
 292  * @length:     Length of outgoing payload, in bytes
 293  * @data:       Userspace pointer to payload
 294  * @handle:     The handle from the &fw_cdev_event_request
 295  *
 296  * Send a response to an incoming request.  By setting up an address range using
 297  * the %FW_CDEV_IOC_ALLOCATE ioctl, userspace can listen for incoming requests.  An
 298  * incoming request will generate an %FW_CDEV_EVENT_REQUEST, and userspace must
 299  * send a reply using this ioctl.  The event has a handle to the kernel-side
 300  * pending transaction, which should be used with this ioctl.
 301  */
 302 struct fw_cdev_send_response {
 303         __u32 rcode;
 304         __u32 length;
 305         __u64 data;
 306         __u32 handle;
 307 };
 308
 309 /**
 310  * struct fw_cdev_allocate - Allocate a CSR address range
 311  * @offset:     Start offset of the address range
 312  * @closure:    To be passed back to userspace in request events
 313  * @length:     Length of the address range, in bytes
 314  * @handle:     Handle to the allocation, written by the kernel
 315  *
 316  * Allocate an address range in the 48-bit address space on the local node
 317  * (the controller).  This allows userspace to listen for requests with an
 318  * offset within that address range.  When the kernel receives a request
 319  * within the range, an &fw_cdev_event_request event will be written back.
 320  * The @closure field is passed back to userspace in the response event.
 321  * The @handle field is an out parameter, returning a handle to the allocated
 322  * range to be used for later deallocation of the range.
 323  */
 324 struct fw_cdev_allocate {
 325         __u64 offset;
 326         __u64 closure;
 327         __u32 length;
 328         __u32 handle;
 329 };
 330
 331 /**
 332  * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource
 333  * @handle:     Handle to the address range or iso resource, as returned by the
 334  *              kernel when the range or resource was allocated
 335  */
 336 struct fw_cdev_deallocate {
 337         __u32 handle;
 338 };
 339
 340 #define FW_CDEV_LONG_RESET      0
 341 #define FW_CDEV_SHORT_RESET     1
 342
 343 /**
 344  * struct fw_cdev_initiate_bus_reset - Initiate a bus reset
 345  * @type:       %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET
 346  *
 347  * Initiate a bus reset for the bus this device is on.  The bus reset can be
 348  * either the original (long) bus reset or the arbitrated (short) bus reset
 349  * introduced in 1394a-2000.
 350  */
 351 struct fw_cdev_initiate_bus_reset {
 352         __u32 type;     /* FW_CDEV_SHORT_RESET or FW_CDEV_LONG_RESET */
 353 };
 354
 355 /**
 356  * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM
 357  * @immediate:  If non-zero, immediate key to insert before pointer
 358  * @key:        Upper 8 bits of root directory pointer
 359  * @data:       Userspace pointer to contents of descriptor block
 360  * @length:     Length of descriptor block data, in bytes
 361  * @handle:     Handle to the descriptor, written by the kernel
 362  *
 363  * Add a descriptor block and optionally a preceding immediate key to the local
 364  * node's configuration ROM.
 365  *
 366  * The @key field specifies the upper 8 bits of the descriptor root directory
 367  * pointer and the @data and @length fields specify the contents. The @key
 368  * should be of the form 0xXX000000. The offset part of the root directory entry
 369  * will be filled in by the kernel.
 370  *
 371  * If not 0, the @immediate field specifies an immediate key which will be
 372  * inserted before the root directory pointer.
 373  *
 374  * If successful, the kernel adds the descriptor and writes back a handle to the
 375  * kernel-side object to be used for later removal of the descriptor block and
 376  * immediate key.
 377  */
 378 struct fw_cdev_add_descriptor {
 379         __u32 immediate;
 380         __u32 key;
 381         __u64 data;
 382         __u32 length;
 383         __u32 handle;
 384 };
 385
 386 /**
 387  * struct fw_cdev_remove_descriptor - Remove contents from the configuration ROM
 388  * @handle:     Handle to the descriptor, as returned by the kernel when the
 389  *              descriptor was added
 390  *
 391  * Remove a descriptor block and accompanying immediate key from the local
 392  * node's configuration ROM.
 393  */
 394 struct fw_cdev_remove_descriptor {
 395         __u32 handle;
 396 };
 397
 398 #define FW_CDEV_ISO_CONTEXT_TRANSMIT    0
 399 #define FW_CDEV_ISO_CONTEXT_RECEIVE     1
 400
 401 /**
 402  * struct fw_cdev_create_iso_context - Create a context for isochronous IO
 403  * @type:       %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE
 404  * @header_size: Header size to strip for receive contexts
 405  * @channel:    Channel to bind to
 406  * @speed:      Speed to transmit at
 407  * @closure:    To be returned in &fw_cdev_event_iso_interrupt
 408  * @handle:     Handle to context, written back by kernel
 409  *
 410  * Prior to sending or receiving isochronous I/O, a context must be created.
 411  * The context records information about the transmit or receive configuration
 412  * and typically maps to an underlying hardware resource.  A context is set up
 413  * for either sending or receiving.  It is bound to a specific isochronous
 414  * channel.
 415  *
 416  * If a context was successfully created, the kernel writes back a handle to the
 417  * context, which must be passed in for subsequent operations on that context.
 418  */
 419 struct fw_cdev_create_iso_context {
 420         __u32 type;
 421         __u32 header_size;
 422         __u32 channel;
 423         __u32 speed;
 424         __u64 closure;
 425         __u32 handle;
 426 };
 427
 428 #define FW_CDEV_ISO_PAYLOAD_LENGTH(v)   (v)
 429 #define FW_CDEV_ISO_INTERRUPT           (1 << 16)
 430 #define FW_CDEV_ISO_SKIP                (1 << 17)
 431 #define FW_CDEV_ISO_SYNC                (1 << 17)
 432 #define FW_CDEV_ISO_TAG(v)              ((v) << 18)
 433 #define FW_CDEV_ISO_SY(v)               ((v) << 20)
 434 #define FW_CDEV_ISO_HEADER_LENGTH(v)    ((v) << 24)
 435
 436 /**
 437  * struct fw_cdev_iso_packet - Isochronous packet
 438  * @control:    Contains the header length (8 uppermost bits), the sy field
 439  *              (4 bits), the tag field (2 bits), a sync flag (1 bit),
 440  *              a skip flag (1 bit), an interrupt flag (1 bit), and the
 441  *              payload length (16 lowermost bits)
 442  * @header:     Header and payload
 443  *
 444  * &struct fw_cdev_iso_packet is used to describe isochronous packet queues.
 445  *
 446  * Use the FW_CDEV_ISO_ macros to fill in @control.  The sy and tag fields are
 447  * specified by IEEE 1394a and IEC 61883.
 448  *
 449  * FIXME - finish this documentation
 450  */
 451 struct fw_cdev_iso_packet {
 452         __u32 control;
 453         __u32 header[0];
 454 };
 455
 456 /**
 457  * struct fw_cdev_queue_iso - Queue isochronous packets for I/O
 458  * @packets:    Userspace pointer to packet data
 459  * @data:       Pointer into mmap()'ed payload buffer
 460  * @size:       Size of packet data in bytes
 461  * @handle:     Isochronous context handle
 462  *
 463  * Queue a number of isochronous packets for reception or transmission.
 464  * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs,
 465  * which describe how to transmit from or receive into a contiguous region
 466  * of a mmap()'ed payload buffer.  As part of the packet descriptors,
 467  * a series of headers can be supplied, which will be prepended to the
 468  * payload during DMA.
 469  *
 470  * The kernel may or may not queue all packets, but will write back updated
 471  * values of the @packets, @data and @size fields, so the ioctl can be
 472  * resubmitted easily.
 473  */
 474 struct fw_cdev_queue_iso {
 475         __u64 packets;
 476         __u64 data;
 477         __u32 size;
 478         __u32 handle;
 479 };
 480
 481 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0           1
 482 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1           2
 483 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2           4
 484 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3           8
 485 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS      15
 486
 487 /**
 488  * struct fw_cdev_start_iso - Start an isochronous transmission or reception
 489  * @cycle:      Cycle in which to start I/O.  If @cycle is greater than or
 490  *              equal to 0, the I/O will start on that cycle.
 491  * @sync:       Determines the value to wait for for receive packets that have
 492  *              the %FW_CDEV_ISO_SYNC bit set
 493  * @tags:       Tag filter bit mask.  Only valid for isochronous reception.
 494  *              Determines the tag values for which packets will be accepted.
 495  *              Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags.
 496  * @handle:     Isochronous context handle within which to transmit or receive
 497  */
 498 struct fw_cdev_start_iso {
 499         __s32 cycle;
 500         __u32 sync;
 501         __u32 tags;
 502         __u32 handle;
 503 };
 504
 505 /**
 506  * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception
 507  * @handle:     Handle of isochronous context to stop
 508  */
 509 struct fw_cdev_stop_iso {
 510         __u32 handle;
 511 };
 512
 513 /**
 514  * struct fw_cdev_get_cycle_timer - read cycle timer register
 515  * @local_time:   system time, in microseconds since the Epoch
 516  * @cycle_timer:  isochronous cycle timer, as per OHCI 1.1 clause 5.13
 517  *
 518  * The %FW_CDEV_IOC_GET_CYCLE_TIMER ioctl reads the isochronous cycle timer
 519  * and also the system clock.  This allows to express the receive time of an
 520  * isochronous packet as a system time with microsecond accuracy.
 521  */
 522 struct fw_cdev_get_cycle_timer {
 523         __u64 local_time;
 524         __u32 cycle_timer;
 525 };
 526
 527 /**
 528  * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth
 529  * @closure:    Passed back to userspace in correponding iso resource events
 530  * @channels:   Isochronous channels of which one is to be (de)allocated
 531  * @bandwidth:  Isochronous bandwidth units to be (de)allocated
 532  * @handle:     Handle to the allocation, written by the kernel (only valid in
 533  *              case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls)
 534  *
 535  * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an
 536  * isochronous channel and/or of isochronous bandwidth at the isochronous
 537  * resource manager (IRM).  Only one of the channels specified in @channels is
 538  * allocated.  An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after
 539  * communication with the IRM, indicating success or failure in the event data.
 540  * The kernel will automatically reallocate the resources after bus resets.
 541  * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event
 542  * will be sent.  The kernel will also automatically deallocate the resources
 543  * when the file descriptor is closed.
 544  *
 545  * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate
 546  * deallocation of resources which were allocated as described above.
 547  * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
 548  *
 549  * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation
 550  * without automatic re- or deallocation.
 551  * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation,
 552  * indicating success or failure in its data.
 553  *
 554  * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like
 555  * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed
 556  * instead of allocated.  At most one channel may be specified in this ioctl.
 557  * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
 558  *
 559  * To summarize, %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE allocates iso resources
 560  * for the lifetime of the fd or handle.
 561  * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources
 562  * for the duration of a bus generation.
 563  *
 564  * @channels is a host-endian bitfield with the most significant bit
 565  * representing channel 0 and the least significant bit representing channel 63:
 566  * 1ULL << (63 - c)
 567  *
 568  * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send
 569  * one quadlet of data (payload or header data) at speed S1600.
 570  */
 571 struct fw_cdev_allocate_iso_resource {
 572         __u64 closure;
 573         __u64 channels;
 574         __u32 bandwidth;
 575         __u32 handle;
 576 };
 577
 578 #endif /* _LINUX_FIREWIRE_CDEV_H */