summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/get-boot-time.yml
blob: b56d10ac11ac6619edee2247d77762f2bd061e74 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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