1 /** 2 * \file 3 * 4 * \brief Time measure related functionality declaration. 5 * 6 * Copyright (C) 2014 Atmel Corporation. All rights reserved. 7 * 8 * \asf_license_start 9 * 10 * \page License 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above copyright notice, 16 * this list of conditions and the following disclaimer. 17 * 18 * 2. Redistributions in binary form must reproduce the above copyright notice, 19 * this list of conditions and the following disclaimer in the documentation 20 * and/or other materials provided with the distribution. 21 * 22 * 3. The name of Atmel may not be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * 4. This software may only be redistributed and used in connection with an 26 * Atmel microcontroller product. 27 * 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 * 40 * \asf_license_stop 41 * 42 */ 43 44 #ifndef _HPL_TIME_MEASURE_H_INCLUDED 45 #define _HPL_TIME_MEASURE_H_INCLUDED 46 47 /** 48 * \addtogroup HPL Time measure 49 * 50 * \section hpl_time_measure_rev Revision History 51 * - v1.0.0 Initial Release 52 * 53 *@{ 54 */ 55 56 #include <compiler.h> 57 58 #ifdef __cplusplus 59 extern "C" { 60 #endif 61 62 /** 63 * \brief System time type 64 */ 65 typedef uint32_t system_time_t; 66 67 /** 68 * \name HPL functions 69 */ 70 //@{ 71 /** 72 * \brief Initialize system time module 73 * 74 * \param[in] hw The pointer to hardware instance to initialize 75 */ 76 void _system_time_init(void *const hw); 77 78 /** 79 * \brief Deinitialize system time module 80 * 81 * \param[in] hw The pointer to hardware instance to initialize 82 */ 83 void _system_time_deinit(void *const hw); 84 85 /** 86 * \brief Get system time 87 * 88 * \param[in] hw The pointer to hardware instance to initialize 89 */ 90 system_time_t _system_time_get(const void *const hw); 91 92 /** 93 * \brief Get maximum possible system time 94 * 95 * \param[in] hw The pointer to hardware instance to initialize 96 */ 97 system_time_t _system_time_get_max_time_value(const void *const hw); 98 //@} 99 100 #ifdef __cplusplus 101 } 102 #endif 103 /**@}*/ 104 #endif /* _HPL_TIME_MEASURE_H_INCLUDED */ 105
