History

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.

Francois Dugast committed 2 years ago

Commit b0e47221 parent d3d76731 file · +40 −3Browse files

Showing the changes to include/uapi/drm (1 of 1 file). Show all

Unified · Split

include/uapi/drm/xe_drm.h+40−3
@@ -464,7 +464,8 @@ struct drm_xe_query_topology_mask { · 463 unmodified lines
464};464};
465 465
466/**466/**
467 * struct drm_xe_device_query - main structure to query device information467 * struct drm_xe_device_query - Input of &DRM_IOCTL_XE_DEVICE_QUERY - main
468 * structure to query device information
468 *469 *
469 * If size is set to 0, the driver fills it with the required size for the470 * If size is set to 0, the driver fills it with the required size for the
470 * requested type of data to query. If size is equal to the required size,471 * requested type of data to query. If size is equal to the required size,
@@ -526,6 +527,10 @@ struct drm_xe_device_query { · 55 unmodified lines
526 __u64 reserved[2];527 __u64 reserved[2];
527};528};
528 529
530/**
531 * struct drm_xe_gem_create - Input of &DRM_IOCTL_XE_GEM_CREATE - A structure for
532 * gem creation
533 */
529struct drm_xe_gem_create {534struct drm_xe_gem_create {
530 /** @extensions: Pointer to the first extension struct, if any */535 /** @extensions: Pointer to the first extension struct, if any */
531 __u64 extensions;536 __u64 extensions;
@@ -604,6 +609,9 @@ struct drm_xe_gem_create { · 72 unmodified lines
604 __u64 reserved[2];609 __u64 reserved[2];
605};610};
606 611
612/**
613 * struct drm_xe_gem_mmap_offset - Input of &DRM_IOCTL_XE_GEM_MMAP_OFFSET
614 */
607struct drm_xe_gem_mmap_offset {615struct drm_xe_gem_mmap_offset {
608 /** @extensions: Pointer to the first extension struct, if any */616 /** @extensions: Pointer to the first extension struct, if any */
609 __u64 extensions;617 __u64 extensions;
@@ -621,7 +629,9 @@ struct drm_xe_gem_mmap_offset { · 11 unmodified lines
621 __u64 reserved[2];629 __u64 reserved[2];
622};630};
623 631
624/** struct drm_xe_ext_set_property - XE set property extension */632/**
633 * struct drm_xe_ext_set_property - XE set property extension
634 */
625struct drm_xe_ext_set_property {635struct drm_xe_ext_set_property {
626 /** @base: base user extension */636 /** @base: base user extension */
627 struct drm_xe_user_extension base;637 struct drm_xe_user_extension base;
@@ -639,6 +649,9 @@ struct drm_xe_ext_set_property { · 11 unmodified lines
639 __u64 reserved[2];649 __u64 reserved[2];
640};650};
641 651
652/**
653 * struct drm_xe_vm_create - Input of &DRM_IOCTL_XE_VM_CREATE
654 */
642struct drm_xe_vm_create {655struct drm_xe_vm_create {
643 /** @extensions: Pointer to the first extension struct, if any */656 /** @extensions: Pointer to the first extension struct, if any */
644 __u64 extensions;657 __u64 extensions;
@@ -677,6 +690,9 @@ struct drm_xe_vm_create { · 32 unmodified lines
677 __u64 reserved[2];690 __u64 reserved[2];
678};691};
679 692
693/**
694 * struct drm_xe_vm_destroy - Input of &DRM_IOCTL_XE_VM_DESTROY
695 */
680struct drm_xe_vm_destroy {696struct drm_xe_vm_destroy {
681 /** @vm_id: VM ID */697 /** @vm_id: VM ID */
682 __u32 vm_id;698 __u32 vm_id;
@@ -688,6 +704,9 @@ struct drm_xe_vm_destroy { · 5 unmodified lines
688 __u64 reserved[2];704 __u64 reserved[2];
689};705};
690 706
707/**
708 * struct drm_xe_vm_bind_op
709 */
691struct drm_xe_vm_bind_op {710struct drm_xe_vm_bind_op {
692 /** @extensions: Pointer to the first extension struct, if any */711 /** @extensions: Pointer to the first extension struct, if any */
693 __u64 extensions;712 __u64 extensions;
@@ -804,6 +823,9 @@ struct drm_xe_vm_bind_op { · 110 unmodified lines
804 __u64 reserved[3];823 __u64 reserved[3];
805};824};
806 825
826/**
827 * struct drm_xe_vm_bind - Input of &DRM_IOCTL_XE_VM_BIND
828 */
807struct drm_xe_vm_bind {829struct drm_xe_vm_bind {
808 /** @extensions: Pointer to the first extension struct, if any */830 /** @extensions: Pointer to the first extension struct, if any */
809 __u64 extensions;831 __u64 extensions;
@@ -862,6 +884,9 @@ struct drm_xe_vm_bind { · 52 unmodified lines
862/* Monitor 64MB contiguous region with 2M sub-granularity */884/* Monitor 64MB contiguous region with 2M sub-granularity */
863#define DRM_XE_ACC_GRANULARITY_64M 3885#define DRM_XE_ACC_GRANULARITY_64M 3
864 886
887/**
888 * struct drm_xe_exec_queue_create - Input of &DRM_IOCTL_XE_EXEC_QUEUE_CREATE
889 */
865struct drm_xe_exec_queue_create {890struct drm_xe_exec_queue_create {
866#define DRM_XE_EXEC_QUEUE_EXTENSION_SET_PROPERTY 0891#define DRM_XE_EXEC_QUEUE_EXTENSION_SET_PROPERTY 0
867#define DRM_XE_EXEC_QUEUE_SET_PROPERTY_PRIORITY 0892#define DRM_XE_EXEC_QUEUE_SET_PROPERTY_PRIORITY 0
@@ -904,6 +929,9 @@ struct drm_xe_exec_queue_create { · 36 unmodified lines
904 __u64 reserved[2];929 __u64 reserved[2];
905};930};
906 931
932/**
933 * struct drm_xe_exec_queue_get_property - Input of &DRM_IOCTL_XE_EXEC_QUEUE_GET_PROPERTY
934 */
907struct drm_xe_exec_queue_get_property {935struct drm_xe_exec_queue_get_property {
908 /** @extensions: Pointer to the first extension struct, if any */936 /** @extensions: Pointer to the first extension struct, if any */
909 __u64 extensions;937 __u64 extensions;
@@ -922,6 +950,9 @@ struct drm_xe_exec_queue_get_property { · 12 unmodified lines
922 __u64 reserved[2];950 __u64 reserved[2];
923};951};
924 952
953/**
954 * struct drm_xe_exec_queue_destroy - Input of &DRM_IOCTL_XE_EXEC_QUEUE_DESTROY
955 */
925struct drm_xe_exec_queue_destroy {956struct drm_xe_exec_queue_destroy {
926 /** @exec_queue_id: Exec queue ID */957 /** @exec_queue_id: Exec queue ID */
927 __u32 exec_queue_id;958 __u32 exec_queue_id;
@@ -933,6 +964,9 @@ struct drm_xe_exec_queue_destroy { · 5 unmodified lines
933 __u64 reserved[2];964 __u64 reserved[2];
934};965};
935 966
967/**
968 * struct drm_xe_sync
969 */
936struct drm_xe_sync {970struct drm_xe_sync {
937 /** @extensions: Pointer to the first extension struct, if any */971 /** @extensions: Pointer to the first extension struct, if any */
938 __u64 extensions;972 __u64 extensions;
@@ -967,6 +1001,9 @@ struct drm_xe_sync { · 28 unmodified lines
967 __u64 reserved[2];1001 __u64 reserved[2];
968};1002};
969 1003
1004/**
1005 * struct drm_xe_exec - Input of &DRM_IOCTL_XE_EXEC
1006 */
970struct drm_xe_exec {1007struct drm_xe_exec {
971 /** @extensions: Pointer to the first extension struct, if any */1008 /** @extensions: Pointer to the first extension struct, if any */
972 __u64 extensions;1009 __u64 extensions;
@@ -1000,7 +1037,7 @@ struct drm_xe_exec { · 27 unmodified lines
1000};1037};
1001 1038
1002/**1039/**
1003 * struct drm_xe_wait_user_fence - wait user fence1040 * struct drm_xe_wait_user_fence - Input of &DRM_IOCTL_XE_WAIT_USER_FENCE
1004 *1041 *
1005 * Wait on user fence, XE will wake-up on every HW engine interrupt in the1042 * Wait on user fence, XE will wake-up on every HW engine interrupt in the
1006 * instances list and check if user fence is complete::1043 * instances list and check if user fence is complete::