From ecaa7102d20c08fb666f148c7c9616b09bdfe3df Mon Sep 17 00:00:00 2001
From: Jan Van Winkel <jan.van_winkel@dxplore.eu>
Date: Thu, 16 Jan 2020 22:22:27 +0100
Subject: [PATCH] driver: display: Clarified byte order of pixel formats

Clarified that the byte order of multi byte pixel formats is in big
endian order.

Signed-off-by: Jan Van Winkel <jan.van_winkel@dxplore.eu>
---
 include/drivers/display.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/drivers/display.h b/include/drivers/display.h
index cc374ca2d46..2d4870b3ff5 100644
--- a/include/drivers/display.h
+++ b/include/drivers/display.h
@@ -27,6 +27,14 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Display pixel formats
+ *
+ * Display pixel format enumeration.
+ *
+ * In case a pixel format consists out of multiple bytes the byte order is
+ * big endian.
+ */
 enum display_pixel_format {
 	PIXEL_FORMAT_RGB_888		= BIT(0),
 	PIXEL_FORMAT_MONO01		= BIT(1), /* 0=Black 1=White */