diff options
Diffstat (limited to 'spec/rtems/timer/if/get-information.yml')
| -rw-r--r-- | spec/rtems/timer/if/get-information.yml | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/spec/rtems/timer/if/get-information.yml b/spec/rtems/timer/if/get-information.yml index 6d89a721..b4a414ea 100644 --- a/spec/rtems/timer/if/get-information.yml +++ b/spec/rtems/timer/if/get-information.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Gets information about the timer. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -12,7 +13,8 @@ definition: - ${information:/name} *${.:/params[1]/name} return: ${../../status/if/code:/name} variants: [] -description: null +description: | + This directive returns information about the timer. enabled-by: true index-entries: [] interface-type: function @@ -22,15 +24,28 @@ links: - role: interface-ingroup uid: group name: rtems_timer_get_information -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: '%' - dir: null +- description: | + is the pointer to a timer information variable. The information about the + timer will be stored in this variable, in case of a successful operation. + dir: out name: the_info 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 ${/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 |