kopia lustrzana https://github.com/OpenRTX/OpenRTX
76 wiersze
3.4 KiB
C++
76 wiersze
3.4 KiB
C++
/***************************************************************************
|
|
* Copyright (C) 2010 by Terraneo Federico *
|
|
* *
|
|
* 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 2 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. *
|
|
* *
|
|
* As a special exception, if other files instantiate templates or use *
|
|
* macros or inline functions from this file, or you compile this file *
|
|
* and link it with other works to produce a work based on this file, *
|
|
* this file does not by itself cause the resulting work to be covered *
|
|
* by the GNU General Public License. However the source code for this *
|
|
* file must still be made available in accordance with the GNU General *
|
|
* Public License. This exception does not invalidate any other reasons *
|
|
* why a work based on this file might be covered by the GNU General *
|
|
* Public License. *
|
|
* *
|
|
* 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
|
|
|
|
namespace miosix {
|
|
|
|
/**
|
|
* \addtogroup Interfaces
|
|
* \{
|
|
*/
|
|
|
|
/**
|
|
* \file delays.h
|
|
* This file contains two functions, delayMs() and delayUs() which implement
|
|
* busy wait delays.
|
|
*/
|
|
|
|
/**
|
|
* Delay function. Accuracy depends on the underlying implementation which is
|
|
* architecture specific.<br>
|
|
* Delay time can be inaccurate if interrupts are enabled or the kernel is
|
|
* running due to time spent in interrupts and due to preemption.<br>
|
|
* It is implemented using busy wait, so can be safely used even when the
|
|
* kernel is paused or interrupts are disabled.<br>
|
|
* If the kernel is running it is *highly* recomended to use Thread::sleep since
|
|
* it gives CPU time to other threads and/or it puts the CPU in low power mode.
|
|
* \param mseconds milliseconds to wait
|
|
*/
|
|
void delayMs(unsigned int mseconds);
|
|
|
|
/**
|
|
* Delay function. Accuracy depends on the underlying implementation which is
|
|
* architecture specific.<br>
|
|
* Delay time can be inaccurate if interrupts are enabled or the kernel is
|
|
* running due to time spent in interrupts and due to preemption.<br>
|
|
* It is implemented using busy wait, so can be safely used even when the
|
|
* kernel is paused or interrupts are disabled.<br>
|
|
* \param useconds microseconds to wait. Only values between 1 and 1000 are
|
|
* allowed. For greater delays use Thread::sleep() or delayMs().
|
|
*/
|
|
void delayUs(unsigned int useconds);
|
|
|
|
/**
|
|
* \}
|
|
*/
|
|
|
|
}
|
|
|
|
#endif //DELAYS_H
|