clock.h

00001 /******************** (C) COPYRIGHT 2012 STMicroelectronics ********************
00002 * File Name          : clock.h
00003 * Author             : AMS - HEA&RF BU
00004 * Version            : V1.0.0
00005 * Date               : 19-July-2012
00006 * Description        : Header file for clock library, that gives a simple time
00007 *                       reference to the BLE Stack.
00008 ********************************************************************************
00009 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
00010 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
00011 * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
00012 * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
00013 * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
00014 * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
00015 *******************************************************************************/
00016 
00017 #ifndef __CLOCK_H__
00018 #define __CLOCK_H__
00019 
00020 //#include <hal_types.h>
00021 #include <stdint.h>
00022 
00023 /**
00024  * Number of clocks in one seconds.
00025  * This value must be set by each platorm implementation, basing on its needs.
00026  */
00027 extern const uint32_t CLOCK_SECOND;
00028 
00029 typedef uint32_t tClockTime;
00030 
00031 /**
00032  * This function initializes the clock library and should be called before
00033  * any other Stack functions.
00034  *
00035  */
00036 void Clock_Init(void);
00037 
00038 /**
00039  * This function returns the current system clock time. it is used by
00040  * the host stack and has to be implemented.
00041  *
00042  * @return The current clock time, measured in system ticks.
00043  */
00044 tClockTime Clock_Time(void);
00045 
00046 /**
00047  * This function waits for a given number of milliseconds.
00048  *
00049  */
00050 void Clock_Wait(int i);
00051 
00052 
00053 #endif /* __CLOCK_H__ */
00054 
00055 
00056