2 * Char device interface.
4 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
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 /* available since kernel version 2.6.36 */
36 #define FW_CDEV_EVENT_REQUEST2 0x06
37 #define FW_CDEV_EVENT_PHY_PACKET_SENT 0x07
40 * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types
41 * @closure: For arbitrary use by userspace
42 * @type: Discriminates the fw_cdev_event_ types
44 * This struct may be used to access generic members of all fw_cdev_event_
45 * types regardless of the specific type.
47 * Data passed in the @closure field for a request will be returned in the
48 * corresponding event. It is big enough to hold a pointer on all platforms.
49 * The ioctl used to set @closure depends on the @type of event.
51 struct fw_cdev_event_common {
57 * struct fw_cdev_event_bus_reset - Sent when a bus reset occurred
58 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_GET_INFO ioctl
59 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_BUS_RESET
60 * @node_id: New node ID of this node
61 * @local_node_id: Node ID of the local node, i.e. of the controller
62 * @bm_node_id: Node ID of the bus manager
63 * @irm_node_id: Node ID of the iso resource manager
64 * @root_node_id: Node ID of the root node
65 * @generation: New bus generation
67 * This event is sent when the bus the device belongs to goes through a bus
68 * reset. It provides information about the new bus configuration, such as
69 * new node ID for this device, new root ID, and others.
71 * If @bm_node_id is 0xffff right after bus reset it can be reread by an
72 * %FW_CDEV_IOC_GET_INFO ioctl after bus manager selection was finished.
73 * Kernels with ABI version < 4 do not set @bm_node_id.
75 struct fw_cdev_event_bus_reset {
87 * struct fw_cdev_event_response - Sent when a response packet was received
88 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_SEND_REQUEST
89 * or %FW_CDEV_IOC_SEND_BROADCAST_REQUEST
90 * or %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl
91 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_RESPONSE
92 * @rcode: Response code returned by the remote node
93 * @length: Data length, i.e. the response's payload size in bytes
94 * @data: Payload data, if any
96 * This event is sent when the stack receives a response to an outgoing request
97 * sent by %FW_CDEV_IOC_SEND_REQUEST ioctl. The payload data for responses
98 * carrying data (read and lock responses) follows immediately and can be
99 * accessed through the @data field.
101 * The event is also generated after conclusions of transactions that do not
102 * involve response packets. This includes unified write transactions,
103 * broadcast write transactions, and transmission of asynchronous stream
104 * packets. @rcode indicates success or failure of such transmissions.
106 struct fw_cdev_event_response {
115 * struct fw_cdev_event_request - Old version of &fw_cdev_event_request2
116 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl
117 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST
118 * @tcode: See &fw_cdev_event_request2
119 * @offset: See &fw_cdev_event_request2
120 * @handle: See &fw_cdev_event_request2
121 * @length: See &fw_cdev_event_request2
122 * @data: See &fw_cdev_event_request2
124 * This event is sent instead of &fw_cdev_event_request2 if the kernel or
125 * the client implements ABI version <= 3.
127 * Unlike &fw_cdev_event_request2, the sender identity cannot be established,
128 * broadcast write requests cannot be distinguished from unicast writes, and
129 * @tcode of lock requests is %TCODE_LOCK_REQUEST.
131 * Requests to the FCP_REQUEST or FCP_RESPONSE register are responded to as
132 * with &fw_cdev_event_request2, except in kernel 2.6.32 and older which send
133 * the response packet of the client's %FW_CDEV_IOC_SEND_RESPONSE ioctl.
135 struct fw_cdev_event_request {
146 * struct fw_cdev_event_request2 - Sent on incoming request to an address region
147 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl
148 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST2
149 * @tcode: Transaction code of the incoming request
150 * @offset: The offset into the 48-bit per-node address space
151 * @source_node_id: Sender node ID
152 * @destination_node_id: Destination node ID
153 * @card: The index of the card from which the request came
154 * @generation: Bus generation in which the request is valid
155 * @handle: Reference to the kernel-side pending request
156 * @length: Data length, i.e. the request's payload size in bytes
157 * @data: Incoming data, if any
159 * This event is sent when the stack receives an incoming request to an address
160 * region registered using the %FW_CDEV_IOC_ALLOCATE ioctl. The request is
161 * guaranteed to be completely contained in the specified region. Userspace is
162 * responsible for sending the response by %FW_CDEV_IOC_SEND_RESPONSE ioctl,
163 * using the same @handle.
165 * The payload data for requests carrying data (write and lock requests)
166 * follows immediately and can be accessed through the @data field.
168 * Unlike &fw_cdev_event_request, @tcode of lock requests is one of the
169 * firewire-core specific %TCODE_LOCK_MASK_SWAP...%TCODE_LOCK_VENDOR_DEPENDENT,
170 * i.e. encodes the extended transaction code.
172 * @card may differ from &fw_cdev_get_info.card because requests are received
173 * from all cards of the Linux host. @source_node_id, @destination_node_id, and
174 * @generation pertain to that card. Destination node ID and bus generation may
175 * therefore differ from the corresponding fields of the last
176 * &fw_cdev_event_bus_reset.
178 * @destination_node_id may also differ from the current node ID because of a
179 * non-local bus ID part or in case of a broadcast write request. Note, a
180 * client must call an %FW_CDEV_IOC_SEND_RESPONSE ioctl even in case of a
181 * broadcast write request; the kernel will then release the kernel-side pending
182 * request but will not actually send a response packet.
184 * In case of a write request to FCP_REQUEST or FCP_RESPONSE, the kernel already
185 * sent a write response immediately after the request was received; in this
186 * case the client must still call an %FW_CDEV_IOC_SEND_RESPONSE ioctl to
187 * release the kernel-side pending request, though another response won't be
190 * If the client subsequently needs to initiate requests to the sender node of
191 * an &fw_cdev_event_request2, it needs to use a device file with matching
192 * card index, node ID, and generation for outbound requests.
194 struct fw_cdev_event_request2 {
199 __u32 source_node_id;
200 __u32 destination_node_id;
209 * struct fw_cdev_event_iso_interrupt - Sent when an iso packet was completed
210 * @closure: See &fw_cdev_event_common;
211 * set by %FW_CDEV_CREATE_ISO_CONTEXT ioctl
212 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_ISO_INTERRUPT
213 * @cycle: Cycle counter of the interrupt packet
214 * @header_length: Total length of following headers, in bytes
215 * @header: Stripped headers, if any
217 * This event is sent when the controller has completed an &fw_cdev_iso_packet
218 * with the %FW_CDEV_ISO_INTERRUPT bit set.
220 * Isochronous transmit events:
222 * In version 1 of the ABI, &header_length is 0. In version 3 and some
223 * implementations of version 2 of the ABI, &header_length is a multiple of 4
224 * and &header contains timestamps of all packets up until the interrupt packet.
225 * The format of the timestamps is as described below for isochronous reception.
227 * Isochronous receive events:
229 * The headers stripped of all packets up until and including the interrupt
230 * packet are returned in the @header field. The amount of header data per
231 * packet is as specified at iso context creation by
232 * &fw_cdev_create_iso_context.header_size.
234 * In version 1 of this ABI, header data consisted of the 1394 isochronous
235 * packet header, followed by quadlets from the packet payload if
236 * &fw_cdev_create_iso_context.header_size > 4.
238 * In version 2 of this ABI, header data consist of the 1394 isochronous
239 * packet header, followed by a timestamp quadlet if
240 * &fw_cdev_create_iso_context.header_size > 4, followed by quadlets from the
241 * packet payload if &fw_cdev_create_iso_context.header_size > 8.
243 * Behaviour of ver. 1 of this ABI is no longer available since ABI ver. 2.
245 * Format of 1394 iso packet header: 16 bits len, 2 bits tag, 6 bits channel,
246 * 4 bits tcode, 4 bits sy, in big endian byte order. Format of timestamp:
247 * 16 bits invalid, 3 bits cycleSeconds, 13 bits cycleCount, in big endian byte
250 struct fw_cdev_event_iso_interrupt {
259 * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
260 * @closure: See &fw_cdev_event_common;
261 * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
262 * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
263 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
264 * @handle: Reference by which an allocated resource can be deallocated
265 * @channel: Isochronous channel which was (de)allocated, if any
266 * @bandwidth: Bandwidth allocation units which were (de)allocated, if any
268 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event is sent after an isochronous
269 * resource was allocated at the IRM. The client has to check @channel and
270 * @bandwidth for whether the allocation actually succeeded.
272 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event is sent after an isochronous
273 * resource was deallocated at the IRM. It is also sent when automatic
274 * reallocation after a bus reset failed.
276 * @channel is <0 if no channel was (de)allocated or if reallocation failed.
277 * @bandwidth is 0 if no bandwidth was (de)allocated or if reallocation failed.
279 struct fw_cdev_event_iso_resource {
288 * struct fw_cdev_event_phy_packet - A PHY packet was transmitted
289 * @closure: See &fw_cdev_event_common;
290 * set by %FW_CDEV_IOC_SEND_PHY_PACKET ioctl
291 * @type: %FW_CDEV_EVENT_PHY_PACKET_SENT
292 * @rcode: %RCODE_..., indicates success or failure of transmission
294 struct fw_cdev_event_phy_packet {
301 * union fw_cdev_event - Convenience union of fw_cdev_event_ types
302 * @common: Valid for all types
303 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
304 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
305 * @request: Valid if @common.type == %FW_CDEV_EVENT_REQUEST
306 * @request2: Valid if @common.type == %FW_CDEV_EVENT_REQUEST2
307 * @iso_interrupt: Valid if @common.type == %FW_CDEV_EVENT_ISO_INTERRUPT
308 * @iso_resource: Valid if @common.type ==
309 * %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
310 * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
311 * @phy_packet: Valid if @common.type == %FW_CDEV_EVENT_PHY_PACKET_SENT
313 * Convenience union for userspace use. Events could be read(2) into an
314 * appropriately aligned char buffer and then cast to this union for further
315 * processing. Note that for a request, response or iso_interrupt event,
316 * the data[] or header[] may make the size of the full event larger than
317 * sizeof(union fw_cdev_event). Also note that if you attempt to read(2)
318 * an event into a buffer that is not large enough for it, the data that does
319 * not fit will be discarded so that the next read(2) will return a new event.
321 union fw_cdev_event {
322 struct fw_cdev_event_common common;
323 struct fw_cdev_event_bus_reset bus_reset;
324 struct fw_cdev_event_response response;
325 struct fw_cdev_event_request request;
326 struct fw_cdev_event_request2 request2; /* added in 2.6.36 */
327 struct fw_cdev_event_iso_interrupt iso_interrupt;
328 struct fw_cdev_event_iso_resource iso_resource; /* added in 2.6.30 */
329 struct fw_cdev_event_phy_packet phy_packet; /* added in 2.6.36 */
332 /* available since kernel version 2.6.22 */
333 #define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
334 #define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
335 #define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
336 #define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
337 #define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
338 #define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
339 #define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
340 #define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
341 #define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
342 #define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
343 #define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
344 #define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
346 /* available since kernel version 2.6.24 */
347 #define FW_CDEV_IOC_GET_CYCLE_TIMER _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer)
349 /* available since kernel version 2.6.30 */
350 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource)
351 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE _IOW('#', 0x0e, struct fw_cdev_deallocate)
352 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource)
353 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource)
354 #define FW_CDEV_IOC_GET_SPEED _IO('#', 0x11) /* returns speed code */
355 #define FW_CDEV_IOC_SEND_BROADCAST_REQUEST _IOW('#', 0x12, struct fw_cdev_send_request)
356 #define FW_CDEV_IOC_SEND_STREAM_PACKET _IOW('#', 0x13, struct fw_cdev_send_stream_packet)
358 /* available since kernel version 2.6.34 */
359 #define FW_CDEV_IOC_GET_CYCLE_TIMER2 _IOWR('#', 0x14, struct fw_cdev_get_cycle_timer2)
361 /* available since kernel version 2.6.36 */
362 #define FW_CDEV_IOC_SEND_PHY_PACKET _IOWR('#', 0x15, struct fw_cdev_send_phy_packet)
365 * ABI version history
366 * 1 (2.6.22) - initial version
367 * (2.6.24) - added %FW_CDEV_IOC_GET_CYCLE_TIMER
368 * 2 (2.6.30) - changed &fw_cdev_event_iso_interrupt.header if
369 * &fw_cdev_create_iso_context.header_size is 8 or more
370 * - added %FW_CDEV_IOC_*_ISO_RESOURCE*,
371 * %FW_CDEV_IOC_GET_SPEED, %FW_CDEV_IOC_SEND_BROADCAST_REQUEST,
372 * %FW_CDEV_IOC_SEND_STREAM_PACKET
373 * (2.6.32) - added time stamp to xmit &fw_cdev_event_iso_interrupt
374 * (2.6.33) - IR has always packet-per-buffer semantics now, not one of
375 * dual-buffer or packet-per-buffer depending on hardware
376 * - shared use and auto-response for FCP registers
377 * 3 (2.6.34) - made &fw_cdev_get_cycle_timer reliable
378 * - added %FW_CDEV_IOC_GET_CYCLE_TIMER2
379 * 4 (2.6.36) - added %FW_CDEV_EVENT_REQUEST2, %FW_CDEV_EVENT_PHY_PACKET_SENT
380 * - implemented &fw_cdev_event_bus_reset.bm_node_id
381 * - added %FW_CDEV_IOC_SEND_PHY_PACKET
383 #define FW_CDEV_VERSION 3 /* Meaningless; don't use this macro. */
386 * struct fw_cdev_get_info - General purpose information ioctl
387 * @version: The version field is just a running serial number. Both an
388 * input parameter (ABI version implemented by the client) and
389 * output parameter (ABI version implemented by the kernel).
390 * A client must not fill in an %FW_CDEV_VERSION defined from an
391 * included kernel header file but the actual version for which
392 * the client was implemented. This is necessary for forward
393 * compatibility. We never break backwards compatibility, but
394 * may add more structs, events, and ioctls in later revisions.
395 * @rom_length: If @rom is non-zero, at most rom_length bytes of configuration
396 * ROM will be copied into that user space address. In either
397 * case, @rom_length is updated with the actual length of the
399 * @rom: If non-zero, address of a buffer to be filled by a copy of the
400 * device's configuration ROM
401 * @bus_reset: If non-zero, address of a buffer to be filled by a
402 * &struct fw_cdev_event_bus_reset with the current state
403 * of the bus. This does not cause a bus reset to happen.
404 * @bus_reset_closure: Value of &closure in this and subsequent bus reset events
405 * @card: The index of the card this device belongs to
407 struct fw_cdev_get_info {
412 __u64 bus_reset_closure;
417 * struct fw_cdev_send_request - Send an asynchronous request packet
418 * @tcode: Transaction code of the request
419 * @length: Length of outgoing payload, in bytes
420 * @offset: 48-bit offset at destination node
421 * @closure: Passed back to userspace in the response event
422 * @data: Userspace pointer to payload
423 * @generation: The bus generation where packet is valid
425 * Send a request to the device. This ioctl implements all outgoing requests.
426 * Both quadlet and block request specify the payload as a pointer to the data
427 * in the @data field. Once the transaction completes, the kernel writes an
428 * &fw_cdev_event_response event back. The @closure field is passed back to
429 * user space in the response event.
431 struct fw_cdev_send_request {
441 * struct fw_cdev_send_response - Send an asynchronous response packet
442 * @rcode: Response code as determined by the userspace handler
443 * @length: Length of outgoing payload, in bytes
444 * @data: Userspace pointer to payload
445 * @handle: The handle from the &fw_cdev_event_request
447 * Send a response to an incoming request. By setting up an address range using
448 * the %FW_CDEV_IOC_ALLOCATE ioctl, userspace can listen for incoming requests. An
449 * incoming request will generate an %FW_CDEV_EVENT_REQUEST, and userspace must
450 * send a reply using this ioctl. The event has a handle to the kernel-side
451 * pending transaction, which should be used with this ioctl.
453 struct fw_cdev_send_response {
461 * struct fw_cdev_allocate - Allocate a CSR address range
462 * @offset: Start offset of the address range
463 * @closure: To be passed back to userspace in request events
464 * @length: Length of the address range, in bytes
465 * @handle: Handle to the allocation, written by the kernel
467 * Allocate an address range in the 48-bit address space on the local node
468 * (the controller). This allows userspace to listen for requests with an
469 * offset within that address range. When the kernel receives a request
470 * within the range, an &fw_cdev_event_request event will be written back.
471 * The @closure field is passed back to userspace in the response event.
472 * The @handle field is an out parameter, returning a handle to the allocated
473 * range to be used for later deallocation of the range.
475 * The address range is allocated on all local nodes. The address allocation
476 * is exclusive except for the FCP command and response registers. If an
477 * exclusive address region is already in use, the ioctl fails with errno set
480 struct fw_cdev_allocate {
488 * struct fw_cdev_deallocate - Free a CSR address range or isochronous resource
489 * @handle: Handle to the address range or iso resource, as returned by the
490 * kernel when the range or resource was allocated
492 struct fw_cdev_deallocate {
496 #define FW_CDEV_LONG_RESET 0
497 #define FW_CDEV_SHORT_RESET 1
500 * struct fw_cdev_initiate_bus_reset - Initiate a bus reset
501 * @type: %FW_CDEV_SHORT_RESET or %FW_CDEV_LONG_RESET
503 * Initiate a bus reset for the bus this device is on. The bus reset can be
504 * either the original (long) bus reset or the arbitrated (short) bus reset
505 * introduced in 1394a-2000.
507 * The ioctl returns immediately. A subsequent &fw_cdev_event_bus_reset
508 * indicates when the reset actually happened. Since ABI v4, this may be
509 * considerably later than the ioctl because the kernel ensures a grace period
510 * between subsequent bus resets as per IEEE 1394 bus management specification.
512 struct fw_cdev_initiate_bus_reset {
517 * struct fw_cdev_add_descriptor - Add contents to the local node's config ROM
518 * @immediate: If non-zero, immediate key to insert before pointer
519 * @key: Upper 8 bits of root directory pointer
520 * @data: Userspace pointer to contents of descriptor block
521 * @length: Length of descriptor block data, in quadlets
522 * @handle: Handle to the descriptor, written by the kernel
524 * Add a descriptor block and optionally a preceding immediate key to the local
525 * node's configuration ROM.
527 * The @key field specifies the upper 8 bits of the descriptor root directory
528 * pointer and the @data and @length fields specify the contents. The @key
529 * should be of the form 0xXX000000. The offset part of the root directory entry
530 * will be filled in by the kernel.
532 * If not 0, the @immediate field specifies an immediate key which will be
533 * inserted before the root directory pointer.
535 * @immediate, @key, and @data array elements are CPU-endian quadlets.
537 * If successful, the kernel adds the descriptor and writes back a @handle to
538 * the kernel-side object to be used for later removal of the descriptor block
539 * and immediate key. The kernel will also generate a bus reset to signal the
540 * change of the configuration ROM to other nodes.
542 * This ioctl affects the configuration ROMs of all local nodes.
543 * The ioctl only succeeds on device files which represent a local node.
545 struct fw_cdev_add_descriptor {
554 * struct fw_cdev_remove_descriptor - Remove contents from the configuration ROM
555 * @handle: Handle to the descriptor, as returned by the kernel when the
556 * descriptor was added
558 * Remove a descriptor block and accompanying immediate key from the local
559 * nodes' configuration ROMs. The kernel will also generate a bus reset to
560 * signal the change of the configuration ROM to other nodes.
562 struct fw_cdev_remove_descriptor {
566 #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
567 #define FW_CDEV_ISO_CONTEXT_RECEIVE 1
570 * struct fw_cdev_create_iso_context - Create a context for isochronous IO
571 * @type: %FW_CDEV_ISO_CONTEXT_TRANSMIT or %FW_CDEV_ISO_CONTEXT_RECEIVE
572 * @header_size: Header size to strip for receive contexts
573 * @channel: Channel to bind to
574 * @speed: Speed for transmit contexts
575 * @closure: To be returned in &fw_cdev_event_iso_interrupt
576 * @handle: Handle to context, written back by kernel
578 * Prior to sending or receiving isochronous I/O, a context must be created.
579 * The context records information about the transmit or receive configuration
580 * and typically maps to an underlying hardware resource. A context is set up
581 * for either sending or receiving. It is bound to a specific isochronous
584 * If a context was successfully created, the kernel writes back a handle to the
585 * context, which must be passed in for subsequent operations on that context.
587 * For receive contexts, @header_size must be at least 4 and must be a multiple
590 * Note that the effect of a @header_size > 4 depends on
591 * &fw_cdev_get_info.version, as documented at &fw_cdev_event_iso_interrupt.
593 * No more than one iso context can be created per fd.
595 struct fw_cdev_create_iso_context {
604 #define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v)
605 #define FW_CDEV_ISO_INTERRUPT (1 << 16)
606 #define FW_CDEV_ISO_SKIP (1 << 17)
607 #define FW_CDEV_ISO_SYNC (1 << 17)
608 #define FW_CDEV_ISO_TAG(v) ((v) << 18)
609 #define FW_CDEV_ISO_SY(v) ((v) << 20)
610 #define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24)
613 * struct fw_cdev_iso_packet - Isochronous packet
614 * @control: Contains the header length (8 uppermost bits), the sy field
615 * (4 bits), the tag field (2 bits), a sync flag (1 bit),
616 * a skip flag (1 bit), an interrupt flag (1 bit), and the
617 * payload length (16 lowermost bits)
618 * @header: Header and payload
620 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues.
622 * Use the FW_CDEV_ISO_ macros to fill in @control.
624 * For transmit packets, the header length must be a multiple of 4 and specifies
625 * the numbers of bytes in @header that will be prepended to the packet's
626 * payload; these bytes are copied into the kernel and will not be accessed
627 * after the ioctl has returned. The sy and tag fields are copied to the iso
628 * packet header (these fields are specified by IEEE 1394a and IEC 61883-1).
629 * The skip flag specifies that no packet is to be sent in a frame; when using
630 * this, all other fields except the interrupt flag must be zero.
632 * For receive packets, the header length must be a multiple of the context's
633 * header size; if the header length is larger than the context's header size,
634 * multiple packets are queued for this entry. The sy and tag fields are
635 * ignored. If the sync flag is set, the context drops all packets until
636 * a packet with a matching sy field is received (the sync value to wait for is
637 * specified in the &fw_cdev_start_iso structure). The payload length defines
638 * how many payload bytes can be received for one packet (in addition to payload
639 * quadlets that have been defined as headers and are stripped and returned in
640 * the &fw_cdev_event_iso_interrupt structure). If more bytes are received, the
641 * additional bytes are dropped. If less bytes are received, the remaining
642 * bytes in this part of the payload buffer will not be written to, not even by
643 * the next packet, i.e., packets received in consecutive frames will not
644 * necessarily be consecutive in memory. If an entry has queued multiple
645 * packets, the payload length is divided equally among them.
647 * When a packet with the interrupt flag set has been completed, the
648 * &fw_cdev_event_iso_interrupt event will be sent. An entry that has queued
649 * multiple receive packets is completed when its last packet is completed.
651 struct fw_cdev_iso_packet {
657 * struct fw_cdev_queue_iso - Queue isochronous packets for I/O
658 * @packets: Userspace pointer to packet data
659 * @data: Pointer into mmap()'ed payload buffer
660 * @size: Size of packet data in bytes
661 * @handle: Isochronous context handle
663 * Queue a number of isochronous packets for reception or transmission.
664 * This ioctl takes a pointer to an array of &fw_cdev_iso_packet structs,
665 * which describe how to transmit from or receive into a contiguous region
666 * of a mmap()'ed payload buffer. As part of transmit packet descriptors,
667 * a series of headers can be supplied, which will be prepended to the
668 * payload during DMA.
670 * The kernel may or may not queue all packets, but will write back updated
671 * values of the @packets, @data and @size fields, so the ioctl can be
672 * resubmitted easily.
674 struct fw_cdev_queue_iso {
681 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
682 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
683 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
684 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
685 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
688 * struct fw_cdev_start_iso - Start an isochronous transmission or reception
689 * @cycle: Cycle in which to start I/O. If @cycle is greater than or
690 * equal to 0, the I/O will start on that cycle.
691 * @sync: Determines the value to wait for for receive packets that have
692 * the %FW_CDEV_ISO_SYNC bit set
693 * @tags: Tag filter bit mask. Only valid for isochronous reception.
694 * Determines the tag values for which packets will be accepted.
695 * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags.
696 * @handle: Isochronous context handle within which to transmit or receive
698 struct fw_cdev_start_iso {
706 * struct fw_cdev_stop_iso - Stop an isochronous transmission or reception
707 * @handle: Handle of isochronous context to stop
709 struct fw_cdev_stop_iso {
714 * struct fw_cdev_get_cycle_timer - read cycle timer register
715 * @local_time: system time, in microseconds since the Epoch
716 * @cycle_timer: Cycle Time register contents
718 * The %FW_CDEV_IOC_GET_CYCLE_TIMER ioctl reads the isochronous cycle timer
719 * and also the system clock (%CLOCK_REALTIME). This allows to express the
720 * receive time of an isochronous packet as a system time.
722 * @cycle_timer consists of 7 bits cycleSeconds, 13 bits cycleCount, and
723 * 12 bits cycleOffset, in host byte order. Cf. the Cycle Time register
724 * per IEEE 1394 or Isochronous Cycle Timer register per OHCI-1394.
726 * In version 1 and 2 of the ABI, this ioctl returned unreliable (non-
727 * monotonic) @cycle_timer values on certain controllers.
729 struct fw_cdev_get_cycle_timer {
735 * struct fw_cdev_get_cycle_timer2 - read cycle timer register
736 * @tv_sec: system time, seconds
737 * @tv_nsec: system time, sub-seconds part in nanoseconds
738 * @clk_id: input parameter, clock from which to get the system time
739 * @cycle_timer: Cycle Time register contents
741 * The %FW_CDEV_IOC_GET_CYCLE_TIMER2 works like
742 * %FW_CDEV_IOC_GET_CYCLE_TIMER but lets you choose a clock like with POSIX'
743 * clock_gettime function. Supported @clk_id values are POSIX' %CLOCK_REALTIME
744 * and %CLOCK_MONOTONIC and Linux' %CLOCK_MONOTONIC_RAW.
746 struct fw_cdev_get_cycle_timer2 {
754 * struct fw_cdev_allocate_iso_resource - (De)allocate a channel or bandwidth
755 * @closure: Passed back to userspace in correponding iso resource events
756 * @channels: Isochronous channels of which one is to be (de)allocated
757 * @bandwidth: Isochronous bandwidth units to be (de)allocated
758 * @handle: Handle to the allocation, written by the kernel (only valid in
759 * case of %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctls)
761 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE ioctl initiates allocation of an
762 * isochronous channel and/or of isochronous bandwidth at the isochronous
763 * resource manager (IRM). Only one of the channels specified in @channels is
764 * allocated. An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED is sent after
765 * communication with the IRM, indicating success or failure in the event data.
766 * The kernel will automatically reallocate the resources after bus resets.
767 * Should a reallocation fail, an %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event
768 * will be sent. The kernel will also automatically deallocate the resources
769 * when the file descriptor is closed.
771 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE ioctl can be used to initiate
772 * deallocation of resources which were allocated as described above.
773 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
775 * The %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE ioctl is a variant of allocation
776 * without automatic re- or deallocation.
777 * An %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED event concludes this operation,
778 * indicating success or failure in its data.
780 * The %FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE ioctl works like
781 * %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE except that resources are freed
782 * instead of allocated.
783 * An %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED event concludes this operation.
785 * To summarize, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE allocates iso resources
786 * for the lifetime of the fd or @handle.
787 * In contrast, %FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE allocates iso resources
788 * for the duration of a bus generation.
790 * @channels is a host-endian bitfield with the least significant bit
791 * representing channel 0 and the most significant bit representing channel 63:
792 * 1ULL << c for each channel c that is a candidate for (de)allocation.
794 * @bandwidth is expressed in bandwidth allocation units, i.e. the time to send
795 * one quadlet of data (payload or header data) at speed S1600.
797 struct fw_cdev_allocate_iso_resource {
805 * struct fw_cdev_send_stream_packet - send an asynchronous stream packet
806 * @length: Length of outgoing payload, in bytes
807 * @tag: Data format tag
808 * @channel: Isochronous channel to transmit to
809 * @sy: Synchronization code
810 * @closure: Passed back to userspace in the response event
811 * @data: Userspace pointer to payload
812 * @generation: The bus generation where packet is valid
813 * @speed: Speed to transmit at
815 * The %FW_CDEV_IOC_SEND_STREAM_PACKET ioctl sends an asynchronous stream packet
816 * to every device which is listening to the specified channel. The kernel
817 * writes an &fw_cdev_event_response event which indicates success or failure of
820 struct fw_cdev_send_stream_packet {
832 * struct fw_cdev_send_phy_packet - send a PHY packet
833 * @closure: Passed back to userspace in the PHY-packet-sent event
834 * @data: First and second quadlet of the PHY packet
835 * @generation: The bus generation where packet is valid
837 * The %FW_CDEV_IOC_SEND_PHY_PACKET ioctl sends a PHY packet to all nodes
838 * on the same card as this device. After transmission, an
839 * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated.
841 * The payload @data[] shall be specified in host byte order. Usually,
842 * @data[1] needs to be the bitwise inverse of @data[0]. VersaPHY packets
843 * are an exception to this rule.
845 * The ioctl is only permitted on device files which represent a local node.
847 struct fw_cdev_send_phy_packet {
853 #endif /* _LINUX_FIREWIRE_CDEV_H */