summaryrefslogtreecommitdiffstats
path: root/spec/rtems/timer/if/reset.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/timer/if/reset.yml')
-rw-r--r--spec/rtems/timer/if/reset.yml38
1 files changed, 32 insertions, 6 deletions
diff --git a/spec/rtems/timer/if/reset.yml b/spec/rtems/timer/if/reset.yml
index 3002027e..6bbac0fe 100644
--- a/spec/rtems/timer/if/reset.yml
+++ b/spec/rtems/timer/if/reset.yml
@@ -1,5 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Resets the timer.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -11,9 +12,16 @@ definition:
- ${../../type/if/id:/name} ${.:/params[0]/name}
return: ${../../status/if/code:/name}
variants: []
-description: null
+description: |
+ This directive resets the timer specified by ${.:/params[0]/name}. This
+ timer must have been previously initiated with either the ${fire-after:/name}
+ or ${server-fire-after:/name} directive. If active the timer is canceled,
+ after which the timer is reinitiated using the same interval and timer
+ service routine which the original ${fire-after:/name} or
+ ${server-fire-after:/name} directive used.
enabled-by: true
-index-entries: []
+index-entries:
+- reset a timer
interface-type: function
links:
- role: interface-placement
@@ -21,12 +29,30 @@ links:
- role: interface-ingroup
uid: group
name: rtems_timer_reset
-notes: null
+notes: |
+ This directive will not cause the running task to be preempted.
+
+ If the timer has not been used or the last usage of this timer was by a
+ ${fire-when:/name} or ${server-fire-when:/name} directive, then the
+ ${../../status/if/not-defined:/name} error is returned.
+
+ Restarting a cancelled after timer results in the timer being reinitiated
+ with its previous timer service routine and interval.
params:
-- description: '%'
+- description: is the timer identifier.
dir: null
name: id
return:
return: null
- return-values: []
+ return-values:
+ - description: |
+ The requested operation was successful.
+ value: ${../../status/if/successful:/name}
+ - description: |
+ There was no timer associated with the identifier specified by
+ ${.:/params[0]/name}.
+ value: ${../../status/if/invalid-id:/name}
+ - description: |
+ The timer was not of the interval class.
+ value: ${../../status/if/not-defined:/name}
type: interface