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/mxc_sys.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 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 186:707f6e361f3e 3 *
Anna Bridge 186:707f6e361f3e 4 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 186:707f6e361f3e 5 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 186:707f6e361f3e 6 * to deal in the Software without restriction, including without limitation
Anna Bridge 186:707f6e361f3e 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 186:707f6e361f3e 8 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 186:707f6e361f3e 9 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 186:707f6e361f3e 10 *
Anna Bridge 186:707f6e361f3e 11 * The above copyright notice and this permission notice shall be included
Anna Bridge 186:707f6e361f3e 12 * in all copies or substantial portions of the Software.
Anna Bridge 186:707f6e361f3e 13 *
Anna Bridge 186:707f6e361f3e 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 186:707f6e361f3e 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 186:707f6e361f3e 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 186:707f6e361f3e 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 186:707f6e361f3e 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 186:707f6e361f3e 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 186:707f6e361f3e 20 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 186:707f6e361f3e 21 *
Anna Bridge 186:707f6e361f3e 22 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 186:707f6e361f3e 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 186:707f6e361f3e 24 * Products, Inc. Branding Policy.
Anna Bridge 186:707f6e361f3e 25 *
Anna Bridge 186:707f6e361f3e 26 * The mere transfer of this software does not imply any licenses
Anna Bridge 186:707f6e361f3e 27 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 186:707f6e361f3e 28 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 186:707f6e361f3e 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 186:707f6e361f3e 30 * ownership rights.
Anna Bridge 186:707f6e361f3e 31 *
Anna Bridge 186:707f6e361f3e 32 * $Date: 2016-06-03 14:21:38 -0500 (Fri, 03 Jun 2016) $
Anna Bridge 186:707f6e361f3e 33 * $Revision: 23194 $
Anna Bridge 186:707f6e361f3e 34 *
Anna Bridge 186:707f6e361f3e 35 ******************************************************************************/
Anna Bridge 186:707f6e361f3e 36
Anna Bridge 186:707f6e361f3e 37 /**
Anna Bridge 186:707f6e361f3e 38 * @file mxc_sys.h
Anna Bridge 186:707f6e361f3e 39 * @brief System level header file.
Anna Bridge 186:707f6e361f3e 40 */
Anna Bridge 186:707f6e361f3e 41
Anna Bridge 186:707f6e361f3e 42 #ifndef _MXC_SYS_H_
Anna Bridge 186:707f6e361f3e 43 #define _MXC_SYS_H_
Anna Bridge 186:707f6e361f3e 44
Anna Bridge 186:707f6e361f3e 45 #include "mxc_config.h"
Anna Bridge 186:707f6e361f3e 46 #include "clkman.h"
Anna Bridge 186:707f6e361f3e 47 #include "ioman.h"
Anna Bridge 186:707f6e361f3e 48 #include "gpio.h"
Anna Bridge 186:707f6e361f3e 49 #include "i2cm_regs.h"
Anna Bridge 186:707f6e361f3e 50 #include "i2cs_regs.h"
Anna Bridge 186:707f6e361f3e 51 #include "tmr_regs.h"
Anna Bridge 186:707f6e361f3e 52 #include "pt_regs.h"
Anna Bridge 186:707f6e361f3e 53 #include "wdt_regs.h"
Anna Bridge 186:707f6e361f3e 54 #include "owm_regs.h"
Anna Bridge 186:707f6e361f3e 55
Anna Bridge 186:707f6e361f3e 56 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 57 extern "C" {
Anna Bridge 186:707f6e361f3e 58 #endif
Anna Bridge 186:707f6e361f3e 59
Anna Bridge 186:707f6e361f3e 60 /***** Definitions *****/
Anna Bridge 186:707f6e361f3e 61
Anna Bridge 186:707f6e361f3e 62 /** @brief System Configuration Object */
Anna Bridge 186:707f6e361f3e 63 typedef struct {
Anna Bridge 186:707f6e361f3e 64 clkman_scale_t clk_scale; /** desired clock scale value for the peripheral */
Anna Bridge 186:707f6e361f3e 65 ioman_cfg_t io_cfg; /** IOMAN configuration object */
Anna Bridge 186:707f6e361f3e 66 } sys_cfg_t;
Anna Bridge 186:707f6e361f3e 67
Anna Bridge 186:707f6e361f3e 68 /** @brief Watchdog System Configuration Object */
Anna Bridge 186:707f6e361f3e 69 typedef struct {
Anna Bridge 186:707f6e361f3e 70 clkman_wdt_clk_select_t clk; /** select the clock source for the watchdog */
Anna Bridge 186:707f6e361f3e 71 clkman_scale_t clk_scale; /** desired clock scale value for the peripheral */
Anna Bridge 186:707f6e361f3e 72 /** clk_scale is only applied if the system clock is used as the clk */
Anna Bridge 186:707f6e361f3e 73 } sys_cfg_wdt_t;
Anna Bridge 186:707f6e361f3e 74
Anna Bridge 186:707f6e361f3e 75 /** @brief UART System Configuration Object */
Anna Bridge 186:707f6e361f3e 76 typedef sys_cfg_t sys_cfg_uart_t;
Anna Bridge 186:707f6e361f3e 77
Anna Bridge 186:707f6e361f3e 78 /** @brief I2CM System Configuration Object */
Anna Bridge 186:707f6e361f3e 79 typedef sys_cfg_t sys_cfg_i2cm_t;
Anna Bridge 186:707f6e361f3e 80
Anna Bridge 186:707f6e361f3e 81 /** @brief I2CS System Configuration Object */
Anna Bridge 186:707f6e361f3e 82 typedef sys_cfg_t sys_cfg_i2cs_t;
Anna Bridge 186:707f6e361f3e 83
Anna Bridge 186:707f6e361f3e 84 /** @brief SPIM System Configuration Object */
Anna Bridge 186:707f6e361f3e 85 typedef sys_cfg_t sys_cfg_spim_t;
Anna Bridge 186:707f6e361f3e 86
Anna Bridge 186:707f6e361f3e 87 /** @brief SPIX System Configuration Object */
Anna Bridge 186:707f6e361f3e 88 typedef sys_cfg_t sys_cfg_spix_t;
Anna Bridge 186:707f6e361f3e 89
Anna Bridge 186:707f6e361f3e 90 /** @brief SPIS System Configuration Object */
Anna Bridge 186:707f6e361f3e 91 typedef sys_cfg_t sys_cfg_spis_t;
Anna Bridge 186:707f6e361f3e 92
Anna Bridge 186:707f6e361f3e 93 /** @brief OWM System Configuration Object */
Anna Bridge 186:707f6e361f3e 94 typedef sys_cfg_t sys_cfg_owm_t;
Anna Bridge 186:707f6e361f3e 95
Anna Bridge 186:707f6e361f3e 96 /** @brief Timer System Configuration Object */
Anna Bridge 186:707f6e361f3e 97 typedef gpio_cfg_t sys_cfg_tmr_t;
Anna Bridge 186:707f6e361f3e 98
Anna Bridge 186:707f6e361f3e 99 /** @brief Pulse Train System Configuration Object */
Anna Bridge 186:707f6e361f3e 100 typedef gpio_cfg_t sys_cfg_pt_t;
Anna Bridge 186:707f6e361f3e 101 typedef clkman_scale_t sys_pt_clk_scale;
Anna Bridge 186:707f6e361f3e 102
Anna Bridge 186:707f6e361f3e 103 /***** Include Files *****/
Anna Bridge 186:707f6e361f3e 104 /* These includes require the above types to be defined first */
Anna Bridge 186:707f6e361f3e 105 #include "uart.h"
Anna Bridge 186:707f6e361f3e 106 #include "spim.h"
Anna Bridge 186:707f6e361f3e 107
Anna Bridge 186:707f6e361f3e 108 /***** Function Prototypes *****/
Anna Bridge 186:707f6e361f3e 109
Anna Bridge 186:707f6e361f3e 110 /**
Anna Bridge 186:707f6e361f3e 111 * @brief Get the frequency of a clock scaler
Anna Bridge 186:707f6e361f3e 112 * @param clk_scale value of clk_scale field from clk_ctrl register
Anna Bridge 186:707f6e361f3e 113 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 114 */
Anna Bridge 186:707f6e361f3e 115 uint32_t SYS_GetFreq(uint32_t clk_scale);
Anna Bridge 186:707f6e361f3e 116
Anna Bridge 186:707f6e361f3e 117 /**
Anna Bridge 186:707f6e361f3e 118 * @brief Get the frequency of the CPU
Anna Bridge 186:707f6e361f3e 119 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 120 */
Anna Bridge 186:707f6e361f3e 121 uint32_t SYS_CPU_GetFreq(void);
Anna Bridge 186:707f6e361f3e 122
Anna Bridge 186:707f6e361f3e 123 /**
Anna Bridge 186:707f6e361f3e 124 * @brief System level initialization for ADC module.
Anna Bridge 186:707f6e361f3e 125 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 126 */
Anna Bridge 186:707f6e361f3e 127 int SYS_ADC_Init(void);
Anna Bridge 186:707f6e361f3e 128
Anna Bridge 186:707f6e361f3e 129 /**
Anna Bridge 186:707f6e361f3e 130 * @brief System level initialization for AES module.
Anna Bridge 186:707f6e361f3e 131 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 132 */
Anna Bridge 186:707f6e361f3e 133 int SYS_AES_Init(void);
Anna Bridge 186:707f6e361f3e 134
Anna Bridge 186:707f6e361f3e 135 /**
Anna Bridge 186:707f6e361f3e 136 * @brief System level initialization for GPIO module.
Anna Bridge 186:707f6e361f3e 137 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 138 */
Anna Bridge 186:707f6e361f3e 139 int SYS_GPIO_Init(void);
Anna Bridge 186:707f6e361f3e 140
Anna Bridge 186:707f6e361f3e 141 /**
Anna Bridge 186:707f6e361f3e 142 * @brief System level initialization for UART module.
Anna Bridge 186:707f6e361f3e 143 * @param uart Pointer to UART module registers
Anna Bridge 186:707f6e361f3e 144 * @param uart_cfg UART configuration object
Anna Bridge 186:707f6e361f3e 145 * @param sys_cfg System configuration object
Anna Bridge 186:707f6e361f3e 146 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 147 */
Anna Bridge 186:707f6e361f3e 148 int SYS_UART_Init(mxc_uart_regs_t *uart, const uart_cfg_t *uart_cfg, const sys_cfg_uart_t *sys_cfg);
Anna Bridge 186:707f6e361f3e 149
Anna Bridge 186:707f6e361f3e 150 /**
Anna Bridge 186:707f6e361f3e 151 * @brief System level shutdown for UART module
Anna Bridge 186:707f6e361f3e 152 * @param uart Pointer to UART module registers
Anna Bridge 186:707f6e361f3e 153 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 154 */
Anna Bridge 186:707f6e361f3e 155 int SYS_UART_Shutdown(mxc_uart_regs_t *uart);
Anna Bridge 186:707f6e361f3e 156
Anna Bridge 186:707f6e361f3e 157 /**
Anna Bridge 186:707f6e361f3e 158 * @brief Get the frequency of the UART module source clock
Anna Bridge 186:707f6e361f3e 159 * @param uart Pointer to UART module registers
Anna Bridge 186:707f6e361f3e 160 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 161 */
Anna Bridge 186:707f6e361f3e 162 uint32_t SYS_UART_GetFreq(mxc_uart_regs_t *uart);
Anna Bridge 186:707f6e361f3e 163
Anna Bridge 186:707f6e361f3e 164 /**
Anna Bridge 186:707f6e361f3e 165 * @brief System level initialization for I2CM module.
Anna Bridge 186:707f6e361f3e 166 * @param i2cm Pointer to I2CM module registers
Anna Bridge 186:707f6e361f3e 167 * @param cfg System configuration object
Anna Bridge 186:707f6e361f3e 168 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 169 */
Anna Bridge 186:707f6e361f3e 170 int SYS_I2CM_Init(mxc_i2cm_regs_t *i2cm, const sys_cfg_i2cm_t *cfg);
Anna Bridge 186:707f6e361f3e 171
Anna Bridge 186:707f6e361f3e 172 /**
Anna Bridge 186:707f6e361f3e 173 * @brief System level shutdown for I2CM module
Anna Bridge 186:707f6e361f3e 174 * @param i2cm Pointer to I2CM module registers
Anna Bridge 186:707f6e361f3e 175 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 176 */
Anna Bridge 186:707f6e361f3e 177 int SYS_I2CM_Shutdown(mxc_i2cm_regs_t *i2cm);
Anna Bridge 186:707f6e361f3e 178
Anna Bridge 186:707f6e361f3e 179 /**
Anna Bridge 186:707f6e361f3e 180 * @brief Get the frequency of the I2CM module source clock
Anna Bridge 186:707f6e361f3e 181 * @param i2cm Pointer to I2CM module registers
Anna Bridge 186:707f6e361f3e 182 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 183 */
Anna Bridge 186:707f6e361f3e 184 uint32_t SYS_I2CM_GetFreq(mxc_i2cm_regs_t *i2cm);
Anna Bridge 186:707f6e361f3e 185
Anna Bridge 186:707f6e361f3e 186 /**
Anna Bridge 186:707f6e361f3e 187 * @brief System level initialization for I2CS module.
Anna Bridge 186:707f6e361f3e 188 * @param i2cs Pointer to I2CS module registers
Anna Bridge 186:707f6e361f3e 189 * @param cfg System configuration object
Anna Bridge 186:707f6e361f3e 190 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 191 */
Anna Bridge 186:707f6e361f3e 192 int SYS_I2CS_Init(mxc_i2cs_regs_t *i2cs, const sys_cfg_i2cs_t *cfg);
Anna Bridge 186:707f6e361f3e 193
Anna Bridge 186:707f6e361f3e 194 /**
Anna Bridge 186:707f6e361f3e 195 * @brief System level shutdown for I2CS module
Anna Bridge 186:707f6e361f3e 196 * @param i2cs Pointer to I2CS module registers
Anna Bridge 186:707f6e361f3e 197 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 198 */
Anna Bridge 186:707f6e361f3e 199 int SYS_I2CS_Shutdown(mxc_i2cs_regs_t *i2cs);
Anna Bridge 186:707f6e361f3e 200
Anna Bridge 186:707f6e361f3e 201 /**
Anna Bridge 186:707f6e361f3e 202 * @brief Get the frequency of the I2CS module source clock
Anna Bridge 186:707f6e361f3e 203 * @param i2cs Pointer to I2CS module registers
Anna Bridge 186:707f6e361f3e 204 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 205 */
Anna Bridge 186:707f6e361f3e 206 uint32_t SYS_I2CS_GetFreq(mxc_i2cs_regs_t *i2cs);
Anna Bridge 186:707f6e361f3e 207
Anna Bridge 186:707f6e361f3e 208 /**
Anna Bridge 186:707f6e361f3e 209 * @brief System level initialization for SPIM module.
Anna Bridge 186:707f6e361f3e 210 * @param spim Pointer to SPIM module registers
Anna Bridge 186:707f6e361f3e 211 * @param spim_cfg SPIM configuration object
Anna Bridge 186:707f6e361f3e 212 * @param sys_cfg System configuration object
Anna Bridge 186:707f6e361f3e 213 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 214 */
Anna Bridge 186:707f6e361f3e 215 int SYS_SPIM_Init(mxc_spim_regs_t *spim, const spim_cfg_t *spim_cfg, const sys_cfg_spim_t *sys_cfg);
Anna Bridge 186:707f6e361f3e 216
Anna Bridge 186:707f6e361f3e 217 /**
Anna Bridge 186:707f6e361f3e 218 * @brief System level shutdown for SPIM module
Anna Bridge 186:707f6e361f3e 219 * @param spim Pointer to SPIM module registers
Anna Bridge 186:707f6e361f3e 220 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 221 */
Anna Bridge 186:707f6e361f3e 222 int SYS_SPIM_Shutdown(mxc_spim_regs_t *spim);
Anna Bridge 186:707f6e361f3e 223
Anna Bridge 186:707f6e361f3e 224 /**
Anna Bridge 186:707f6e361f3e 225 * @brief Get the frequency of the SPIM module source clock
Anna Bridge 186:707f6e361f3e 226 * @param spim Pointer to SPIM module registers
Anna Bridge 186:707f6e361f3e 227 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 228 */
Anna Bridge 186:707f6e361f3e 229 uint32_t SYS_SPIM_GetFreq(mxc_spim_regs_t *spim);
Anna Bridge 186:707f6e361f3e 230
Anna Bridge 186:707f6e361f3e 231 /**
Anna Bridge 186:707f6e361f3e 232 * @brief System level initialization for SPIX module.
Anna Bridge 186:707f6e361f3e 233 * @param sys_cfg System configuration object
Anna Bridge 186:707f6e361f3e 234 * @param baud Baud rate for clock divider configuration
Anna Bridge 186:707f6e361f3e 235 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 236 */
Anna Bridge 186:707f6e361f3e 237 int SYS_SPIX_Init(const sys_cfg_spix_t *sys_cfg, uint32_t baud);
Anna Bridge 186:707f6e361f3e 238
Anna Bridge 186:707f6e361f3e 239 /**
Anna Bridge 186:707f6e361f3e 240 * @brief System level shutdown for SPIX module
Anna Bridge 186:707f6e361f3e 241 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 242 */
Anna Bridge 186:707f6e361f3e 243 int SYS_SPIX_Shutdown(void);
Anna Bridge 186:707f6e361f3e 244
Anna Bridge 186:707f6e361f3e 245 /**
Anna Bridge 186:707f6e361f3e 246 * @brief Get the frequency of the SPIX module source clock
Anna Bridge 186:707f6e361f3e 247 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 248 */
Anna Bridge 186:707f6e361f3e 249 uint32_t SYS_SPIX_GetFreq(void);
Anna Bridge 186:707f6e361f3e 250
Anna Bridge 186:707f6e361f3e 251 /**
Anna Bridge 186:707f6e361f3e 252 * @brief System level initialization for SPIS module.
Anna Bridge 186:707f6e361f3e 253 * @param sys_cfg System configuration object.
Anna Bridge 186:707f6e361f3e 254 * @returns E_NO_ERROR if everything is successful.
Anna Bridge 186:707f6e361f3e 255 */
Anna Bridge 186:707f6e361f3e 256 int SYS_SPIS_Init(const sys_cfg_spix_t *sys_cfg);
Anna Bridge 186:707f6e361f3e 257
Anna Bridge 186:707f6e361f3e 258 /**
Anna Bridge 186:707f6e361f3e 259 * @brief System level shutdown for SPIS module
Anna Bridge 186:707f6e361f3e 260 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 261 */
Anna Bridge 186:707f6e361f3e 262 int SYS_SPIS_Shutdown(void);
Anna Bridge 186:707f6e361f3e 263
Anna Bridge 186:707f6e361f3e 264 /**
Anna Bridge 186:707f6e361f3e 265 * @brief Get the frequency of the SPIS module source clock
Anna Bridge 186:707f6e361f3e 266 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 267 */
Anna Bridge 186:707f6e361f3e 268 uint32_t SYS_SPIS_GetFreq(void);
Anna Bridge 186:707f6e361f3e 269
Anna Bridge 186:707f6e361f3e 270 /**
Anna Bridge 186:707f6e361f3e 271 * @brief System level initialization for OWM module.
Anna Bridge 186:707f6e361f3e 272 * @param owm Pointer to OWM module registers
Anna Bridge 186:707f6e361f3e 273 * @param owm_cfg OWM configuration object
Anna Bridge 186:707f6e361f3e 274 * @param sys_cfg System configuration object
Anna Bridge 186:707f6e361f3e 275 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 276 */
Anna Bridge 186:707f6e361f3e 277 int SYS_OWM_Init(mxc_owm_regs_t *owm, const sys_cfg_owm_t *sys_cfg);
Anna Bridge 186:707f6e361f3e 278
Anna Bridge 186:707f6e361f3e 279 /**
Anna Bridge 186:707f6e361f3e 280 * @brief System level shutdown for OWM module
Anna Bridge 186:707f6e361f3e 281 * @param owm Pointer to OWM module registers
Anna Bridge 186:707f6e361f3e 282 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 283 */
Anna Bridge 186:707f6e361f3e 284 int SYS_OWM_Shutdown(mxc_owm_regs_t *owm);
Anna Bridge 186:707f6e361f3e 285
Anna Bridge 186:707f6e361f3e 286 /**
Anna Bridge 186:707f6e361f3e 287 * @brief Get the frequency of the OWM module source clock
Anna Bridge 186:707f6e361f3e 288 * @param owm Pointer to OWM module registers
Anna Bridge 186:707f6e361f3e 289 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 290 */
Anna Bridge 186:707f6e361f3e 291 uint32_t SYS_OWM_GetFreq(mxc_owm_regs_t *owm);
Anna Bridge 186:707f6e361f3e 292
Anna Bridge 186:707f6e361f3e 293 /**
Anna Bridge 186:707f6e361f3e 294 * @brief System level initialization for TMR module.
Anna Bridge 186:707f6e361f3e 295 * @param tmr Pointer to TMR module registers
Anna Bridge 186:707f6e361f3e 296 * @param cfg System configuration object
Anna Bridge 186:707f6e361f3e 297 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 298 */
Anna Bridge 186:707f6e361f3e 299 int SYS_TMR_Init(mxc_tmr_regs_t *tmr, const sys_cfg_tmr_t *cfg);
Anna Bridge 186:707f6e361f3e 300
Anna Bridge 186:707f6e361f3e 301 /**
Anna Bridge 186:707f6e361f3e 302 * @brief Get the frequency of the TMR module source clock
Anna Bridge 186:707f6e361f3e 303 * @param spim Pointer to TMR module registers
Anna Bridge 186:707f6e361f3e 304 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 305 */
Anna Bridge 186:707f6e361f3e 306 uint32_t SYS_TMR_GetFreq(mxc_tmr_regs_t *tmr);
Anna Bridge 186:707f6e361f3e 307
Anna Bridge 186:707f6e361f3e 308 /**
Anna Bridge 186:707f6e361f3e 309 * @brief Get the frequency of the Pulse Train module source clock
Anna Bridge 186:707f6e361f3e 310 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 311 */
Anna Bridge 186:707f6e361f3e 312 uint32_t SYS_PT_GetFreq(void);
Anna Bridge 186:707f6e361f3e 313
Anna Bridge 186:707f6e361f3e 314 /**
Anna Bridge 186:707f6e361f3e 315 * @brief Initialize the global pulse train clock scale
Anna Bridge 186:707f6e361f3e 316 * @param clk_scale scale the system clock for the PT clock
Anna Bridge 186:707f6e361f3e 317 */
Anna Bridge 186:707f6e361f3e 318 void SYS_PT_Init(sys_pt_clk_scale clk_scale);
Anna Bridge 186:707f6e361f3e 319
Anna Bridge 186:707f6e361f3e 320 /**
Anna Bridge 186:707f6e361f3e 321 * @brief System level initialization for Pulse Train module.
Anna Bridge 186:707f6e361f3e 322 * @param pt Pointer to PT module registers
Anna Bridge 186:707f6e361f3e 323 * @param cfg System configuration object
Anna Bridge 186:707f6e361f3e 324 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 325 */
Anna Bridge 186:707f6e361f3e 326 int SYS_PT_Config(mxc_pt_regs_t *pt, const sys_cfg_pt_t *cfg);
Anna Bridge 186:707f6e361f3e 327
Anna Bridge 186:707f6e361f3e 328 /**
Anna Bridge 186:707f6e361f3e 329 * @brief System level initialization for USB device.
Anna Bridge 186:707f6e361f3e 330 * @param enable 1 to enable the peripheral, 0 to disable.
Anna Bridge 186:707f6e361f3e 331 */
Anna Bridge 186:707f6e361f3e 332 void SYS_USB_Enable(uint8_t enable);
Anna Bridge 186:707f6e361f3e 333
Anna Bridge 186:707f6e361f3e 334 /**
Anna Bridge 186:707f6e361f3e 335 * @brief System Tick Configuration Helper
Anna Bridge 186:707f6e361f3e 336 *
Anna Bridge 186:707f6e361f3e 337 * The function enables selection of the external clock source for the
Anna Bridge 186:707f6e361f3e 338 * System Tick Timer. It initializes the System Timer and its interrupt,
Anna Bridge 186:707f6e361f3e 339 * and starts the System Tick Timer. Counter is in free running mode to generate
Anna Bridge 186:707f6e361f3e 340 * periodic interrupts.
Anna Bridge 186:707f6e361f3e 341
Anna Bridge 186:707f6e361f3e 342 * @param ticks Number of ticks between two interrupts.
Anna Bridge 186:707f6e361f3e 343 * @param clk_src Selects between default SystemClock or External Clock.
Anna Bridge 186:707f6e361f3e 344 * - 0 Use external clock source
Anna Bridge 186:707f6e361f3e 345 * - 1 SystemClock
Anna Bridge 186:707f6e361f3e 346 * @return E_NO_ERROR Function succeeded.
Anna Bridge 186:707f6e361f3e 347 * @return E_INVALID Invalid reload value requested.
Anna Bridge 186:707f6e361f3e 348 *
Anna Bridge 186:707f6e361f3e 349 * @see CLKMAN_SetRTOSMode(uint8_t enable) if using the external clock source to drive the System Tick Timer
Anna Bridge 186:707f6e361f3e 350 *
Anna Bridge 186:707f6e361f3e 351 */
Anna Bridge 186:707f6e361f3e 352 int SYS_SysTick_Config(uint32_t ticks, int clk_src);
Anna Bridge 186:707f6e361f3e 353
Anna Bridge 186:707f6e361f3e 354 /**
Anna Bridge 186:707f6e361f3e 355 * @brief Disable System Tick timer
Anna Bridge 186:707f6e361f3e 356 *
Anna Bridge 186:707f6e361f3e 357 *
Anna Bridge 186:707f6e361f3e 358 */
Anna Bridge 186:707f6e361f3e 359 __STATIC_INLINE void SYS_SysTick_Disable(void)
Anna Bridge 186:707f6e361f3e 360 {
Anna Bridge 186:707f6e361f3e 361 SysTick->CTRL = 0;
Anna Bridge 186:707f6e361f3e 362 }
Anna Bridge 186:707f6e361f3e 363
Anna Bridge 186:707f6e361f3e 364 /**
Anna Bridge 186:707f6e361f3e 365 * @brief Delay a requested number of SysTick Timer Ticks.
Anna Bridge 186:707f6e361f3e 366 * @param ticks Number of System Ticks to delay.
Anna Bridge 186:707f6e361f3e 367 * @note This delay function is based on the clock used for the SysTick timer
Anna Bridge 186:707f6e361f3e 368 * if the SysTick timer is enabled. If the SysTick timer is
Anna Bridge 186:707f6e361f3e 369 * not enabled, the current SysTick registers are saved and the
Anna Bridge 186:707f6e361f3e 370 * timer will use the SystemClock as the source for the delay.
Anna Bridge 186:707f6e361f3e 371 * The delay is measured in clock ticks and is not based on the
Anna Bridge 186:707f6e361f3e 372 * SysTick interval.
Anna Bridge 186:707f6e361f3e 373 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 374 */
Anna Bridge 186:707f6e361f3e 375 int SYS_SysTick_Delay(uint32_t ticks);
Anna Bridge 186:707f6e361f3e 376
Anna Bridge 186:707f6e361f3e 377 /**
Anna Bridge 186:707f6e361f3e 378 * @brief Get the frequency of the SysTick Timer
Anna Bridge 186:707f6e361f3e 379 * @returns frequency in Hz
Anna Bridge 186:707f6e361f3e 380 */
Anna Bridge 186:707f6e361f3e 381 uint32_t SYS_SysTick_GetFreq(void);
Anna Bridge 186:707f6e361f3e 382
Anna Bridge 186:707f6e361f3e 383 /**
Anna Bridge 186:707f6e361f3e 384 * @brief Delay a requested number of microseconds.
Anna Bridge 186:707f6e361f3e 385 * @param us Number of microseconds to delay.
Anna Bridge 186:707f6e361f3e 386 * @note Calls SYS_SysTick_Delay.
Anna Bridge 186:707f6e361f3e 387 */
Anna Bridge 186:707f6e361f3e 388 __STATIC_INLINE void SYS_SysTick_DelayUs(uint32_t us)
Anna Bridge 186:707f6e361f3e 389 {
Anna Bridge 186:707f6e361f3e 390 SYS_SysTick_Delay((uint32_t)(((uint64_t)SYS_SysTick_GetFreq() * us) / 1000000));
Anna Bridge 186:707f6e361f3e 391 }
Anna Bridge 186:707f6e361f3e 392
Anna Bridge 186:707f6e361f3e 393 /**
Anna Bridge 186:707f6e361f3e 394 * @brief System level initialization for RTC module.
Anna Bridge 186:707f6e361f3e 395 * @returns E_NO_ERROR if everything is successful
Anna Bridge 186:707f6e361f3e 396 */
Anna Bridge 186:707f6e361f3e 397 int SYS_RTC_Init(void);
Anna Bridge 186:707f6e361f3e 398
Anna Bridge 186:707f6e361f3e 399 /**
Anna Bridge 186:707f6e361f3e 400 * @brief Select VDDIO for the specified GPIO pin.
Anna Bridge 186:707f6e361f3e 401 */
Anna Bridge 186:707f6e361f3e 402 void SYS_IOMAN_UseVDDIO(const gpio_cfg_t *cfg);
Anna Bridge 186:707f6e361f3e 403
Anna Bridge 186:707f6e361f3e 404 /**
Anna Bridge 186:707f6e361f3e 405 * @brief Select VDDIOH for the specified GPIO pin.
Anna Bridge 186:707f6e361f3e 406 */
Anna Bridge 186:707f6e361f3e 407 void SYS_IOMAN_UseVDDIOH(const gpio_cfg_t *cfg);
Anna Bridge 186:707f6e361f3e 408
Anna Bridge 186:707f6e361f3e 409 /**
Anna Bridge 186:707f6e361f3e 410 * @brief System level initialization for Watchdog module.
Anna Bridge 186:707f6e361f3e 411 * @param wdt Pointer to Watchdog module registers
Anna Bridge 186:707f6e361f3e 412 * @param cfg Watchdog System configuration object
Anna Bridge 186:707f6e361f3e 413 */
Anna Bridge 186:707f6e361f3e 414 void SYS_WDT_Init(mxc_wdt_regs_t *wdt, const sys_cfg_wdt_t *cfg);
Anna Bridge 186:707f6e361f3e 415
Anna Bridge 186:707f6e361f3e 416 /**
Anna Bridge 186:707f6e361f3e 417 * @brief System level initialization for PRNG module.
Anna Bridge 186:707f6e361f3e 418 * Enable crypto clock and set divisors to 1 if disabled
Anna Bridge 186:707f6e361f3e 419 */
Anna Bridge 186:707f6e361f3e 420 void SYS_PRNG_Init(void);
Anna Bridge 186:707f6e361f3e 421
Anna Bridge 186:707f6e361f3e 422 /**
Anna Bridge 186:707f6e361f3e 423 * @brief System level initialization for MAA module.
Anna Bridge 186:707f6e361f3e 424 * Enable crypto clock and set divisors to 1 if disabled
Anna Bridge 186:707f6e361f3e 425 */
Anna Bridge 186:707f6e361f3e 426 void SYS_MAA_Init(void);
Anna Bridge 186:707f6e361f3e 427
Anna Bridge 186:707f6e361f3e 428 /*
Anna Bridge 186:707f6e361f3e 429 * @brief Gets the size of the SRAM
Anna Bridge 186:707f6e361f3e 430 * @returns size of SRAM in bytes
Anna Bridge 186:707f6e361f3e 431 */
Anna Bridge 186:707f6e361f3e 432 uint32_t SYS_SRAM_GetSize(void);
Anna Bridge 186:707f6e361f3e 433
Anna Bridge 186:707f6e361f3e 434 /*
Anna Bridge 186:707f6e361f3e 435 * @brief Gets the size of the Flash
Anna Bridge 186:707f6e361f3e 436 * @returns size of Flash in bytes
Anna Bridge 186:707f6e361f3e 437 */
Anna Bridge 186:707f6e361f3e 438 uint32_t SYS_FLASH_GetSize(void);
Anna Bridge 186:707f6e361f3e 439
Anna Bridge 186:707f6e361f3e 440 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 441 }
Anna Bridge 186:707f6e361f3e 442 #endif
Anna Bridge 186:707f6e361f3e 443
Anna Bridge 186:707f6e361f3e 444 #endif /* _MXC_SYS_H_*/