aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/framebuffer/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/gdisp/framebuffer/readme.txt')
-rw-r--r--drivers/gdisp/framebuffer/readme.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/drivers/gdisp/framebuffer/readme.txt b/drivers/gdisp/framebuffer/readme.txt
index d07b5dfb..e13321e4 100644
--- a/drivers/gdisp/framebuffer/readme.txt
+++ b/drivers/gdisp/framebuffer/readme.txt
@@ -9,3 +9,9 @@ To use this driver:
3. Add a board_framebuffer.h to you project directory (or board directory)
base on one of the templates.
+
+Note: This driver supports framebuffers in byte, word or dword sized pixels.
+ It does not support packed pixel formats eg 1, 2, 4, 15 or 24 bits per pixel
+ except where the framebuffer format expects those in memory as 1 byte, 2 bytes or 4 bytes per pixel.
+
+Note: For RGB888 and BGR888 packed framebuffer formats use the Fb24bpp driver instead.