Si4455 revB1B 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

BOOT_COMMANDS
Number Name Summary Feature Available
0x02 POWER_UP Command to power-up the device and select the operational mode and functionality.
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.
RX_COMMANDS
Number Name Summary Feature Available
0x16 PACKET_INFO Returns information about the length of the variable field in the last packet received, and (optionally) overrides field length.
0x22 GET_MODEM_STATUS Returns the interrupt status of the Modem Interrupt Group (both STATUS and PENDING). Optionally, it may be used to clear latched (PENDING) interrupt events.
0x32 START_RX Switches to RX state and starts reception of a packet.
0x77 READ_RX_FIFO Reads data byte(s) from the RX 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.
EZCONFIG_COMMANDS
Number Name Summary Feature Available
0x19 EZCONFIG_CHECK Validates the EZConfig array was written correctly.
0x66 EZCONFIG_ARRAY_WRITE Writes data byte(s) to the EZConfig array.

Property Summary

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 0x02 INT_CTL_MODEM_ENABLE 0x00 Enable individual interrupt sources within the Modem 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.
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.
PA (0x22)
Group Number Name Default Summary Feature Available
0x22 0x01 PA_PWR_LVL 0x7f Configuration of PA output power level.
EZCONFIG (0x24)
Group Number Name Default Summary Feature Available
0x24 0x00 EZCONFIG_MODULATION 0x02 Selects the type of modulation using the EZConfig feature.
0x24 0x03 EZCONFIG_XO_TUNE 0x40 Configure the internal capacitor frequency tuning bank for the crystal oscillator.
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.

Command Details

BOOT_COMMANDS

POWER_UP


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


RX_COMMANDS

PACKET_INFO


GET_MODEM_STATUS


START_RX


READ_RX_FIFO


ADVANCED_COMMANDS

GET_ADC_READING


GET_PH_STATUS


GET_CHIP_STATUS


EZCONFIG_COMMANDS

EZCONFIG_CHECK


EZCONFIG_ARRAY_WRITE


Property Details

INT_CTL

INT_CTL_ENABLE


INT_CTL_PH_ENABLE


INT_CTL_MODEM_ENABLE


INT_CTL_CHIP_ENABLE


FRR_CTL

FRR_CTL_A_MODE


FRR_CTL_B_MODE


FRR_CTL_C_MODE


FRR_CTL_D_MODE


SYNC

SYNC_CONFIG


SYNC_BITS


PA

PA_PWR_LVL


EZCONFIG

EZCONFIG_MODULATION


EZCONFIG_XO_TUNE


FREQ_CONTROL

FREQ_CONTROL_INTE


FREQ_CONTROL_FRAC


FREQ_CONTROL_CHANNEL_STEP_SIZE