1 /*
2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
3 * Copyright 2016-2017 NXP
4 * All rights reserved.
5 *
6 * SPDX-License-Identifier: BSD-3-Clause
7 */
8
9 #ifndef _FSL_SIM_H_
10 #define _FSL_SIM_H_
11
12 #include "fsl_common.h"
13
14 /*! @addtogroup sim */
15 /*! @{*/
16
17 /*******************************************************************************
18 * Definitions
19 *******************************************************************************/
20
21 /*! @name Driver version */
22 /*@{*/
23 #define FSL_SIM_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Driver version 2.0.0 */
24 /*@}*/
25
26 #if (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR)
27 /*!@brief USB voltage regulator enable setting. */
28 enum _sim_usb_volt_reg_enable_mode
29 {
30 kSIM_UsbVoltRegEnable = SIM_SOPT1_USBREGEN_MASK, /*!< Enable voltage regulator. */
31 kSIM_UsbVoltRegEnableInLowPower = SIM_SOPT1_USBVSTBY_MASK, /*!< Enable voltage regulator in VLPR/VLPW modes. */
32 kSIM_UsbVoltRegEnableInStop = SIM_SOPT1_USBSSTBY_MASK, /*!< Enable voltage regulator in STOP/VLPS/LLS/VLLS modes. */
33 kSIM_UsbVoltRegEnableInAllModes = SIM_SOPT1_USBREGEN_MASK | SIM_SOPT1_USBSSTBY_MASK |
34 SIM_SOPT1_USBVSTBY_MASK /*!< Enable voltage regulator in all power modes. */
35 };
36 #endif /* (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) */
37
38 /*!@brief Unique ID. */
39 typedef struct _sim_uid
40 {
41 #if defined(SIM_UIDH)
42 uint32_t H; /*!< UIDH. */
43 #endif
44
45 #if (defined(FSL_FEATURE_SIM_HAS_UIDM) && FSL_FEATURE_SIM_HAS_UIDM)
46 uint32_t M; /*!< SIM_UIDM. */
47 #else
48 uint32_t MH; /*!< UIDMH. */
49 uint32_t ML; /*!< UIDML. */
50 #endif /* FSL_FEATURE_SIM_HAS_UIDM */
51 uint32_t L; /*!< UIDL. */
52 } sim_uid_t;
53
54 #if (defined(FSL_FEATURE_SIM_HAS_RF_MAC_ADDR) && FSL_FEATURE_SIM_HAS_RF_MAC_ADDR)
55 /*! @brief RF Mac Address.*/
56 typedef struct _sim_rf_addr
57 {
58 uint32_t rfAddrL; /*!< RFADDRL. */
59 uint32_t rfAddrH; /*!< RFADDRH. */
60 } sim_rf_addr_t;
61 #endif /* FSL_FEATURE_SIM_HAS_RF_MAC_ADDR */
62
63 /*!@brief Flash enable mode. */
64 enum _sim_flash_mode
65 {
66 kSIM_FlashDisableInWait = SIM_FCFG1_FLASHDOZE_MASK, /*!< Disable flash in wait mode. */
67 kSIM_FlashDisable = SIM_FCFG1_FLASHDIS_MASK /*!< Disable flash in normal mode. */
68 };
69
70 /*******************************************************************************
71 * API
72 ******************************************************************************/
73
74 #if defined(__cplusplus)
75 extern "C" {
76 #endif /* __cplusplus*/
77
78 #if (defined(FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR) && FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR)
79 /*!
80 * @brief Sets the USB voltage regulator setting.
81 *
82 * This function configures whether the USB voltage regulator is enabled in
83 * normal RUN mode, STOP/VLPS/LLS/VLLS modes, and VLPR/VLPW modes. The configurations
84 * are passed in as mask value of \ref _sim_usb_volt_reg_enable_mode. For example, to enable
85 * USB voltage regulator in RUN/VLPR/VLPW modes and disable in STOP/VLPS/LLS/VLLS mode,
86 * use:
87 *
88 * SIM_SetUsbVoltRegulatorEnableMode(kSIM_UsbVoltRegEnable | kSIM_UsbVoltRegEnableInLowPower);
89 *
90 * @param mask USB voltage regulator enable setting.
91 */
92 void SIM_SetUsbVoltRegulatorEnableMode(uint32_t mask);
93 #endif /* FSL_FEATURE_SIM_OPT_HAS_USB_VOLTAGE_REGULATOR */
94
95 /*!
96 * @brief Gets the unique identification register value.
97 *
98 * @param uid Pointer to the structure to save the UID value.
99 */
100 void SIM_GetUniqueId(sim_uid_t *uid);
101
102 /*!
103 * @brief Sets the flash enable mode.
104 *
105 * @param mode The mode to set; see \ref _sim_flash_mode for mode details.
106 */
SIM_SetFlashMode(uint8_t mode)107 static inline void SIM_SetFlashMode(uint8_t mode)
108 {
109 SIM->FCFG1 = mode;
110 }
111
112 #if (defined(FSL_FEATURE_SIM_HAS_RF_MAC_ADDR) && FSL_FEATURE_SIM_HAS_RF_MAC_ADDR)
113 /*!
114 * @brief Gets the RF address register value.
115 *
116 * @param info Pointer to the structure to save the RF address value.
117 */
118 void SIM_GetRfAddr(sim_rf_addr_t *info);
119 #endif /* FSL_FEATURE_SIM_HAS_RF_MAC_ADDR */
120
121 #if (defined(FSL_FEATURE_SIM_MISC2_HAS_SYSTICK_CLK_EN) && FSL_FEATURE_SIM_MISC2_HAS_SYSTICK_CLK_EN)
122
123 /*!
124 * @brief Enable the Systick clock or not.
125 *
126 * The Systick clock is enabled by default.
127 *
128 * @param enable The switcher for Systick clock.
129 */
SIM_EnableSystickClock(bool enable)130 static inline void SIM_EnableSystickClock(bool enable)
131 {
132 if (enable)
133 {
134 SIM->MISC2 &= ~SIM_MISC2_SYSTICK_CLK_EN_MASK; /* Clear to enable. */
135 }
136 else
137 {
138 SIM->MISC2 |= SIM_MISC2_SYSTICK_CLK_EN_MASK; /* Set to disable. */
139 }
140 }
141
142 #endif /* FSL_FEATURE_SIM_MISC2_HAS_SYSTICK_CLK_EN */
143
144 #if defined(__cplusplus)
145 }
146 #endif /* __cplusplus*/
147
148 /*! @}*/
149
150 #endif /* _FSL_SIM_H_ */
151
