iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

drm/xe/uapi: Add a comment to each struct

Browse Source 
Add a comment to each struct to complete documentation, ensure all
struct appear in the kernel doc, and bind structs to IOCTLs.

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Acked-by: José Roberto de Souza <jose.souza@intel.com>
Acked-by: Mateusz Naklicki <mateusz.naklicki@intel.com>
Signed-off-by: Francois Dugast <francois.dugast@intel.com>
Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
This commit is contained in:
Francois Dugast 2023-12-15 15:45:40 +00:00 committed by Rodrigo Vivi
parent d3d767396a
commit b0e47225a1
1 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
include/uapi/drm/xe_drm.h
View File

@ -464,7 +464,8 @@ struct drm_xe_query_topology_mask {
};
/**
* struct drm_xe_device_query - main structure to query device information
* struct drm_xe_device_query - Input of &DRM_IOCTL_XE_DEVICE_QUERY - main
* structure to query device information
*
* If size is set to 0, the driver fills it with the required size for the
* requested type of data to query. If size is equal to the required size,
@ -526,6 +527,10 @@ struct drm_xe_device_query {
__u64 reserved[2];
};
/**
* struct drm_xe_gem_create - Input of &DRM_IOCTL_XE_GEM_CREATE - A structure for
* gem creation
*/
struct drm_xe_gem_create {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -604,6 +609,9 @@ struct drm_xe_gem_create {
__u64 reserved[2];
};
/**
* struct drm_xe_gem_mmap_offset - Input of &DRM_IOCTL_XE_GEM_MMAP_OFFSET
*/
struct drm_xe_gem_mmap_offset {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -621,7 +629,9 @@ struct drm_xe_gem_mmap_offset {
__u64 reserved[2];
};
/** struct drm_xe_ext_set_property - XE set property extension */
/**
* struct drm_xe_ext_set_property - XE set property extension
*/
struct drm_xe_ext_set_property {
/** @base: base user extension */
struct drm_xe_user_extension base;
@ -639,6 +649,9 @@ struct drm_xe_ext_set_property {
__u64 reserved[2];
};
/**
* struct drm_xe_vm_create - Input of &DRM_IOCTL_XE_VM_CREATE
*/
struct drm_xe_vm_create {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -677,6 +690,9 @@ struct drm_xe_vm_create {
__u64 reserved[2];
};
/**
* struct drm_xe_vm_destroy - Input of &DRM_IOCTL_XE_VM_DESTROY
*/
struct drm_xe_vm_destroy {
/** @vm_id: VM ID */
__u32 vm_id;
@ -688,6 +704,9 @@ struct drm_xe_vm_destroy {
__u64 reserved[2];
};
/**
* struct drm_xe_vm_bind_op
*/
struct drm_xe_vm_bind_op {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -804,6 +823,9 @@ struct drm_xe_vm_bind_op {
__u64 reserved[3];
};
/**
* struct drm_xe_vm_bind - Input of &DRM_IOCTL_XE_VM_BIND
*/
struct drm_xe_vm_bind {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -862,6 +884,9 @@ struct drm_xe_vm_bind {
/* Monitor 64MB contiguous region with 2M sub-granularity */
#define DRM_XE_ACC_GRANULARITY_64M 3
/**
* struct drm_xe_exec_queue_create - Input of &DRM_IOCTL_XE_EXEC_QUEUE_CREATE
*/
struct drm_xe_exec_queue_create {
#define DRM_XE_EXEC_QUEUE_EXTENSION_SET_PROPERTY 0
#define DRM_XE_EXEC_QUEUE_SET_PROPERTY_PRIORITY 0
@ -904,6 +929,9 @@ struct drm_xe_exec_queue_create {
__u64 reserved[2];
};
/**
* struct drm_xe_exec_queue_get_property - Input of &DRM_IOCTL_XE_EXEC_QUEUE_GET_PROPERTY
*/
struct drm_xe_exec_queue_get_property {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -922,6 +950,9 @@ struct drm_xe_exec_queue_get_property {
__u64 reserved[2];
};
/**
* struct drm_xe_exec_queue_destroy - Input of &DRM_IOCTL_XE_EXEC_QUEUE_DESTROY
*/
struct drm_xe_exec_queue_destroy {
/** @exec_queue_id: Exec queue ID */
__u32 exec_queue_id;
@ -933,6 +964,9 @@ struct drm_xe_exec_queue_destroy {
__u64 reserved[2];
};
/**
* struct drm_xe_sync
*/
struct drm_xe_sync {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -967,6 +1001,9 @@ struct drm_xe_sync {
__u64 reserved[2];
};
/**
* struct drm_xe_exec - Input of &DRM_IOCTL_XE_EXEC
*/
struct drm_xe_exec {
/** @extensions: Pointer to the first extension struct, if any */
__u64 extensions;
@ -1000,7 +1037,7 @@ struct drm_xe_exec {
};
/**
* struct drm_xe_wait_user_fence - wait user fence
* struct drm_xe_wait_user_fence - Input of &DRM_IOCTL_XE_WAIT_USER_FENCE
*
* Wait on user fence, XE will wake-up on every HW engine interrupt in the
* instances list and check if user fence is complete::