mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/tmr_utils.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 186:707f6e361f3e 1 /**
Anna Bridge 186:707f6e361f3e 2 * @file
Anna Bridge 186:707f6e361f3e 3 * @brief Timer utility functions.
Anna Bridge 186:707f6e361f3e 4 */
Anna Bridge 186:707f6e361f3e 5 /* *****************************************************************************
Anna Bridge 186:707f6e361f3e 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 186:707f6e361f3e 7 *
Anna Bridge 186:707f6e361f3e 8 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 186:707f6e361f3e 9 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 186:707f6e361f3e 10 * to deal in the Software without restriction, including without limitation
Anna Bridge 186:707f6e361f3e 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 186:707f6e361f3e 12 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 186:707f6e361f3e 13 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 186:707f6e361f3e 14 *
Anna Bridge 186:707f6e361f3e 15 * The above copyright notice and this permission notice shall be included
Anna Bridge 186:707f6e361f3e 16 * in all copies or substantial portions of the Software.
Anna Bridge 186:707f6e361f3e 17 *
Anna Bridge 186:707f6e361f3e 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 186:707f6e361f3e 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 186:707f6e361f3e 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 186:707f6e361f3e 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 186:707f6e361f3e 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 186:707f6e361f3e 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 186:707f6e361f3e 24 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 186:707f6e361f3e 25 *
Anna Bridge 186:707f6e361f3e 26 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 186:707f6e361f3e 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 186:707f6e361f3e 28 * Products, Inc. Branding Policy.
Anna Bridge 186:707f6e361f3e 29 *
Anna Bridge 186:707f6e361f3e 30 * The mere transfer of this software does not imply any licenses
Anna Bridge 186:707f6e361f3e 31 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 186:707f6e361f3e 32 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 186:707f6e361f3e 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 186:707f6e361f3e 34 * ownership rights.
Anna Bridge 186:707f6e361f3e 35 *
Anna Bridge 186:707f6e361f3e 36 * $Date: 2016-10-10 19:49:16 -0500 (Mon, 10 Oct 2016) $
Anna Bridge 186:707f6e361f3e 37 * $Revision: 24675 $
Anna Bridge 186:707f6e361f3e 38 *
Anna Bridge 186:707f6e361f3e 39 **************************************************************************** */
Anna Bridge 186:707f6e361f3e 40
Anna Bridge 186:707f6e361f3e 41 /* Define to prevent redundant inclusion */
Anna Bridge 186:707f6e361f3e 42 #ifndef _TMR_UTILS_H
Anna Bridge 186:707f6e361f3e 43 #define _TMR_UTILS_H
Anna Bridge 186:707f6e361f3e 44
Anna Bridge 186:707f6e361f3e 45 /***** Includes *****/
Anna Bridge 186:707f6e361f3e 46 #include "mxc_config.h"
Anna Bridge 186:707f6e361f3e 47 #include "tmr_regs.h"
Anna Bridge 186:707f6e361f3e 48 #include "mxc_sys.h"
Anna Bridge 186:707f6e361f3e 49
Anna Bridge 186:707f6e361f3e 50 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 51 extern "C" {
Anna Bridge 186:707f6e361f3e 52 #endif
Anna Bridge 186:707f6e361f3e 53
Anna Bridge 186:707f6e361f3e 54 /**
Anna Bridge 186:707f6e361f3e 55 * @ingroup tmr
Anna Bridge 186:707f6e361f3e 56 * @defgroup tmr_utils Timer Utility Functions
Anna Bridge 186:707f6e361f3e 57 * @{
Anna Bridge 186:707f6e361f3e 58 */
Anna Bridge 186:707f6e361f3e 59 /* **** Definitions **** */
Anna Bridge 186:707f6e361f3e 60 /** Macro to convert the parameter \p s from seconds to micro-seconds. */
Anna Bridge 186:707f6e361f3e 61 #define SEC(s) (((unsigned long)s) * 1000000UL)
Anna Bridge 186:707f6e361f3e 62 /** Macro to convert the parameter \p ms from milli-seconds to micro-seconds. */
Anna Bridge 186:707f6e361f3e 63 #define MSEC(ms) (ms * 1000UL)
Anna Bridge 186:707f6e361f3e 64 /** Macro to convert the parameter \p us to micro-seconds. */
Anna Bridge 186:707f6e361f3e 65 #define USEC(us) (us)
Anna Bridge 186:707f6e361f3e 66
Anna Bridge 186:707f6e361f3e 67 /* **** Globals **** */
Anna Bridge 186:707f6e361f3e 68
Anna Bridge 186:707f6e361f3e 69 /* **** Function Prototypes **** */
Anna Bridge 186:707f6e361f3e 70
Anna Bridge 186:707f6e361f3e 71 /**
Anna Bridge 186:707f6e361f3e 72 * @brief Delays for the specified number of microseconds.
Anna Bridge 186:707f6e361f3e 73 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 74 * @param us Number of microseconds to delay.
Anna Bridge 186:707f6e361f3e 75 */
Anna Bridge 186:707f6e361f3e 76 void TMR_Delay(mxc_tmr_regs_t* tmr, unsigned long us);
Anna Bridge 186:707f6e361f3e 77
Anna Bridge 186:707f6e361f3e 78 /**
Anna Bridge 186:707f6e361f3e 79 * @brief Start the timeout time for the specified number of microseconds.
Anna Bridge 186:707f6e361f3e 80 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 81 * @param us Number of microseconds in the timeout.
Anna Bridge 186:707f6e361f3e 82 */
Anna Bridge 186:707f6e361f3e 83 void TMR_TO_Start(mxc_tmr_regs_t* tmr, unsigned long us);
Anna Bridge 186:707f6e361f3e 84
Anna Bridge 186:707f6e361f3e 85 /**
Anna Bridge 186:707f6e361f3e 86 * @brief Check if the timeout has occured.
Anna Bridge 186:707f6e361f3e 87 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 88 * @return #E_NO_ERROR if the timeout has not occurred, #E_TIME_OUT if it has.
Anna Bridge 186:707f6e361f3e 89 */
Anna Bridge 186:707f6e361f3e 90 int TMR_TO_Check(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 91
Anna Bridge 186:707f6e361f3e 92 /**
Anna Bridge 186:707f6e361f3e 93 * @brief Stops the timer for the timeout.
Anna Bridge 186:707f6e361f3e 94 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 95 */
Anna Bridge 186:707f6e361f3e 96 void TMR_TO_Stop(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 97
Anna Bridge 186:707f6e361f3e 98 /**
Anna Bridge 186:707f6e361f3e 99 * @brief Clears the timeout flag.
Anna Bridge 186:707f6e361f3e 100 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 101 */
Anna Bridge 186:707f6e361f3e 102 void TMR_TO_Clear(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 103
Anna Bridge 186:707f6e361f3e 104 /**
Anna Bridge 186:707f6e361f3e 105 * @brief Get the number of microseconds elapsed since TMR_TO_Start().
Anna Bridge 186:707f6e361f3e 106 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 107 * @return Number of microseconds since TMR_TO_Start().
Anna Bridge 186:707f6e361f3e 108 */
Anna Bridge 186:707f6e361f3e 109 unsigned TMR_TO_Elapsed(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 110
Anna Bridge 186:707f6e361f3e 111 /**
Anna Bridge 186:707f6e361f3e 112 * @brief Get the number of microseconds remaining in the timeout.
Anna Bridge 186:707f6e361f3e 113 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 114 * @return Number of microseconds since TMR_TO_Start().
Anna Bridge 186:707f6e361f3e 115 */
Anna Bridge 186:707f6e361f3e 116 unsigned TMR_TO_Remaining(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 117
Anna Bridge 186:707f6e361f3e 118 /**
Anna Bridge 186:707f6e361f3e 119 * @brief Start the stopwatch.
Anna Bridge 186:707f6e361f3e 120 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 121 */
Anna Bridge 186:707f6e361f3e 122 void TMR_SW_Start(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 123
Anna Bridge 186:707f6e361f3e 124 /**
Anna Bridge 186:707f6e361f3e 125 * @brief Stop the stopwatch and return the number of microseconds that
Anna Bridge 186:707f6e361f3e 126 * have elapsed.
Anna Bridge 186:707f6e361f3e 127 * @param tmr TMR module to operate on
Anna Bridge 186:707f6e361f3e 128 * @return Number of microseconds since TMR_TO_Start().
Anna Bridge 186:707f6e361f3e 129 */
Anna Bridge 186:707f6e361f3e 130 unsigned TMR_SW_Stop(mxc_tmr_regs_t* tmr);
Anna Bridge 186:707f6e361f3e 131 /**@} end of defgroup tmr_utils*/
Anna Bridge 186:707f6e361f3e 132 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 133 }
Anna Bridge 186:707f6e361f3e 134 #endif
Anna Bridge 186:707f6e361f3e 135
Anna Bridge 186:707f6e361f3e 136 #endif /* _TMR_UTILS_H */