summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/get-ticks-since-boot.yml
blob: 936435a8886a4385dc91ac95b20d29f8b058ae68 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the number of ${/glossary/clock-tick:/plural} since some time point
  during the system initialization or the last overflow of the clock tick
  counter.
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: []
    return: ${../../type/if/interval:/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
name: rtems_clock_get_ticks_since_boot
notes: |
  With a 1ms clock tick, this counter overflows after 50 days since boot.  This
  is the historical measure of uptime in an RTEMS system.  The newer service
  ${get-uptime:/name} is another and potentially more accurate way of obtaining
  similar information.
params: []
return:
  return: |
    Returns the number of ${/glossary/clock-tick:/plural} since some time point
    during the system initialization or the last overflow of the clock tick
    counter.
  return-values: []
type: interface