summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/get-uptime.yml
blob: e869966838ab72c740604c698f01f55b660a2070 (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
51
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the seconds and nanoseconds elapsed since some time point during the
  system initialization using ${/glossary/clock-monotonic:/term}.
copyrights:
- Copyright (C) 2021 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:
    - ${/c/if/timespec:/name} *${.:/params[0]/name}
    return: ${../../status/if/code:/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_uptime
notes: null
params:
- description: |
    is the pointer to a ${/c/if/timespec:/name} object.  When the directive
    call is successful, the seconds and nanoseconds elapsed since some time
    point during the system initialization and some point during the directive
    call using ${/glossary/clock-monotonic:/term} will be stored in this
    object.
  dir: out
  name: uptime
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      The ${.:/params[0]/name} parameter was ${/c/if/null:/name}.
    value: ${../../status/if/invalid-address:/name}
type: interface