Si4063 revC2A Command/Property API Documentation

Interface Version: 1.0

Document Version: 2.0.5

Generated: 2015-03-18T10:15:42-05:00


Introduction

This document provides API descriptions for the commands and properties used to control and configure the part. The interface version tracks any functional changes to the API (command, property, field, enumeration, etc.). The documentation version tracks any text changes to the summary or description text of the API components.

The commands are listed in a summary table with links to command details. The properties are listed in a summary table with links to property details. The feature available column in the summary tables lists the firmware revision which first implemented the command or property.

An entry in the summary table will link to a details section, which contains a register view with fields. Clicking a field in the register view will auto-expand the corresponding field details. An up button in the field detail links back to the register view. Each register view title links back to the summary table entry. These hyper-links provide two-click access from top to bottom.

Command Summary

COMMON_COMMANDS
Number Name Summary Feature Available
0x00 NOP No Operation command.
0x01 PART_INFO Reports basic information about the device.
0x10 FUNC_INFO Returns the Function revision information of the device.
0x11 SET_PROPERTY Sets the value of one or more properties.
0x12 GET_PROPERTY Retrieves the value of one or more properties
0x13 GPIO_PIN_CFG Configures the GPIO pins.
0x15 FIFO_INFO Access the current byte counts in the TX and RX FIFOs, and provide for resetting the FIFOs.
0x20 GET_INT_STATUS Returns the interrupt status of ALL the possible interrupt events (both STATUS and PENDING). Optionally, it may be used to clear latched (PENDING) interrupt events.
0x33 REQUEST_DEVICE_STATE Request current device state and channel.
0x34 CHANGE_STATE Manually switch the chip to a desired operating state.
0x44 READ_CMD_BUFF Used to read CTS and the command response.
0x50 FRR_A_READ Reads the fast response registers (FRR) starting with FRR_A.
0x51 FRR_B_READ Reads the fast response registers (FRR) starting with FRR_B.
0x53 FRR_C_READ Reads the fast response registers (FRR) starting with FRR_C.
0x57 FRR_D_READ Reads the fast response registers (FRR) starting with FRR_D.
TX_COMMANDS
Number Name Summary Feature Available
0x31 START_TX Switches to TX state and starts transmission of a packet.
0x66 WRITE_TX_FIFO Writes data byte(s) to the TX FIFO.
ADVANCED_COMMANDS
Number Name Summary Feature Available
0x14 GET_ADC_READING Performs conversions using the Auxiliary ADC and returns the results of those conversions.
0x21 GET_PH_STATUS Returns the interrupt status of the Packet Handler Interrupt Group (both STATUS and PENDING). Optionally, it may be used to clear latched (PENDING) interrupt events.
0x23 GET_CHIP_STATUS Returns the interrupt status of the Chip Interrupt Group (both STATUS and PENDING). Optionally, it may be used to clear latched (PENDING) interrupt events.

Property Summary

GLOBAL (0x00)
Group Number Name Default Summary Feature Available
0x00 0x00 GLOBAL_XO_TUNE 0x40 Configure the internal capacitor frequency tuning bank for the crystal oscillator.
0x00 0x01 GLOBAL_CLK_CFG 0x00 Clock configuration options.
0x00 0x02 GLOBAL_LOW_BATT_THRESH 0x18 Configures the threshold voltage for low-battery detection.
0x00 0x03 GLOBAL_CONFIG 0x20 Global configuration settings.
0x00 0x04 GLOBAL_WUT_CONFIG 0x00 General Wakeup Timer feature configuration.
0x00 0x05
0x06
GLOBAL_WUT_M 0x00
0x01
Configure the mantissa of the Wake-Up Timer (WUT) value.
0x00 0x07 GLOBAL_WUT_R 0x60 Configure the exponent of the Wake-Up Timer (WUT) value.
0x00 0x08 GLOBAL_WUT_LDC 0x00 Configures the period of time the chip remains active after automatic wake-up in LDC mode.
0x00 0x09 GLOBAL_WUT_CAL 0x00 Controls if calibration of the 32K R-C Oscillator will be performed on intervals of the WUT.
INT_CTL (0x01)
Group Number Name Default Summary Feature Available
0x01 0x00 INT_CTL_ENABLE 0x04 This property provides for global enabling of the three interrupt groups (Chip, Modem and Packet Handler) in order to generate HW interrupts at the NIRQ pin.
0x01 0x01 INT_CTL_PH_ENABLE 0x00 Enable individual interrupt sources within the Packet Handler Interrupt Group to generate a HW interrupt on the NIRQ output pin.
0x01 0x03 INT_CTL_CHIP_ENABLE 0x04 Enable individual interrupt sources within the Chip Interrupt Group to generate a HW interrupt on the NIRQ output pin.
FRR_CTL (0x02)
Group Number Name Default Summary Feature Available
0x02 0x00 FRR_CTL_A_MODE 0x01 Fast Response Register A Configuration.
0x02 0x01 FRR_CTL_B_MODE 0x02 Fast Response Register B Configuration.
0x02 0x02 FRR_CTL_C_MODE 0x09 Fast Response Register C Configuration.
0x02 0x03 FRR_CTL_D_MODE 0x00 Fast Response Register D Configuration.
PREAMBLE (0x10)
Group Number Name Default Summary Feature Available
0x10 0x00 PREAMBLE_TX_LENGTH 0x08 Configure length of TX Preamble.
0x10 0x01 PREAMBLE_CONFIG_STD_1 0x14 Configuration of reception of a packet with a Standard Preamble pattern.
0x10 0x02 PREAMBLE_CONFIG_NSTD 0x00 Configuration of transmission/reception of a packet with a Non-Standard Preamble pattern.
0x10 0x04 PREAMBLE_CONFIG 0x21 General configuration bits for the Preamble field.
0x10 0x05
0x06
0x07
0x08
PREAMBLE_PATTERN 0x00
0x00
0x00
0x00
Configuration of the bit values describing a Non-Standard Preamble pattern.
SYNC (0x11)
Group Number Name Default Summary Feature Available
0x11 0x00 SYNC_CONFIG 0x01 Sync Word configuration bits.
0x11 0x01
0x02
0x03
0x04
SYNC_BITS 0x2d
0xd4
0x2d
0xd4
Sync word.
0x11 0x05 SYNC_CONFIG2 0x00 Sync Word configuration bits.
PKT (0x12)
Group Number Name Default Summary Feature Available
0x12 0x00 PKT_CRC_CONFIG 0x00 Select a CRC polynomial and seed.
0x12 0x01
0x02
PKT_WHT_POLY 0x01
0x08
16-bit polynomial value for the PN Generator (e.g., for Data Whitening)
0x12 0x03
0x04
PKT_WHT_SEED 0xff
0xff
16-bit seed value for the PN Generator (e.g., for Data Whitening)
0x12 0x05 PKT_WHT_BIT_NUM 0x00 Selects which bit of the LFSR (used to generate the PN / data whitening sequence) is used as the output bit for data scrambling.
0x12 0x06 PKT_CONFIG1 0x00 General configuration bits for transmission or reception of a packet.
0x12 0x07 PKT_CONFIG2 0x00 General packet configuration bits.
0x12 0x0b PKT_TX_THRESHOLD 0x30 TX FIFO almost empty threshold.
0x12 0x0d
0x0e
PKT_FIELD_1_LENGTH 0x00
0x00
Unsigned 13-bit Field 1 length value.
0x12 0x0f PKT_FIELD_1_CONFIG 0x00 General data processing and packet configuration bits for Field 1.
0x12 0x10 PKT_FIELD_1_CRC_CONFIG 0x00 Configuration of CRC control bits across Field 1.
0x12 0x11
0x12
PKT_FIELD_2_LENGTH 0x00
0x00
Unsigned 13-bit Field 2 length value.
0x12 0x13 PKT_FIELD_2_CONFIG 0x00 General data processing and packet configuration bits for Field 2.
0x12 0x14 PKT_FIELD_2_CRC_CONFIG 0x00 Configuration of CRC control bits across Field 2.
0x12 0x15
0x16
PKT_FIELD_3_LENGTH 0x00
0x00
Unsigned 13-bit Field 3 length value.
0x12 0x17 PKT_FIELD_3_CONFIG 0x00 General data processing and packet configuration bits for Field 3.
0x12 0x18 PKT_FIELD_3_CRC_CONFIG 0x00 Configuration of CRC control bits across Field 3.
0x12 0x19
0x1a
PKT_FIELD_4_LENGTH 0x00
0x00
Unsigned 13-bit Field 4 length value.
0x12 0x1b PKT_FIELD_4_CONFIG 0x00 General data processing and packet configuration bits for Field 4.
0x12 0x1c PKT_FIELD_4_CRC_CONFIG 0x00 Configuration of CRC control bits across Field 4.
0x12 0x1d
0x1e
PKT_FIELD_5_LENGTH 0x00
0x00
Unsigned 13-bit Field 5 length value.
0x12 0x1f PKT_FIELD_5_CONFIG 0x00 General data processing and packet configuration bits for Field 5.
0x12 0x20 PKT_FIELD_5_CRC_CONFIG 0x00 Configuration of CRC control bits across Field 5.
MODEM (0x20)
Group Number Name Default Summary Feature Available
0x20 0x00 MODEM_MOD_TYPE 0x02 Selects the type of modulation. In TX mode, additionally selects the source of the modulation.
0x20 0x01 MODEM_MAP_CONTROL 0x80 Controls polarity and mapping of transmit and receive bits.
0x20 0x02 MODEM_DSM_CTRL 0x07 Miscellaneous control bits for the Delta-Sigma Modulator (DSM) in the PLL Synthesizer.
0x20 0x03
0x04
0x05
MODEM_DATA_RATE 0x0f
0x42
0x40
Unsigned 24-bit value used to determine the TX data rate
0x20 0x06
0x07
0x08
0x09
MODEM_TX_NCO_MODE 0x01
0xc9
0xc3
0x80
TX Gaussian filter oversampling ratio and Byte 3 of unsigned 26-bit TX Numerically Controlled Oscillator (NCO) modulus.
0x20 0x0a
0x0b
0x0c
MODEM_FREQ_DEV 0x00
0x06
0xd3
17-bit unsigned TX frequency deviation word.
0x20 0x0d
0x0e
MODEM_FREQ_OFFSET 0x00
0x00
Frequency offset adjustment (a 16-bit signed number).
0x20 0x0f MODEM_TX_FILTER_COEFF_8 0x67 The 8th coefficient of TX spectral shaping filter.
0x20 0x10 MODEM_TX_FILTER_COEFF_7 0x60 The 7th coefficient of TX spectral shaping filter.
0x20 0x11 MODEM_TX_FILTER_COEFF_6 0x4d The 6th coefficient of TX spectral shaping filter.
0x20 0x12 MODEM_TX_FILTER_COEFF_5 0x36 The 5th coefficient of TX spectral shaping filter.
0x20 0x13 MODEM_TX_FILTER_COEFF_4 0x21 The 4th coefficient of TX spectral shaping filter.
0x20 0x14 MODEM_TX_FILTER_COEFF_3 0x11 The 3rd coefficient of TX spectral shaping filter.
0x20 0x15 MODEM_TX_FILTER_COEFF_2 0x08 The 2nd coefficient of TX spectral shaping filter.
0x20 0x16 MODEM_TX_FILTER_COEFF_1 0x03 The 1st coefficient of TX spectral shaping filter.
0x20 0x17 MODEM_TX_FILTER_COEFF_0 0x01 The 0th coefficient of TX spectral shaping filter.
0x20 0x18 MODEM_TX_RAMP_DELAY 0x01 TX ramp-down delay setting.
0x20 0x19 MODEM_MDM_CTRL 0x00 MDM control.
0x20 0x1a MODEM_IF_CONTROL 0x08 Selects Fixed-IF, Scaled-IF, or Zero-IF mode of RX Modem operation.
0x20 0x1b
0x1c
0x1d
MODEM_IF_FREQ 0x03
0xc0
0x00
the IF frequency setting (an 18-bit signed number).
0x20 0x1e MODEM_DECIMATION_CFG1 0x10 Specifies three decimator ratios for the Cascaded Integrator Comb (CIC) filter.
0x20 0x1f MODEM_DECIMATION_CFG0 0x20 Specifies miscellaneous parameters and decimator ratios for the Cascaded Integrator Comb (CIC) filter.
0x20 0x20 MODEM_DECIMATION_CFG2 0x00 Specifies miscellaneous decimator filter selections.
0x20 0x21 MODEM_IFPKD_THRESHOLDS 0xe8
0x20 0x22
0x23
MODEM_BCR_OSR 0x00
0x4b
RX BCR/Slicer oversampling rate (12-bit unsigned number).
0x20 0x24
0x25
0x26
MODEM_BCR_NCO_OFFSET 0x06
0xd3
0xa0
RX BCR NCO offset value (an unsigned 22-bit number).
0x20 0x27
0x28
MODEM_BCR_GAIN 0x06
0xd3
The unsigned 11-bit RX BCR loop gain value.
0x20 0x29 MODEM_BCR_GEAR 0x02 RX BCR loop gear control.
0x20 0x2a MODEM_BCR_MISC1 0xc0 Miscellaneous control bits for the RX BCR loop.
0x20 0x2b MODEM_BCR_MISC0 0x00 Miscellaneous RX BCR loop controls.
0x20 0x2c MODEM_AFC_GEAR 0x00 RX AFC loop gear control.
0x20 0x2d MODEM_AFC_WAIT 0x23 RX AFC loop wait time control.
0x20 0x2e
0x2f
MODEM_AFC_GAIN 0x83
0x69
Sets the gain of the PLL-based AFC acquisition loop, and provides miscellaneous control bits for AFC functionality.
0x20 0x30
0x31
MODEM_AFC_LIMITER 0x00
0x40
Set the AFC limiter value.
0x20 0x32 MODEM_AFC_MISC 0xa0 Specifies miscellaneous AFC control bits.
0x20 0x33 MODEM_AFC_ZIFOFF 0x00 AFC fixed frequency offset in zero IF mode.
0x20 0x34 MODEM_ADC_CTRL 0x00 Sigma Delta ADC controls.
0x20 0x35 MODEM_AGC_CONTROL 0xe0 Miscellaneous control bits for the Automatic Gain Control (AGC) function in the RX Chain.
0x20 0x38 MODEM_AGC_WINDOW_SIZE 0x11 Specifies the size of the measurement and settling windows for the AGC algorithm.
0x20 0x39 MODEM_AGC_RFPD_DECAY 0x10 Sets the decay time of the RF peak detectors.
0x20 0x3a MODEM_AGC_IFPD_DECAY 0x10 Sets the decay time of the IF peak detectors.
0x20 0x3b MODEM_FSK4_GAIN1 0x0b Specifies the gain factor of the secondary branch in 4(G)FSK ISI-suppression.
0x20 0x3c MODEM_FSK4_GAIN0 0x1c Specifies the gain factor of the primary branch in 4(G)FSK ISI-suppression.
0x20 0x3d
0x3e
MODEM_FSK4_TH 0x40
0x00
16 bit 4(G)FSK slicer threshold.
0x20 0x3f MODEM_FSK4_MAP 0x00 4(G)FSK symbol mapping code.
0x20 0x40 MODEM_OOK_PDTC 0x2b Configures the attack and decay times of the OOK Peak Detector.
0x20 0x41 MODEM_OOK_BLOPK 0x0c Configures the slicing reference level of the OOK Peak Detector.
0x20 0x42 MODEM_OOK_CNT1 0xa4 OOK control.
0x20 0x43 MODEM_OOK_MISC 0x03 Selects the detector(s) used for demodulation of an OOK signal, or for demodulation of a (G)FSK signal when using the asynchronous demodulator.
0x20 0x45 MODEM_RAW_CONTROL 0x02 Defines gain and enable controls for raw / nonstandard mode.
0x20 0x46
0x47
MODEM_RAW_EYE 0x00
0xa3
11 bit eye-open detector threshold.
0x20 0x50 MODEM_RAW_SEARCH2 0x00 Defines and controls the search period length for the Moving Average and Min-Max detectors.
0x20 0x51 MODEM_CLKGEN_BAND 0x08 Select PLL Synthesizer output divider ratio as a function of frequency band.
0x20 0x54 MODEM_SPIKE_DET 0x00 Configures the threshold for (G)FSK Spike Detection.
PA (0x22)
Group Number Name Default Summary Feature Available
0x22 0x00 PA_MODE 0x08 Selects the PA operating mode, and selects resolution of PA power adjustment (i.e., step size).
0x22 0x01 PA_PWR_LVL 0x7f Configuration of PA output power level.
0x22 0x02 PA_BIAS_CLKDUTY 0x00 Configuration of the PA Bias and duty cycle of the TX clock source.
0x22 0x03 PA_TC 0x5d Configuration of PA ramping parameters.
0x22 0x04 PA_RAMP_EX 0x80 Select the time constant of the external PA ramp signal.
0x22 0x05 PA_RAMP_DOWN_DELAY 0x23 Delay from the start of the PA ramp down to disabling of the PA output.
SYNTH (0x23)
Group Number Name Default Summary Feature Available
0x23 0x00 SYNTH_PFDCP_CPFF 0x2c Feed forward charge pump current selection.
0x23 0x01 SYNTH_PFDCP_CPINT 0x0e Integration charge pump current selection.
0x23 0x02 SYNTH_VCO_KV 0x0b Gain scaling factors (Kv) for the VCO tuning varactors on both the integrated-path and feed forward path.
0x23 0x03 SYNTH_LPFILT3 0x04 Value of resistor R2 in feed-forward path of loop filter.
0x23 0x04 SYNTH_LPFILT2 0x0c Value of capacitor C2 in feed-forward path of loop filter.
0x23 0x05 SYNTH_LPFILT1 0x73 Value of capacitors C1 and C3 in feed-forward path of loop filter.
0x23 0x06 SYNTH_LPFILT0 0x03 Bias current of the active amplifier in the feed-forward loop filter.
0x23 0x07 SYNTH_VCO_KVCAL 0x05 Scaling entire KV of VCO.
FREQ_CONTROL (0x40)
Group Number Name Default Summary Feature Available
0x40 0x00 FREQ_CONTROL_INTE 0x3c Frac-N PLL Synthesizer integer divide number.
0x40 0x01
0x02
0x03
FREQ_CONTROL_FRAC 0x08
0x00
0x00
Frac-N PLL fraction number.
0x40 0x04
0x05
FREQ_CONTROL_CHANNEL_STEP_SIZE 0x00
0x00
EZ Frequency Programming channel step size.
0x40 0x06 FREQ_CONTROL_W_SIZE 0x20 Set window gating period (in number of crystal reference clock cycles) for counting VCO frequency during calibration.
PTI (0xf0)
Group Number Name Default Summary Feature Available
0xf0 0x00 PTI_CTL 0x80 Packet Trace Interface control fields.
0xf0 0x01
0x02
PTI_BAUD 0x13
0x88
Desired baud rate for the PTI interface.
0xf0 0x03 PTI_LOG_EN 0x00 Enables what the PTI logs.

Command Details

COMMON_COMMANDS

NOP


PART_INFO


FUNC_INFO


SET_PROPERTY


GET_PROPERTY


GPIO_PIN_CFG


FIFO_INFO


GET_INT_STATUS


REQUEST_DEVICE_STATE


CHANGE_STATE


READ_CMD_BUFF


FRR_A_READ


FRR_B_READ


FRR_C_READ


FRR_D_READ


TX_COMMANDS

START_TX


WRITE_TX_FIFO


ADVANCED_COMMANDS

GET_ADC_READING


GET_PH_STATUS


GET_CHIP_STATUS


Property Details

GLOBAL

GLOBAL_XO_TUNE


GLOBAL_CLK_CFG


GLOBAL_LOW_BATT_THRESH


GLOBAL_CONFIG


GLOBAL_WUT_CONFIG


GLOBAL_WUT_M


GLOBAL_WUT_R


GLOBAL_WUT_LDC


GLOBAL_WUT_CAL


INT_CTL

INT_CTL_ENABLE


INT_CTL_PH_ENABLE


INT_CTL_CHIP_ENABLE


FRR_CTL

FRR_CTL_A_MODE


FRR_CTL_B_MODE


FRR_CTL_C_MODE


FRR_CTL_D_MODE


PREAMBLE

PREAMBLE_TX_LENGTH


PREAMBLE_CONFIG_STD_1


PREAMBLE_CONFIG_NSTD


PREAMBLE_CONFIG


PREAMBLE_PATTERN


SYNC

SYNC_CONFIG


SYNC_BITS


SYNC_CONFIG2


PKT

PKT_CRC_CONFIG


PKT_WHT_POLY


PKT_WHT_SEED


PKT_WHT_BIT_NUM


PKT_CONFIG1


PKT_CONFIG2


PKT_TX_THRESHOLD


PKT_FIELD_1_LENGTH


PKT_FIELD_1_CONFIG


PKT_FIELD_1_CRC_CONFIG


PKT_FIELD_2_LENGTH


PKT_FIELD_2_CONFIG


PKT_FIELD_2_CRC_CONFIG


PKT_FIELD_3_LENGTH


PKT_FIELD_3_CONFIG


PKT_FIELD_3_CRC_CONFIG


PKT_FIELD_4_LENGTH


PKT_FIELD_4_CONFIG


PKT_FIELD_4_CRC_CONFIG


PKT_FIELD_5_LENGTH


PKT_FIELD_5_CONFIG


PKT_FIELD_5_CRC_CONFIG


MODEM

MODEM_MOD_TYPE


MODEM_MAP_CONTROL


MODEM_DSM_CTRL


MODEM_DATA_RATE


MODEM_TX_NCO_MODE


MODEM_FREQ_DEV


MODEM_FREQ_OFFSET


MODEM_TX_FILTER_COEFF_8


MODEM_TX_FILTER_COEFF_7


MODEM_TX_FILTER_COEFF_6


MODEM_TX_FILTER_COEFF_5


MODEM_TX_FILTER_COEFF_4


MODEM_TX_FILTER_COEFF_3


MODEM_TX_FILTER_COEFF_2


MODEM_TX_FILTER_COEFF_1


MODEM_TX_FILTER_COEFF_0


MODEM_TX_RAMP_DELAY


MODEM_MDM_CTRL


MODEM_IF_CONTROL


MODEM_IF_FREQ


MODEM_DECIMATION_CFG1


MODEM_DECIMATION_CFG0


MODEM_DECIMATION_CFG2


MODEM_IFPKD_THRESHOLDS


MODEM_BCR_OSR


MODEM_BCR_NCO_OFFSET


MODEM_BCR_GAIN


MODEM_BCR_GEAR


MODEM_BCR_MISC1


MODEM_BCR_MISC0


MODEM_AFC_GEAR


MODEM_AFC_WAIT


MODEM_AFC_GAIN


MODEM_AFC_LIMITER


MODEM_AFC_MISC


MODEM_AFC_ZIFOFF


MODEM_ADC_CTRL


MODEM_AGC_CONTROL


MODEM_AGC_WINDOW_SIZE


MODEM_AGC_RFPD_DECAY


MODEM_AGC_IFPD_DECAY


MODEM_FSK4_GAIN1


MODEM_FSK4_GAIN0


MODEM_FSK4_TH


MODEM_FSK4_MAP


MODEM_OOK_PDTC


MODEM_OOK_BLOPK


MODEM_OOK_CNT1


MODEM_OOK_MISC


MODEM_RAW_CONTROL


MODEM_RAW_EYE


MODEM_RAW_SEARCH2


MODEM_CLKGEN_BAND


MODEM_SPIKE_DET


PA

PA_MODE


PA_PWR_LVL


PA_BIAS_CLKDUTY


PA_TC


PA_RAMP_EX


PA_RAMP_DOWN_DELAY


SYNTH

SYNTH_PFDCP_CPFF


SYNTH_PFDCP_CPINT


SYNTH_VCO_KV


SYNTH_LPFILT3


SYNTH_LPFILT2


SYNTH_LPFILT1


SYNTH_LPFILT0


SYNTH_VCO_KVCAL


FREQ_CONTROL

FREQ_CONTROL_INTE


FREQ_CONTROL_FRAC


FREQ_CONTROL_CHANNEL_STEP_SIZE


FREQ_CONTROL_W_SIZE


PTI

PTI_CTL


PTI_BAUD


PTI_LOG_EN