clock.h

00001 /******************** (C) COPYRIGHT 2012 STMicroelectronics ********************
00002 * File Name          : clock.h
00003 * Author             : AMS - HEA&RF BU
00004 * Version            : V1.0.1
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 
00022 /**
00023  * Number of clocks in one seconds.
00024  * This value must be set by each platorm implementation, basing on its needs.
00025  */
00026 extern const uint32_t CLOCK_SECOND;
00027 
00028 typedef uint32_t tClockTime;
00029 
00030 /**
00031  * This function initializes the clock library and should be called before
00032  * any other Stack functions.
00033  *
00034  */
00035 void Clock_Init(void);
00036 
00037 /**
00038  * This function returns the current system clock time. it is used by
00039  * the host stack and has to be implemented.
00040  *
00041  * @return The current clock time, measured in system ticks.
00042  */
00043 tClockTime Clock_Time(void);
00044 
00045 /**
00046  * This function waits for a given number of milliseconds.
00047  *
00048  */
00049 void Clock_Wait(uint32_t i);
00050 
00051 /**
00052  * It suspends system clock.
00053  *
00054  */
00055 void Clock_Suspend(void);
00056 
00057 
00058 #endif /* __CLOCK_H__ */
00059