1 /** 2 * \file 3 * 4 * \brief Timer related functionality declaration. 5 * 6 * Copyright (C) 2014 - 2016 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_TIMER_H_INCLUDED 45 #define _HPL_TIMER_H_INCLUDED 46 47 /** 48 * \addtogroup HPL Timer 49 * 50 * \section hpl_timer_rev Revision History 51 * - v1.0.0 Initial Release 52 * 53 *@{ 54 */ 55 56 #include <compiler.h> 57 #include <hpl_irq.h> 58 59 #ifdef __cplusplus 60 extern "C" { 61 #endif 62 63 /** 64 * \brief Timer device structure 65 * 66 * The Timer device structure forward declaration. 67 */ 68 struct _timer_device; 69 70 /** 71 * \brief Timer interrupt callbacks 72 */ 73 struct _timer_callbacks { 74 void (*period_expired)(struct _timer_device *device); 75 }; 76 77 /** 78 * \brief Timer device structure 79 */ 80 struct _timer_device { 81 struct _timer_callbacks timer_cb; 82 struct _irq_descriptor irq; 83 void * hw; 84 }; 85 86 /** 87 * \brief Timer functions, pointers to low-level functions 88 */ 89 struct _timer_hpl_interface { 90 int32_t (*init)(struct _timer_device *const device, void *const hw); 91 void (*deinit)(struct _timer_device *const device); 92 void (*start_timer)(struct _timer_device *const device); 93 void (*stop_timer)(struct _timer_device *const device); 94 void (*set_timer_period)(struct _timer_device *const device, const uint32_t clock_cycles); 95 uint32_t (*get_period)(const struct _timer_device *const device); 96 bool (*is_timer_started)(const struct _timer_device *const device); 97 void (*set_timer_irq)(struct _timer_device *const device); 98 }; 99 /** 100 * \brief Initialize TCC 101 * 102 * This function does low level TCC configuration. 103 * 104 * \param[in] device The pointer to timer device instance 105 * \param[in] hw The pointer to hardware instance 106 * 107 * \return Initialization status. 108 */ 109 int32_t _timer_init(struct _timer_device *const device, void *const hw); 110 111 /** 112 * \brief Deinitialize TCC 113 * 114 * \param[in] device The pointer to timer device instance 115 */ 116 void _timer_deinit(struct _timer_device *const device); 117 118 /** 119 * \brief Start hardware timer 120 * 121 * \param[in] device The pointer to timer device instance 122 */ 123 void _timer_start(struct _timer_device *const device); 124 125 /** 126 * \brief Stop hardware timer 127 * 128 * \param[in] device The pointer to timer device instance 129 */ 130 void _timer_stop(struct _timer_device *const device); 131 132 /** 133 * \brief Set timer period 134 * 135 * \param[in] device The pointer to timer device instance 136 */ 137 void _timer_set_period(struct _timer_device *const device, const uint32_t clock_cycles); 138 139 /** 140 * \brief Retrieve timer period 141 * 142 * \param[in] device The pointer to timer device instance 143 * 144 * \return Timer period 145 */ 146 uint32_t _timer_get_period(const struct _timer_device *const device); 147 148 /** 149 * \brief Check if timer is running 150 * 151 * \param[in] device The pointer to timer device instance 152 * 153 * \return Check status. 154 * \retval true The given timer is running 155 * \retval false The given timer is not running 156 */ 157 bool _timer_is_started(const struct _timer_device *const device); 158 159 /** 160 * \brief Set timer IRQ 161 * 162 * \param[in] device The pointer to timer device instance 163 */ 164 void _timer_set_irq(struct _timer_device *const device); 165 166 #ifdef __cplusplus 167 } 168 #endif 169 /**@}*/ 170 #endif /* _HPL_TIMER_H_INCLUDED */ 171
