summaryrefslogtreecommitdiffstats
path: root/spec/rtems/support/if/microseconds-to-ticks.yml
blob: 2a477bf2c9cf238df7b48426e49dddbc7f73f81f (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns the number of clock ticks for the specified microseconds value.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
definition:
  default: |
    ( ( ${.:/params[0]/name} ) / ${../../config/if/get-microseconds-per-tick:/name}() )
  variants: []
description: null
enabled-by: true
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_MICROSECONDS_TO_TICKS
notes: |
  The number of clock ticks per second is defined by the
  ${/acfg/if/microseconds-per-tick:/name} application configuration option.
params:
- description: is the microseconds value to convert to clock ticks.
  dir: null
  name: _us
return:
  return: |
    The number of clock ticks for the specified microseconds value is returned.
  return-values: []
type: interface