osal.h

00001 /******************** (C) COPYRIGHT 2012 STMicroelectronics ********************
00002 * File Name          : osal.h
00003 * Author             : AMS - HEA&RF BU
00004 * Version            : V1.0.0
00005 * Date               : 19-July-2012
00006 * Description        : This header file defines the OS abstraction layer used by
00007 *                      the BLE stack. OSAL defines the set of functions
00008 *                      which needs to be ported to target operating system and
00009 *                      target platform.
00010 ********************************************************************************
00011 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
00012 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
00013 * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
00014 * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
00015 * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
00016 * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
00017 *******************************************************************************/
00018 
00019 #ifndef __OSAL_H__
00020 #define __OSAL_H__
00021 
00022 #ifdef __cplusplus
00023  extern "C" {
00024 #endif
00025 
00026 /******************************************************************************
00027  * Includes
00028  *****************************************************************************/
00029 #include <hal_types.h>
00030 #ifdef __ICCARM__
00031 #include <intrinsics.h>
00032 #endif
00033 
00034 /******************************************************************************
00035  * Macros
00036  *****************************************************************************/
00037 
00038 
00039 /******************************************************************************
00040  * Function Prototypes
00041  *****************************************************************************/
00042 
00043 /**
00044  * This function copies size number of bytes from a 
00045  * memory location pointed by src to a destination 
00046  * memory location pointed by dest
00047  * 
00048  * @param[in] dest Destination address
00049  * @param[in] src  Source address
00050  * @param[in] size size in the bytes  
00051  * 
00052  * @return  Address of the destination
00053  */
00054  
00055 extern void* Osal_MemCpy(void *dest,const void *src,tHalUint size);
00056 
00057 
00058 /**
00059  * This function sets first number of bytes, specified
00060  * by size, to the destination memory pointed by ptr 
00061  * to the specified value
00062  * 
00063  * @param[in] ptr    Destination address
00064  * @param[in] value  Value to be set
00065  * @param[in] size   Size in the bytes  
00066  * 
00067  * @return  Address of the destination
00068  */
00069  
00070 extern void* Osal_MemSet(void *ptr, tHalInt value,tHalUint size);
00071 
00072 #ifdef __cplusplus
00073 }
00074 #endif
00075 
00076 #endif /* __OSAL_H__ */
00077