aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/ginput/touch/STMPE811/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/ginput/touch/STMPE811/readme.txt')
-rw-r--r--drivers/ginput/touch/STMPE811/readme.txt29
1 files changed, 20 insertions, 9 deletions
diff --git a/drivers/ginput/touch/STMPE811/readme.txt b/drivers/ginput/touch/STMPE811/readme.txt
index 1d7a8b4f..065840d8 100644
--- a/drivers/ginput/touch/STMPE811/readme.txt
+++ b/drivers/ginput/touch/STMPE811/readme.txt
@@ -1,9 +1,20 @@
-To use this driver:
-
-1. Add in your halconf.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/STMPE811/ginput_lld.mk
-
+The STMPE811 driver comes with two different #defines to perfectly fit
+your application:
+
+
+STMPE811_NO_GPIO_IRQPIN
+This Macro is meant to be set in your board file. When you set this macro to
+TRUE, the GINPUT module will not use the IRQ lane which might be connected
+to a GPIO pin to recognize interrupts by the STMPE811 controller. This
+costs a few more I2C calls.
+When the interrupt IRQ pin is connected to a GPIO of your MCU, set this
+macro to FALSE.
+
+
+STMP811_SLOW_CPU
+If you have a slow CPU and you need to take care of your resources, you can
+set this macro TRUE. This will save some IRQs and therefore a few I2C calls.
+The disadvantage is a little higher response time.
+If you don't want to draw continious lines on your display, it's recommended
+to set this to TRUE anyways.
+