Re: [PATCH v8 05/16] dma-buf/sync_file: Surface sync-file uABI
Hi Rob, I love your patch! Perhaps something to improve: [auto build test WARNING on drm-intel/for-linux-next] [also build test WARNING on drm-intel/for-linux-next-fixes drm/drm-next linus/master v6.2 next-20230301] [cannot apply to drm-misc/drm-misc-next] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in https://git-scm.com/docs/git-format-patch#_base_tree_information] url: https://github.com/intel-lab-lkp/linux/commits/Rob-Clark/dma-buf-dma-fence-Add-deadline-awareness/20230301-070358 base: git://anongit.freedesktop.org/drm-intel for-linux-next patch link: https://lore.kernel.org/r/20230228225833.2920879-6-robdclark%40gmail.com patch subject: [PATCH v8 05/16] dma-buf/sync_file: Surface sync-file uABI reproduce: # https://github.com/intel-lab-lkp/linux/commit/b13821931cc3898065e4264fad78bad23c7d2208 git remote add linux-review https://github.com/intel-lab-lkp/linux git fetch --no-tags linux-review Rob-Clark/dma-buf-dma-fence-Add-deadline-awareness/20230301-070358 git checkout b13821931cc3898065e4264fad78bad23c7d2208 make menuconfig # enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS make htmldocs If you fix the issue, kindly add following tag where applicable | Reported-by: kernel test robot | Link: https://lore.kernel.org/oe-kbuild-all/202303021119.ral7hvmc-...@intel.com/ All warnings (new ones prefixed by >>): >> ./include/uapi/linux/sync_file.h:82: warning: This comment starts with >> '/**', but isn't a kernel-doc comment. Refer >> Documentation/doc-guide/kernel-doc.rst vim +82 ./include/uapi/linux/sync_file.h 64907b94dab947 drivers/staging/android/uapi/sync.h Colin Cross 2014-02-17 80 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 81 /** 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 @82 * Opcodes 0, 1 and 2 were burned during a API change to avoid users of the 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 83 * old API to get weird errors when trying to handling sync_files. The API 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 84 * change happened during the de-stage of the Sync Framework when there was 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 85 * no upstream users available. 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 86 */ 2d75c88fefb228 drivers/staging/android/uapi/sync.h Gustavo Padovan 2016-04-26 87 -- 0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests
Re: [PATCH v8 05/16] dma-buf/sync_file: Surface sync-file uABI
On Tue, 28 Feb 2023 14:58:09 -0800
Rob Clark wrote:
> From: Rob Clark
>
> We had all of the internal driver APIs, but not the all important
> userspace uABI, in the dma-buf doc. Fix that. And re-arrange the
> comments slightly as otherwise the comments for the ioctl nr defines
> would not show up.
>
> Signed-off-by: Rob Clark
> ---
> Documentation/driver-api/dma-buf.rst | 10 ++--
> include/uapi/linux/sync_file.h | 35 +++-
> 2 files changed, 22 insertions(+), 23 deletions(-)
>
Sounds good.
Acked-by: Pekka Paalanen
Thanks,
pq
> diff --git a/Documentation/driver-api/dma-buf.rst
> b/Documentation/driver-api/dma-buf.rst
> index 183e480d8cea..ff3f8da296af 100644
> --- a/Documentation/driver-api/dma-buf.rst
> +++ b/Documentation/driver-api/dma-buf.rst
> @@ -203,8 +203,8 @@ DMA Fence unwrap
> .. kernel-doc:: include/linux/dma-fence-unwrap.h
> :internal:
>
> -DMA Fence uABI/Sync File
> -
> +DMA Fence Sync File
> +~~~
>
> .. kernel-doc:: drivers/dma-buf/sync_file.c
> :export:
> @@ -212,6 +212,12 @@ DMA Fence uABI/Sync File
> .. kernel-doc:: include/linux/sync_file.h
> :internal:
>
> +DMA Fence Sync File uABI
> +
> +
> +.. kernel-doc:: include/uapi/linux/sync_file.h
> + :internal:
> +
> Indefinite DMA Fences
> ~
>
> diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h
> index ee2dcfb3d660..eced40c204d7 100644
> --- a/include/uapi/linux/sync_file.h
> +++ b/include/uapi/linux/sync_file.h
> @@ -16,12 +16,16 @@
> #include
>
> /**
> - * struct sync_merge_data - data passed to merge ioctl
> + * struct sync_merge_data - SYNC_IOC_MERGE: merge two fences
> * @name:name of new fence
> * @fd2: file descriptor of second fence
> * @fence: returns the fd of the new fence to userspace
> * @flags: merge_data flags
> * @pad: padding for 64-bit alignment, should always be zero
> + *
> + * Creates a new fence containing copies of the sync_pts in both
> + * the calling fd and sync_merge_data.fd2. Returns the new fence's
> + * fd in sync_merge_data.fence
> */
> struct sync_merge_data {
> charname[32];
> @@ -34,8 +38,8 @@ struct sync_merge_data {
> /**
> * struct sync_fence_info - detailed fence information
> * @obj_name:name of parent sync_timeline
> -* @driver_name: name of driver implementing the parent
> -* @status: status of the fence 0:active 1:signaled <0:error
> + * @driver_name: name of driver implementing the parent
> + * @status: status of the fence 0:active 1:signaled <0:error
> * @flags: fence_info flags
> * @timestamp_ns:timestamp of status change in nanoseconds
> */
> @@ -48,14 +52,19 @@ struct sync_fence_info {
> };
>
> /**
> - * struct sync_file_info - data returned from fence info ioctl
> + * struct sync_file_info - SYNC_IOC_FILE_INFO: get detailed information on a
> sync_file
> * @name:name of fence
> * @status: status of fence. 1: signaled 0:active <0:error
> * @flags: sync_file_info flags
> * @num_fences number of fences in the sync_file
> * @pad: padding for 64-bit alignment, should always be zero
> - * @sync_fence_info: pointer to array of structs sync_fence_info with all
> + * @sync_fence_info: pointer to array of struct _fence_info with all
> *fences in the sync_file
> + *
> + * Takes a struct sync_file_info. If num_fences is 0, the field is updated
> + * with the actual number of fences. If num_fences is > 0, the system will
> + * use the pointer provided on sync_fence_info to return up to num_fences of
> + * struct sync_fence_info, with detailed fence information.
> */
> struct sync_file_info {
> charname[32];
> @@ -76,23 +85,7 @@ struct sync_file_info {
> * no upstream users available.
> */
>
> -/**
> - * DOC: SYNC_IOC_MERGE - merge two fences
> - *
> - * Takes a struct sync_merge_data. Creates a new fence containing copies of
> - * the sync_pts in both the calling fd and sync_merge_data.fd2. Returns the
> - * new fence's fd in sync_merge_data.fence
> - */
> #define SYNC_IOC_MERGE _IOWR(SYNC_IOC_MAGIC, 3, struct
> sync_merge_data)
> -
> -/**
> - * DOC: SYNC_IOC_FILE_INFO - get detailed information on a sync_file
> - *
> - * Takes a struct sync_file_info. If num_fences is 0, the field is updated
> - * with the actual number of fences. If num_fences is > 0, the system will
> - * use the pointer provided on sync_fence_info to return up to num_fences of
> - * struct sync_fence_info, with detailed fence information.
> - */
> #define SYNC_IOC_FILE_INFO _IOWR(SYNC_IOC_MAGIC, 4, struct sync_file_info)
>
> #endif /* _UAPI_LINUX_SYNC_H */
pgpldOu2oAb_O.pgp
Description: OpenPGP digital signature
[PATCH v8 05/16] dma-buf/sync_file: Surface sync-file uABI
From: Rob Clark
We had all of the internal driver APIs, but not the all important
userspace uABI, in the dma-buf doc. Fix that. And re-arrange the
comments slightly as otherwise the comments for the ioctl nr defines
would not show up.
Signed-off-by: Rob Clark
---
Documentation/driver-api/dma-buf.rst | 10 ++--
include/uapi/linux/sync_file.h | 35 +++-
2 files changed, 22 insertions(+), 23 deletions(-)
diff --git a/Documentation/driver-api/dma-buf.rst
b/Documentation/driver-api/dma-buf.rst
index 183e480d8cea..ff3f8da296af 100644
--- a/Documentation/driver-api/dma-buf.rst
+++ b/Documentation/driver-api/dma-buf.rst
@@ -203,8 +203,8 @@ DMA Fence unwrap
.. kernel-doc:: include/linux/dma-fence-unwrap.h
:internal:
-DMA Fence uABI/Sync File
-
+DMA Fence Sync File
+~~~
.. kernel-doc:: drivers/dma-buf/sync_file.c
:export:
@@ -212,6 +212,12 @@ DMA Fence uABI/Sync File
.. kernel-doc:: include/linux/sync_file.h
:internal:
+DMA Fence Sync File uABI
+
+
+.. kernel-doc:: include/uapi/linux/sync_file.h
+ :internal:
+
Indefinite DMA Fences
~
diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h
index ee2dcfb3d660..eced40c204d7 100644
--- a/include/uapi/linux/sync_file.h
+++ b/include/uapi/linux/sync_file.h
@@ -16,12 +16,16 @@
#include
/**
- * struct sync_merge_data - data passed to merge ioctl
+ * struct sync_merge_data - SYNC_IOC_MERGE: merge two fences
* @name: name of new fence
* @fd2: file descriptor of second fence
* @fence: returns the fd of the new fence to userspace
* @flags: merge_data flags
* @pad: padding for 64-bit alignment, should always be zero
+ *
+ * Creates a new fence containing copies of the sync_pts in both
+ * the calling fd and sync_merge_data.fd2. Returns the new fence's
+ * fd in sync_merge_data.fence
*/
struct sync_merge_data {
charname[32];
@@ -34,8 +38,8 @@ struct sync_merge_data {
/**
* struct sync_fence_info - detailed fence information
* @obj_name: name of parent sync_timeline
-* @driver_name:name of driver implementing the parent
-* @status: status of the fence 0:active 1:signaled <0:error
+ * @driver_name: name of driver implementing the parent
+ * @status:status of the fence 0:active 1:signaled <0:error
* @flags: fence_info flags
* @timestamp_ns: timestamp of status change in nanoseconds
*/
@@ -48,14 +52,19 @@ struct sync_fence_info {
};
/**
- * struct sync_file_info - data returned from fence info ioctl
+ * struct sync_file_info - SYNC_IOC_FILE_INFO: get detailed information on a
sync_file
* @name: name of fence
* @status:status of fence. 1: signaled 0:active <0:error
* @flags: sync_file_info flags
* @num_fences number of fences in the sync_file
* @pad: padding for 64-bit alignment, should always be zero
- * @sync_fence_info: pointer to array of structs sync_fence_info with all
+ * @sync_fence_info: pointer to array of struct _fence_info with all
* fences in the sync_file
+ *
+ * Takes a struct sync_file_info. If num_fences is 0, the field is updated
+ * with the actual number of fences. If num_fences is > 0, the system will
+ * use the pointer provided on sync_fence_info to return up to num_fences of
+ * struct sync_fence_info, with detailed fence information.
*/
struct sync_file_info {
charname[32];
@@ -76,23 +85,7 @@ struct sync_file_info {
* no upstream users available.
*/
-/**
- * DOC: SYNC_IOC_MERGE - merge two fences
- *
- * Takes a struct sync_merge_data. Creates a new fence containing copies of
- * the sync_pts in both the calling fd and sync_merge_data.fd2. Returns the
- * new fence's fd in sync_merge_data.fence
- */
#define SYNC_IOC_MERGE _IOWR(SYNC_IOC_MAGIC, 3, struct sync_merge_data)
-
-/**
- * DOC: SYNC_IOC_FILE_INFO - get detailed information on a sync_file
- *
- * Takes a struct sync_file_info. If num_fences is 0, the field is updated
- * with the actual number of fences. If num_fences is > 0, the system will
- * use the pointer provided on sync_fence_info to return up to num_fences of
- * struct sync_fence_info, with detailed fence information.
- */
#define SYNC_IOC_FILE_INFO _IOWR(SYNC_IOC_MAGIC, 4, struct sync_file_info)
#endif /* _UAPI_LINUX_SYNC_H */
--
2.39.1
