aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/SSD1322/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/gdisp/SSD1322/readme.txt')
-rw-r--r--drivers/gdisp/SSD1322/readme.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/drivers/gdisp/SSD1322/readme.txt b/drivers/gdisp/SSD1322/readme.txt
new file mode 100644
index 00000000..571dcd62
--- /dev/null
+++ b/drivers/gdisp/SSD1322/readme.txt
@@ -0,0 +1,25 @@
+Description:
+
+Driver for OLED with 4-wire serial interface and I2C/SPI interface
+
+Know restictions:
+- Driver works only with SSD1306 hooked up over I2C or SPI (include corresponding header)
+- Driver is written for 128x64 pixel displays (128x32 are only partly supported and need small further work)
+- Flushing is required for this driver
+
+To use this driver:
+
+1. Add in your gfxconf.h:
+ a) #define GFX_USE_GDISP TRUE
+
+ b) Any optional high level driver defines (see gdisp.h) eg: GDISP_NEED_MULTITHREAD
+
+ c) The following are optional - define them if you are not using the defaults below:
+ #define GDISP_SCREEN_WIDTH 128
+ #define GDISP_SCREEN_HEIGHT 64
+
+2. If you are not using a known board then create a gdisp_lld_board.h file according to
+ given example files (or just stick with them) and ensure it is on your include path.
+
+3. To your makefile add the following lines:
+ include $(GFXLIB)/drivers/gdisp/SSD1322/gdisp_lld.mk