Skip to content

Commit 884dafd

Browse files
committed
doc: update
1 parent 5538bb8 commit 884dafd

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The posix timer module supports three different modes.
66

77
## Modes
88

9-
Two different modes are supported by **module_posix_timer**.
9+
Three different modes are supported by **module_posix_timer**.
1010

1111
* ***nanosleep :*** In this mode the **module_posix_timer** main thread just does a nanosleep until the period time has been elapsed. If the nanosleep call was interrupted by some signal it will sleep until the calculated period end time has been reached. This mode is easy and efficient as well. The **module_posix_timer*** thread should run at a very high priority to ensure, that it will be waken up when it's necessary.
1212
* ***posix_timer :*** This mode creates a timer with timer_create. It configures the timer and connects it to the given signal number from the configuration string.

debian/control

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,9 @@ Package: module-posix-timer
1313
Architecture: any
1414
Multi-Arch: same
1515
Depends: robotkernel ${misc:Depends}
16-
Description: <insert up to 60 chars description>
17-
<insert long description, indented with spaces>
16+
Description: Robotkernel module to generate deterministic triggers for other modules.
17+
It supports three different modes.
18+
19+
nanosleep: In this mode the **module_posix_timer** main thread just does a nanosleep until the period time has been elapsed. If the nanosleep call was interrupted by some signal it will sleep until the calculated period end time has been reached. This mode is easy and efficient as well. The **module_posix_timer*** thread should run at a very high priority to ensure, that it will be waken up when it's necessary.
20+
posix_timer: This mode creates a timer with timer_create. It configures the timer and connects it to the given signal number from the configuration string.
21+
busywait: In busywait the timer threads does active wait on the cpu and consumes all cpu time. This can cause higher power consumption and higher temperature (But on a PREEMPT-RT system that should not matter).

0 commit comments

Comments
 (0)