summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/get-boot-time.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-11 15:28:47 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-10-12 13:47:37 +0200
commit7085cb7a4c7abada24dd8398d7cfeac07affa6ef (patch)
tree44761f5b9bc7fae7d120d8ea892e0fdcf6c2d670 /spec/rtems/clock/if/get-boot-time.yml
parentspec: Improve thread wait lock test case (diff)
downloadrtems-central-7085cb7a4c7abada24dd8398d7cfeac07affa6ef.tar.bz2
spec: Add new clock directives
Diffstat (limited to 'spec/rtems/clock/if/get-boot-time.yml')
-rw-r--r--spec/rtems/clock/if/get-boot-time.yml43
1 files changed, 43 insertions, 0 deletions
diff --git a/spec/rtems/clock/if/get-boot-time.yml b/spec/rtems/clock/if/get-boot-time.yml
new file mode 100644
index 00000000..b56d10ac
--- /dev/null
+++ b/spec/rtems/clock/if/get-boot-time.yml
@@ -0,0 +1,43 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ Gets a time point during system initialization used by
+ ${/glossary/clock-realtime:/term} in seconds and nanoseconds format.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+ default:
+ attributes: null
+ body: null
+ params:
+ - ${/c/if/timespec:/name} *${.:/params[0]/name}
+ return: void
+ variants: []
+description: null
+enabled-by: true
+index-entries: []
+interface-type: function
+links:
+- role: interface-placement
+ uid: header
+- role: interface-ingroup
+ uid: group
+- role: constraint
+ uid: /constraint/directive-ctx-any
+- role: constraint
+ uid: /constraint/directive-no-preempt
+- role: constraint
+ uid: /constraint/clock-driver
+name: rtems_clock_get_boot_time
+notes: |
+ See ${get-boot-time-bintime:/name} and ${get-boot-time-timeval:/name} to get
+ the boot time in alternative formats.
+params:
+- description: |
+ is the pointer to a ${/c/if/timespec:/name} object. A time point during
+ system initialization used by ${/glossary/clock-realtime:/term} will be
+ stored in this object. Calling the directive with a pointer equal to
+ ${/c/if/null:/name} is undefined behaviour.
+ dir: out
+ name: boot_time
+return: null
+type: interface