diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-10-10 10:47:18 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-10-10 10:47:18 +0200 |
| commit | 0daeabe5868469d89c8827d1fbcfae2ad9ba8ee5 (patch) | |
| tree | 13887dafa4169e798b1e7272e018adc5875be326 /docs | |
| parent | 19afa19bd31a28afbca3666858c7a168bd5c9954 (diff) | |
| download | uGFX-0daeabe5868469d89c8827d1fbcfae2ad9ba8ee5.tar.gz uGFX-0daeabe5868469d89c8827d1fbcfae2ad9ba8ee5.tar.bz2 uGFX-0daeabe5868469d89c8827d1fbcfae2ad9ba8ee5.zip | |
docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configure.txt | 19 | ||||
| -rw-r--r-- | docs/usage.txt | 37 |
2 files changed, 35 insertions, 21 deletions
diff --git a/docs/configure.txt b/docs/configure.txt new file mode 100644 index 00000000..02c6be9a --- /dev/null +++ b/docs/configure.txt @@ -0,0 +1,19 @@ +There are serval macros available to configure the behaviour of the GFX-Library. + +HAL macros: + + #define HAL_USE_GFX // enables the GDISP sub system. This is essentially needed to use the display + #define HAL_USE_TOUCHPAD // enables the TouchPad sub system. This is essentially needed to use the touchpad + + +GDISP macors: + + #define GDISP_ + + + +TouchPAD macros: + + #define TOUCHPAD_ + + diff --git a/docs/usage.txt b/docs/usage.txt index 52cd39b1..4971ec01 100644 --- a/docs/usage.txt +++ b/docs/usage.txt @@ -3,30 +3,25 @@ To include any of these functions/drivers in your project... 1/ Specify the path to the GFXLIB. 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 $(GFXLIB)/lcd.mk
+ include $(GFXLIB)/gfx.mk
3/ Add $(GFXSRC) and $(GFXINC) 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 $(GFXLIB)/halext/drivers/touchpad/XPT2046/touchpad_lld.mk
- include $(GFXLIB)/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
+ include $(GFXLIB)/drivers/touchpad/XPT2046/touchpad_lld.mk
+ include $(GFXLIB)/drivers/gdisp/SSD1289/gdisp_lld.mk
+
+ 5/ In your project halconf.h turn on the support you want. Please take a look to
+ docs/configure.txt for a list and description of all available macros. For example:
+
+ #define HAL_USE_GDISP TRUE
+ #define HAL_USE_TOUCHPAD TRUE
+
+ #define GDISP_USE_GPIO TRUE
+ #define GDISP_SCREEN_WIDTH 240
+ #define GDISP_SCREEN_HEIGHT 320
+ #define GDISP_NEED_CONTROL TRUE
+ #define TOUCHPAD_NEED_MULTITHREAD TRUE
- 6/ Do a make clean.
+ 6/ Do a make clean
|