Amit Gandhi / sensen_copy_2

t

Fork of mbed-dev by mbed official

targets/TARGET_Maxim/TARGET_MAX32625/mxc/tmr_utils.h@178:c26431f84b0d, 2017-11-09 (annotated)

Committer:
amithy
Date:
Thu Nov 09 22:14:37 2017 +0000
Revision:
178:c26431f84b0d
Parent:
150:02e0a0aed4ec 
test export

Who changed what in which revision?

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