aboutsummaryrefslogtreecommitdiffstats
path: root/include/uapi/linux/firewire-cdev.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/uapi/linux/firewire-cdev.h')
-rw-r--r--include/uapi/linux/firewire-cdev.h22
1 files changed, 14 insertions, 8 deletions
diff --git a/include/uapi/linux/firewire-cdev.h b/include/uapi/linux/firewire-cdev.h
index 1db453e4b550..1acd2b179aef 100644
--- a/include/uapi/linux/firewire-cdev.h
+++ b/include/uapi/linux/firewire-cdev.h
@@ -47,11 +47,11 @@
47#define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 0x09 47#define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 0x09
48 48
49/** 49/**
50 * struct fw_cdev_event_common - Common part of all fw_cdev_event_ types 50 * struct fw_cdev_event_common - Common part of all fw_cdev_event_* types
51 * @closure: For arbitrary use by userspace 51 * @closure: For arbitrary use by userspace
52 * @type: Discriminates the fw_cdev_event_ types 52 * @type: Discriminates the fw_cdev_event_* types
53 * 53 *
54 * This struct may be used to access generic members of all fw_cdev_event_ 54 * This struct may be used to access generic members of all fw_cdev_event_*
55 * types regardless of the specific type. 55 * types regardless of the specific type.
56 * 56 *
57 * Data passed in the @closure field for a request will be returned in the 57 * Data passed in the @closure field for a request will be returned in the
@@ -123,7 +123,13 @@ struct fw_cdev_event_response {
123 123
124/** 124/**
125 * struct fw_cdev_event_request - Old version of &fw_cdev_event_request2 125 * struct fw_cdev_event_request - Old version of &fw_cdev_event_request2
126 * @closure: See &fw_cdev_event_common; set by %FW_CDEV_IOC_ALLOCATE ioctl
126 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST 127 * @type: See &fw_cdev_event_common; always %FW_CDEV_EVENT_REQUEST
128 * @tcode: Transaction code of the incoming request
129 * @offset: The offset into the 48-bit per-node address space
130 * @handle: Reference to the kernel-side pending request
131 * @length: Data length, i.e. the request's payload size in bytes
132 * @data: Incoming data, if any
127 * 133 *
128 * This event is sent instead of &fw_cdev_event_request2 if the kernel or 134 * 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 135 * the client implements ABI version <= 3. &fw_cdev_event_request lacks
@@ -353,7 +359,7 @@ struct fw_cdev_event_phy_packet {
353}; 359};
354 360
355/** 361/**
356 * union fw_cdev_event - Convenience union of fw_cdev_event_ types 362 * union fw_cdev_event - Convenience union of fw_cdev_event_* types
357 * @common: Valid for all types 363 * @common: Valid for all types
358 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET 364 * @bus_reset: Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
359 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE 365 * @response: Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
@@ -735,7 +741,7 @@ struct fw_cdev_set_iso_channels {
735 * @header: Header and payload in case of a transmit context. 741 * @header: Header and payload in case of a transmit context.
736 * 742 *
737 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues. 743 * &struct fw_cdev_iso_packet is used to describe isochronous packet queues.
738 * Use the FW_CDEV_ISO_ macros to fill in @control. 744 * Use the FW_CDEV_ISO_* macros to fill in @control.
739 * The @header array is empty in case of receive contexts. 745 * The @header array is empty in case of receive contexts.
740 * 746 *
741 * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT: 747 * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT:
@@ -842,7 +848,7 @@ struct fw_cdev_queue_iso {
842 * the %FW_CDEV_ISO_SYNC bit set 848 * the %FW_CDEV_ISO_SYNC bit set
843 * @tags: Tag filter bit mask. Only valid for isochronous reception. 849 * @tags: Tag filter bit mask. Only valid for isochronous reception.
844 * Determines the tag values for which packets will be accepted. 850 * Determines the tag values for which packets will be accepted.
845 * Use FW_CDEV_ISO_CONTEXT_MATCH_ macros to set @tags. 851 * Use FW_CDEV_ISO_CONTEXT_MATCH_* macros to set @tags.
846 * @handle: Isochronous context handle within which to transmit or receive 852 * @handle: Isochronous context handle within which to transmit or receive
847 */ 853 */
848struct fw_cdev_start_iso { 854struct fw_cdev_start_iso {
@@ -1009,8 +1015,8 @@ struct fw_cdev_send_stream_packet {
1009 * on the same card as this device. After transmission, an 1015 * on the same card as this device. After transmission, an
1010 * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated. 1016 * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated.
1011 * 1017 *
1012 * The payload @data[] shall be specified in host byte order. Usually, 1018 * The payload @data\[\] shall be specified in host byte order. Usually,
1013 * @data[1] needs to be the bitwise inverse of @data[0]. VersaPHY packets 1019 * @data\[1\] needs to be the bitwise inverse of @data\[0\]. VersaPHY packets
1014 * are an exception to this rule. 1020 * are an exception to this rule.
1015 * 1021 *
1016 * The ioctl is only permitted on device files which represent a local node. 1022 * The ioctl is only permitted on device files which represent a local node.