forked from ~ljy/RK356X_SDK_RELEASE

blame | history | patch | commit | commitdiff
hc
2024-05-10 61598093bbdd283a7edc367d900f223070ead8d2 
 kernel/include/uapi/linux/firewire-cdev.h
....@@ -47,11 +47,11 @@
4747 #define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL	0x09
4848 
4949 /**
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
5151  * @closure:	For arbitrary use by userspace
52
- * @type:	Discriminates the fw_cdev_event_ types
52
+ * @type:	Discriminates the fw_cdev_event_* types
5353  *
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_*
5555  * types regardless of the specific type.
5656  *
5757  * Data passed in the @closure field for a request will be returned in the
....@@ -123,7 +123,13 @@
123123 
124124 /**
125125  * 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
126127  * @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
127133  *
128134  * This event is sent instead of &fw_cdev_event_request2 if the kernel or
129135  * the client implements ABI version <= 3.  &fw_cdev_event_request lacks
....@@ -302,7 +308,7 @@
302308 /**
303309  * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
304310  * @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
306312  * @type:	%FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
307313  *		%FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
308314  * @handle:	Reference by which an allocated resource can be deallocated
....@@ -353,7 +359,7 @@
353359 };
354360 
355361 /**
356
- * union fw_cdev_event - Convenience union of fw_cdev_event_ types
362
+ * union fw_cdev_event - Convenience union of fw_cdev_event_* types
357363  * @common:		Valid for all types
358364  * @bus_reset:		Valid if @common.type == %FW_CDEV_EVENT_BUS_RESET
359365  * @response:		Valid if @common.type == %FW_CDEV_EVENT_RESPONSE
....@@ -735,7 +741,7 @@
735741  * @header:	Header and payload in case of a transmit context.
736742  *
737743  * &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.
739745  * The @header array is empty in case of receive contexts.
740746  *
741747  * Context type %FW_CDEV_ISO_CONTEXT_TRANSMIT:
....@@ -842,7 +848,7 @@
842848  *		the %FW_CDEV_ISO_SYNC bit set
843849  * @tags:	Tag filter bit mask.  Only valid for isochronous reception.
844850  *		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.
846852  * @handle:	Isochronous context handle within which to transmit or receive
847853  */
848854 struct fw_cdev_start_iso {
....@@ -1009,8 +1015,8 @@
10091015  * on the same card as this device.  After transmission, an
10101016  * %FW_CDEV_EVENT_PHY_PACKET_SENT event is generated.
10111017  *
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
10141020  * are an exception to this rule.
10151021  *
10161022  * The ioctl is only permitted on device files which represent a local node.