firewire: fix warnings to generate UAPI documentation
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Thu, 1 Jun 2023 14:49:37 +0000 (23:49 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Mon, 5 Jun 2023 22:54:00 +0000 (07:54 +0900)
Any target to generate UAPI documentation reports warnings to missing
annotation for padding member in structures added recently.

This commit suppresses the warnings.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20230531135306.43613a59@canb.auug.org.au/
Fixes: 7c22d4a92bb2 ("firewire: cdev: add new event to notify request subaction with time stamp")
Fixes: fc2b52cf2e0e ("firewire: cdev: add new event to notify response subaction with time stamp")
Link: https://lore.kernel.org/r/20230601144937.121179-1-o-takashi@sakamocchi.jp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
include/uapi/linux/firewire-cdev.h

index 99e8239354276cbed6e73c5fca49ee2fb47048bc..1f2c9469f9214e989354907fd65a5066ac28f79b 100644 (file)
@@ -130,6 +130,9 @@ struct fw_cdev_event_response {
  * @length:    Data length, i.e. the response's payload size in bytes
  * @request_tstamp:    The time stamp of isochronous cycle at which the request was sent.
  * @response_tstamp:   The time stamp of isochronous cycle at which the response was sent.
+ * @padding:   Padding to keep the size of structure as multiples of 8 in various architectures
+ *             since 4 byte alignment is used for 8 byte of object type in System V ABI for i386
+ *             architecture.
  * @data:      Payload data, if any
  *
  * This event is sent when the stack receives a response to an outgoing request
@@ -155,10 +158,6 @@ struct fw_cdev_event_response2 {
        __u32 length;
        __u32 request_tstamp;
        __u32 response_tstamp;
-       /*
-        * Padding to keep the size of structure as multiples of 8 in various architectures since
-        * 4 byte alignment is used for 8 byte of object type in System V ABI for i386 architecture.
-        */
        __u32 padding;
        __u32 data[];
 };
@@ -231,6 +230,9 @@ struct fw_cdev_event_request2 {
  * @handle:    Reference to the kernel-side pending request
  * @length:    Data length, i.e. the request's payload size in bytes
  * @tstamp:    The time stamp of isochronous cycle at which the request arrived.
+ * @padding:   Padding to keep the size of structure as multiples of 8 in various architectures
+ *             since 4 byte alignment is used for 8 byte of object type in System V ABI for i386
+ *             architecture.
  * @data:      Incoming data, if any
  *
  * This event is sent when the stack receives an incoming request to an address
@@ -284,10 +286,6 @@ struct fw_cdev_event_request3 {
        __u32 handle;
        __u32 length;
        __u32 tstamp;
-       /*
-        * Padding to keep the size of structure as multiples of 8 in various architectures since
-        * 4 byte alignment is used for 8 byte of object type in System V ABI for i386 architecture.
-        */
        __u32 padding;
        __u32 data[];
 };