diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/console.txt | 20 | ||||
| -rw-r--r-- | docs/contributors.txt | 25 | ||||
| -rw-r--r-- | docs/files.txt | 106 | ||||
| -rw-r--r-- | docs/readme.txt | 2 | ||||
| -rw-r--r-- | docs/releases.txt | 7 | ||||
| -rw-r--r-- | docs/usage.txt | 32 |
6 files changed, 192 insertions, 0 deletions
diff --git a/docs/console.txt b/docs/console.txt new file mode 100644 index 00000000..09e7ae86 --- /dev/null +++ b/docs/console.txt @@ -0,0 +1,20 @@ +The console module acts as a BaseSequentialStream at a user defined area of the LCD. + +Requirements: +The console code requires a lld that has vertical scroll implemented. +It is also necessary to enable the scroll code: + + #define GDISP_NEED_SCROLL TRUE + +Usage: + + #include "console.h" + + /* Define a console object */ + GLCDConsole CON1; + + /* initialise the console to take up the entire screen */ + lcdConsoleInit(&CON1, 0, 0, 320, 240, &fontLarger, Black, White); + + /* print something */ + chprintf((BaseSequentialStream *)&CON1, "Hello the time is %d\nGoodbye.", chTimeNow()); diff --git a/docs/contributors.txt b/docs/contributors.txt new file mode 100644 index 00000000..2586ed61 --- /dev/null +++ b/docs/contributors.txt @@ -0,0 +1,25 @@ +This file is a complete history of persons who contributed to the GLCD Library. + +At this point we want to thank all of these people for their work. + + +NickName RealName Contribution +======== ======== ============ + +inmarket Andrew Hannam GDISP (restructorizing the entire library) + VMT + ASYNC and MULTITHREAD implementation + +Badger Thomas Saunders console implementation + FSMC for STM32F1 and F4 + lld orientation fixed for S6F1121 and SSD1289 + +Abhishek Abhishek Kumar S6D1121 GPIO + font rendering + touchpad noise filtering & optimizations + +benwilliam - lcdDrawEllipse() + fastMath + +dxli Dongxu Li lcdDrawEllipse() filled option + diff --git a/docs/files.txt b/docs/files.txt new file mode 100644 index 00000000..244a4c66 --- /dev/null +++ b/docs/files.txt @@ -0,0 +1,106 @@ +This is a tree of the toplevel directory of the GLCD library. +The maintainer is supposed to keep it up to date at any new release. + +├── demos +│ ├── lcd +│ │ └── main.c +│ ├── readme.txt +│ └── touchpad +│ └── main.c +├── docs +│ ├── contributors.txt +│ ├── files.txt +│ ├── readme.txt +│ ├── releases.txt +│ └── usage.txt +├── Doxygenfile +├── drivers +│ ├── gdisp +│ │ ├── gdispNokia6610 +│ │ │ ├── gdisp_lld_board_example.h +│ │ │ ├── gdisp_lld_board_olimexsam7ex256.h +│ │ │ ├── gdisp_lld.c +│ │ │ ├── gdisp_lld_config.h +│ │ │ ├── gdisp_lld.mk +│ │ │ ├── GE12.h +│ │ │ ├── GE8.h +│ │ │ └── readme.txt +│ │ ├── gdispS6d1121 +│ │ │ ├── gdisp_lld.c +│ │ │ ├── gdisp_lld_config.h +│ │ │ ├── gdisp_lld.mk +│ │ │ ├── readme.txt +│ │ │ └── s6d1121_lld.c.h +│ │ ├── gdispSsd1289 +│ │ │ ├── gdisp_lld.c +│ │ │ ├── gdisp_lld_config.h +│ │ │ ├── gdisp_lld.mk +│ │ │ ├── readme.txt +│ │ │ └── ssd1289_lld.c.h +│ │ ├── gdispTestStub +│ │ │ ├── gdisp_lld.c +│ │ │ ├── gdisp_lld_config.h +│ │ │ ├── gdisp_lld.mk +│ │ │ └── readme.txt +│ │ └── gdispVMT +│ │ ├── gdisp_lld.c +│ │ ├── gdisp_lld_config.h +│ │ ├── gdisp_lld_driver1.c +│ │ ├── gdisp_lld_driver2.c +│ │ ├── gdisp_lld.mk +│ │ └── readme.txt +│ └── touchpad +│ ├── touchpadADS7843 +│ │ ├── readme.txt +│ │ ├── touchpad_lld.c +│ │ ├── touchpad_lld_config.h +│ │ └── touchpad_lld.mk +│ └── touchpadXPT2046 +│ ├── readme.txt +│ ├── touchpad_lld.c +│ ├── touchpad_lld_config.h +│ └── touchpad_lld.mk +├── include +│ ├── console.h +│ ├── gdisp_emulation.c +│ ├── gdisp_fonts.h +│ ├── gdisp.h +│ ├── gdisp_lld.h +│ ├── gdisp_lld_msgs.h +│ ├── glcd.h +│ ├── touchpad.h +│ └── touchpad_lld.h +├── lcd.mk +├── license.txt +├── old +│ ├── graph +│ │ ├── graph.c +│ │ ├── graph.h +│ │ └── graph.mk +│ └── gui +│ ├── gui.c +│ ├── gui.h +│ └── gui.mk +├── readme.txt +├── src +│ ├── console.c +│ ├── gdisp.c +│ ├── gdisp_fonts.c +│ ├── gdisp-readme.txt +│ └── touchpad.c +├── templates +│ ├── gdispXXXXX +│ │ ├── gdisp_lld.c +│ │ ├── gdisp_lld_config.h +│ │ ├── gdisp_lld.mk +│ │ └── readme.txt +│ ├── readme.txt +│ └── touchpadXXXXX +│ ├── touchpad_lld.c +│ ├── touchpad_lld_config.h +│ └── touchpad_lld.mk +└── tools + └── readme.txt + +23 directories, 77 files + diff --git a/docs/readme.txt b/docs/readme.txt new file mode 100644 index 00000000..3a76a92f --- /dev/null +++ b/docs/readme.txt @@ -0,0 +1,2 @@ +This folder contains documentation about this GLCD library. + diff --git a/docs/releases.txt b/docs/releases.txt new file mode 100644 index 00000000..f895106e --- /dev/null +++ b/docs/releases.txt @@ -0,0 +1,7 @@ +***************************************************************************** +*** Releases *** +***************************************************************************** + +*** 0.1.0 *** +FIX: removed gdisp and touchpad prefix of driver directories + diff --git a/docs/usage.txt b/docs/usage.txt new file mode 100644 index 00000000..961fa2c6 --- /dev/null +++ b/docs/usage.txt @@ -0,0 +1,32 @@ +To include any of these functions/drivers in your project...
+
+ 1/ Specify the path to the LCDLIB. If none defined, default is $(CHIBIOS)/ext/lcd
+
+ 2/ In your project Makefile (amongst similiar lines but after the hal line) add the line...
+ include $(LCDLIB)/lcd.mk
+
+ 3/ Add $(LCDSRC) and $(LCDINC) to your SRCS and INCDIR of your projects Makefile
+
+ 4/ In your project Makefile add the makefiles for any specific drivers you want e.g
+ include $(LCDLIB)/halext/drivers/touchpad/XPT2046/touchpad_lld.mk
+ include $(LCDLIB)/halext/drivers/gdisp/Nokia6610/gdisp_lld.mk
+
+ 5/ In your project halconf.h turn on the support you want eg.
+ /**
+ * @brief Enables the Touchpad subsystem.
+ */
+ #if !defined(HAL_USE_TOUCHPAD) || defined(__DOXYGEN__)
+ #define HAL_USE_TOUCHPAD TRUE
+ #endif
+
+ /**
+ * @brief Enables the GDISP subsystem.
+ */
+ #if !defined(HAL_USE_GDISP) || defined(__DOXYGEN__)
+ #define HAL_USE_GDISP TRUE
+ /* Any driver specific defines required go here. The below line is an example. */
+ #define GDISP_NEED_MULTITHREAD TRUE
+ #endif
+
+ 6/ Do a make clean.
+
|