summaryrefslogtreecommitdiffstats
path: root/spec/rtems/clock/if/tick-later.yml
blob: 9ce69c7f395430e14d7ee699d65c62ecbfe39af7 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns the ticks counter value delta ticks in the future.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    body: |
      return ${/score/watchdog/if/ticks-since-boot:/name} + ${.:/params[0]/name};
    params:
    - ${../../type/if/interval:/name} ${.:/params[0]/name}
    return: ${../../type/if/interval:/name}
  variants: []
description: null
enabled-by: true
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: rtems_clock_tick_later
notes: null
params:
- description: is the ticks delta value.
  dir: null
  name: delta
return:
  return: |
    The tick counter value delta ticks in the future is returned.
  return-values: []
type: interface