drm/amd/doc: add rough outline of tracepoint documentation
Subsystems (4)
PATCH 1/1 drm/amd/doc: add rough outline of tracepoint documentation
--- Documentation/gpu/amdgpu.rst | 10 + drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h | 221 ++++++++++++++++++++++ 2 files changed, 231 insertions(+)
Documentation/gpu/amdgpu.rst +10 -0
@@ -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 =========================================
drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h +221 -0
227 lines not on this page · raw message
Signature · 6 lines
2.21.0 _______________________________________________ amd-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/amd-gfx
A message that is not in the archive (sent off-list or not yet received): [email protected]
Comments inline (marked with [slava a]).
General comment - word capitalisation in the lists is inconsistent
________________________________
From: amd-gfx <amd-gfx-bounces-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org> 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
--- Documentation/gpu/amdgpu.rst | 10 + drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h | 221 ++++++++++++++++++++++ 2 files changed, 231 insertions(+)
Documentation/gpu/amdgpu.rst +10 -0
@@ -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 =========================================
drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h +18 -0
@@ -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
A message that is not in the archive (sent off-list or not yet received): MWHPR12MB1422F8CD20776EFC9B4C8288FE180-Gy0DoCVfaSXuYgwfTSIEYwdYzm3356FpvxpqHgZTriW3zl9H0oFU5g@public.gmane.org
Fixed with "is".
Thanks. I'll wait for more feedback before submitting a v2.
Tom
Quoted 74 lines · Slava
Comments inline (marked with [slava a]).
General comment - word capitalisation in the lists is inconsistent
------------------------------
*From:* amd-gfx <amd-gfx-bounces-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org> 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
documentationSigned-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(+)Documentation/gpu/amdgpu.rst +10
-0@@ -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 =========================================drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h +18
-0@@ -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.
Quoted 5 lines
[snap]
_______________________________________________
amd-gfx mailing list [email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx