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