[PATCH 1/2] drm/amd/display: Document the union in dc_probe_status

From: TAKANO Mitsuhiro

Date: Fri Nov 20 2026 - 23:14:42 EST


The members of the union in dc_probe_status are described one by one as
@u.bandwidth_mbps and so on, but the union itself has no description, so
kernel-doc reports:

dc.h:2225 struct member 'u' not described in
'dc_probe_status'

Describe it, saying that the member holding the result depends on the
probe type.

Written with Hermes Agent, an LLM assistant; the author reviewed it and
ran kernel-doc on the file with and without the change.

Fixes: 52771a3254ea ("drm/amd/display: Wire probe commit path into dc_update_state")
Signed-off-by: TAKANO Mitsuhiro <takano32@xxxxxxxxx>
---
drivers/gpu/drm/amd/display/dc/dc.h | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
index d3c484f45333..debdd69bbe4e 100644
--- a/drivers/gpu/drm/amd/display/dc/dc.h
+++ b/drivers/gpu/drm/amd/display/dc/dc.h
@@ -2207,6 +2207,7 @@ struct dc_probe_latencies {
* @valid: true if a measurement was latched.
* @measuring: true if the hardware counter is currently running.
* @type: type of the probe that produced this result.
+ * @u: probe result; the member holding it depends on @type.
* @u.bandwidth_mbps: peak BW in Mbps (DC_PROBE_PEAK_MEM_BW).
* @u.latency: min/max/avg memory latency in ns (DC_PROBE_MEM_LATENCY),
* stored as struct dc_probe_latencies.

base-commit: d0f871bfb831705d9f55479f5b2b40f636ea7b16
--
2.53.0