summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-milliseconds-per-tick.yml
blob: bddc5aadfa4b3851e04d82acd64de3326c5a99d6 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the number of milliseconds per clock tick configured for this
  application.
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
definition:
  default:
    attributes: null
    body: ( ${/score/watchdog/if/microseconds-per-tick:/name} / 1000 )
    params: []
    return: ${/c/if/uint32_t:/name}
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
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_configuration_get_milliseconds_per_tick
notes: |
  The number of milliseconds per ${/glossary/clock-tick:/term} is defined by
  the ${/acfg/if/microseconds-per-tick:/name} application configuration option.
params: []
return:
  return: |
    Returns the number of milliseconds per clock tick configured for this
    application.
  return-values: []
type: interface