Genadi Zawidowski / mbed-dev

mbed library sources. Supersedes mbed-src. Edited target satm32f446 for user USART3 pins

Dependents:   IGLOO_board

Fork of mbed-dev by mbed official

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/pt.c@186:707f6e361f3e, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 16:45:37 2018 +0100
Revision:
186:707f6e361f3e
mbed-dev library. Release version 162

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 Pulse Train Engine Function Implementations.
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-09-08 17:43:36 -0500 (Thu, 08 Sep 2016) $
Anna Bridge 186:707f6e361f3e 37 * $Revision: 24327 $
Anna Bridge 186:707f6e361f3e 38 *
Anna Bridge 186:707f6e361f3e 39 **************************************************************************** */
Anna Bridge 186:707f6e361f3e 40
Anna Bridge 186:707f6e361f3e 41 /* **** Includes **** */
Anna Bridge 186:707f6e361f3e 42 #include <stddef.h>
Anna Bridge 186:707f6e361f3e 43 #include "pt.h"
Anna Bridge 186:707f6e361f3e 44
Anna Bridge 186:707f6e361f3e 45 /**
Anna Bridge 186:707f6e361f3e 46 * @ingroup pulsetrain
Anna Bridge 186:707f6e361f3e 47 * @{
Anna Bridge 186:707f6e361f3e 48 */
Anna Bridge 186:707f6e361f3e 49
Anna Bridge 186:707f6e361f3e 50 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 51 void PT_Init(sys_pt_clk_scale clk_scale)
Anna Bridge 186:707f6e361f3e 52 {
Anna Bridge 186:707f6e361f3e 53 //disable all pulse trains
Anna Bridge 186:707f6e361f3e 54 MXC_PTG->enable = 0;
Anna Bridge 186:707f6e361f3e 55
Anna Bridge 186:707f6e361f3e 56 //clear all interrupts
Anna Bridge 186:707f6e361f3e 57 MXC_PTG->intfl = MXC_PTG->intfl;
Anna Bridge 186:707f6e361f3e 58
Anna Bridge 186:707f6e361f3e 59 SYS_PT_Init(clk_scale);
Anna Bridge 186:707f6e361f3e 60 }
Anna Bridge 186:707f6e361f3e 61
Anna Bridge 186:707f6e361f3e 62 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 63 int PT_PTConfig(mxc_pt_regs_t *pt, pt_pt_cfg_t *cfg, const sys_cfg_pt_t *sysCfg)
Anna Bridge 186:707f6e361f3e 64 {
Anna Bridge 186:707f6e361f3e 65 int err;
Anna Bridge 186:707f6e361f3e 66 uint32_t ptClock;
Anna Bridge 186:707f6e361f3e 67 uint32_t rate;
Anna Bridge 186:707f6e361f3e 68
Anna Bridge 186:707f6e361f3e 69 //check for valid base pointer
Anna Bridge 186:707f6e361f3e 70 MXC_ASSERT(MXC_PT_GET_IDX(pt) >= 0);
Anna Bridge 186:707f6e361f3e 71
Anna Bridge 186:707f6e361f3e 72 if(cfg == NULL)
Anna Bridge 186:707f6e361f3e 73 return E_NULL_PTR;
Anna Bridge 186:707f6e361f3e 74
Anna Bridge 186:707f6e361f3e 75 if(cfg->bps == 0)
Anna Bridge 186:707f6e361f3e 76 return E_BAD_PARAM;
Anna Bridge 186:707f6e361f3e 77
Anna Bridge 186:707f6e361f3e 78 //disable pulse train
Anna Bridge 186:707f6e361f3e 79 PT_Stop(pt);
Anna Bridge 186:707f6e361f3e 80
Anna Bridge 186:707f6e361f3e 81 //setup system GPIO configuration
Anna Bridge 186:707f6e361f3e 82 if((err = SYS_PT_Config(pt, sysCfg)) != E_NO_ERROR)
Anna Bridge 186:707f6e361f3e 83 return err;
Anna Bridge 186:707f6e361f3e 84
Anna Bridge 186:707f6e361f3e 85 //get PT clock frequency from SYS level
Anna Bridge 186:707f6e361f3e 86 ptClock = SYS_PT_GetFreq();
Anna Bridge 186:707f6e361f3e 87
Anna Bridge 186:707f6e361f3e 88 if(ptClock == 0)
Anna Bridge 186:707f6e361f3e 89 return E_UNINITIALIZED;
Anna Bridge 186:707f6e361f3e 90
Anna Bridge 186:707f6e361f3e 91 if(ptClock < (cfg->bps))
Anna Bridge 186:707f6e361f3e 92 return E_BAD_STATE;
Anna Bridge 186:707f6e361f3e 93
Anna Bridge 186:707f6e361f3e 94 rate = (ptClock / (cfg->bps));
Anna Bridge 186:707f6e361f3e 95
Anna Bridge 186:707f6e361f3e 96 pt->rate_length = ((rate << MXC_F_PT_RATE_LENGTH_RATE_CONTROL_POS)
Anna Bridge 186:707f6e361f3e 97 & MXC_F_PT_RATE_LENGTH_RATE_CONTROL) |
Anna Bridge 186:707f6e361f3e 98 ((cfg->ptLength << MXC_F_PT_RATE_LENGTH_MODE_POS)
Anna Bridge 186:707f6e361f3e 99 & MXC_F_PT_RATE_LENGTH_MODE);
Anna Bridge 186:707f6e361f3e 100
Anna Bridge 186:707f6e361f3e 101 pt->train = cfg->pattern;
Anna Bridge 186:707f6e361f3e 102 pt->loop = ((cfg->loop << MXC_F_PT_LOOP_COUNT_POS) & MXC_F_PT_LOOP_COUNT) |
Anna Bridge 186:707f6e361f3e 103 ((cfg->loopDelay << MXC_F_PT_LOOP_DELAY_POS) & MXC_F_PT_LOOP_DELAY);
Anna Bridge 186:707f6e361f3e 104
Anna Bridge 186:707f6e361f3e 105 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 106 }
Anna Bridge 186:707f6e361f3e 107
Anna Bridge 186:707f6e361f3e 108 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 109 int PT_SqrWaveConfig(mxc_pt_regs_t *pt, uint32_t freq, const sys_cfg_pt_t *sysCfg)
Anna Bridge 186:707f6e361f3e 110 {
Anna Bridge 186:707f6e361f3e 111 int err;
Anna Bridge 186:707f6e361f3e 112 uint32_t ptClock;
Anna Bridge 186:707f6e361f3e 113 uint32_t rate;
Anna Bridge 186:707f6e361f3e 114
Anna Bridge 186:707f6e361f3e 115 //check for valid base pointer
Anna Bridge 186:707f6e361f3e 116 MXC_ASSERT(MXC_PT_GET_IDX(pt) >= 0);
Anna Bridge 186:707f6e361f3e 117
Anna Bridge 186:707f6e361f3e 118 if(freq == 0)
Anna Bridge 186:707f6e361f3e 119 return E_BAD_PARAM;
Anna Bridge 186:707f6e361f3e 120
Anna Bridge 186:707f6e361f3e 121 //disable pulse train
Anna Bridge 186:707f6e361f3e 122 PT_Stop(pt);
Anna Bridge 186:707f6e361f3e 123
Anna Bridge 186:707f6e361f3e 124 //setup system GPIO configuration
Anna Bridge 186:707f6e361f3e 125 if((err = SYS_PT_Config(pt, sysCfg)) != E_NO_ERROR)
Anna Bridge 186:707f6e361f3e 126 return err;
Anna Bridge 186:707f6e361f3e 127
Anna Bridge 186:707f6e361f3e 128 //get PT clock frequency from SYS level
Anna Bridge 186:707f6e361f3e 129 ptClock = SYS_PT_GetFreq();
Anna Bridge 186:707f6e361f3e 130
Anna Bridge 186:707f6e361f3e 131 if(ptClock == 0)
Anna Bridge 186:707f6e361f3e 132 return E_UNINITIALIZED;
Anna Bridge 186:707f6e361f3e 133
Anna Bridge 186:707f6e361f3e 134 if(ptClock < (2*freq))
Anna Bridge 186:707f6e361f3e 135 return E_BAD_STATE;
Anna Bridge 186:707f6e361f3e 136
Anna Bridge 186:707f6e361f3e 137 rate = (ptClock / (2*freq)) + 1;
Anna Bridge 186:707f6e361f3e 138
Anna Bridge 186:707f6e361f3e 139 pt->rate_length = ((rate << MXC_F_PT_RATE_LENGTH_RATE_CONTROL_POS)
Anna Bridge 186:707f6e361f3e 140 & MXC_F_PT_RATE_LENGTH_RATE_CONTROL) |
Anna Bridge 186:707f6e361f3e 141 (MXC_V_PT_RATE_LENGTH_MODE_SQUARE_WAVE << MXC_F_PT_RATE_LENGTH_MODE_POS);
Anna Bridge 186:707f6e361f3e 142
Anna Bridge 186:707f6e361f3e 143 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 144 }
Anna Bridge 186:707f6e361f3e 145 /**@} end of ingroup pulsetrain*/