| blob | 011fdf1eaec5e533cfff7ecc0f563419d7b78654 |
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 */
21 #ifndef _LINUX_FIREWIRE_CDEV_H
22 #define _LINUX_FIREWIRE_CDEV_H
24 #include <linux/ioctl.h>
25 #include <linux/types.h>
26 #include <linux/firewire-constants.h>
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
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 */
48 __u64 closure;
49 __u32 type;
50 };
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 */
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 };
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 */
93 __u64 closure;
94 __u32 type;
95 __u32 rcode;
96 __u32 length;
98 };
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 */
120 __u64 closure;
121 __u32 type;
122 __u32 tcode;
123 __u64 offset;
124 __u32 handle;
125 __u32 length;
127 };
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. The amount of header data per packet is as
142 * specified at iso context creation by &fw_cdev_create_iso_context.header_size.
143 *
144 * In version 1 of this ABI, header data consisted of the 1394 isochronous
145 * packet header, followed by quadlets from the packet payload if
146 * &fw_cdev_create_iso_context.header_size > 4.
147 *
148 * In version 2 of this ABI, header data consist of the 1394 isochronous
149 * packet header, followed by a timestamp quadlet if
150 * &fw_cdev_create_iso_context.header_size > 4, followed by quadlets from the
151 * packet payload if &fw_cdev_create_iso_context.header_size > 8.
152 *
153 * Behaviour of ver. 1 of this ABI is no longer available since ABI ver. 2.
154 *
155 * Format of 1394 iso packet header: 16 bits len, 2 bits tag, 6 bits channel,
156 * 4 bits tcode, 4 bits sy, in big endian byte order. Format of timestamp:
157 * 16 bits invalid, 3 bits cycleSeconds, 13 bits cycleCount, in big endian byte
158 * order.
159 */
161 __u64 closure;
162 __u32 type;
163 __u32 cycle;
164 __u32 header_length;
166 };
168 /**
169 * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
170 * @closure: See &fw_cdev_event_common;
171 * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
172 * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
173 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
174 * @handle: Reference by which an allocated resource can be deallocated
175 * @channel: Isochronous channel which was (de)allocated, if any
176 * @bandwidth: Bandwidth allocation units which were (de)allocated, if any
177 *
178 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event is sent after an isochronous
179 * resource was allocated at the IRM. The client has to check @channel and
180 * @bandwidth for whether the allocation actually succeeded.
181 *
182 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event is sent after an isochronous
183 * resource was deallocated at the IRM. It is also sent when automatic
184 * reallocation after a bus reset failed.
185 *
186 * @channel is <0 if no channel was (de)allocated or if reallocation failed.
187 * @bandwidth is 0 if no bandwidth was (de)allocated or if reallocation failed.
188 */
190 __u64 closure;
191 __u32 type;
192 __u32 handle;
193 __s32 channel;
194 __s32 bandwidth;
195 };
197 /**
198 * union fw_cdev_event - Convenience union of fw_cdev_event_ types
199 * @common: Valid for all types
200 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
201 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
202 * @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST
203 * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT
204 * @iso_resource: Valid if @common.type ==
205 * %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
206 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
207 *
208 * Convenience union for userspace use. Events could be read(2) into an
209 * appropriately aligned char buffer and then cast to this union for further
210 * processing. Note that for a request, response or iso_interrupt event,
211 * the data[] or header[] may make the size of the full event larger than
212 * sizeof(union fw_cdev_event). Also note that if you attempt to read(2)
213 * an event into a buffer that is not large enough for it, the data that does
214 * not fit will be discarded so that the next read(2) will return a new event.
215 */
223 };
225 /* available since kernel version 2.6.22 */
239 /* available since kernel version 2.6.24 */
242 /* available since kernel version 2.6.30 */
243 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource)
245 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource)
246 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource)
251 /* available since kernel version 2.6.34 */
254 /*
255 * FW_CDEV_VERSION History
256 * 1 (2.6.22) - initial version
257 * 2 (2.6.30) - changed &fw_cdev_event_iso_interrupt.header if
258 * &fw_cdev_create_iso_context.header_size is 8 or more
259 * (2.6.32) - added time stamp to xmit &fw_cdev_event_iso_interrupt
260 * (2.6.33) - IR has always packet-per-buffer semantics now, not one of
261 * dual-buffer or packet-per-buffer depending on hardware
262 * 3 (2.6.34) - made &fw_cdev_get_cycle_timer reliable
263 */
264 #define FW_CDEV_VERSION 3
266 /**
267 * struct fw_cdev_get_info - General purpose information ioctl
268 * @version: The version field is just a running serial number.
269 * We never break backwards compatibility, but may add more
270 * structs and ioctls in later revisions.
271 * @rom_length: If @rom is non-zero, at most rom_length bytes of configuration
272 * ROM will be copied into that user space address. In either
273 * case, @rom_length is updated with the actual length of the
274 * configuration ROM.
275 * @rom: If non-zero, address of a buffer to be filled by a copy of the
276 * device's configuration ROM
277 * @bus_reset: If non-zero, address of a buffer to be filled by a
278 * &struct fw_cdev_event_bus_reset with the current state
279 * of the bus. This does not cause a bus reset to happen.
280 * @bus_reset_closure: Value of &closure in this and subsequent bus reset events
281 * @card: The index of the card this device belongs to
282 */
284 __u32 version;
285 __u32 rom_length;
286 __u64 rom;
287 __u64 bus_reset;
288 __u64 bus_reset_closure;
289 __u32 card;
290 };
292 /**
293 * struct fw_cdev_send_request - Send an asynchronous request packet
294 * @tcode: Transaction code of the request
295 * @length: Length of outgoing payload, in bytes
296 * @offset: 48-bit offset at destination node
297 * @closure: Passed back to userspace in the response event
298 * @data: Userspace pointer to payload
299 * @generation: The bus generation where packet is valid
300 *
301 * Send a request to the device. This ioctl implements all outgoing requests.
302 * Both quadlet and block request specify the payload as a pointer to the data
303 * in the @data field. Once the transaction completes, the kernel writes an
304 * &fw_cdev_event_response event back. The @closure field is passed back to
305 * user space in the response event.
306 */
308 __u32 tcode;
309 __u32 length;
310 __u64 offset;
311 __u64 closure;
312 __u64 data;
313 __u32 generation;
314 };
316 /**
317 * struct fw_cdev_send_response - Send an asynchronous response packet
318 * @rcode: Response code as determined by the userspace handler
319 * @length: Length of outgoing payload, in bytes
320 * @data: Userspace pointer to payload
321 * @handle: The handle from the &fw_cdev_event_request
322 *
323 * Send a response to an incoming request. By setting up an address range using
324 * the %FW_CDEV_IOC_ALLOCATE ioctl, userspace can listen for incoming requests. An
325 * incoming request will generate an %FW_CDEV_EVENT_REQUEST, and userspace must
326 * send a reply using this ioctl. The event has a handle to the kernel-side
327 * pending transaction, which should be used with this ioctl.
328 */
330 __u32 rcode;
331 __u32 length;
332 __u64 data;
333 __u32 handle;
334 };
336 /**
337 * struct fw_cdev_allocate - Allocate a CSR address range
338 * @offset: Start offset of the address range
339 * @closure: To be passed back to userspace in request events
340 * @length: Length of the address range, in bytes
341 * @handle: Handle to the allocation, written by the kernel
342 *
343 * Allocate an address range in the 48-bit address space on the local node
344 * (the controller). This allows userspace to listen for requests with an
345 * offset within that address range. When the kernel receives a request
346 * within the range, an &fw_cdev_event_request event will be written back.
347 * The @closure field is passed back to userspace in the response event.
348 * The @handle field is an out parameter, returning a handle to the allocated
349 * range to be used for later deallocation of the range.
350 *
351 * The address range is allocated on all local nodes. The address allocation
352 * is exclusive except for the FCP command and response registers.
353 */
355 __u64 offset;
356 __u64 closure;
357 __u32 length;
358 __u32 handle;
359 };
361 /**
362 * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource
363 * @handle: Handle to the address range or iso resource, as returned by the
364 * kernel when the range or resource was allocated
365 */
367 __u32 handle;
368 };
370 #define FW_CDEV_LONG_RESET 0
371 #define FW_CDEV_SHORT_RESET 1
373 /**
374 * struct fw_cdev_initiate_bus_reset - Initiate a bus reset
375 * @type: %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET
376 *
377 * Initiate a bus reset for the bus this device is on. The bus reset can be
378 * either the original (long) bus reset or the arbitrated (short) bus reset
379 * introduced in 1394a-2000.
380 */
383 };
385 /**
386 * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM
387 * @immediate: If non-zero, immediate key to insert before pointer
388 * @key: Upper 8 bits of root directory pointer
389 * @data: Userspace pointer to contents of descriptor block
390 * @length: Length of descriptor block data, in quadlets
391 * @handle: Handle to the descriptor, written by the kernel
392 *
393 * Add a descriptor block and optionally a preceding immediate key to the local
394 * node's configuration ROM.
395 *
396 * The @key field specifies the upper 8 bits of the descriptor root directory
397 * pointer and the @data and @length fields specify the contents. The @key
398 * should be of the form 0xXX000000. The offset part of the root directory entry
399 * will be filled in by the kernel.
400 *
401 * If not 0, the @immediate field specifies an immediate key which will be
402 * inserted before the root directory pointer.
403 *
404 * @immediate, @key, and @data array elements are CPU-endian quadlets.
405 *
406 * If successful, the kernel adds the descriptor and writes back a handle to the
407 * kernel-side object to be used for later removal of the descriptor block and
408 * immediate key.
409 *
410 * This ioctl affects the configuration ROMs of all local nodes.
411 * The ioctl only succeeds on device files which represent a local node.
412 */
414 __u32 immediate;
415 __u32 key;
416 __u64 data;
417 __u32 length;
418 __u32 handle;
419 };
421 /**
422 * struct fw_cdev_remove_descriptor - Remove contents from the configuration ROM
423 * @handle: Handle to the descriptor, as returned by the kernel when the
424 * descriptor was added
425 *
426 * Remove a descriptor block and accompanying immediate key from the local
427 * nodes' configuration ROMs.
428 */
430 __u32 handle;
431 };
433 #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
434 #define FW_CDEV_ISO_CONTEXT_RECEIVE 1
436 /**
437 * struct fw_cdev_create_iso_context - Create a context for isochronous IO
438 * @type: %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE
439 * @header_size: Header size to strip for receive contexts
440 * @channel: Channel to bind to
441 * @speed: Speed for transmit contexts
442 * @closure: To be returned in &fw_cdev_event_iso_interrupt
443 * @handle: Handle to context, written back by kernel
444 *
445 * Prior to sending or receiving isochronous I/O, a context must be created.
446 * The context records information about the transmit or receive configuration
447 * and typically maps to an underlying hardware resource. A context is set up
448 * for either sending or receiving. It is bound to a specific isochronous
449 * channel.
450 *
451 * If a context was successfully created, the kernel writes back a handle to the
452 * context, which must be passed in for subsequent operations on that context.
453 *
454 * For receive contexts, @header_size must be at least 4 and must be a multiple
455 * of 4.
456 *
457 * Note that the effect of a @header_size > 4 depends on
458 * &fw_cdev_get_info.version, as documented at &fw_cdev_event_iso_interrupt.
459 */
461 __u32 type;
462 __u32 header_size;
463 __u32 channel;
464 __u32 speed;
465 __u64 closure;
466 __u32 handle;
467 };
469 #define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v)
470 #define FW_CDEV_ISO_INTERRUPT (1 << 16)
471 #define FW_CDEV_ISO_SKIP (1 << 17)
472 #define FW_CDEV_ISO_SYNC (1 << 17)
473 #define FW_CDEV_ISO_TAG(v) ((v) << 18)
474 #define FW_CDEV_ISO_SY(v) ((v) << 20)
475 #define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24)
477 /**
478 * struct fw_cdev_iso_packet - Isochronous packet
479 * @control: Contains the header length (8 uppermost bits), the sy field
480 * (4 bits), the tag field (2 bits), a sync flag (1 bit),
481 * a skip flag (1 bit), an interrupt flag (1 bit), and the
482 * payload length (16 lowermost bits)
483 * @header: Header and payload
484 *
485 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues.
486 *
487 * Use the FW_CDEV_ISO_ macros to fill in @control.
488 *
489 * For transmit packets, the header length must be a multiple of 4 and specifies
490 * the numbers of bytes in @header that will be prepended to the packet's
491 * payload; these bytes are copied into the kernel and will not be accessed
492 * after the ioctl has returned. The sy and tag fields are copied to the iso
493 * packet header (these fields are specified by IEEE 1394a and IEC 61883-1).
494 * The skip flag specifies that no packet is to be sent in a frame; when using
495 * this, all other fields except the interrupt flag must be zero.
496 *
497 * For receive packets, the header length must be a multiple of the context's
498 * header size; if the header length is larger than the context's header size,
499 * multiple packets are queued for this entry. The sy and tag fields are
500 * ignored. If the sync flag is set, the context drops all packets until
501 * a packet with a matching sy field is received (the sync value to wait for is
502 * specified in the &fw_cdev_start_iso structure). The payload length defines
503 * how many payload bytes can be received for one packet (in addition to payload
504 * quadlets that have been defined as headers and are stripped and returned in
505 * the &fw_cdev_event_iso_interrupt structure). If more bytes are received, the
506 * additional bytes are dropped. If less bytes are received, the remaining
507 * bytes in this part of the payload buffer will not be written to, not even by
508 * the next packet, i.e., packets received in consecutive frames will not
509 * necessarily be consecutive in memory. If an entry has queued multiple
510 * packets, the payload length is divided equally among them.
511 *
512 * When a packet with the interrupt flag set has been completed, the
513 * &fw_cdev_event_iso_interrupt event will be sent. An entry that has queued
514 * multiple receive packets is completed when its last packet is completed.
515 */
517 __u32 control;
519 };
521 /**
522 * struct fw_cdev_queue_iso - Queue isochronous packets for I/O
523 * @packets: Userspace pointer to packet data
524 * @data: Pointer into mmap()'ed payload buffer
525 * @size: Size of packet data in bytes
526 * @handle: Isochronous context handle
527 *
528 * Queue a number of isochronous packets for reception or transmission.
529 * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs,
530 * which describe how to transmit from or receive into a contiguous region
531 * of a mmap()'ed payload buffer. As part of transmit packet descriptors,
532 * a series of headers can be supplied, which will be prepended to the
533 * payload during DMA.
534 *
535 * The kernel may or may not queue all packets, but will write back updated
536 * values of the @packets, @data and @size fields, so the ioctl can be
537 * resubmitted easily.
538 */
540 __u64 packets;
541 __u64 data;
542 __u32 size;
543 __u32 handle;
544 };
546 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
547 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
548 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
549 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
550 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
552 /**
553 * struct fw_cdev_start_iso - Start an isochronous transmission or reception
554 * @cycle: Cycle in which to start I/O. If @cycle is greater than or
555 * equal to 0, the I/O will start on that cycle.
556 * @sync: Determines the value to wait for for receive packets that have
557 * the %FW_CDEV_ISO_SYNC bit set
558 * @tags: Tag filter bit mask. Only valid for isochronous reception.
559 * Determines the tag values for which packets will be accepted.
560 * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags.
561 * @handle: Isochronous context handle within which to transmit or receive
562 */
564 __s32 cycle;
565 __u32 sync;
566 __u32 tags;
567 __u32 handle;
568 };
570 /**
571 * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception
572 * @handle: Handle of isochronous context to stop
573 */
575 __u32 handle;
576 };
578 /**
579 * struct fw_cdev_get_cycle_timer - read cycle timer register
580 * @local_time: system time, in microseconds since the Epoch
581 * @cycle_timer: Cycle Time register contents
582 *
583 * The %FW_CDEV_IOC_GET_CYCLE_TIMER ioctl reads the isochronous cycle timer
584 * and also the system clock (%CLOCK_REALTIME). This allows to express the
585 * receive time of an isochronous packet as a system time.
586 *
587 * @cycle_timer consists of 7 bits cycleSeconds, 13 bits cycleCount, and
588 * 12 bits cycleOffset, in host byte order. Cf. the Cycle Time register
589 * per IEEE 1394 or Isochronous Cycle Timer register per OHCI-1394.
590 *
591 * In version 1 and 2 of the ABI, this ioctl returned unreliable (non-
592 * monotonic) @cycle_timer values on certain controllers.
593 */
595 __u64 local_time;
596 __u32 cycle_timer;
597 };
599 /**
600 * struct fw_cdev_get_cycle_timer2 - read cycle timer register
601 * @tv_sec: system time, seconds
602 * @tv_nsec: system time, sub-seconds part in nanoseconds
603 * @clk_id: input parameter, clock from which to get the system time
604 * @cycle_timer: Cycle Time register contents
605 *
606 * The %FW_CDEV_IOC_GET_CYCLE_TIMER2 works like
607 * %FW_CDEV_IOC_GET_CYCLE_TIMER but lets you choose a clock like with POSIX'
608 * clock_gettime function. Supported @clk_id values are POSIX' %CLOCK_REALTIME
609 * and %CLOCK_MONOTONIC and Linux' %CLOCK_MONOTONIC_RAW.
610 */
612 __s64 tv_sec;
613 __s32 tv_nsec;
614 __s32 clk_id;
615 __u32 cycle_timer;
616 };
618 /**
619 * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth
620 * @closure: Passed back to userspace in correponding iso resource events
621 * @channels: Isochronous channels of which one is to be (de)allocated
622 * @bandwidth: Isochronous bandwidth units to be (de)allocated
623 * @handle: Handle to the allocation, written by the kernel (only valid in
624 * case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls)
625 *
626 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an
627 * isochronous channel and/or of isochronous bandwidth at the isochronous
628 * resource manager (IRM). Only one of the channels specified in @channels is
629 * allocated. An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after
630 * communication with the IRM, indicating success or failure in the event data.
631 * The kernel will automatically reallocate the resources after bus resets.
632 * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event
633 * will be sent. The kernel will also automatically deallocate the resources
634 * when the file descriptor is closed.
635 *
636 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate
637 * deallocation of resources which were allocated as described above.
638 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
639 *
640 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation
641 * without automatic re- or deallocation.
642 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation,
643 * indicating success or failure in its data.
644 *
645 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like
646 * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed
647 * instead of allocated.
648 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
649 *
650 * To summarize, %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE allocates iso resources
651 * for the lifetime of the fd or handle.
652 * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources
653 * for the duration of a bus generation.
654 *
655 * @channels is a host-endian bitfield with the least significant bit
656 * representing channel 0 and the most significant bit representing channel 63:
657 * 1ULL << c for each channel c that is a candidate for (de)allocation.
658 *
659 * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send
660 * one quadlet of data (payload or header data) at speed S1600.
661 */
663 __u64 closure;
664 __u64 channels;
665 __u32 bandwidth;
666 __u32 handle;
667 };
669 /**
670 * struct fw_cdev_send_stream_packet - send an asynchronous stream packet
671 * @length: Length of outgoing payload, in bytes
672 * @tag: Data format tag
673 * @channel: Isochronous channel to transmit to
674 * @sy: Synchronization code
675 * @closure: Passed back to userspace in the response event
676 * @data: Userspace pointer to payload
677 * @generation: The bus generation where packet is valid
678 * @speed: Speed to transmit at
679 *
680 * The %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl sends an asynchronous stream packet
681 * to every device which is listening to the specified channel. The kernel
682 * writes an &fw_cdev_event_response event which indicates success or failure of
683 * the transmission.
684 */
686 __u32 length;
687 __u32 tag;
688 __u32 channel;
689 __u32 sy;
690 __u64 closure;
691 __u64 data;
692 __u32 generation;
693 __u32 speed;
694 };