[PATCH v10 03/21] drm/edid: Convert cea_sad helper struct to kernelDoc

From: Guillaume Ranquet
Date: Mon May 23 2022 - 06:50:40 EST


Signed-off-by: Guillaume Ranquet <granquet@xxxxxxxxxxxx>
---
include/drm/drm_edid.h | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/include/drm/drm_edid.h b/include/drm/drm_edid.h
index 144c495b99c4..37c420423625 100644
--- a/include/drm/drm_edid.h
+++ b/include/drm/drm_edid.h
@@ -359,12 +359,18 @@ struct edid {

#define EDID_PRODUCT_ID(e) ((e)->prod_code[0] | ((e)->prod_code[1] << 8))

-/* Short Audio Descriptor */
+/**
+ * struct cea_sad - Short Audio Descriptor.
+ * @format: See HDMI_AUDIO_CODING_TYPE_*.
+ * @channels: max number of channels - 1.
+ * @freq: See CEA_SAD_FREQ_*.
+ * @byte2: meaning depends on format.
+ */
struct cea_sad {
u8 format;
- u8 channels; /* max number of channels - 1 */
+ u8 channels;
u8 freq;
- u8 byte2; /* meaning depends on format */
+ u8 byte2;
};

struct drm_encoder;
--
2.35.1