OpenRTX/openrtx/include/interfaces/delays.h

69 wiersze
2.3 KiB
C

/***************************************************************************
* Copyright (C) 2020 - 2023 by Silvano Seva IU2KWO *
* and Niccolò Izzo IU2KIN *
* *
* This program 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. *
* *
* This program 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/> *
***************************************************************************/
#ifndef DELAYS_H
#define DELAYS_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* Function prototypes for microsecond and millisecond delays.
* Their implementation is device-specific, thus it is placed inside the drivers
* folder.
*/
/**
* Exact microsecond delay.
* @param useconds: delay value
*/
void delayUs(unsigned int useconds);
/**
* Exact millisecond delay.
* @param mseconds: delay value
*/
void delayMs(unsigned int mseconds);
/**
* Puts the calling thread in a sleeping state for the specified amount of time.
* @param seconds: sleep time, seconds.
* @param mseconds: sleep time, milliseconds.
*/
void sleepFor(unsigned int seconds, unsigned int mseconds);
/**
* Puts the calling thread in a sleeping state until the system time reaches
* the target value passed as parameter.
* @param timestamp: traget timestamp for the wakeup.
*/
void sleepUntil(long long timestamp);
/**
* Get the current value of the system tick.
* @return current system tick value.
*/
long long getTick();
#ifdef __cplusplus
}
#endif
#endif /* DELAYS_H */