summaryrefslogtreecommitdiffstats
path: root/spec/rtems/ratemon/if/period-statistics.yml
blob: f3e09816491d372e584396391cd4b67948e97d2a (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  This structure provides the statistics of a period.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default:
    brief: |
      This member contains the number of periods executed.
    definition: ${/c/if/uint32_t:/name} ${.:name}
    description: null
    kind: member
    name: count
  variants: []
- default:
    brief: |
      This member contains the number of periods missed.
    definition: ${/c/if/uint32_t:/name} ${.:name}
    description: null
    kind: member
    name: missed_count
  variants: []
- default:
    brief: |
      This member contains the least amount of processor time used in a period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: min_cpu_time
  variants: []
- default:
    brief: |
      This member contains the highest amount of processor time used in a
      period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: max_cpu_time
  variants: []
- default:
    brief: |
      This member contains the total amount of processor time used in a period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: total_cpu_time
  variants: []
- default:
    brief: |
      This member contains the least amount of
      ${/glossary/clock-monotonic:/term} time used in a period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: min_wall_time
  variants: []
- default:
    brief: |
      This member contains the highest amount of
      ${/glossary/clock-monotonic:/term} time used in a period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: max_wall_time
  variants: []
- default:
    brief: |
      This member contains the total amount of
      ${/glossary/clock-monotonic:/term} time used in a period.
    definition: ${/c/if/timespec:/name} ${.:name}
    description: null
    kind: member
    name: total_wall_time
  variants: []
definition-kind: typedef-only
description: null
enabled-by: true
index-entries: []
interface-type: struct
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: rtems_rate_monotonic_period_statistics
notes: null
type: interface