Comments inline (marked with [slava a]).
General comment - word capitalisation in the lists is inconsistent ________________________________ From: amd-gfx <[email protected]> on behalf of StDenis, Tom <[email protected]> Sent: Thursday, May 30, 2019 10:56 AM To: [email protected] Cc: StDenis, Tom Subject: [PATCH] drm/amd/doc: add rough outline of tracepoint documentation Signed-off-by: Tom St Denis <[email protected]> --- Documentation/gpu/amdgpu.rst | 10 + drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h | 221 ++++++++++++++++++++++ 2 files changed, 231 insertions(+) diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst index 86138798128f..3564765110e5 100644 --- a/Documentation/gpu/amdgpu.rst +++ b/Documentation/gpu/amdgpu.rst @@ -89,6 +89,16 @@ AMDGPU RAS debugfs control interface .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c :internal: +AMDGPU Tracing Support +====================== + +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h + :doc: AMDGPU Tracing Support + + +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h + :internal: + GPU Power/Thermal Controls and Monitoring ========================================= diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h b/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h index d3ca2424b5fe..71febb90d3e3 100644 --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h @@ -37,6 +37,227 @@ #define AMDGPU_JOB_GET_TIMELINE_NAME(job) \ job->base.s_fence->finished.ops->get_timeline_name(&job->base.s_fence->finished) +/** + * DOC: AMDGPU Tracing Support + * + * The AMDGPU driver provides numerous trace points that can aid + * in debugging. They are globally enabled by the file: + * + * /sys/kernel/debug/tracing/events/amdgpu/enable + * + * or individually by the enable files in the sub-directories + * of that directory. + * + * amdgpu_mm_rreg, amdgpu_mm_wreg + * ------------------------------ + * + * These trace points track reads and writes to MMIO registers by + * the kernel driver (activity inside ring/indirect buffers are not + * traced) which can be used to diagnose IP block activity and + * responses. [slava a] Either 'activities are not traced' or 'activity is not traced' [slava a] Double usage of word 'activity' sounds weird. [snap]
_______________________________________________ amd-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/amd-gfx
