summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/clock/tick-before.yml
blob: ef7c69f4814d4e4c0e2410f3a875c5c3da6d2449 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Returns true if the current ticks counter value indicates a time before the
  time specified by the tick value and false otherwise.
copyrights:
- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    body: |
      return (${/if/c/int32_t:/name}) ( ${.:/params[0]/name} - ${/if/impl/watchdog/ticks-since-boot:/name} ) > 0;
    params:
    - ${../types/interval:/name} ${.:/params[0]/name}
    return: ${/if/c/bool:/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_before
notes: |
  This directive can be used to write busy loops with a timeout.
params:
- description: is the tick value.
  dir: null
  name: tick
return:
  return: null
  return-values:
  - description: |
      The current ticks counter value indicates a time before the time
      specified by the tick value.
    value: 'true'
  - description: |
      Otherwise.
    value: 'false'
type: interface