aboutsummaryrefslogtreecommitdiffstats
path: root/src/include/sleep.h
blob: c718bb4ba3d2cad49f3779e2ecd4b96e8ce44abe (plain)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @addtogroup Time
 * @{
 */

#ifndef _SLEEP_H_
#define _SLEEP_H_

#ifdef __cplusplus
extern "C" {
#endif
#ifdef CH_USE_SLEEP
  void chThdSleep(systime_t time);
#endif /* CH_USE_SLEEP */
#ifdef CH_USE_SYSTEMTIME
bool_t chSysInTimeWindow(systime_t start, systime_t end);
#endif /* CH_USE_SYSTEMTIME */
#ifdef __cplusplus
}
#endif

#ifdef CH_USE_SYSTEMTIME
/**
 * Returns the number of system ticks since the \p chSysInit() invocation.
 * @return the system ticks number
 * @note The counter can reach its maximum and then returns to zero.
 * @note This function is designed to work with the \p chThdSleepUntil().
 * @note The function is available only if the \p CH_USE_SYSTEMTIME
 *       option is enabled in \p chconf.h.
 */
#define chSysGetTime() rlist.r_stime

/**
 * Suspends the invoking thread until the system time arrives to the specified
 * value.
 * @note The function is available only if the \p CH_USE_SYSTEMTIME
 *       option is enabled in \p chconf.h.
 */
#define chThdSleepUntil(t) {                                            \
  chSysLock();                                                          \
  chSchGoSleepTimeoutS(PRSLEEP,                                         \
                      (systime_t)((t) - chSysGetTime()));               \
  chSysUnlock();                                                        \
}
#endif /* CH_USE_SYSTEMTIME */

#endif /* _SLEEP_H_ */

/** @} */