Skip to content

Commit 3217649

Browse files
committed
Clarify the functional description of the touch_sense core
Signed-off-by: Joachim Strömbergson <[email protected]>
1 parent d7b8bb2 commit 3217649

File tree

1 file changed

+6
-4
lines changed
  • hw/application_fpga/core/touch_sense

1 file changed

+6
-4
lines changed

hw/application_fpga/core/touch_sense/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# touch_sense
22

3-
Core that handles touch senor events and provides them SW via an API.
3+
Core that handles touch senor events and provides them to the SW via
4+
an API.
45

56
## Introduction
67

78
This core implements a touch sensor handler. The core detects and
89
holds events for SW to read. The touch sensor input is expected to be
910
a change in level from low (0) to high (1). When an event is seen, the
10-
core will set a status bit that SW can read. SW must then clear the
11-
event by writing to the status register.
11+
core will set a status bit that SW can read.
1212

13-
The user is expected to lift the finger between multiple touch events.
13+
SW must clear the captured event by writing to the status
14+
register. The core will wait for the sensor input to become low again
15+
before being able to detect another event.
1416

1517

1618
## API

0 commit comments

Comments
 (0)