blob: de16fc9a6de417a9ba7614a0e91837141d573ac6 (
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
45
46
47
48
49
50
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the time elapsed since the ${/glossary/unix-epoch:/term} measured using
${/glossary/clock-realtime:/term} in coarse resolution in seconds and
microseconds format.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
definition:
default:
attributes: null
body: null
params:
- ${/c/if/timeval:/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_realtime_coarse_timeval
notes: |
The directive does not access a device to get the time. It uses a recent
snapshot provided by the ${/glossary/clock-driver:/term}. Alternatively, the
${get-realtime-timeval:/name} directive may be used to get the time in a
higher resolution and with a higher runtime overhead.
See ${get-realtime-coarse:/name} and ${get-realtime-coarse-timeval:/name} to
get the time in alternative formats.
params:
- description: |
is the pointer to a ${/c/if/timeval:/name} object. The time elapsed since
the ${/glossary/unix-epoch:/term} measured using the
${/glossary/clock-realtime:/term} at some time point close to the directive
call will be stored in this object. Calling the directive with a pointer
equal to ${/c/if/null:/name} is undefined behaviour.
dir: out
name: time_snapshot
return: null
type: interface
|