Commit 08641973 authored by David Francis's avatar David Francis Committed by Christian König
Browse files

drm: Move drm_gem ioctl kerneldoc to uapi file 



The drm_gem ioctls were documented in internal file drm_gem.c
instead of uapi header drm.h. Move them there and change to
appropriate kerneldoc formatting.

Signed-off-by: default avatarDavid Francis <David.Francis@amd.com>
Reviewed-by: default avatarSimona Vetter <simona.vetter@ffwll.ch>
Signed-off-by: default avatarChristian König <christian.koenig@amd.com>
Link: https://lore.kernel.org/r/20250717143556.857893-3-David.Francis@amd.com
parent 53096728

drivers/gpu/drm/drm_gem.c

+0 −30
Original line number Diff line number Diff line
@@ -821,14 +821,6 @@ long drm_gem_dma_resv_wait(struct drm_file *filep, u32 handle, 
}

EXPORT_SYMBOL(drm_gem_dma_resv_wait);



/**

 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl

 * @dev: drm_device

 * @data: ioctl data

 * @file_priv: drm file-private structure

 *

 * Releases the handle to an mm object.

 */

int

drm_gem_close_ioctl(struct drm_device *dev, void *data,

		    struct drm_file *file_priv)
@@ -844,17 +836,6 @@ drm_gem_close_ioctl(struct drm_device *dev, void *data, 
	return ret;

}



/**

 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl

 * @dev: drm_device

 * @data: ioctl data

 * @file_priv: drm file-private structure

 *

 * Create a global name for an object, returning the name.

 *

 * Note that the name does not hold a reference; when the object

 * is freed, the name goes away.

 */

int

drm_gem_flink_ioctl(struct drm_device *dev, void *data,

		    struct drm_file *file_priv)
@@ -894,17 +875,6 @@ drm_gem_flink_ioctl(struct drm_device *dev, void *data, 
	return ret;

}



/**

 * drm_gem_open_ioctl - implementation of the GEM_OPEN ioctl

 * @dev: drm_device

 * @data: ioctl data

 * @file_priv: drm file-private structure

 *

 * Open an object using the global name, returning a handle and the size.

 *

 * This handle (of course) holds a reference to the object, so the object

 * will not go away until the handle is deleted.

 */

int

drm_gem_open_ioctl(struct drm_device *dev, void *data,

		   struct drm_file *file_priv)

include/uapi/drm/drm.h

+28 −12
Original line number Diff line number Diff line
@@ -597,31 +597,47 @@ struct drm_set_version { 
	int drm_dd_minor;

};



/* DRM_IOCTL_GEM_CLOSE ioctl argument type */

/**

 * struct drm_gem_close - Argument for &DRM_IOCTL_GEM_CLOSE ioctl.

 * @handle: Handle of the object to be closed.

 * @pad: Padding.

 *

 * Releases the handle to an mm object.

 */

struct drm_gem_close {

	/** Handle of the object to be closed. */

	__u32 handle;

	__u32 pad;

};



/* DRM_IOCTL_GEM_FLINK ioctl argument type */

/**

 * struct drm_gem_flink - Argument for &DRM_IOCTL_GEM_FLINK ioctl.

 * @handle: Handle for the object being named.

 * @name: Returned global name.

 *

 * Create a global name for an object, returning the name.

 *

 * Note that the name does not hold a reference; when the object

 * is freed, the name goes away.

 */

struct drm_gem_flink {

	/** Handle for the object being named */

	__u32 handle;



	/** Returned global name */

	__u32 name;

};



/* DRM_IOCTL_GEM_OPEN ioctl argument type */

/**

 * struct drm_gem_open - Argument for &DRM_IOCTL_GEM_OPEN ioctl.

 * @name: Name of object being opened.

 * @handle: Returned handle for the object.

 * @size: Returned size of the object

 *

 * Open an object using the global name, returning a handle and the size.

 *

 * This handle (of course) holds a reference to the object, so the object

 * will not go away until the handle is deleted.

 */

struct drm_gem_open {

	/** Name of object being opened */

	__u32 name;



	/** Returned handle for the object */

	__u32 handle;



	/** Returned size of the object */

	__u64 size;

};