mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MAX32625NEXPAQ/TOOLCHAIN_GCC_ARM/tmr_utils.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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