mirror of
https://github.com/libretro/RetroArch
synced 2025-01-30 12:32:52 +00:00
116 lines
4.0 KiB
C
116 lines
4.0 KiB
C
/*
|
|
Copyright (c) 2012, Broadcom Europe Ltd
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
* Neither the name of the copyright holder nor the
|
|
names of its contributors may be used to endorse or promote products
|
|
derived from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
|
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/*=============================================================================
|
|
VideoCore OS Abstraction Layer - timer support
|
|
=============================================================================*/
|
|
|
|
#ifndef VCOS_TIMER_H
|
|
#define VCOS_TIMER_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "interface/vcos/vcos_types.h"
|
|
#ifndef VCOS_PLATFORM_H
|
|
#include "vcos.h"
|
|
#endif
|
|
|
|
/** \file vcos_timer.h
|
|
*
|
|
* Timers are single shot.
|
|
*
|
|
* Timer times are in milliseconds.
|
|
*
|
|
* \note that timer callback functions are called from an arbitrary thread
|
|
* context. The expiration function should do its work as quickly as possible;
|
|
* blocking should be avoided.
|
|
*
|
|
* \note On Windows, the separate function vcos_timer_init() must be called
|
|
* as timer initialization from DllMain is not possible.
|
|
*/
|
|
|
|
/** Perform timer subsystem initialization. This function is not needed
|
|
* on non-Windows platforms but is still present so that it can be
|
|
* called. On Windows it is needed because vcos_init() gets called
|
|
* from DLL initialization where it is not possible to create a
|
|
* time queue (deadlock occurs if you try).
|
|
*
|
|
* @return VCOS_SUCCESS on success. VCOS_EEXIST if this has already been called
|
|
* once. VCOS_ENOMEM if resource allocation failed.
|
|
*/
|
|
VCOSPRE_ VCOS_STATUS_T VCOSPOST_ vcos_timer_init(void);
|
|
|
|
/** Create a timer in a disabled state.
|
|
*
|
|
* The timer is initially disabled.
|
|
*
|
|
* @param timer timer handle
|
|
* @param name name for timer
|
|
* @param expiration_routine function to call when timer expires
|
|
* @param context context passed to expiration routine
|
|
*
|
|
*/
|
|
VCOS_INLINE_DECL
|
|
VCOS_STATUS_T vcos_timer_create(VCOS_TIMER_T *timer,
|
|
const char *name,
|
|
void (*expiration_routine)(void *context),
|
|
void *context);
|
|
|
|
/** Start a timer running.
|
|
*
|
|
* Timer must be stopped.
|
|
*
|
|
* @param timer timer handle
|
|
* @param delay Delay to wait for, in ms
|
|
*/
|
|
VCOS_INLINE_DECL
|
|
void vcos_timer_set(VCOS_TIMER_T *timer, VCOS_UNSIGNED delay);
|
|
|
|
/** Stop an already running timer.
|
|
*
|
|
* @param timer timer handle
|
|
*/
|
|
VCOS_INLINE_DECL
|
|
void vcos_timer_cancel(VCOS_TIMER_T *timer);
|
|
|
|
/** Stop a timer and restart it.
|
|
* @param timer timer handle
|
|
* @param delay delay in ms
|
|
*/
|
|
VCOS_INLINE_DECL
|
|
void vcos_timer_reset(VCOS_TIMER_T *timer, VCOS_UNSIGNED delay);
|
|
|
|
VCOS_INLINE_DECL
|
|
void vcos_timer_delete(VCOS_TIMER_T *timer);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|