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