Igor Stepura / kw41z-rf-driver Featured
Embed: (wiki syntax)

« Back to documentation index

fsl_xcvr.h File Reference

fsl_xcvr.h File Reference

Go to the source code of this file.

Data Structures

struct  xcvr_currConfig_tag
 Current configuration of the radio. More...
struct  _xcvr_rx_chf_coeffs
 XCVR RX_DIG channel filter coefficient storage Storage of the coefficients varies from 6 bits to 10 bits so all use int16_t for storage. More...
struct  _xcvr_masked_init_32
 XCVR masked init type for 32 bit registers Initialization uses the mask to clear selected fields of the register and then OR's in the init value. All init values must be in their proper field position. More...
struct  _xcvr_common_config
 XCVR common configure structure. More...
struct  _xcvr_mode_config
 XCVR mode specific configure structure (varies by radio mode) More...
struct  _xcvr_mode_datarate_config
 XCVR modeXdatarate specific configure structure (varies by radio mode AND data rate) This structure is used to store all of the XCVR settings which are dependent upon both radio mode and data rate. It is used as an overlay on top of the xcvr_mode_config_t structure to supply definitions which are either not in that table or which must be overridden for data rate. More...
struct  _xcvr_datarate_config
 XCVR datarate specific configure structure (varies by data rate) This structure is used to store all of the XCVR settings which are dependent upon data rate. It is used as an overlay on top of the xcvr_mode_config_t structure to supply definitions which are either not in that table or which must be overridden for data rate. More...

Typedefs

typedef enum _xcvrStatus xcvrStatus_t
 Error codes for the XCVR driver.
typedef enum _healthStatus healthStatus_t
 Health status returned from PHY upon status check function return.
typedef enum _ext_clock_config ext_clock_config_t
 Health status returned from PHY upon status check function return.
typedef enum _radio_mode radio_mode_t
 Radio operating mode setting types.
typedef enum _link_layer link_layer_t
 Link layer types.
typedef enum _data_rate data_rate_t
 Data rate selections.
typedef enum _FAD_LPPS_CTRL FAD_LPPS_CTRL_T
 Control settings for Fast Antenna Diversity.
typedef enum _XCVR_PANIC_ID XCVR_PANIC_ID_T
 XCVR XCVR Panic codes for indicating panic reason.
typedef enum _XCVR_INIT_MODE_CHG XCVR_INIT_MODE_CHG_T
 Initialization or mode change selection for config routine.
typedef struct xcvr_currConfig_tag xcvr_currConfig_t
 Current configuration of the radio.
typedef struct _xcvr_rx_chf_coeffs xcvr_rx_chf_coeffs_t
 XCVR RX_DIG channel filter coefficient storage Storage of the coefficients varies from 6 bits to 10 bits so all use int16_t for storage.
typedef struct _xcvr_masked_init_32 xcvr_masked_init_32_t
 XCVR masked init type for 32 bit registers Initialization uses the mask to clear selected fields of the register and then OR's in the init value. All init values must be in their proper field position.
typedef struct _xcvr_common_config xcvr_common_config_t
 XCVR common configure structure.
typedef struct _xcvr_mode_config xcvr_mode_config_t
 XCVR mode specific configure structure (varies by radio mode)
typedef struct
_xcvr_mode_datarate_config 
xcvr_mode_datarate_config_t
 XCVR modeXdatarate specific configure structure (varies by radio mode AND data rate) This structure is used to store all of the XCVR settings which are dependent upon both radio mode and data rate. It is used as an overlay on top of the xcvr_mode_config_t structure to supply definitions which are either not in that table or which must be overridden for data rate.
typedef struct
_xcvr_datarate_config 
xcvr_datarate_config_t
 XCVR datarate specific configure structure (varies by data rate) This structure is used to store all of the XCVR settings which are dependent upon data rate. It is used as an overlay on top of the xcvr_mode_config_t structure to supply definitions which are either not in that table or which must be overridden for data rate.
typedef void(* panic_fptr )(uint32_t panic_id, uint32_t location, uint32_t extra1, uint32_t extra2)
 LPUART callback function type.

Enumerations

enum  _xcvrStatus
 

Error codes for the XCVR driver.

More...
enum  _healthStatus
 

Health status returned from PHY upon status check function return.

More...
enum  _ext_clock_config
 

Health status returned from PHY upon status check function return.

More...
enum  _radio_mode
 

Radio operating mode setting types.

More...
enum  _link_layer
 

Link layer types.

More...
enum  _data_rate
 

Data rate selections.

More...
enum  _FAD_LPPS_CTRL
 

Control settings for Fast Antenna Diversity.

More...
enum  _XCVR_PANIC_ID
 

XCVR XCVR Panic codes for indicating panic reason.

More...
enum  _XCVR_INIT_MODE_CHG
 

Initialization or mode change selection for config routine.

More...

Functions

XCVR functional Operation
xcvrStatus_t XCVR_Init (radio_mode_t radio_mode, data_rate_t data_rate)
 Initializes an XCVR instance.
void XCVR_Deinit (void)
 Deinitializes an XCVR instance.
xcvrStatus_t XCVR_GetDefaultConfig (radio_mode_t radio_mode, data_rate_t data_rate, const xcvr_common_config_t **com_config, const xcvr_mode_config_t **mode_config, const xcvr_mode_datarate_config_t **mode_datarate_config, const xcvr_datarate_config_t **datarate_config)
 Initializes XCVR configure structure.
xcvrStatus_t XCVR_Configure (const xcvr_common_config_t *com_config, const xcvr_mode_config_t *mode_config, const xcvr_mode_datarate_config_t *mode_datarate_config, const xcvr_datarate_config_t *datarate_config, int16_t tempDegC, XCVR_INIT_MODE_CHG_T first_init)
 Initializes an XCVR instance.
void XCVR_Reset (void)
 Set XCVR register to reset value.
xcvrStatus_t XCVR_ChangeMode (radio_mode_t new_radio_mode, data_rate_t new_data_rate)
 Change the operating mode of the radio.
void XCVR_EnaNBRSSIMeas (uint8_t IIRnbEnable)
 Enable Narrowband RSSI measurement.
xcvrStatus_t XCVR_OverrideFrequency (uint32_t freq, uint32_t refOsc)
 Set an arbitrary frequency for RX and TX for the radio.
void XCVR_RegisterPanicCb (panic_fptr fptr)
 Register a callback from upper layers.
healthStatus_t XCVR_HealthCheck (void)
 Read the health status of the XCVR to detect errors.
void XCVR_FadLppsControl (FAD_LPPS_CTRL_T control)
 Control FAD and LPPS features.
xcvrStatus_t XCVR_SetIRQMapping (radio_mode_t irq0_mapping, radio_mode_t irq1_mapping)
 Change the mapping of the radio IRQs.
void XCVR_SetBSM_NTW_Address (uint32_t bsm_ntw_address)
 Sets the network address used by the PHY during BLE Bit Streaming Mode.
uint32_t XCVR_GetBSM_NTW_Address (void)
 Reads the currently programmed network address used by the PHY during BLE Bit Streaming Mode.
link_layer_t XCVR_GetIRQMapping (uint8_t int_num)
 Get the mapping of the one of the radio IRQs.
xcvrStatus_t XCVR_GetCurrentConfig (xcvr_currConfig_t *curr_config)
 Get the current configuration of the XCVR.
xcvrStatus_t XCVR_SetXtalTrim (uint8_t xtalTrim)
 Controls setting the XTAL trim value..
uint8_t XCVR_GetXtalTrim (void)
 Controls getting the XTAL trim value..
xcvrStatus_t XCVR_SetRssiAdjustment (int8_t adj)
 Controls setting the RSSI adjustment..
int8_t XCVR_GetRssiAdjustment (void)
 Controls getting the RSSI adjustment..
xcvrStatus_t XCVR_OverrideChannel (uint8_t channel, uint8_t useMappedChannel)
 Controls setting the PLL to a particular channel.
uint32_t XCVR_GetFreq (void)
 Reads the current frequency for RX and TX for the radio.
void XCVR_ForceRxWu (void)
 Force receiver warmup.
void XCVR_ForceRxWd (void)
 Force receiver warmdown.
void XCVR_ForceTxWu (void)
 Force transmitter warmup.
void XCVR_ForceTxWd (void)
 Force transmitter warmdown.
xcvrStatus_t XCVR_DftTxPatternReg (uint16_t channel_num, radio_mode_t radio_mode, data_rate_t data_rate, uint32_t tx_pattern)
 Starts transmit with a TX pattern register data sequence.
xcvrStatus_t XCVR_DftTxLfsrReg (uint16_t channel_num, radio_mode_t radio_mode, data_rate_t data_rate, uint8_t lfsr_length)
 Starts transmit with a TX LFSR register data sequence.
void XCVR_DftTxOff (void)
 Controls clearing all TX DFT settings.
xcvrStatus_t XCVR_ForcePAPower (uint8_t pa_power)
 Controls setting the PA power level.
xcvrStatus_t XCVR_DftTxCW (uint16_t rf_channel_freq, uint8_t protocol)
 Starts CW TX.
xcvrStatus_t XCVR_CoexistenceInit (void)
xcvrStatus_t XCVR_CoexistenceSetPriority (XCVR_COEX_PRIORITY_T rxPriority, XCVR_COEX_PRIORITY_T txPriority)
xcvrStatus_t XCVR_CoexistenceSaveRestoreTimings (uint8_t saveTimings)

Variables

const xcvr_datarate_config_t xcvr_1mbps_config
 XCVR 1Mbps DATA RATE specific configure structure.
const xcvr_datarate_config_t xcvr_500kbps_config
 XCVR 500K bps DATA RATE specific configure structure.
const xcvr_datarate_config_t xcvr_250kbps_config
 XCVR 250K bps DATA RATE specific configure structure.
const xcvr_datarate_config_t xcvr_802_15_4_500kbps_config
 XCVR 500K bps DATA RATE specific configure structure.

Detailed Description

Definition in file fsl_xcvr.h.