drm/xe: Add kernel doc for xe_hw_engine_lookup

kerneldoc was missing from earlier commit where
we exported xe_hw_engine_lookup. Add it.

Cc: Dominik Grzegorzek <dominik.grzegorzek@intel.com>
Cc: Mika Kuoppala <mika.kuoppala@linux.intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: "Thomas Hellström" <thomas.hellstrom@linux.intel.com>
Cc: intel-xe@lists.freedesktop.org
Signed-off-by: Mika Kuoppala <mika.kuoppala@linux.intel.com>
Reviewed-by: Jonathan Cavitt <jonathan.cavitt@intel.com>
Signed-off-by: Matthew Brost <matthew.brost@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240806153009.1081382-2-mika.kuoppala@linux.intel.com

diff --git a/drivers/gpu/drm/xe/xe_hw_engine.c b/drivers/gpu/drm/xe/xe_hw_engine.c
index c7c44de7c30f3abb35a17448ca807696a4f76c1a..402dfa748e168f8f7b863095b3e32fd93af82903 100644 (file)
--- a/drivers/gpu/drm/xe/xe_hw_engine.c
+++ b/drivers/gpu/drm/xe/xe_hw_engine.c
@@ -329,11 +329,11 @@ void xe_hw_engine_enable_ring(struct xe_hw_engine *hwe)
 
        xe_hw_engine_mmio_write32(hwe, RING_HWSTAM(0), ~0x0);
        xe_hw_engine_mmio_write32(hwe, RING_HWS_PGA(0),
-                              xe_bo_ggtt_addr(hwe->hwsp));
+                                 xe_bo_ggtt_addr(hwe->hwsp));
        xe_hw_engine_mmio_write32(hwe, RING_MODE(0),
-                              _MASKED_BIT_ENABLE(GFX_DISABLE_LEGACY_MODE));
+                                 _MASKED_BIT_ENABLE(GFX_DISABLE_LEGACY_MODE));
        xe_hw_engine_mmio_write32(hwe, RING_MI_MODE(0),
-                              _MASKED_BIT_DISABLE(STOP_RING));
+                                 _MASKED_BIT_DISABLE(STOP_RING));
        xe_hw_engine_mmio_read32(hwe, RING_MI_MODE(0));
 }
 
@@ -1173,6 +1173,16 @@ static const enum xe_engine_class user_to_xe_engine_class[] = {
        [DRM_XE_ENGINE_CLASS_COMPUTE] = XE_ENGINE_CLASS_COMPUTE,
 };
 
+/**
+ * xe_hw_engine_lookup() - Lookup hardware engine for class:instance
+ * @xe: xe device
+ * @eci: engine class and instance
+ *
+ * This function will find a hardware engine for given engine
+ * class and instance.
+ *
+ * Return: If found xe_hw_engine pointer, NULL otherwise.
+ */
 struct xe_hw_engine *
 xe_hw_engine_lookup(struct xe_device *xe,
                    struct drm_xe_engine_class_instance eci)