Commit 63f9c3cd authored by Matthew Auld's avatar Matthew Auld Committed by Rodrigo Vivi

drm/xe/uapi: silence kernel-doc errors

./include/uapi/drm/xe_drm.h:263: warning: Function parameter or member
'gts' not described in 'drm_xe_query_gts'

./include/uapi/drm/xe_drm.h:854: WARNING: Inline emphasis start-string
without end-string.

With the idea to also include the uapi file in the pre-merge CI hooks
when building the kernel-doc, so first make sure it's clean:

https://gitlab.freedesktop.org/drm/xe/ci/-/merge_requests/16

v2: (Francois)
  - It makes more sense to just fix the kernel-doc for 'gts'
Signed-off-by: default avatarMatthew Auld <matthew.auld@intel.com>
Cc: Francois Dugast <francois.dugast@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Reviewed-by: default avatarFrancois Dugast <francois.dugast@intel.com>
Signed-off-by: default avatarRodrigo Vivi <rodrigo.vivi@intel.com>
parent a9c4a069
...@@ -242,11 +242,13 @@ struct drm_xe_query_gts { ...@@ -242,11 +242,13 @@ struct drm_xe_query_gts {
/** @pad: MBZ */ /** @pad: MBZ */
__u32 pad; __u32 pad;
/* /**
* @gts: The GTs returned for this device
*
* TODO: convert drm_xe_query_gt to proper kernel-doc.
* TODO: Perhaps info about every mem region relative to this GT? e.g. * TODO: Perhaps info about every mem region relative to this GT? e.g.
* bandwidth between this GT and remote region? * bandwidth between this GT and remote region?
*/ */
struct drm_xe_query_gt { struct drm_xe_query_gt {
#define XE_QUERY_GT_TYPE_MAIN 0 #define XE_QUERY_GT_TYPE_MAIN 0
#define XE_QUERY_GT_TYPE_REMOTE 1 #define XE_QUERY_GT_TYPE_REMOTE 1
...@@ -852,8 +854,9 @@ struct drm_xe_mmio { ...@@ -852,8 +854,9 @@ struct drm_xe_mmio {
* struct drm_xe_wait_user_fence - wait user fence * struct drm_xe_wait_user_fence - wait user fence
* *
* Wait on user fence, XE will wakeup on every HW engine interrupt in the * Wait on user fence, XE will wakeup 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::
* (*addr & MASK) OP (VALUE & MASK) *
* (*addr & MASK) OP (VALUE & MASK)
* *
* Returns to user on user fence completion or timeout. * Returns to user on user fence completion or timeout.
*/ */
......
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