aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMateusz Tomaszkiewicz <silentdemon@gmail.com>2013-06-21 00:02:54 +0200
committerMateusz Tomaszkiewicz <silentdemon@gmail.com>2013-06-21 00:02:54 +0200
commit129041e791e22fd71242035b756d725863fa7e60 (patch)
treef7fda11a6e3a703ba535e352c440f2ccf7564fb2
parentd57eacc345da25732ec6bace92878a76b587e548 (diff)
downloaduGFX-129041e791e22fd71242035b756d725863fa7e60.tar.gz
uGFX-129041e791e22fd71242035b756d725863fa7e60.tar.bz2
uGFX-129041e791e22fd71242035b756d725863fa7e60.zip
Various README updates
Changed misleading description.
-rw-r--r--drivers/gdisp/HX8347D/readme.txt2
-rw-r--r--drivers/gdisp/ILI9320/readme.txt6
-rw-r--r--drivers/gdisp/ILI9325/readme.txt6
-rw-r--r--drivers/gdisp/ILI9481/readme.txt4
-rw-r--r--drivers/gdisp/Nokia6610GE12/readme.txt4
-rw-r--r--drivers/gdisp/Nokia6610GE8/readme.txt4
-rw-r--r--drivers/gdisp/S6D1121/readme.txt3
-rw-r--r--drivers/gdisp/SSD1963/readme.txt20
-rw-r--r--drivers/gdisp/TestStub/readme.txt2
-rw-r--r--drivers/ginput/dial/GADC/readme.txt5
-rw-r--r--drivers/ginput/toggle/Pal/readme.txt4
-rw-r--r--drivers/ginput/touch/ADS7843/readme.txt3
-rw-r--r--drivers/ginput/touch/MCU/readme.txt3
-rw-r--r--drivers/multiple/Win32/readme.txt3
-rw-r--r--include/gdisp/gdisp.h2
15 files changed, 33 insertions, 38 deletions
diff --git a/drivers/gdisp/HX8347D/readme.txt b/drivers/gdisp/HX8347D/readme.txt
index 1725ef60..d0000287 100644
--- a/drivers/gdisp/HX8347D/readme.txt
+++ b/drivers/gdisp/HX8347D/readme.txt
@@ -4,7 +4,7 @@ Driver for LCD with 4-wire serial interface (65k colors).
To use this driver:
-1. Add in your halconf.h:
+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
diff --git a/drivers/gdisp/ILI9320/readme.txt b/drivers/gdisp/ILI9320/readme.txt
index dcffe206..028af728 100644
--- a/drivers/gdisp/ILI9320/readme.txt
+++ b/drivers/gdisp/ILI9320/readme.txt
@@ -1,15 +1,15 @@
To use this driver:
-1. Add in your halconf.h:
+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
-
+
d) If you are not using a known board then create a gdisp_lld_board.h file
and ensure it is on your include path.
Use the gdisp_lld_board_example.h file as a basis.
Currently known boards are:
- Olimex STM32-LCD
+ Olimex STM32-LCD
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/ILI9320/gdisp_lld.mk
diff --git a/drivers/gdisp/ILI9325/readme.txt b/drivers/gdisp/ILI9325/readme.txt
index 9150610e..9bd96e6a 100644
--- a/drivers/gdisp/ILI9325/readme.txt
+++ b/drivers/gdisp/ILI9325/readme.txt
@@ -1,15 +1,15 @@
To use this driver:
-1. Add in your halconf.h:
+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
-
+
d) If you are not using a known board then create a gdisp_lld_board.h file
and ensure it is on your include path.
Use the gdisp_lld_board_example.h file as a basis.
Currently known boards are:
- HY_STM32_100p
+ HY_STM32_100p
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/ILI9325/gdisp_lld.mk
diff --git a/drivers/gdisp/ILI9481/readme.txt b/drivers/gdisp/ILI9481/readme.txt
index dc66e27b..235c2582 100644
--- a/drivers/gdisp/ILI9481/readme.txt
+++ b/drivers/gdisp/ILI9481/readme.txt
@@ -1,6 +1,6 @@
To use this driver:
-1. Add in your halconf.h:
+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
@@ -9,7 +9,7 @@ To use this driver:
and ensure it is on your include path.
Use the gdisp_lld_board_example.h or gdisp_lld_board_fsmc.h file as a basis.
Currently known boards are:
- BOARD_FIREBULL_STM32_F103 - GPIO interface: requires GDISP_CMD_PORT and GDISP_DATA_PORT to be defined
+ BOARD_FIREBULL_STM32_F103 - GPIO interface: requires GDISP_CMD_PORT and GDISP_DATA_PORT to be defined
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/ILI9481/gdisp_lld.mk
diff --git a/drivers/gdisp/Nokia6610GE12/readme.txt b/drivers/gdisp/Nokia6610GE12/readme.txt
index 54c4570f..bc0ee248 100644
--- a/drivers/gdisp/Nokia6610GE12/readme.txt
+++ b/drivers/gdisp/Nokia6610GE12/readme.txt
@@ -2,14 +2,14 @@ This driver is for the Nokia6610 Philips (GE12) controller
To use this driver:
-1. Add in your halconf.h:
+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) If you are not using a known board then create a gdisp_lld_board.h file
and ensure it is on your include path.
Use the gdisp_lld_board_example.h file as a basis.
Currently known boards are:
- Olimex SAM7-EX256
+ Olimex SAM7-EX256
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/Nokia6610GE12/gdisp_lld.mk
diff --git a/drivers/gdisp/Nokia6610GE8/readme.txt b/drivers/gdisp/Nokia6610GE8/readme.txt
index c8ad8faa..503ca0b9 100644
--- a/drivers/gdisp/Nokia6610GE8/readme.txt
+++ b/drivers/gdisp/Nokia6610GE8/readme.txt
@@ -2,14 +2,14 @@ This driver is for the Nokia6610 Epson (GE8) controller
To use this driver:
-1. Add in your halconf.h:
+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) If you are not using a known board then create a gdisp_lld_board.h file
and ensure it is on your include path.
Use the gdisp_lld_board_example.h file as a basis.
Currently known boards are:
- Olimex SAM7-EX256
+ Olimex SAM7-EX256
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/Nokia6610GE8/gdisp_lld.mk
diff --git a/drivers/gdisp/S6D1121/readme.txt b/drivers/gdisp/S6D1121/readme.txt
index b76b565f..54bb3091 100644
--- a/drivers/gdisp/S6D1121/readme.txt
+++ b/drivers/gdisp/S6D1121/readme.txt
@@ -1,9 +1,8 @@
To use this driver:
-1. Add in your halconf.h:
+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
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/gdisp/S6D1121/gdisp_lld.mk
-
diff --git a/drivers/gdisp/SSD1963/readme.txt b/drivers/gdisp/SSD1963/readme.txt
index 567faf58..f74e9b7f 100644
--- a/drivers/gdisp/SSD1963/readme.txt
+++ b/drivers/gdisp/SSD1963/readme.txt
@@ -1,14 +1,14 @@
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GDISP TRUE
b) Any optional high level driver defines (see gdisp.h) eg: #define GDISP_NEED_MULTITHREAD TRUE
c) One (only) of:
#define GDISP_USE_GPIO
#define GDISP_USE_FSMC
- d) If you want to use DMA (only works with FSMC):
- #define GDISP_USE_DMA
- #define GDISP_DMA_STREAM STM32_DMA2_STREAM6 //You can change the DMA channel according to your needs
+ d) If you want to use DMA (only works with FSMC):
+ #define GDISP_USE_DMA
+ #define GDISP_DMA_STREAM STM32_DMA2_STREAM6 //You can change the DMA channel according to your needs
2. Edit gdisp_lld_panel.h with your panel properties
@@ -28,11 +28,11 @@ Example FSMC config with DMA:
#if defined(GDISP_USE_GPIO)
- #define GDISP_CMD_PORT GPIOC
- #define GDISP_DATA_PORT GPIOD
+ #define GDISP_CMD_PORT GPIOC
+ #define GDISP_DATA_PORT GPIOD
- #define GDISP_CS 0
- #define GDISP_RS 1
- #define GDISP_WR 2
- #define GDISP_RD 3
+ #define GDISP_CS 0
+ #define GDISP_RS 1
+ #define GDISP_WR 2
+ #define GDISP_RD 3
#endif
diff --git a/drivers/gdisp/TestStub/readme.txt b/drivers/gdisp/TestStub/readme.txt
index 11145290..ddd7d38e 100644
--- a/drivers/gdisp/TestStub/readme.txt
+++ b/drivers/gdisp/TestStub/readme.txt
@@ -7,7 +7,7 @@ Do not use this driver as a template for new drivers. Use the
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GDISP TRUE
b) Any optional high level driver defines (see gdisp.h)
you want to compile test eg: GDISP_NEED_MULTITHREAD
diff --git a/drivers/ginput/dial/GADC/readme.txt b/drivers/ginput/dial/GADC/readme.txt
index 5c303870..25558dbc 100644
--- a/drivers/ginput/dial/GADC/readme.txt
+++ b/drivers/ginput/dial/GADC/readme.txt
@@ -1,6 +1,6 @@
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GINPUT TRUE
#define GINPUT_NEED_DIAL TRUE
#define GINPUT_NEED_GADC TRUE
@@ -8,9 +8,8 @@ To use this driver:
and ensure it is on your include path.
Use the ginput_lld_dial_board_example.h file as a basis.
Currently known boards are:
- Olimex SAM7-EX256
+ Olimex SAM7-EX256
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/ginput/dial/GADC/ginput_lld.mk
include $(GFXLIB)/drivers/gadc/yourGADCdriver/gadc_lld.mk
- \ No newline at end of file
diff --git a/drivers/ginput/toggle/Pal/readme.txt b/drivers/ginput/toggle/Pal/readme.txt
index e6976f7d..35d2ee47 100644
--- a/drivers/ginput/toggle/Pal/readme.txt
+++ b/drivers/ginput/toggle/Pal/readme.txt
@@ -1,13 +1,13 @@
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GINPUT TRUE
#define GINPUT_NEED_TOGGLE TRUE
d) If you are not using a known board then create a ginput_lld_toggle_board.h file
and ensure it is on your include path.
Use the ginput_lld_toggle_board_example.h file as a basis.
Currently known boards are:
- Olimex SAM7-EX256
+ Olimex SAM7-EX256
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/ginput/togglePal/ginput_lld.mk
diff --git a/drivers/ginput/touch/ADS7843/readme.txt b/drivers/ginput/touch/ADS7843/readme.txt
index 852a1ea0..abc4b0e9 100644
--- a/drivers/ginput/touch/ADS7843/readme.txt
+++ b/drivers/ginput/touch/ADS7843/readme.txt
@@ -1,9 +1,8 @@
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GINPUT TRUE
b) #define GINPUT_NEED_MOUSE TRUE
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/ginput/touch/ADS7843/ginput_lld.mk
-
diff --git a/drivers/ginput/touch/MCU/readme.txt b/drivers/ginput/touch/MCU/readme.txt
index 4dbe5543..c7bb90f8 100644
--- a/drivers/ginput/touch/MCU/readme.txt
+++ b/drivers/ginput/touch/MCU/readme.txt
@@ -1,9 +1,8 @@
To use this driver:
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GINPUT TRUE
b) #define GINPUT_NEED_MOUSE TRUE
2. To your makefile add the following lines:
include $(GFXLIB)/drivers/ginput/touch/MCU/ginput_lld.mk
-
diff --git a/drivers/multiple/Win32/readme.txt b/drivers/multiple/Win32/readme.txt
index 6151f2f2..7ff8546c 100644
--- a/drivers/multiple/Win32/readme.txt
+++ b/drivers/multiple/Win32/readme.txt
@@ -3,7 +3,7 @@ To use this driver:
This driver is special in that it implements both the gdisp low level driver
and a touchscreen driver.
-1. Add in your halconf.h:
+1. Add in your gfxconf.h:
a) #define GFX_USE_GDISP TRUE
b) #define GFX_USE_GINPUT TRUE
#define GINPUT_USE_MOUSE TRUE
@@ -19,4 +19,3 @@ and a touchscreen driver.
3. Modify your makefile to add -lgdi32 to the DLIBS line. i.e.
DLIBS = -lws2_32 -lgdi32
-
diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h
index f7208b00..4ba72580 100644
--- a/include/gdisp/gdisp.h
+++ b/include/gdisp/gdisp.h
@@ -522,7 +522,7 @@ extern "C" {
#if GDISP_NEED_SCROLL || defined(__DOXYGEN__)
/**
* @brief Scroll vertically a section of the screen.
- * @pre GDISP_NEED_SCROLL must be set to TRUE in halconf.h
+ * @pre GDISP_NEED_SCROLL must be set to TRUE in gfxconf.h
* @note Optional.
* @note If lines is >= cy, it is equivelent to a area fill with bgcolor.
*