mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_sim.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_SIM_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_SIM_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*! @addtogroup sim */
AnnaBridge 189:f392fc9709a3 37 /*! @{*/
AnnaBridge 189:f392fc9709a3 38
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 41 * Definitions
AnnaBridge 189:f392fc9709a3 42 *******************************************************************************/
AnnaBridge 189:f392fc9709a3 43
AnnaBridge 189:f392fc9709a3 44 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 45 /*@{*/
AnnaBridge 189:f392fc9709a3 46 #define FSL_SIM_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Driver version 2.0.0 */
AnnaBridge 189:f392fc9709a3 47 /*@}*/
AnnaBridge 189:f392fc9709a3 48
AnnaBridge 189:f392fc9709a3 49 #if (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR)
AnnaBridge 189:f392fc9709a3 50 /*!@brief USB voltage regulator enable setting. */
AnnaBridge 189:f392fc9709a3 51 enum _sim_usb_volt_reg_enable_mode
AnnaBridge 189:f392fc9709a3 52 {
AnnaBridge 189:f392fc9709a3 53 kSIM_UsbVoltRegEnable = SIM_SOPT1_USBREGEN_MASK, /*!< Enable voltage regulator. */
AnnaBridge 189:f392fc9709a3 54 kSIM_UsbVoltRegEnableInLowPower = SIM_SOPT1_USBVSTBY_MASK, /*!< Enable voltage regulator in VLPR/VLPW modes. */
AnnaBridge 189:f392fc9709a3 55 kSIM_UsbVoltRegEnableInStop = SIM_SOPT1_USBSSTBY_MASK, /*!< Enable voltage regulator in STOP/VLPS/LLS/VLLS modes. */
AnnaBridge 189:f392fc9709a3 56 kSIM_UsbVoltRegEnableInAllModes = SIM_SOPT1_USBREGEN_MASK | SIM_SOPT1_USBSSTBY_MASK |
AnnaBridge 189:f392fc9709a3 57 SIM_SOPT1_USBVSTBY_MASK /*!< Enable voltage regulator in all power modes. */
AnnaBridge 189:f392fc9709a3 58 };
AnnaBridge 189:f392fc9709a3 59 #endif /* (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) */
AnnaBridge 189:f392fc9709a3 60
AnnaBridge 189:f392fc9709a3 61 /*!@brief Unique ID. */
AnnaBridge 189:f392fc9709a3 62 typedef struct _sim_uid
AnnaBridge 189:f392fc9709a3 63 {
AnnaBridge 189:f392fc9709a3 64 #if defined(SIM_UIDH)
AnnaBridge 189:f392fc9709a3 65 uint32_t H; /*!< UIDH. */
AnnaBridge 189:f392fc9709a3 66 #endif
AnnaBridge 189:f392fc9709a3 67 uint32_t MH; /*!< UIDMH. */
AnnaBridge 189:f392fc9709a3 68 uint32_t ML; /*!< UIDML. */
AnnaBridge 189:f392fc9709a3 69 uint32_t L; /*!< UIDL. */
AnnaBridge 189:f392fc9709a3 70 } sim_uid_t;
AnnaBridge 189:f392fc9709a3 71
AnnaBridge 189:f392fc9709a3 72 /*!@brief Flash enable mode. */
AnnaBridge 189:f392fc9709a3 73 enum _sim_flash_mode
AnnaBridge 189:f392fc9709a3 74 {
AnnaBridge 189:f392fc9709a3 75 kSIM_FlashDisableInWait = SIM_FCFG1_FLASHDOZE_MASK, /*!< Disable flash in wait mode. */
AnnaBridge 189:f392fc9709a3 76 kSIM_FlashDisable = SIM_FCFG1_FLASHDIS_MASK /*!< Disable flash in normal mode. */
AnnaBridge 189:f392fc9709a3 77 };
AnnaBridge 189:f392fc9709a3 78
AnnaBridge 189:f392fc9709a3 79 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 80 * API
AnnaBridge 189:f392fc9709a3 81 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 82
AnnaBridge 189:f392fc9709a3 83 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 84 extern "C" {
AnnaBridge 189:f392fc9709a3 85 #endif /* __cplusplus*/
AnnaBridge 189:f392fc9709a3 86
AnnaBridge 189:f392fc9709a3 87 #if (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR)
AnnaBridge 189:f392fc9709a3 88 /*!
AnnaBridge 189:f392fc9709a3 89 * @brief Sets the USB voltage regulator setting.
AnnaBridge 189:f392fc9709a3 90 *
AnnaBridge 189:f392fc9709a3 91 * This function configures whether the USB voltage regulator is enabled in
AnnaBridge 189:f392fc9709a3 92 * normal RUN mode, STOP/VLPS/LLS/VLLS modes, and VLPR/VLPW modes. The configurations
AnnaBridge 189:f392fc9709a3 93 * are passed in as mask value of \ref _sim_usb_volt_reg_enable_mode. For example, to enable
AnnaBridge 189:f392fc9709a3 94 * USB voltage regulator in RUN/VLPR/VLPW modes and disable in STOP/VLPS/LLS/VLLS mode,
AnnaBridge 189:f392fc9709a3 95 * use:
AnnaBridge 189:f392fc9709a3 96 *
AnnaBridge 189:f392fc9709a3 97 * SIM_SetUsbVoltRegulatorEnableMode(kSIM_UsbVoltRegEnable | kSIM_UsbVoltRegEnableInLowPower);
AnnaBridge 189:f392fc9709a3 98 *
AnnaBridge 189:f392fc9709a3 99 * @param mask USB voltage regulator enable setting.
AnnaBridge 189:f392fc9709a3 100 */
AnnaBridge 189:f392fc9709a3 101 void SIM_SetUsbVoltRegulatorEnableMode(uint32_t mask);
AnnaBridge 189:f392fc9709a3 102 #endif /* FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR */
AnnaBridge 189:f392fc9709a3 103
AnnaBridge 189:f392fc9709a3 104 /*!
AnnaBridge 189:f392fc9709a3 105 * @brief Gets the unique identification register value.
AnnaBridge 189:f392fc9709a3 106 *
AnnaBridge 189:f392fc9709a3 107 * @param uid Pointer to the structure to save the UID value.
AnnaBridge 189:f392fc9709a3 108 */
AnnaBridge 189:f392fc9709a3 109 void SIM_GetUniqueId(sim_uid_t *uid);
AnnaBridge 189:f392fc9709a3 110
AnnaBridge 189:f392fc9709a3 111 /*!
AnnaBridge 189:f392fc9709a3 112 * @brief Sets the flash enable mode.
AnnaBridge 189:f392fc9709a3 113 *
AnnaBridge 189:f392fc9709a3 114 * @param mode The mode to set; see \ref _sim_flash_mode for mode details.
AnnaBridge 189:f392fc9709a3 115 */
AnnaBridge 189:f392fc9709a3 116 static inline void SIM_SetFlashMode(uint8_t mode)
AnnaBridge 189:f392fc9709a3 117 {
AnnaBridge 189:f392fc9709a3 118 SIM->FCFG1 = mode;
AnnaBridge 189:f392fc9709a3 119 }
AnnaBridge 189:f392fc9709a3 120
AnnaBridge 189:f392fc9709a3 121 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 122 }
AnnaBridge 189:f392fc9709a3 123 #endif /* __cplusplus*/
AnnaBridge 189:f392fc9709a3 124
AnnaBridge 189:f392fc9709a3 125 /*! @}*/
AnnaBridge 189:f392fc9709a3 126
AnnaBridge 189:f392fc9709a3 127 #endif /* _FSL_SIM_H_ */