Commit b0e47225 authored by Francois Dugast's avatar Francois Dugast Committed by Rodrigo Vivi

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

Add a comment to each struct to complete documentation, ensure all
struct appear in the kernel doc, and bind structs to IOCTLs.
Reviewed-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
Acked-by: default avatarJosé Roberto de Souza <jose.souza@intel.com>
Acked-by: default avatarMateusz Naklicki <mateusz.naklicki@intel.com>
Signed-off-by: default avatarFrancois Dugast <francois.dugast@intel.com>
Signed-off-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
parent d3d76739
...@@ -464,7 +464,8 @@ struct drm_xe_query_topology_mask { ...@@ -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 * 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, * requested type of data to query. If size is equal to the required size,
...@@ -526,6 +527,10 @@ struct drm_xe_device_query { ...@@ -526,6 +527,10 @@ struct drm_xe_device_query {
__u64 reserved[2]; __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 { struct drm_xe_gem_create {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -604,6 +609,9 @@ struct drm_xe_gem_create { ...@@ -604,6 +609,9 @@ struct drm_xe_gem_create {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_gem_mmap_offset - Input of &DRM_IOCTL_XE_GEM_MMAP_OFFSET
*/
struct drm_xe_gem_mmap_offset { struct drm_xe_gem_mmap_offset {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -621,7 +629,9 @@ struct drm_xe_gem_mmap_offset { ...@@ -621,7 +629,9 @@ struct drm_xe_gem_mmap_offset {
__u64 reserved[2]; __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 { struct drm_xe_ext_set_property {
/** @base: base user extension */ /** @base: base user extension */
struct drm_xe_user_extension base; struct drm_xe_user_extension base;
...@@ -639,6 +649,9 @@ struct drm_xe_ext_set_property { ...@@ -639,6 +649,9 @@ struct drm_xe_ext_set_property {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_vm_create - Input of &DRM_IOCTL_XE_VM_CREATE
*/
struct drm_xe_vm_create { struct drm_xe_vm_create {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -677,6 +690,9 @@ struct drm_xe_vm_create { ...@@ -677,6 +690,9 @@ struct drm_xe_vm_create {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_vm_destroy - Input of &DRM_IOCTL_XE_VM_DESTROY
*/
struct drm_xe_vm_destroy { struct drm_xe_vm_destroy {
/** @vm_id: VM ID */ /** @vm_id: VM ID */
__u32 vm_id; __u32 vm_id;
...@@ -688,6 +704,9 @@ struct drm_xe_vm_destroy { ...@@ -688,6 +704,9 @@ struct drm_xe_vm_destroy {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_vm_bind_op
*/
struct drm_xe_vm_bind_op { struct drm_xe_vm_bind_op {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -804,6 +823,9 @@ struct drm_xe_vm_bind_op { ...@@ -804,6 +823,9 @@ struct drm_xe_vm_bind_op {
__u64 reserved[3]; __u64 reserved[3];
}; };
/**
* struct drm_xe_vm_bind - Input of &DRM_IOCTL_XE_VM_BIND
*/
struct drm_xe_vm_bind { struct drm_xe_vm_bind {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -862,6 +884,9 @@ struct drm_xe_vm_bind { ...@@ -862,6 +884,9 @@ struct drm_xe_vm_bind {
/* Monitor 64MB contiguous region with 2M sub-granularity */ /* Monitor 64MB contiguous region with 2M sub-granularity */
#define DRM_XE_ACC_GRANULARITY_64M 3 #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 { struct drm_xe_exec_queue_create {
#define DRM_XE_EXEC_QUEUE_EXTENSION_SET_PROPERTY 0 #define DRM_XE_EXEC_QUEUE_EXTENSION_SET_PROPERTY 0
#define DRM_XE_EXEC_QUEUE_SET_PROPERTY_PRIORITY 0 #define DRM_XE_EXEC_QUEUE_SET_PROPERTY_PRIORITY 0
...@@ -904,6 +929,9 @@ struct drm_xe_exec_queue_create { ...@@ -904,6 +929,9 @@ struct drm_xe_exec_queue_create {
__u64 reserved[2]; __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 { struct drm_xe_exec_queue_get_property {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -922,6 +950,9 @@ struct drm_xe_exec_queue_get_property { ...@@ -922,6 +950,9 @@ struct drm_xe_exec_queue_get_property {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_exec_queue_destroy - Input of &DRM_IOCTL_XE_EXEC_QUEUE_DESTROY
*/
struct drm_xe_exec_queue_destroy { struct drm_xe_exec_queue_destroy {
/** @exec_queue_id: Exec queue ID */ /** @exec_queue_id: Exec queue ID */
__u32 exec_queue_id; __u32 exec_queue_id;
...@@ -933,6 +964,9 @@ struct drm_xe_exec_queue_destroy { ...@@ -933,6 +964,9 @@ struct drm_xe_exec_queue_destroy {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_sync
*/
struct drm_xe_sync { struct drm_xe_sync {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -967,6 +1001,9 @@ struct drm_xe_sync { ...@@ -967,6 +1001,9 @@ struct drm_xe_sync {
__u64 reserved[2]; __u64 reserved[2];
}; };
/**
* struct drm_xe_exec - Input of &DRM_IOCTL_XE_EXEC
*/
struct drm_xe_exec { struct drm_xe_exec {
/** @extensions: Pointer to the first extension struct, if any */ /** @extensions: Pointer to the first extension struct, if any */
__u64 extensions; __u64 extensions;
...@@ -1000,7 +1037,7 @@ struct drm_xe_exec { ...@@ -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 * Wait on user fence, XE will wake-up on every HW engine interrupt in the
* instances list and check if user fence is complete:: * instances list and check if user fence is complete::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment