Pratyush Mallick / Mbed OS nano_dac

this is testing

noos_mbed/include/timer.h@0:e8a1ba50c46b, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 19:12:57 2021 +0530
Revision:
0:e8a1ba50c46b
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:e8a1ba50c46b 1 /***************************************************************************//**
pmallick 0:e8a1ba50c46b 2 * @file timer.h
pmallick 0:e8a1ba50c46b 3 * @brief Timer control module header.
pmallick 0:e8a1ba50c46b 4 * @author Andrei Drimbarean (andrei.drimbarean@analog.com)
pmallick 0:e8a1ba50c46b 5 ********************************************************************************
pmallick 0:e8a1ba50c46b 6 * Copyright 2019(c) Analog Devices, Inc.
pmallick 0:e8a1ba50c46b 7 *
pmallick 0:e8a1ba50c46b 8 * All rights reserved.
pmallick 0:e8a1ba50c46b 9 *
pmallick 0:e8a1ba50c46b 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:e8a1ba50c46b 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:e8a1ba50c46b 12 * - Redistributions of source code must retain the above copyright
pmallick 0:e8a1ba50c46b 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:e8a1ba50c46b 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:e8a1ba50c46b 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:e8a1ba50c46b 16 * the documentation and/or other materials provided with the
pmallick 0:e8a1ba50c46b 17 * distribution.
pmallick 0:e8a1ba50c46b 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:e8a1ba50c46b 19 * contributors may be used to endorse or promote products derived
pmallick 0:e8a1ba50c46b 20 * from this software without specific prior written permission.
pmallick 0:e8a1ba50c46b 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:e8a1ba50c46b 22 * of one or more patent holders. This license does not release you
pmallick 0:e8a1ba50c46b 23 * from the requirement that you obtain separate licenses from these
pmallick 0:e8a1ba50c46b 24 * patent holders to use this software.
pmallick 0:e8a1ba50c46b 25 * - Use of the software either in source or binary form, must be run
pmallick 0:e8a1ba50c46b 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:e8a1ba50c46b 27 *
pmallick 0:e8a1ba50c46b 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED
pmallick 0:e8a1ba50c46b 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY
pmallick 0:e8a1ba50c46b 30 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:e8a1ba50c46b 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:e8a1ba50c46b 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:e8a1ba50c46b 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:e8a1ba50c46b 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:e8a1ba50c46b 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:e8a1ba50c46b 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:e8a1ba50c46b 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:e8a1ba50c46b 38 *******************************************************************************/
pmallick 0:e8a1ba50c46b 39
pmallick 0:e8a1ba50c46b 40 #ifndef SRC_TIMER_H_
pmallick 0:e8a1ba50c46b 41 #define SRC_TIMER_H_
pmallick 0:e8a1ba50c46b 42
pmallick 0:e8a1ba50c46b 43 /******************************************************************************/
pmallick 0:e8a1ba50c46b 44 /***************************** Include Files **********************************/
pmallick 0:e8a1ba50c46b 45 /******************************************************************************/
pmallick 0:e8a1ba50c46b 46
pmallick 0:e8a1ba50c46b 47 #include <stdint.h>
pmallick 0:e8a1ba50c46b 48
pmallick 0:e8a1ba50c46b 49 /******************************************************************************/
pmallick 0:e8a1ba50c46b 50 /*************************** Types Declarations *******************************/
pmallick 0:e8a1ba50c46b 51 /******************************************************************************/
pmallick 0:e8a1ba50c46b 52
pmallick 0:e8a1ba50c46b 53 /**
pmallick 0:e8a1ba50c46b 54 * @struct timer_desc
pmallick 0:e8a1ba50c46b 55 * @brief Structure holding timer descriptor
pmallick 0:e8a1ba50c46b 56 */
pmallick 0:e8a1ba50c46b 57 struct timer_desc {
pmallick 0:e8a1ba50c46b 58 /** timer ID */
pmallick 0:e8a1ba50c46b 59 uint16_t id;
pmallick 0:e8a1ba50c46b 60 /** timer count frequency (Hz) */
pmallick 0:e8a1ba50c46b 61 uint32_t freq_hz;
pmallick 0:e8a1ba50c46b 62 /** counter start value */
pmallick 0:e8a1ba50c46b 63 uint32_t load_value;
pmallick 0:e8a1ba50c46b 64 /** timer extra parameters (device specific) */
pmallick 0:e8a1ba50c46b 65 void *extra;
pmallick 0:e8a1ba50c46b 66 };
pmallick 0:e8a1ba50c46b 67
pmallick 0:e8a1ba50c46b 68 /**
pmallick 0:e8a1ba50c46b 69 * @struct timer_init_param
pmallick 0:e8a1ba50c46b 70 * @brief Structure holding the parameters for timer initialization
pmallick 0:e8a1ba50c46b 71 */
pmallick 0:e8a1ba50c46b 72 struct timer_init_param {
pmallick 0:e8a1ba50c46b 73 /** timer ID */
pmallick 0:e8a1ba50c46b 74 uint16_t id;
pmallick 0:e8a1ba50c46b 75 /** timer count frequency (Hz) */
pmallick 0:e8a1ba50c46b 76 uint32_t freq_hz;
pmallick 0:e8a1ba50c46b 77 /** counter start value */
pmallick 0:e8a1ba50c46b 78 uint32_t load_value;
pmallick 0:e8a1ba50c46b 79 /** timer extra parameters (device specific) */
pmallick 0:e8a1ba50c46b 80 void *extra;
pmallick 0:e8a1ba50c46b 81 };
pmallick 0:e8a1ba50c46b 82
pmallick 0:e8a1ba50c46b 83 /******************************************************************************/
pmallick 0:e8a1ba50c46b 84 /************************ Functions Declarations ******************************/
pmallick 0:e8a1ba50c46b 85 /******************************************************************************/
pmallick 0:e8a1ba50c46b 86
pmallick 0:e8a1ba50c46b 87 /* Initialize hardware timer and the handler structure associated with it. */
pmallick 0:e8a1ba50c46b 88 int32_t timer_init(struct timer_desc **desc,
pmallick 0:e8a1ba50c46b 89 struct timer_init_param *param);
pmallick 0:e8a1ba50c46b 90
pmallick 0:e8a1ba50c46b 91 /* Free the memory allocated by timer_setup(). */
pmallick 0:e8a1ba50c46b 92 int32_t timer_remove(struct timer_desc *desc);
pmallick 0:e8a1ba50c46b 93
pmallick 0:e8a1ba50c46b 94 /* Start a timer. */
pmallick 0:e8a1ba50c46b 95 int32_t timer_start(struct timer_desc *desc);
pmallick 0:e8a1ba50c46b 96
pmallick 0:e8a1ba50c46b 97 /* Stop a timer from counting. */
pmallick 0:e8a1ba50c46b 98 int32_t timer_stop(struct timer_desc *desc);
pmallick 0:e8a1ba50c46b 99
pmallick 0:e8a1ba50c46b 100 /* Get the value of the counter register for the timer. */
pmallick 0:e8a1ba50c46b 101 int32_t timer_counter_get(struct timer_desc *desc, uint32_t *counter);
pmallick 0:e8a1ba50c46b 102
pmallick 0:e8a1ba50c46b 103 /* Set the timer counter register value. */
pmallick 0:e8a1ba50c46b 104 int32_t timer_counter_set(struct timer_desc *desc, uint32_t new_val);
pmallick 0:e8a1ba50c46b 105
pmallick 0:e8a1ba50c46b 106 /* Get the timer clock frequency. */
pmallick 0:e8a1ba50c46b 107 int32_t timer_count_clk_get(struct timer_desc *desc, uint32_t *freq_hz);
pmallick 0:e8a1ba50c46b 108
pmallick 0:e8a1ba50c46b 109 /* Set the timer clock frequency. */
pmallick 0:e8a1ba50c46b 110 int32_t timer_count_clk_set(struct timer_desc *desc, uint32_t freq_hz);
pmallick 0:e8a1ba50c46b 111
pmallick 0:e8a1ba50c46b 112 #endif /* SRC_TIMER_H_ */
pmallick 0:e8a1ba50c46b 113