summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/get-monotonic-sbintime.yml
blob: ae071740d3fae1e6821c5377538662d3225dc259 (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
44
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the time elapsed since some fixed time point in the past measured using
  the ${/glossary/clock-monotonic:/term} in signed binary time format.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: null
    params: []
    return: ${/c/if/int64_t:/name}
  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_monotonic_sbintime
notes: |
  The directive accesses a device provided by the
  ${/glossary/clock-driver:/term} to get the time in the highest resolution
  available to the system.

  See ${get-monotonic:/name}, ${get-monotonic-bintime:/name}, and
  ${get-monotonic-timeval:/name} to get the time in alternative formats.
params: []
return:
  return: |
    Returns the time elapsed since some fixed time point in the past
    measured using the ${/glossary/clock-monotonic:/term} at some time point
    during the directive call.
  return-values: []
type: interface