Skip to content

Commit

Permalink
Clarify the functional description of the touch_sense core
Browse files Browse the repository at this point in the history
Signed-off-by: Joachim Strömbergson <[email protected]>
  • Loading branch information
secworks authored and mchack-work committed Apr 22, 2024
1 parent a5e30f1 commit f655196
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions hw/application_fpga/core/touch_sense/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# touch_sense

Core that handles touch senor events and provides them SW via an API.
Core that handles touch sensor events and provides them to the SW via
an API.

## Introduction

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

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


## API
Expand Down

0 comments on commit f655196

Please sign in to comment.