blob: cc46b0a7f7bd61bdbacb6e2f992ede7b932bfcfc [file] [log] [blame]
/*
* Copyright (c) 2012-2013 Qualcomm Atheros, Inc.
* All Rights Reserved.
* Qualcomm Atheros Confidential and Proprietary.
*/
#if !defined( __VOS_THREADS_H )
#define __VOS_THREADS_H
/**=========================================================================
\file vos_threads.h
\brief virtual Operating System Services (vOSS) Threading APIs
Copyright 2008 (c) Qualcomm, Incorporated. All Rights Reserved.
Qualcomm Confidential and Proprietary.
========================================================================*/
/* $Header$ */
/*--------------------------------------------------------------------------
Include Files
------------------------------------------------------------------------*/
#include <vos_types.h>
/*--------------------------------------------------------------------------
Preprocessor definitions and constants
------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------
Type declarations
------------------------------------------------------------------------*/
/*-------------------------------------------------------------------------
Function declarations and documenation
------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
\brief vos_sleep() - sleep
The \a vos_sleep() function suspends the execution of the current thread
until the specified time out interval elapses.
\param msInterval - the number of milliseconds to suspend the current thread.
A value of 0 may or may not cause the current thread to yield.
\return Nothing.
\sa
--------------------------------------------------------------------------*/
v_VOID_t vos_sleep( v_U32_t msInterval );
/*----------------------------------------------------------------------------
\brief vos_sleep_us() - sleep
The \a vos_sleep_us() function suspends the execution of the current thread
until the specified time out interval elapses.
\param usInterval - the number of microseconds to suspend the current thread.
A value of 0 may or may not cause the current thread to yield.
\return Nothing.
\sa
--------------------------------------------------------------------------*/
v_VOID_t vos_sleep_us( v_U32_t usInterval );
/*----------------------------------------------------------------------------
\brief vos_busy_wait() - busy wait
The \a vos_busy_wait() function places the current thread in busy wait
until the specified time out interval elapses. If the interval is greater
than 50us on WM, the behaviour is undefined.
\param usInterval - the number of microseconds to busy wait.
\return Nothing.
\sa
--------------------------------------------------------------------------*/
v_VOID_t vos_busy_wait( v_U32_t usInterval );
#endif // __VOS_THREADS_H