diff options
Diffstat (limited to 'spec/rtems/timer/if/delete.yml')
| -rw-r--r-- | spec/rtems/timer/if/delete.yml | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/spec/rtems/timer/if/delete.yml b/spec/rtems/timer/if/delete.yml index 1155e20f..5bc65bdc 100644 --- a/spec/rtems/timer/if/delete.yml +++ b/spec/rtems/timer/if/delete.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Deletes 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,12 @@ definition: - ${../../type/if/id:/name} ${.:/params[0]/name} return: ${../../status/if/code:/name} variants: [] -description: null +description: | + This directive deletes the timer specified by the ${.:/params[0]/name} + parameter. If the timer is running, it is automatically canceled. enabled-by: true -index-entries: [] +index-entries: +- delete a timer interface-type: function links: - role: interface-placement @@ -21,12 +25,25 @@ links: - role: interface-ingroup uid: group name: rtems_timer_delete -notes: null +notes: | + This directive may cause the calling task to be preempted due to an obtain + and release of the object allocator mutex. + + The ${/glossary/tmcb:/term} for the deleted timer is reclaimed by RTEMS. + + A timer can be deleted by a task other than the task which created the timer. 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} type: interface |