Supplemental Calibration Library Reference

 

Summary

 

Variables

• CalibrateLib_Version : Calibrate version variable.

 

Data Structures

• CalClock_Type : Contains the quantitative results of the calibration, returned from each clock calibration function.
• CalPower_Type : Contains the quantitative results of the calibration, returned from each rail calibration function.

 

Enumerations

• clock_check : Enumeration for selecting to check either the 48 MHz crystal or the 32 kHz crystal with Calibrate_Clock_CheckXTAL.

 

Macros

• CALIBRATE_FW_VER_MAJOR : Major version of Calibration Library.
• CALIBRATE_FW_VER_MINOR : Minor version of Calibration Library.
• CALIBRATE_FW_VER_REVISION : Revision of Calibration Library.
• CALIBRATE_FW_VER : Firmware Calibration Library Version Code.
• ERRNO_POWER_CAL_MARKER : Power supply calibration related errors marker.
• ERRNO_VBG_CAL_ERROR : Error during bandgap calibration process.
• ERRNO_VDDRF_CAL_ERROR : Error during VDDRF calibration process.
• ERRNO_VDDPA_CAL_ERROR : Error during VDDPA calibration process.
• ERRNO_DCDC_CAL_ERROR : Error during DC-DC calibration process.
• ERRNO_VDDC_CAL_ERROR : Error during VDDC calibration process.
• ERRNO_VDDM_CAL_ERROR : Error during VDDM calibration process.
• ERRNO_VDDIF_CAL_ERROR : Error during VDDIF calibration process.
• ERRNO_VDDFLASH_CAL_ERROR : Error during VDDFLASH calibration process.
• ERRNO_STORAGE_CAL_ERROR : Error during storage calibration process.
• ERRNO_CLK_CAL_MARKER : Clock calibration related errors marker.
• ERRNO_RCOSC_CAL_ERROR : Error during RC 32 kHz oscillator calibration process.
• ERRNO_START_OSC_CAL_ERROR : Error during RC Start oscillator calibration process.
• ERRNO_INVALID_MIN_MAX_ERROR : Invalid input to binary search algorithm.
• TRIMMING_STEP : Size of trimming steps for RC oscillator, 1.5%.
• ASYNC_CLK_PERIODS : Number of asynchronous clock periods to measure over.
• CAL_32K_RCOSC : Select to calibrate the 32 kHz RC oscillator.
• CAL_START_OSC : Select to calibrate the Start RC oscillator.
• CAL_RC32OSC_DEFAULT : RC32 OSC default target frequency.
• MHZ_TO_HZ : Conversion factor between SMHz to Hz or vice versa.
• TEN_MS_QUOTIENT : Conversion factor between MHz to Hz or vice versa.
• NON_MONOTONIC_POINTS : Number of points to check when encountering non-monotonic code.
• MONOTONIC_POINTS : Number of points to check when encountering monotonic code.
• NON_MONOTONIC_CODE32 : Number of points to check when encountering monotonic code.
• NON_MONOTONIC_CODE48 : Number of points to check when encountering monotonic code.
• MIN_RCCLK_24 : Minimum frequency of 24 MHz oscillator setting worst case.
• MAX_RCCLK_24 : Maximum frequency of 24 MHz oscillator setting worst case.
• RFCLK_FREQ : RFCLK frequency measured.
• XTAL48_ERROR_LIMIT_MIN : MIN = MIN RCCLK / 8 MHz * 16 ASCC periods.
• XTAL48_ERROR_LIMIT_MAX : MAX = MAX RCCLK / 8 MHz * 16 ASCC periods.
• STANDBYCLK_FREQ : RFCLK frequency measured.
• XTAL32_ERROR_LIMIT_MIN : MIN = MIN RCCLK / 32768 Hz * 16 ASCC periods.
• XTAL32_ERROR_LIMIT_MAX : MAX = MAX RCCLK / 32768 Hz * 16 ASCC periods.
• CONVERT_MHZ_TO_CYCLES : Calculates the number of cycles to be returned by the ASCC.
• LSAD_STABILIZED_RANGE : LSAD variance in LSBs considered "stable" and not discharging.
• LSAD_MEASUREMENT_ERROR : Set the LSAD measurement error to 5 [mV].
• LSAD_IF_MEASUREMENT_ERROR : Set the LSAD measurement error to 13 [mV].
• LSAD_NUM_CHANNELS : Number of LSAD channels in device.
• VDDCM_TARGET_OFFSET : Offset the desired target to ensure while calibrating.
• BG_VTRIM_0P820V_BYTE : Bandgap maximum safe voltage - 1 trim step.
• VDDM_TRIM_0P95V_BYTE : Digital Memories voltage regulator minimum safe voltage to maintain function.
• VDDFLASH_TRIM_1P500V_BYTE : Flash voltage regulator minimum safe voltage to maintain function.
• VDDFLASH_TRIM_1P850V_BYTE : Flash voltage regulator maximum safe voltage.
• V_TO_MV : Factor for converting back and forth from mV to V.
• V_TO_MV_F : Float iteration of factor for converting back and forth from mV to V.
• CONVERT : Converts an ADC code to a voltage, calculated as follows voltage = adc_code * (2 V * 1000 [mV]/1 V / 2^14 steps.)
• SWAP : Swap the values in variables a and b.

 

Functions

• Calibrate_Clock_Initialize : Initialize the system to support the clock calibration, consisting of the 48 MHz XTAL oscillator and RC oscillator.
• Calibrate_Clock_32K_RCOSC : Used to calibrate the 32K RC oscillator to a specified frequency.
• Calibrate_Clock_Start_OSC : Used to calibrate the startup oscillator to a specified frequency.
• Calibrate_Clock_CheckXTAL : Used to determine if the specified crystal can oscillate correctly.
• Calibrate_Power_Initialize : Initialize the system to support power supply calibration.
• Calibrate_Power_VDDRF : Calibrate the radio front-end power supply (VDDRF).
• Calibrate_Power_VDDIF : Calibrate the interfaces power supply (VDDIF).
• Calibrate_Power_VDDFLASH : Calibrate the flash power supply (VDDFLASH).
• Calibrate_Power_VDDPA : Calibrate the radio power amplifier power supply (VDDPA).
• Calibrate_Power_DCDC : Calibrate the DC-DC converter (DCDC).
• Calibrate_Power_VDDC : Calibrate the digital core voltage power supply (VDDC).
• Calibrate_Power_VDDM : Calibrate the digital memory voltage (VDDM)