diff mbox series

[V7,44/45] drm/colorop: Add kernel doc for data blob

Message ID 20241220043410.416867-45-alex.hung@amd.com (mailing list archive)
State New
Headers show
Series Color Pipeline API w/ VKMS | expand

Commit Message

Alex Hung Dec. 20, 2024, 4:33 a.m. UTC 
Add layout of data blob for colorop types: DRM_COLOROP_1D_LUT,
DRM_COLOROP_CTM_3X4 and DRM_COLOROP_3D_LUT

Signed-off-by: Alex Hung <alex.hung@amd.com>
---
 include/drm/drm_colorop.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
diff mbox series

Patch

diff --git a/include/drm/drm_colorop.h b/include/drm/drm_colorop.h
index 7b58dcf0615a..11b474a9b10a 100644
--- a/include/drm/drm_colorop.h
+++ b/include/drm/drm_colorop.h
@@ -146,6 +146,24 @@  struct drm_colorop_state {
 	 *
 	 * Data blob for any TYPE that requires such a blob. The
 	 * interpretation of the blob is TYPE-specific.
+	 *
+	 * For 1D LUTs (DRM_COLOROP_1D_LUT), the blob is an array of
+	 * struct drm_color_lut with size of "lut_size".
+	 *
+	 * For 3x4 matrix (DRM_COLOROP_CTM_3X4), the blob is a float[12]:
+	 * out   matrix          in
+	 * |R|   |0  1  2  3 |   | R |
+	 * |G| = |4  5  6  7 | x | G |
+	 * |B|   |8  9  10 12|   | B |
+	 *
+	 * For 3D LUTs (DRM_COLOROP_3D_LUT), the blob is a 3D array of
+	 * struct drm_color_lut with dimension length of "lut_size".
+	 * The LUT elements are traversed like so:
+	 *   for R in range 0..n
+	 *     for G in range 0..n
+	 *       for B in range 0..n
+	 *         color = lut3d[R][G][B]
+	 *
 	 */
 	struct drm_property_blob *data;