File: timeout.h

package info (click to toggle)
crust-firmware 0.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,900 kB
  • sloc: ansic: 19,341; yacc: 596; lex: 479; makefile: 334; asm: 215; sh: 136; python: 42
file content (33 lines) | stat: -rw-r--r-- 807 bytes parent folder | download | duplicates (2)
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
/*
 * Copyright © 2017-2022 The Crust Firmware Authors.
 * SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-only
 */

#ifndef COMMON_TIMEOUT_H
#define COMMON_TIMEOUT_H

#include <stdbool.h>
#include <stdint.h>

#define USEC_PER_MSEC 1000U
#define USEC_PER_SEC  1000000U

/**
 * Check if a timeout has expired.
 *
 * @param timeout The timeout.
 * @return        Whether or not the timeout has expired.
 */
bool timeout_expired(uint32_t timeout);

/**
 * Set a timeout for some point in the near future.
 *
 * Timeouts must not be set for greater than approximately one minute.
 *
 * @param useconds The delay in microseconds before the timeout expires.
 * @return         An opaque number that can be passed to timeout_expired().
 */
uint32_t timeout_set(uint32_t useconds);

#endif /* COMMON_TIMEOUT_H */