Date:   Wed, 1 Mar 2023 10:52:27 +0200
From:   Pekka Paalanen <ppaalanen@gmail.com>
To:     Rob Clark <robdclark@gmail.com>
Cc:     dri-devel@lists.freedesktop.org, freedreno@lists.freedesktop.org,
        Daniel Vetter <daniel@ffwll.ch>,
        Christian =?UTF-8?B?S8O2bmln?= <ckoenig.leichtzumerken@gmail.com>,
        Michel =?UTF-8?B?RMOkbnplcg==?= <michel@daenzer.net>,
        Tvrtko Ursulin <tvrtko.ursulin@intel.com>,
        Rodrigo Vivi <rodrigo.vivi@intel.com>,
        Alex Deucher <alexander.deucher@amd.com>,
        Simon Ser <contact@emersion.fr>,
        Luben Tuikov <luben.tuikov@amd.com>,
        Rob Clark <robdclark@chromium.org>,
        Sumit Semwal <sumit.semwal@linaro.org>,
        Christian =?UTF-8?B?S8O2bmln?= <christian.koenig@amd.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Gustavo Padovan <gustavo@padovan.org>,
        linux-media@vger.kernel.org (open list:DMA BUFFER SHARING FRAMEWORK),
        linaro-mm-sig@lists.linaro.org (moderated list:DMA BUFFER SHARING
        FRAMEWORK), linux-doc@vger.kernel.org (open list:DOCUMENTATION),
        linux-kernel@vger.kernel.org (open list)
Subject: Re: [PATCH v8 05/16] dma-buf/sync_file: Surface sync-file uABI
Message-ID: <20230301105227.756021aa@eldfell>
In-Reply-To: <20230228225833.2920879-6-robdclark@gmail.com>
References: <20230228225833.2920879-1-robdclark@gmail.com>
        <20230228225833.2920879-6-robdclark@gmail.com>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="Sig_/pdLdVdi+WgC8j5E+G3oBH8=";
 protocol="application/pgp-signature"; micalg=pgp-sha256
Precedence: bulk

--Sig_/pdLdVdi+WgC8j5E+G3oBH8=
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: quoted-printable

On Tue, 28 Feb 2023 14:58:09 -0800
Rob Clark <robdclark@gmail.com> wrote:

> From: Rob Clark <robdclark@chromium.org>
>=20
> 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.
>=20
> Signed-off-by: Rob Clark <robdclark@chromium.org>
> ---
>  Documentation/driver-api/dma-buf.rst | 10 ++++++--
>  include/uapi/linux/sync_file.h       | 35 +++++++++++-----------------
>  2 files changed, 22 insertions(+), 23 deletions(-)
>=20

Sounds good.
Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>


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:
> =20
> -DMA Fence uABI/Sync File
> -~~~~~~~~~~~~~~~~~~~~~~~~
> +DMA Fence Sync File
> +~~~~~~~~~~~~~~~~~~~
> =20
>  .. 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:
> =20
> +DMA Fence Sync File uABI
> +~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +.. kernel-doc:: include/uapi/linux/sync_file.h
> +   :internal:
> +
>  Indefinite DMA Fences
>  ~~~~~~~~~~~~~~~~~~~~~
> =20
> diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_fil=
e.h
> index ee2dcfb3d660..eced40c204d7 100644
> --- a/include/uapi/linux/sync_file.h
> +++ b/include/uapi/linux/sync_file.h
> @@ -16,12 +16,16 @@
>  #include <linux/types.h>
> =20
>  /**
> - * 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 {
>  	char	name[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 {
>  };
> =20
>  /**
> - * 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 &sync_fence_info with all
>   *		 fences in the sync_file
> + *
> + * Takes a struct sync_file_info. If num_fences is 0, the field is updat=
ed
> + * with the actual number of fences. If num_fences is > 0, the system wi=
ll
> + * use the pointer provided on sync_fence_info to return up to num_fence=
s of
> + * struct sync_fence_info, with detailed fence information.
>   */
>  struct sync_file_info {
>  	char	name[32];
> @@ -76,23 +85,7 @@ struct sync_file_info {
>   * no upstream users available.
>   */
> =20
> -/**
> - * DOC: SYNC_IOC_MERGE - merge two fences
> - *
> - * Takes a struct sync_merge_data.  Creates a new fence containing copie=
s 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 updat=
ed
> - * with the actual number of fences. If num_fences is > 0, the system wi=
ll
> - * use the pointer provided on sync_fence_info to return up to num_fence=
s of
> - * struct sync_fence_info, with detailed fence information.
> - */
>  #define SYNC_IOC_FILE_INFO	_IOWR(SYNC_IOC_MAGIC, 4, struct sync_file_inf=
o)
> =20
>  #endif /* _UAPI_LINUX_SYNC_H */


--Sig_/pdLdVdi+WgC8j5E+G3oBH8=
Content-Type: application/pgp-signature
Content-Description: OpenPGP digital signature

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEJQjwWQChkWOYOIONI1/ltBGqqqcFAmP/EkwACgkQI1/ltBGq
qqdUKA/+I1j5vdvPjYXQZQ+DoS7zE1P9c4jnXG17sSyBGZkPwmZW+P7ULtei9h2q
nfjeWQgVfNHSB2e4rQps+6fXx5LvdwDIiEpDyP+2xPcLmbfLx2452cS+UtzeqZIi
cm6eTBFQK3YcG1+D0NFbjPiKbpk7i99FprWwO/XREi02BRKpcSSGzT4wZyysBMSu
Ok+GmJdeMnWAzLi7p9DepoG0TKjnzi8e45ovFdieHym0MSstzeLsHe1dokYHfOjv
kOkQCHEzwlWfeZKUnuNXd2VCU3VPmfpst0AAiTgdqz3QWui900Q0S0kdVI/xEqEW
6tekiPHlA+PYf5n6PCc7hpxqiLWB6pr7EadS5fwbjFJaF2gWByGz2q3slURt0Xnf
NAiH7fHsbxBzSkM4KSJrD2kng8iSX3DWYo/L0DesmjhX/RX/nXRpVX7c5uHgQSNY
1sl90g0JRM86o+DU6OUPGO07ZKBe1MlJmsKVcxNnVU+d5YqrDroGsw/ocJlT7zZO
c7QyqIh8qp/Oy8bWWuOgrG2CyEjwiFaB2t0wVnJhnG2BnOrWfF+rpBdU/+SB4AaH
bzy+bvdKaxIJvzUW4GYSu+rO0icdj+VnsGW8/8Ho0aFNYQRS9aq/EDGpBX4CKZ7t
rnzbVZFqzpkat+L+u8tLQkG8LGK9iE63ZS5mg4MfpAlugoDzb6I=
=yVJf
-----END PGP SIGNATURE-----

--Sig_/pdLdVdi+WgC8j5E+G3oBH8=--