diff options
Diffstat (limited to 'spec/rtems/timer/if/fire-after.yml')
| -rw-r--r-- | spec/rtems/timer/if/fire-after.yml | 40 |
1 files changed, 31 insertions, 9 deletions
diff --git a/spec/rtems/timer/if/fire-after.yml b/spec/rtems/timer/if/fire-after.yml index 6664a7ce..63647897 100644 --- a/spec/rtems/timer/if/fire-after.yml +++ b/spec/rtems/timer/if/fire-after.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Fires the timer after the interval. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -14,9 +15,16 @@ definition: - void *${.:/params[3]/name} return: ${../../status/if/code:/name} variants: [] -description: null +description: | + This directive initiates the timer specified by ${.:/params[0]/name}. If the + timer is running, it is automatically canceled before being initiated. The + timer is scheduled to fire after an interval of clock ticks has passed + specified by ${.:/params[1]/name}. When the timer fires, the timer service + routine ${.:/params[2]/name} will be invoked with the argument + ${.:/params[3]/name} in the context of the clock tick ${/glossary/isr:/term}. enabled-by: true -index-entries: [] +index-entries: +- fire a timer after an interval interface-type: function links: - role: interface-placement @@ -24,21 +32,35 @@ links: - role: interface-ingroup uid: group name: rtems_timer_fire_after -notes: null +notes: | + This directive will not cause the running task to be preempted. params: -- description: '%' +- description: is the timer identifier. dir: null name: id -- description: '%' +- description: is the interval until the routine is fired in clock ticks. dir: null name: ticks -- description: '%' +- description: is the routine to schedule. dir: null name: routine -- description: '%' +- description: is the argument passed to the routine when it is fired. dir: null name: user_data return: return: null - return-values: [] + return-values: + - description: | + The requested operation was successful. + value: ${../../status/if/successful:/name} + - description: | + The ${.:/params[1]/name} parameter was 0. + value: ${../../status/if/invalid-number:/name} + - description: | + The ${.:/params[2]/name} parameter was ${/c/if/null:/name}. + value: ${../../status/if/invalid-address:/name} + - description: | + There was no timer associated with the identifier specified by + ${.:/params[0]/name}. + value: ${../../status/if/invalid-id:/name} type: interface |