MCUXpresso SDK API Reference Manual  Rev. 0
NXP Semiconductors
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Dryice_digital

Overview

Data Structures

struct  dryice_digital_config_t
 Config struct for DRYICE DIGITAL module. More...
 
struct  dryice_digital_pin_config_t
 Config struct for DRYICE DIGITAL tamper pin. More...
 

Enumerations

enum  dryice_digital_tamper_pin_t
 List of dryice tamper pins.
 
enum  dryice_digital_ignored_win_width_t
 Ignored window width, countered in 32 kHz clock.
 
enum  dryice_digital_clk_freq_t
 Clock selection for ignored window and pin sampling.
 
enum  dryice_digital_pull_select_t
 Tamper pull select.
 
enum  dryice_digital_hysteresis_control_t
 Control signal to select Schmitt trigger or CMOS input.
 
enum  dryice_digital_tamper_routing_control_t
 External tamper routing control.
 
enum  dryice_digital_tamper_expected_data_t
 Passive tamper expected data.
 
enum  dryice_digital_pin_sampling_freq_t
 Tamper pin sampling frequency.
 
enum  dryice_digital_pin_sampling_width_t
 Tamper pin sample width.
 
enum  dryice_digital_drive_strength_t
 Drive strength controlling.
 
enum  dryice_digital_pull_transition_width_t
 Tamper pin pull transition width.
 
enum  dryice_digital_temp_range_t
 Temperature detect selection.
 
enum  dryice_digital_tamper_result_t
 List of tamper events.
 
enum  dryice_digital_tamper_enable_t
 List of tamper status flags.
 

Functions

void DRYICE_DIGITAL_Init (DRYICE_Type *base, const dryice_digital_config_t *config)
 Enables the DryIce Digital module. More...
 
void DRYICE_DIGITAL_Deinit (DRYICE_Type *base)
 Disables the DryIce Digital module. More...
 
void DRYICE_DIGITAL_GetDefaultConfig (DRYICE_Type *base, dryice_digital_config_t *config)
 Gets default values for the DryIce Digital module. More...
 
void DRYICE_DIGITAL_PinGetDefaultConfig (DRYICE_Type *base, dryice_digital_pin_config_t *pinConfig)
 Gets default values for tamper pin configuration. More...
 
status_t DRYICE_DIGITAL_SetPinConfig (DRYICE_Type *base, dryice_digital_tamper_pin_t pin, const dryice_digital_pin_config_t *pinConfig)
 Writes to the DryIce Digital TPCTRLn register. More...
 
void DRYICE_DIGITAL_EnableTampers (DRYICE_Type *base, uint32_t mask)
 Writes to the DryIce Digital Control Register. More...
 
void DRYICE_DIGITAL_DisableTampers (DRYICE_Type *base, uint32_t mask)
 Writes to the DryIce Digital Control Register. More...
 
static void DRYICE_DIGITAL_GetTamperResults (DRYICE_Type *base, uint32_t *result)
 Reads the Tamper Resuts Register. More...
 

Driver version

#define FSL_DRYICE_DIGITAL_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))
 Version 2.0.0.
 

Data Structure Documentation

struct dryice_digital_config_t
struct dryice_digital_pin_config_t

Function Documentation

void DRYICE_DIGITAL_Init ( DRYICE_Type *  base,
const dryice_digital_config_t config 
)

This function enables the DryIce peripheral.

void DRYICE_DIGITAL_Deinit ( DRYICE_Type *  base)

This function disables the DryIce peripheral.

void DRYICE_DIGITAL_GetDefaultConfig ( DRYICE_Type *  base,
dryice_digital_config_t config 
)

This function fills the given structure with default values for the DryIce module. The default values are:

* defaultConfig->tempHighOffset = 0U;
* defaultConfig->tempLowOffset = 0U;
* defaultConfig->tempMonTrim = 0U;
* defaultConfig->voltMonTrim = 0U;
* defaultConfig->bgrTrim = 0U;
* defaultConfig->tempDetSel = kDRYICE_DIGITAL_Range_105C_125C;
*
Parameters
baseDryIce Digital peripheral base address
[out]defaultConfigPointer to structure to be filled with default parameters
void DRYICE_DIGITAL_PinGetDefaultConfig ( DRYICE_Type *  base,
dryice_digital_pin_config_t pinConfig 
)

This function fills the give structure with default values for the tamper pin configuration. The default values are:

* pinConfig->pinDirection = kDRYICE_TamperPinDirectionIn;
* pinConfig->ignoredWindowWidth = kDRYICE_DIGITAL_NoIgnoredWindow;
* pinConfig->ignoredWinClkSel = kDRYICE_DIGITAL_32768Hz;
* pinConfig->ignoredWinStartCycle = 0U;
* pinConfig->extTamperRoutingCtrl = kDRYICE_DIGITAL_PassiveInput;
* pinConfig->passiveTamperExpDat = kDRYICE_DIGITAL_ExpectedTamperHigh;
* pinConfig->pullEnable = false;
* pinConfig->pullContinuousEnable = false;
* pinConfig->pullSelect = kDRYICE_DIGITAL_PullDown;
* pinConfig->pullTransWidth = kDRYICE_DIGITAL_1CycleTransitionWidth;
* pinConfig->driveStrength = kDRYICE_DIGITAL_DriveStrenght1;
* pinConfig->hysteresisCtrl = kDRYICE_DIGITAL_Schmitt;
* pinConfig->outputKeepEnable = false;
* pinConfig->sampleClkSel = kDRYICE_DIGITAL_32768Hz;
* pinConfig->sampleFreqSel = kDRYICE_DIGITAL_Every8Cycles;
* pinConfig->sampleWidth = kDRYICE_DIGITAL_SamplingDisabled;
*
Parameters
baseDryIce Digital peripheral base address
[out]pinConfigPointer to structure to be filled with tamper pins default parameters
status_t DRYICE_DIGITAL_SetPinConfig ( DRYICE_Type *  base,
dryice_digital_tamper_pin_t  pin,
const dryice_digital_pin_config_t pinConfig 
)

This function writes the given structure to the DryIce Digital TPCTRLn Register.

Parameters
baseDryIce Digital peripheral base address
configPointer to structure with DryIce Digital peripheral configuration parameters
Returns
kStatus_Fail when writing to DryIce Control Register is not allowed
kStatus_Success when operation completes successfully
void DRYICE_DIGITAL_EnableTampers ( DRYICE_Type *  base,
uint32_t  mask 
)

This function sets specified tamper enable bits in DryIce Digital Control Register.

Parameters
baseDryIce Digital peripheral base address
maskBit mask for the tamper enable bits to be set.
void DRYICE_DIGITAL_DisableTampers ( DRYICE_Type *  base,
uint32_t  mask 
)

This function clears specified tamper enable bits in DryIce Digital Control Register.

Parameters
baseDryIce Digital peripheral base address
maskBit mask for the tamper enable bits to be cleared.
static void DRYICE_DIGITAL_GetTamperResults ( DRYICE_Type *  base,
uint32_t *  result 
)
inlinestatic

This function reads result bits from DryIce Tamper Resuts Register.

Parameters
baseDryIce Digital peripheral base address
[out]resultPointer to uint32_t where to write Status Register read value. Use dryice_digital_tamper_result_t to decode individual flags.