123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733 |
- /*
- * Copyright (c) 2016, Freescale Semiconductor, Inc.
- * Copyright 2017-2021, NXP
- * All rights reserved.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
- #ifndef _FSL_SNVS_LP_H_
- #define _FSL_SNVS_LP_H_
- #include "fsl_common.h"
- /*!
- * @addtogroup snvs_lp
- * @{
- */
- /*******************************************************************************
- * Definitions
- ******************************************************************************/
- /*! @name Driver version */
- /*@{*/
- #define FSL_SNVS_LP_DRIVER_VERSION (MAKE_VERSION(2, 4, 3)) /*!< Version 2.4.3 */
- /*@}*/
- /*! @brief Define of SNVS_LP Zeroizable Master Key registers */
- #define SNVS_ZMK_REG_COUNT 8U /* 8 Zeroizable Master Key registers. */
- /*! @brief List of SNVS_LP interrupts */
- typedef enum _snvs_lp_srtc_interrupts
- {
- kSNVS_SRTC_AlarmInterrupt = SNVS_LPCR_LPTA_EN_MASK, /*!< SRTC time alarm.*/
- } snvs_lp_srtc_interrupts_t;
- /*! @brief List of SNVS_LP flags */
- typedef enum _snvs_lp_srtc_status_flags
- {
- kSNVS_SRTC_AlarmInterruptFlag = SNVS_LPSR_LPTA_MASK, /*!< SRTC time alarm flag */
- } snvs_lp_srtc_status_flags_t;
- #if defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0)
- /*! @brief List of SNVS_LP external tampers */
- typedef enum _snvs_lp_external_tamper
- {
- kSNVS_ExternalTamper1 = 1U,
- #if defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 1)
- kSNVS_ExternalTamper2 = 2U,
- kSNVS_ExternalTamper3 = 3U,
- kSNVS_ExternalTamper4 = 4U,
- kSNVS_ExternalTamper5 = 5U,
- kSNVS_ExternalTamper6 = 6U,
- kSNVS_ExternalTamper7 = 7U,
- kSNVS_ExternalTamper8 = 8U,
- kSNVS_ExternalTamper9 = 9U,
- kSNVS_ExternalTamper10 = 10U
- #endif /* defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 1) */
- } snvs_lp_external_tamper_t;
- #endif /* defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0) */
- #if defined(FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS) && (FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS > 0)
- /*! @brief List of SNVS_LP active tampers */
- typedef enum _snvs_lp_active_tamper
- {
- kSNVS_ActiveTamper1 = 1U,
- kSNVS_ActiveTamper2 = 2U,
- kSNVS_ActiveTamper3 = 3U,
- kSNVS_ActiveTamper4 = 4U,
- kSNVS_ActiveTamper5 = 5U,
- } snvs_lp_active_tx_tamper_t;
- /*! @brief List of SNVS_LP external tampers */
- typedef enum _snvs_lp_active_clock
- {
- kSNVS_ActiveTamper16HZ = 0U,
- kSNVS_ActiveTamper8HZ = 1U,
- kSNVS_ActiveTamper4HZ = 2U,
- kSNVS_ActiveTamper2HZ = 3U
- } snvs_lp_active_clock_t;
- /*! @brief Structure is used to configure SNVS LP active TX tamper pins */
- typedef struct
- {
- uint16_t polynomial;
- uint16_t seed;
- snvs_lp_active_clock_t clock;
- } tamper_active_tx_config_t;
- /*! @brief Structure is used to configure SNVS LP active RX tamper pins */
- typedef struct
- {
- uint16_t filterenable;
- uint8_t filter;
- snvs_lp_active_tx_tamper_t activeTamper;
- } tamper_active_rx_config_t;
- #endif /* FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS */
- /*! @brief Structure is used to configure SNVS LP passive tamper pins */
- typedef struct
- {
- uint8_t polarity;
- #if defined(FSL_FEATURE_SNVS_PASSIVE_TAMPER_FILTER) && (FSL_FEATURE_SNVS_PASSIVE_TAMPER_FILTER > 0)
- uint8_t filterenable;
- uint8_t filter;
- #endif /* FSL_FEATURE_SNVS_PASSIVE_TAMPER_FILTER */
- } snvs_lp_passive_tamper_t;
- /* define max possible tamper present */
- /*! @brief Define of SNVS_LP Max possible tamper */
- #if defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 1)
- #define SNVS_LP_MAX_TAMPER kSNVS_ExternalTamper10
- #else
- #define SNVS_LP_MAX_TAMPER kSNVS_ExternalTamper1
- #endif
- /*! @brief List of SNVS_LP external tampers status */
- typedef enum _snvs_lp_external_tamper_status
- {
- kSNVS_TamperNotDetected = 0U,
- kSNVS_TamperDetected = 1U
- } snvs_lp_external_tamper_status_t;
- /*! @brief SNVS_LP external tamper polarity */
- typedef enum _snvs_lp_external_tamper_polarity
- {
- kSNVS_ExternalTamperActiveLow = 0U,
- kSNVS_ExternalTamperActiveHigh = 1U
- } snvs_lp_external_tamper_polarity_t;
- /*! @brief Structure is used to hold the date and time */
- typedef struct _snvs_lp_srtc_datetime
- {
- uint16_t year; /*!< Range from 1970 to 2099.*/
- uint8_t month; /*!< Range from 1 to 12.*/
- uint8_t day; /*!< Range from 1 to 31 (depending on month).*/
- uint8_t hour; /*!< Range from 0 to 23.*/
- uint8_t minute; /*!< Range from 0 to 59.*/
- uint8_t second; /*!< Range from 0 to 59.*/
- } snvs_lp_srtc_datetime_t;
- /*!
- * @brief SNVS_LP config structure
- *
- * This structure holds the configuration settings for the SNVS_LP peripheral. To initialize this
- * structure to reasonable defaults, call the SNVS_LP_GetDefaultConfig() function and pass a
- * pointer to your config structure instance.
- *
- * The config struct can be made const so it resides in flash
- */
- typedef struct _snvs_lp_srtc_config
- {
- bool srtcCalEnable; /*!< true: SRTC calibration mechanism is enabled;
- false: No calibration is used */
- uint32_t srtcCalValue; /*!< Defines signed calibration value for SRTC;
- This is a 5-bit 2's complement value, range from -16 to +15 */
- } snvs_lp_srtc_config_t;
- /*!
- * @brief SNVS_LP Zeroizable Master Key programming mode.
- */
- typedef enum _snvs_lp_zmk_program_mode
- {
- kSNVS_ZMKSoftwareProgram, /*!< Software programming mode. */
- kSNVS_ZMKHardwareProgram, /*!< Hardware programming mode. */
- } snvs_lp_zmk_program_mode_t;
- /*!
- * @brief SNVS_LP Master Key mode.
- */
- typedef enum _snvs_lp_master_key_mode
- {
- kSNVS_OTPMK = 0, /*!< One Time Programmable Master Key. */
- kSNVS_ZMK = 2, /*!< Zeroizable Master Key. */
- kSNVS_CMK = 3, /*!< Combined Master Key, it is XOR of OPTMK and ZMK. */
- } snvs_lp_master_key_mode_t;
- /*******************************************************************************
- * API
- ******************************************************************************/
- #if defined(__cplusplus)
- extern "C" {
- #endif
- /*!
- * @name Initialization and deinitialization
- * @{
- */
- /*!
- * @brief Ungates the SNVS clock and configures the peripheral for basic operation.
- *
- * @note This API should be called at the beginning of the application using the SNVS driver.
- *
- * @param base SNVS peripheral base address
- */
- void SNVS_LP_Init(SNVS_Type *base);
- /*!
- * @brief Deinit the SNVS LP section.
- *
- * @param base SNVS peripheral base address
- */
- void SNVS_LP_Deinit(SNVS_Type *base);
- /*! @}*/
- /*!
- * @brief Ungates the SNVS clock and configures the peripheral for basic operation.
- *
- * @note This API should be called at the beginning of the application using the SNVS driver.
- *
- * @param base SNVS peripheral base address
- * @param config Pointer to the user's SNVS configuration structure.
- */
- void SNVS_LP_SRTC_Init(SNVS_Type *base, const snvs_lp_srtc_config_t *config);
- /*!
- * @brief Stops the SRTC timer.
- *
- * @param base SNVS peripheral base address
- */
- void SNVS_LP_SRTC_Deinit(SNVS_Type *base);
- /*!
- * @brief Fills in the SNVS_LP config struct with the default settings.
- *
- * The default values are as follows.
- * @code
- * config->srtccalenable = false;
- * config->srtccalvalue = 0U;
- * @endcode
- * @param config Pointer to the user's SNVS configuration structure.
- */
- void SNVS_LP_SRTC_GetDefaultConfig(snvs_lp_srtc_config_t *config);
- /*!
- * @name Secure RTC (SRTC) current Time & Alarm
- * @{
- */
- /*!
- * @brief Sets the SNVS SRTC date and time according to the given time structure.
- *
- * @param base SNVS peripheral base address
- * @param datetime Pointer to the structure where the date and time details are stored.
- *
- * @return kStatus_Success: Success in setting the time and starting the SNVS SRTC
- * kStatus_InvalidArgument: Error because the datetime format is incorrect
- */
- status_t SNVS_LP_SRTC_SetDatetime(SNVS_Type *base, const snvs_lp_srtc_datetime_t *datetime);
- /*!
- * @brief Gets the SNVS SRTC time and stores it in the given time structure.
- *
- * @param base SNVS peripheral base address
- * @param datetime Pointer to the structure where the date and time details are stored.
- */
- void SNVS_LP_SRTC_GetDatetime(SNVS_Type *base, snvs_lp_srtc_datetime_t *datetime);
- /*!
- * @brief Sets the SNVS SRTC alarm time.
- *
- * The function sets the SRTC alarm. It also checks whether the specified alarm
- * time is greater than the present time. If not, the function does not set the alarm
- * and returns an error.
- * Please note, that SRTC alarm has limited resolution because only 32 most
- * significant bits of SRTC counter are compared to SRTC Alarm register.
- * If the alarm time is beyond SRTC resolution, the function does not set the alarm
- * and returns an error.
- *
- * @param base SNVS peripheral base address
- * @param alarmTime Pointer to the structure where the alarm time is stored.
- *
- * @return kStatus_Success: success in setting the SNVS SRTC alarm
- * kStatus_InvalidArgument: Error because the alarm datetime format is incorrect
- * kStatus_Fail: Error because the alarm time has already passed or is beyond resolution
- */
- status_t SNVS_LP_SRTC_SetAlarm(SNVS_Type *base, const snvs_lp_srtc_datetime_t *alarmTime);
- /*!
- * @brief Returns the SNVS SRTC alarm time.
- *
- * @param base SNVS peripheral base address
- * @param datetime Pointer to the structure where the alarm date and time details are stored.
- */
- void SNVS_LP_SRTC_GetAlarm(SNVS_Type *base, snvs_lp_srtc_datetime_t *datetime);
- /*! @}*/
- /*!
- * @name Interrupt Interface
- * @{
- */
- /*!
- * @brief Enables the selected SNVS interrupts.
- *
- * @param base SNVS peripheral base address
- * @param mask The interrupts to enable. This is a logical OR of members of the
- * enumeration :: _snvs_lp_srtc_interrupts
- */
- static inline void SNVS_LP_SRTC_EnableInterrupts(SNVS_Type *base, uint32_t mask)
- {
- base->LPCR |= mask;
- }
- /*!
- * @brief Disables the selected SNVS interrupts.
- *
- * @param base SNVS peripheral base address
- * @param mask The interrupts to enable. This is a logical OR of members of the
- * enumeration :: _snvs_lp_srtc_interrupts
- */
- static inline void SNVS_LP_SRTC_DisableInterrupts(SNVS_Type *base, uint32_t mask)
- {
- base->LPCR &= ~mask;
- }
- /*!
- * @brief Gets the enabled SNVS interrupts.
- *
- * @param base SNVS peripheral base address
- *
- * @return The enabled interrupts. This is the logical OR of members of the
- * enumeration :: _snvs_lp_srtc_interrupts
- */
- uint32_t SNVS_LP_SRTC_GetEnabledInterrupts(SNVS_Type *base);
- /*! @}*/
- /*!
- * @name Status Interface
- * @{
- */
- /*!
- * @brief Gets the SNVS status flags.
- *
- * @param base SNVS peripheral base address
- *
- * @return The status flags. This is the logical OR of members of the
- * enumeration :: _snvs_lp_srtc_status_flags
- */
- uint32_t SNVS_LP_SRTC_GetStatusFlags(SNVS_Type *base);
- /*!
- * @brief Clears the SNVS status flags.
- *
- * @param base SNVS peripheral base address
- * @param mask The status flags to clear. This is a logical OR of members of the
- * enumeration :: _snvs_lp_srtc_status_flags
- */
- static inline void SNVS_LP_SRTC_ClearStatusFlags(SNVS_Type *base, uint32_t mask)
- {
- base->LPSR |= mask;
- }
- /*! @}*/
- /*!
- * @name Timer Start and Stop
- * @{
- */
- /*!
- * @brief Starts the SNVS SRTC time counter.
- *
- * @param base SNVS peripheral base address
- */
- static inline void SNVS_LP_SRTC_StartTimer(SNVS_Type *base)
- {
- base->LPCR |= SNVS_LPCR_SRTC_ENV_MASK;
- while ((0U == (base->LPCR & SNVS_LPCR_SRTC_ENV_MASK)))
- {
- }
- }
- /*!
- * @brief Stops the SNVS SRTC time counter.
- *
- * @param base SNVS peripheral base address
- */
- static inline void SNVS_LP_SRTC_StopTimer(SNVS_Type *base)
- {
- base->LPCR &= ~SNVS_LPCR_SRTC_ENV_MASK;
- while ((base->LPCR & SNVS_LPCR_SRTC_ENV_MASK) != 0U)
- {
- }
- }
- /*! @}*/
- /*!
- * @name External tampering
- * @{
- */
- #if defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0)
- /*!
- * @brief Enables the specified SNVS external tamper.
- *
- * @param base SNVS peripheral base address
- * @param pin SNVS external tamper pin
- * @param config Configuration structure of external passive tamper
- */
- void SNVS_LP_EnablePassiveTamper(SNVS_Type *base, snvs_lp_external_tamper_t pin, snvs_lp_passive_tamper_t config);
- #endif /* defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0) */
- #if defined(FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS) && (FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS > 0)
- /*!
- * @brief Enable active tamper tx external pad
- *
- * @param base SNVS peripheral base address
- * @param pin SNVS active tamper pin
- * @param config Configuration structure of external active tamper
- */
- status_t SNVS_LP_EnableTxActiveTamper(SNVS_Type *base,
- snvs_lp_active_tx_tamper_t pin,
- tamper_active_tx_config_t config);
- /*!
- * @brief Enable active tamper rx external pad
- *
- * @param base SNVS peripheral base address
- * @param rx SNVS external RX tamper pin
- * @param config SNVS RX tamper config structure
- */
- status_t SNVS_LP_EnableRxActiveTamper(SNVS_Type *base, snvs_lp_external_tamper_t rx, tamper_active_rx_config_t config);
- /*!
- * @brief Sets voltage tamper detect
- *
- * @param base SNVS peripheral base address
- * @param enable True if enable false if disable
- */
- status_t SNVS_LP_SetVoltageTamper(SNVS_Type *base, bool enable);
- /*!
- * @brief Sets temperature tamper detect
- *
- * @param base SNVS peripheral base address
- * @param enable True if enable false if disable
- */
- status_t SNVS_LP_SetTemperatureTamper(SNVS_Type *base, bool enable);
- /*!
- * @brief Sets clock tamper detect
- *
- * @param base SNVS peripheral base address
- * @param enable True if enable false if disable
- */
- status_t SNVS_LP_SetClockTamper(SNVS_Type *base, bool enable);
- /*!
- * brief Check voltage tamper
- *
- * param base SNVS peripheral base address
- */
- snvs_lp_external_tamper_status_t SNVS_LP_CheckVoltageTamper(SNVS_Type *base);
- /*!
- * @brief Check temperature tamper
- *
- * @param base SNVS peripheral base address
- */
- snvs_lp_external_tamper_status_t SNVS_LP_CheckTemperatureTamper(SNVS_Type *base);
- /*!
- * brief Check clock tamper
- *
- * param base SNVS peripheral base address
- */
- snvs_lp_external_tamper_status_t SNVS_LP_CheckClockTamper(SNVS_Type *base);
- /*!
- * @brief Fills in the SNVS tamper pin config struct with the default settings.
- *
- * The default values are as follows.
- * code
- * config->clock = kSNVS_ActiveTamper16HZ;
- * config->seed = 0U;
- * config->polynomial = 0U;
- * endcode
- * @param config Pointer to the user's SNVS configuration structure.
- */
- void SNVS_LP_TamperPinTx_GetDefaultConfig(tamper_active_tx_config_t *config);
- /*!
- * brief Fills in the SNVS tamper pin config struct with the default settings.
- *
- * The default values are as follows.
- * code
- * config->filterenable = 0U;
- * config->filter = 0U;
- * config->tx = kSNVS_ActiveTamper1;
- * endcode
- * param config Pointer to the user's SNVS configuration structure.
- */
- void SNVS_LP_TamperPinRx_GetDefaultConfig(tamper_active_rx_config_t *config);
- #endif /* defined(FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS) && (FSL_FEATURE_SNVS_HAS_ACTIVE_TAMPERS > 0) */
- /*!
- * @brief Fills in the SNVS tamper pin config struct with the default settings.
- *
- * The default values are as follows.
- * code
- * config->polarity = 0U;
- * config->filterenable = 0U; if available on SoC
- * config->filter = 0U; if available on SoC
- * endcode
- * @param config Pointer to the user's SNVS configuration structure.
- */
- void SNVS_LP_PassiveTamperPin_GetDefaultConfig(snvs_lp_passive_tamper_t *config);
- #if defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0)
- /*!
- * @brief Disables the specified SNVS external tamper.
- *
- * @param base SNVS peripheral base address
- * @param pin SNVS external tamper pin
- */
- void SNVS_LP_DisableExternalTamper(SNVS_Type *base, snvs_lp_external_tamper_t pin);
- /*!
- * @brief Disable all external tamper.
- *
- * @param base SNVS peripheral base address
- */
- void SNVS_LP_DisableAllExternalTamper(SNVS_Type *base);
- /*!
- * @brief Returns status of the specified external tamper.
- *
- * @param base SNVS peripheral base address
- * @param pin SNVS external tamper pin
- *
- * @return The status flag. This is the enumeration :: _snvs_lp_external_tamper_status
- */
- snvs_lp_external_tamper_status_t SNVS_LP_GetExternalTamperStatus(SNVS_Type *base, snvs_lp_external_tamper_t pin);
- /*!
- * @brief Clears status of the specified external tamper.
- *
- * @param base SNVS peripheral base address
- * @param pin SNVS external tamper pin
- */
- void SNVS_LP_ClearExternalTamperStatus(SNVS_Type *base, snvs_lp_external_tamper_t pin);
- /*!
- * @brief Clears status of the all external tamper.
- *
- * @param base SNVS peripheral base address
- */
- void SNVS_LP_ClearAllExternalTamperStatus(SNVS_Type *base);
- #endif /* defined(FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER) && (FSL_FEATURE_SNVS_HAS_MULTIPLE_TAMPER > 0) */
- /*! @}*/
- /*!
- * @name Monotonic Counter (MC)
- * @{
- */
- /*!
- * @brief Enable or disable the Monotonic Counter.
- *
- * @param base SNVS peripheral base address
- * @param enable Pass true to enable, false to disable.
- */
- static inline void SNVS_LP_EnableMonotonicCounter(SNVS_Type *base, bool enable)
- {
- if (enable)
- {
- base->LPCR |= SNVS_LPCR_MC_ENV_MASK;
- }
- else
- {
- base->LPCR &= (~SNVS_LPCR_MC_ENV_MASK);
- }
- }
- /*!
- * @brief Get the current Monotonic Counter.
- *
- * @param base SNVS peripheral base address
- * @return Current Monotonic Counter value.
- */
- uint64_t SNVS_LP_GetMonotonicCounter(SNVS_Type *base);
- /*!
- * @brief Increase the Monotonic Counter.
- *
- * Increase the Monotonic Counter by 1.
- *
- * @param base SNVS peripheral base address
- */
- static inline void SNVS_LP_IncreaseMonotonicCounter(SNVS_Type *base)
- {
- /* Write to the LPSMCLR or LPSMCLR, the counter increases. */
- *((volatile uint32_t *)(uint32_t)(&(base->LPSMCLR))) = 0xFFFFFFFFU;
- }
- /*! @}*/
- /*!
- * @name Zeroizable Master Key (ZMK)
- * @{
- */
- /*!
- * @brief Write Zeroizable Master Key (ZMK) to the SNVS registers.
- *
- * @param base SNVS peripheral base address
- * @param ZMKey The ZMK write to the SNVS register.
- */
- void SNVS_LP_WriteZeroizableMasterKey(SNVS_Type *base, uint32_t ZMKey[SNVS_ZMK_REG_COUNT]);
- /*!
- * @brief Set Zeroizable Master Key valid.
- *
- * This API could only be called when using software programming mode. After writing
- * ZMK using @ref SNVS_LP_WriteZeroizableMasterKey, call this API to make the ZMK
- * valid.
- *
- * @param base SNVS peripheral base address
- * @param valid Pass true to set valid, false to set invalid.
- */
- static inline void SNVS_LP_SetZeroizableMasterKeyValid(SNVS_Type *base, bool valid)
- {
- if (valid)
- {
- base->LPMKCR |= SNVS_LPMKCR_ZMK_VAL_MASK;
- }
- else
- {
- base->LPMKCR &= (~SNVS_LPMKCR_ZMK_VAL_MASK);
- }
- }
- /*!
- * @brief Get Zeroizable Master Key valid status.
- *
- * In hardware programming mode, call this API to check whether the ZMK is valid.
- *
- * @param base SNVS peripheral base address
- * @return true if valid, false if invalid.
- */
- static inline bool SNVS_LP_GetZeroizableMasterKeyValid(SNVS_Type *base)
- {
- return (SNVS_LPMKCR_ZMK_VAL_MASK == (base->LPMKCR & SNVS_LPMKCR_ZMK_VAL_MASK));
- }
- /*!
- * @brief Set Zeroizable Master Key programming mode.
- *
- * @param base SNVS peripheral base address
- * @param mode ZMK programming mode.
- */
- static inline void SNVS_LP_SetZeroizableMasterKeyProgramMode(SNVS_Type *base, snvs_lp_zmk_program_mode_t mode)
- {
- if (kSNVS_ZMKSoftwareProgram == mode)
- {
- base->LPMKCR &= (~SNVS_LPMKCR_ZMK_HWP_MASK);
- }
- else
- {
- base->LPMKCR |= SNVS_LPMKCR_ZMK_HWP_MASK;
- }
- }
- /*!
- * @brief Enable or disable Zeroizable Master Key ECC.
- *
- * @param base SNVS peripheral base address
- * @param enable Pass true to enable, false to disable.
- */
- static inline void SNVS_LP_EnableZeroizableMasterKeyECC(SNVS_Type *base, bool enable)
- {
- if (enable)
- {
- base->LPMKCR |= SNVS_LPMKCR_ZMK_ECC_EN_MASK;
- }
- else
- {
- base->LPMKCR &= (~SNVS_LPMKCR_ZMK_ECC_EN_MASK);
- }
- }
- /*!
- * @brief Set SNVS Master Key mode.
- *
- * @param base SNVS peripheral base address
- * @param mode Master Key mode.
- * @note When @ref kSNVS_ZMK or @ref kSNVS_CMK used, the SNVS_HP must be configured
- * to enable the master key selection.
- */
- static inline void SNVS_LP_SetMasterKeyMode(SNVS_Type *base, snvs_lp_master_key_mode_t mode)
- {
- uint32_t lpmkcr = base->LPMKCR;
- lpmkcr = (lpmkcr & (~SNVS_LPMKCR_MASTER_KEY_SEL_MASK)) | SNVS_LPMKCR_MASTER_KEY_SEL(mode);
- base->LPMKCR = lpmkcr;
- }
- #if defined(FSL_FEATURE_SNVS_HAS_STATE_TRANSITION) && (FSL_FEATURE_SNVS_HAS_STATE_TRANSITION > 0)
- /*!
- * brief Transition SNVS SSM state to Trusted/Non-secure from Check state
- *
- * param base SNVS peripheral base address
- *
- * return kStatus_Success: Success in transitioning SSM State
- * kStatus_Fail: SSM State transition failed
- */
- status_t SNVS_LP_SSM_State_Transition(SNVS_Type *base);
- #endif /* FSL_FEATURE_SNVS_HAS_STATE_TRANSITION */
- /*! @}*/
- #if defined(__cplusplus)
- }
- #endif
- /*! @}*/
- #endif /* _FSL_SNVS_LP_H_ */
|