TIME_AD.h

00001 /***************************************************************************//**
00002  *   @file   TIME_AD.h
00003  *   @brief  Header file of TIME Driver.
00004  *   @author DNechita (Dan.Nechita@analog.com)
00005 ********************************************************************************
00006  * Copyright 2012(c) Analog Devices, Inc.
00007  *
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions are met:
00012  *  - Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer.
00014  *  - Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *  - Neither the name of Analog Devices, Inc. nor the names of its
00019  *    contributors may be used to endorse or promote products derived
00020  *    from this software without specific prior written permission.
00021  *  - The use of this software may or may not infringe the patent rights
00022  *    of one or more patent holders.  This license does not release you
00023  *    from the requirement that you obtain separate licenses from these
00024  *    patent holders to use this software.
00025  *  - Use of the software either in source or binary form, must be run
00026  *    on or directly connected to an Analog Devices Inc. component.
00027  *
00028  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00029  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00030  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00031  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00032  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00033  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00034  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038  *
00039 *******************************************************************************/
00040 #ifndef __TIME_AD_H__
00041 #define __TIME_AD_H__
00042 /******************************************************************************/
00043 /************************ Functions Declarations ******************************/
00044 /******************************************************************************/
00045 
00046 /*! Initializes the timer used in this driver. */
00047 unsigned char TIME_Init(void);
00048 
00049 /*! The timer begins to count in steps of microseconds(us) until the user calls a
00050 stop measurement function. */
00051 void TIME_StartMeasure(void);
00052 
00053 /*! Stops the measurement process when the functions is called. */
00054 unsigned long TIME_StopMeasure(void);
00055 
00056 /*! Creates a delay of microseconds. */
00057 void TIME_DelayUs(unsigned short usUnits);
00058 
00059 /*! Creates a delay of milliseconds. */
00060 void TIME_DelayMs(unsigned short msUnits);
00061 
00062 #endif // __TIME_AD_H__