add audio

hc

2023-12-11 1f93a7dfd1f8d5ff7a5c53246c7534fe2332d6f4

 kernel/include/uapi/linux/firewire-cdev.h
..
..
@@ -47,11 +47,11 @@
47
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
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
55
  * types regardless of the specific type.
56
56
  *
57
57
  * Data passed in the @closure field for a request will be returned in the
..
..
@@ -123,7 +123,13 @@
123
123
 
124
124
 /**
125
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
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
134
  * This event is sent instead of &fw_cdev_event_request2 if the kernel or
129
135
  * the client implements ABI version <= 3.  &fw_cdev_event_request lacks
..
..
@@ -302,7 +308,7 @@
302
308
 /**
303
309
  * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
304
310
  * @closure:	See &fw_cdev_event_common;
305
- *		set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
311
+ *		set by``FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE)`` ioctl
306
312
  * @type:	%FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
307
313
  *		%FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
308
314
  * @handle:	Reference by which an allocated resource can be deallocated
..
..
@@ -353,7 +359,7 @@
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
363
  * @common:		Valid for all types
358
364
  * @bus_reset:		Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
359
365
  * @response:		Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
..
..
@@ -735,7 +741,7 @@
735
741
  * @header:	Header and payload in case of a transmit context.
736
742
  *
737
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
745
  * The @header array is empty in case of receive contexts.
740
746
  *
741
747
  * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT:
..
..
@@ -842,7 +848,7 @@
842
848
  *		the %FW_CDEV_ISO_SYNC bit set
843
849
  * @tags:	Tag filter bit mask.  Only valid for isochronous reception.
844
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
852
  * @handle:	Isochronous context handle within which to transmit or receive
847
853
  */
848
854
 struct fw_cdev_start_iso {
..
..
@@ -1009,8 +1015,8 @@
1009
1015
  * on the same card as this device.  After transmission, an
1010
1016
  * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated.
1011
1017
  *
1012
- * 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
1018
+ * The payload @data\[\] shall be specified in host byte order.  Usually,
1019
+ * @data\[1\] needs to be the bitwise inverse of @data\[0\].  VersaPHY packets
1014
1020
  * are an exception to this rule.
1015
1021
  *
1016
1022
  * The ioctl is only permitted on device files which represent a local node.