diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-12 10:55:46 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-12 10:56:02 +0100 |
| commit | 4081cc65d4211c766ee49fe9b7ab71388d88ecbb (patch) | |
| tree | 92d44ca7e49c5cb0eaed0f06e3545f816cd491fa | |
| parent | spec: Fix format (diff) | |
| download | rtems-central-4081cc65d4211c766ee49fe9b7ab71388d88ecbb.tar.bz2 | |
spec: Fix rtems_clock_get_ticks_per_second()
| -rw-r--r-- | spec/rtems/clock/if/get-ticks-per-second-0.yml | 33 | ||||
| -rw-r--r-- | spec/rtems/clock/if/get-ticks-per-second-1.yml (renamed from spec/rtems/clock/if/get-ticks-per-second.yml) | 16 | ||||
| -rw-r--r-- | spec/rtems/type/if/time-of-day.yml | 2 |
3 files changed, 45 insertions, 6 deletions
diff --git a/spec/rtems/clock/if/get-ticks-per-second-0.yml b/spec/rtems/clock/if/get-ticks-per-second-0.yml new file mode 100644 index 00000000..df201372 --- /dev/null +++ b/spec/rtems/clock/if/get-ticks-per-second-0.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Gets the number of clock ticks per second configured for this application. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +definition: + default: + attributes: null + body: null + params: [] + return: ${../../type/if/interval:/name} + variants: [] +description: null +enabled-by: true +index-entries: [] +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_clock_get_ticks_per_second +notes: | + The number of clock ticks per second is defined indirectly by the + ${/acfg/if/microseconds-per-tick:/name} configuration option. +params: [] +return: + return: | + Returns the number of clock ticks per second configured for this + application. + return-values: [] +type: interface diff --git a/spec/rtems/clock/if/get-ticks-per-second.yml b/spec/rtems/clock/if/get-ticks-per-second-1.yml index 13348834..7cfb8509 100644 --- a/spec/rtems/clock/if/get-ticks-per-second.yml +++ b/spec/rtems/clock/if/get-ticks-per-second-1.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Gets the number of clock ticks per second configured for this application. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) @@ -13,12 +14,17 @@ interface-type: macro links: - role: interface-placement uid: header -- role: interface-ingroup - uid: group name: rtems_clock_get_ticks_per_second -notes: null +notes: | + The number of clock ticks per second is defined indirectly by the + ${/acfg/if/microseconds-per-tick:/name} configuration option. + + This macro is an optimized variant for C/C++ without a function call + overhead. params: [] return: - return: null + return: | + Returns the number of clock ticks per second configured for this + application. return-values: [] type: interface diff --git a/spec/rtems/type/if/time-of-day.yml b/spec/rtems/type/if/time-of-day.yml index 40e9d41f..21e5964c 100644 --- a/spec/rtems/type/if/time-of-day.yml +++ b/spec/rtems/type/if/time-of-day.yml @@ -55,7 +55,7 @@ definition: - default: brief: | This member contains the clock tick of the second with values from 0 to - ${../../clock/if/get-ticks-per-second:/name} minus one. + ${../../clock/if/get-ticks-per-second-0:/name} minus one. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member |