CCxxxx Driver  0.0.1
Macros | Enumerations
Registers: Status

Status Register Addresses. More...

Macros

#define CCX_REG_STATUS_PARTNUM   0x30
 Part number.
 
#define CCX_REG_STATUS_VERSION   0x31
 Current version number.
 
#define CCX_REG_STATUS_FREQEST   0x32
 Frequency offset estimate.
 
#define CCX_REG_STATUS_LQI   0x33
 Demodulator estimate for link quality.
 
#define CCX_REG_STATUS_RSSI   0x34
 Received signal strength indication.
 
#define CCX_REG_STATUS_MARCSTATE   0x35
 Control state machine state.
 
#define CCX_REG_STATUS_WORTIME1   0x36
 High byte of WOR timer.
 
#define CCX_REG_STATUS_WORTIME0   0x37
 Low byte of WOR timer.
 
#define CCX_REG_STATUS_PKTSTATUS   0x38
 Current GDOx status and packet status.
 
#define CCX_REG_STATUS_VCO_VC_DAC   0x39
 Current setting from PLL cal module.
 
#define CCX_REG_STATUS_TXBYTES   0x3A
 Underflow and # of bytes in TXFIFO.
 
#define CCX_REG_STATUS_RXBYTES   0x3B
 Overflow and # of bytes in RXFIFO.
 
#define CCX_MARCSTATE_GET_STATE(_MS)   CCX_GET_BITS_VALUE((_MS), 5, 0)
 Retrives the value of the Main Radio Control FSM state. More...
 
#define CCX_MARCSTATE_IS_IN_TX(_MS)
 Determines if the Main Radio Control FSM state is transmit mode. More...
 
#define CCX_PKTSTATUS_GET_CRC_OK(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 7)
 Obtain CRC_OK from contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_PQT_REACHED(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 5)
 Obtain PQT_REACHED from contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_PQT_REACHED(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 5)
 Obtain PQT_REACHED from contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_CCA(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 4)
 Obtain CCA from contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_SFD(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 3)
 Obtain SDF from the contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_GDO2(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 2)
 Obtain GDO2 from the contents of the Packet Status register. More...
 
#define CCX_PKTSTATUS_GET_GDO0(_PS)   CCX_GET_BITS_VALUE((_PS), 1, 0)
 Obtain GDB0 from the contents of the Packet Status register. More...
 
#define CCX_TX_FIFO_MAX   64
 The size, in bytes, of the Transmit FIFO.
 
#define CCX_TX_BYTES_IS_UNDERFLOW(_TX)   CCX_GET_BITS_VALUE(_TX, 1, 7)
 Obtain TXFIFO_UNDERFLOW from a prior reading of the TX Underflow and Number of bytes register. More...
 
#define CCX_TX_BYTES_IN_FIFO(_TX)   CCX_GET_BITS_VALUE(_TX, 7, 0)
 Obtain NUM_TXBYTES from a prior reading of TX Underflow and Number of bytes register. More...
 
#define CCX_RX_FIFO_MAX   64
 The size, in bytes, of the Receive FIFO.
 
#define CCX_RX_BYTES_IS_OVERFLOW(_RX)   CCX_GET_BITS_VALUE(_RX, 1, 7)
 Obtain RXFIFO_OVERFLOW from a prior reading of Rx Overflow and Number of bytes register. More...
 
#define CCX_RX_BYTES_IN_FIFO(_RX)   CCX_GET_BITS_VALUE(_RX, 7, 0)
 Obtain NUM_RXBYTES from a prior reading of RX Underflow and Number of bytes register. More...
 

Enumerations

enum  CcxMarcState {
  CCX_MARCSTATE_SLEEP = 0x00, CCX_MARCSTATE_IDLE = 0x01, CCX_MARCSTATE_XOFF = 0x02, CCX_MARCSTATE_VCOON_MC = 0x03,
  CCX_MARCSTATE_REGON_MC = 0x04, CCX_MARCSTATE_MANCAL = 0x05, CCX_MARCSTATE_VCOON = 0x06, CCX_MARCSTATE_REGON = 0x07,
  CCX_MARCSTATE_STARTCAL = 0x08, CCX_MARCSTATE_BWBOOST = 0x09, CCX_MARCSTATE_FS_LOCK = 0x0A, CCX_MARCSTATE_IFADCON = 0x0B,
  CCX_MARCSTATE_ENDCAL = 0x0C, CCX_MARCSTATE_RX = 0x0D, CCX_MARCSTATE_RX_END = 0x0E, CCX_MARCSTATE_RX_RST = 0x0F,
  CCX_MARCSTATE_TXRX_SWITCH = 0x10, CCX_MARCSTATE_RXFIFO_OVERFLOW = 0x11, CCX_MARCSTATE_FSTXON = 0x12, CCX_MARCSTATE_TX = 0x13,
  CCX_MARCSTATE_TX_END = 0x14, CCX_MARCSTATE_RXTX_SWITCH = 0x15, CCX_MARCSTATE_TXFIFO_UNDERFLOW = 0x16
}
 Values of the possible Main Radio Control FSM States. The field is present within CCX_REG_STATUS_MARCSTATE and can be retrieved with CCX_MARCSTATE_GET_STATE. More...
 

Detailed Description

Status Register Addresses.

Macro Definition Documentation

◆ CCX_MARCSTATE_GET_STATE

#define CCX_MARCSTATE_GET_STATE (   _MS)    CCX_GET_BITS_VALUE((_MS), 5, 0)

Retrives the value of the Main Radio Control FSM state.

Parameters
_MSMarcstate register value, obtained from CCX_REG_STATUS_MARCSTATE.
Returns
Value from CcxMarcState

◆ CCX_MARCSTATE_IS_IN_TX

#define CCX_MARCSTATE_IS_IN_TX (   _MS)
Value:
CCX_MARCSTATE_GET_STATE((_MS)) == CCX_MARCSTATE_TX || \
CCX_MARCSTATE_GET_STATE((_MS)) == CCX_MARCSTATE_TX_END)
Definition: cc1100_cc2500.h:177
Definition: cc1100_cc2500.h:175
Definition: cc1100_cc2500.h:176
#define CCX_MARCSTATE_GET_STATE(_MS)
Retrives the value of the Main Radio Control FSM state.
Definition: cc1100_cc2500.h:191

Determines if the Main Radio Control FSM state is transmit mode.

Parameters
_MSMarcstate register value, obtained from CCX_REG_STATUS_MARCSTATE.
Returns
Logical true if MARC State suggests radio is in transmit mode.

◆ CCX_PKTSTATUS_GET_CCA

#define CCX_PKTSTATUS_GET_CCA (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 4)

Obtain CCA from contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit Channel is Clear (CCA) value.

◆ CCX_PKTSTATUS_GET_CRC_OK

#define CCX_PKTSTATUS_GET_CRC_OK (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 7)

Obtain CRC_OK from contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit CRC comparison matched (CRC_OK) value.

◆ CCX_PKTSTATUS_GET_GDO0

#define CCX_PKTSTATUS_GET_GDO0 (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 0)

Obtain GDB0 from the contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit GD00 value.

◆ CCX_PKTSTATUS_GET_GDO2

#define CCX_PKTSTATUS_GET_GDO2 (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 2)

Obtain GDO2 from the contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit GD02 value.

◆ CCX_PKTSTATUS_GET_PQT_REACHED [1/2]

#define CCX_PKTSTATUS_GET_PQT_REACHED (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 5)

Obtain PQT_REACHED from contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit Preamble Quality Reached (PQT_REACHED) value.

◆ CCX_PKTSTATUS_GET_PQT_REACHED [2/2]

#define CCX_PKTSTATUS_GET_PQT_REACHED (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 5)

Obtain PQT_REACHED from contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit Preamble Quality Reached (PQT_REACHED) value.

◆ CCX_PKTSTATUS_GET_SFD

#define CCX_PKTSTATUS_GET_SFD (   _PS)    CCX_GET_BITS_VALUE((_PS), 1, 3)

Obtain SDF from the contents of the Packet Status register.

Parameters
_PSValue obtained from reading CCX_REG_STATUS_PKTSTATUS.
Returns
Single bit Start of Frame Delimiter (SFD) bit.

◆ CCX_RX_BYTES_IN_FIFO

#define CCX_RX_BYTES_IN_FIFO (   _RX)    CCX_GET_BITS_VALUE(_RX, 7, 0)

Obtain NUM_RXBYTES from a prior reading of RX Underflow and Number of bytes register.

Parameters
_RXValue obtained from reading CCX_REG_STATUS_RXBYTES.
Returns
Number of bytes in RX FIFO (NUM_RXBYTES).

◆ CCX_RX_BYTES_IS_OVERFLOW

#define CCX_RX_BYTES_IS_OVERFLOW (   _RX)    CCX_GET_BITS_VALUE(_RX, 1, 7)

Obtain RXFIFO_OVERFLOW from a prior reading of Rx Overflow and Number of bytes register.

Parameters
_RXValue obtained from reading CCX_REG_STATUS_RXBYTES.
Returns
Single bit value of RXFIFO_OVERFLOW.

◆ CCX_TX_BYTES_IN_FIFO

#define CCX_TX_BYTES_IN_FIFO (   _TX)    CCX_GET_BITS_VALUE(_TX, 7, 0)

Obtain NUM_TXBYTES from a prior reading of TX Underflow and Number of bytes register.

Parameters
_TXValue obtained from reading CCX_REG_STATUS_TXBYTES.
Returns
Number of bytes in TX FIFO (NUM_TXBYTES).

◆ CCX_TX_BYTES_IS_UNDERFLOW

#define CCX_TX_BYTES_IS_UNDERFLOW (   _TX)    CCX_GET_BITS_VALUE(_TX, 1, 7)

Obtain TXFIFO_UNDERFLOW from a prior reading of the TX Underflow and Number of bytes register.

Parameters
_TXValue obtained from reading CCX_REG_STATUS_TXBYTES.
Returns
Single bit value of TXFIFO_UNDERFLOW.

Enumeration Type Documentation

◆ CcxMarcState

Values of the possible Main Radio Control FSM States. The field is present within CCX_REG_STATUS_MARCSTATE and can be retrieved with CCX_MARCSTATE_GET_STATE.

Enumerator
CCX_MARCSTATE_SLEEP 

SLEEP

CCX_MARCSTATE_IDLE 

IDLE

CCX_MARCSTATE_XOFF 

XOFF

CCX_MARCSTATE_VCOON_MC 

MANCAL

CCX_MARCSTATE_REGON_MC 

MANCAL

CCX_MARCSTATE_MANCAL 

MANCAL

CCX_MARCSTATE_VCOON 

FS_WAKEUP

CCX_MARCSTATE_REGON 

FS_WAKEUP

CCX_MARCSTATE_STARTCAL 

CALIBRATE

CCX_MARCSTATE_BWBOOST 

SETTLING

CCX_MARCSTATE_FS_LOCK 

SETTLING

CCX_MARCSTATE_IFADCON 

SETTLING

CCX_MARCSTATE_ENDCAL 

CALIBRATE

CCX_MARCSTATE_RX 

RX

CCX_MARCSTATE_RX_END 

RX

CCX_MARCSTATE_RX_RST 

RX

CCX_MARCSTATE_TXRX_SWITCH 

TXRX_SETTLING

CCX_MARCSTATE_RXFIFO_OVERFLOW 

RXFIFO_OVERFLOW

CCX_MARCSTATE_FSTXON 

FSTXON

CCX_MARCSTATE_TX 

TX

CCX_MARCSTATE_TX_END 

TX

CCX_MARCSTATE_RXTX_SWITCH 

RXTX_SETTLING

CCX_MARCSTATE_TXFIFO_UNDERFLOW 

TXFIFO_UNDERFLOW