Type definitions#

Modules#

sid_pal_radio_fsk_cad_params_t

sid_pal_radio_fsk_modulation_params_t

sid_pal_radio_fsk_packet_params_t

sid_pal_radio_fsk_phy_hdr_t

sid_pal_radio_fsk_pkt_cfg_t

sid_pal_radio_fsk_rx_packet_status_t

sid_pal_radio_fsk_phy_settings_t

Enumerations#

enum
sid_pal_radio_fsk_header_type {
SID_PAL_RADIO_FSK_SIDEWALK_HEADER = 0
SID_PAL_RADIO_FSK_CUSTOM_HEADER = 1
}

Sidewalk Phy FSK header type.

enum
radio_fsk_fcs_t {
RADIO_FSK_FCS_TYPE_0 = 0
RADIO_FSK_FCS_TYPE_1 = 1
}

Radio FSK FCS enumeration definition.

Macros#

#define
SID_PAL_RADIO_FSK_MOD_SHAPING_OFF 0x00

Radio Mod Shaping parameter.

#define
SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_03 0x08

Gaussian shaping with BT = 0.3.

#define
SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_05 0x09

Gaussian shaping with BT = 0.5.

#define
SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_07 0x0A

Gaussian shaping with BT = 0.7.

#define
SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_1 0x0B

Gaussian shaping with BT = 1.0.

#define
SID_PAL_RADIO_FSK_BW_4800 0x1F

Bandwidth.

#define
SID_PAL_RADIO_FSK_BW_5800 0x07

Bandwidth of 5800 Hz.

#define
SID_PAL_RADIO_FSK_BW_7300 0x0F

Bandwidth of 7300 Hz.

#define
SID_PAL_RADIO_FSK_BW_9700 0x1E

Bandwidth of 9700 Hz.

#define
SID_PAL_RADIO_FSK_BW_11700 0x16

Bandwidth of 11700 Hz.

#define
SID_PAL_RADIO_FSK_BW_14600 0x0E

Bandwidth of 14600 Hz.

#define
SID_PAL_RADIO_FSK_BW_19500 0x1D

Bandwidth of 19500 Hz.

#define
SID_PAL_RADIO_FSK_BW_23400 0x15

Bandwidth of 23400 Hz.

#define
SID_PAL_RADIO_FSK_BW_29300 0x0D

Bandwidth of 29300 Hz.

#define
SID_PAL_RADIO_FSK_BW_39000 0x1C

Bandwidth of 39000 Hz.

#define
SID_PAL_RADIO_FSK_BW_46900 0x14

Bandwidth of 46900 Hz.

#define
SID_PAL_RADIO_FSK_BW_58600 0x0C

Bandwidth of 58600 Hz.

#define
SID_PAL_RADIO_FSK_BW_78200 0x1B

Bandwidth of 78200 Hz.

#define
SID_PAL_RADIO_FSK_BW_93800 0x13

Bandwidth of 93800 Hz.

#define
SID_PAL_RADIO_FSK_BW_117300 0x0B

Bandwidth of 117300 Hz.

#define
SID_PAL_RADIO_FSK_BW_156200 0x1A

Bandwidth of 156200 Hz.

#define
SID_PAL_RADIO_FSK_BW_187200 0x12

Bandwidth of 187200 Hz.

#define
SID_PAL_RADIO_FSK_BW_234300 0x0A

Bandwidth of 234300 Hz.

#define
SID_PAL_RADIO_FSK_BW_312000 0x19

Bandwidth of 312000 Hz.

#define
SID_PAL_RADIO_FSK_BW_373600 0x11

Bandwidth of 373600 Hz.

#define
SID_PAL_RADIO_FSK_BW_467000 0x09

Bandwidth of 467000 Hz.

#define
SID_PAL_RADIO_FSK_BW_100KHZ SID_PAL_RADIO_FSK_BW_93800

Bandwidth of 100000 Hz.

#define
SID_PAL_RADIO_FSK_BW_117KHZ SID_PAL_RADIO_FSK_BW_117300

Bandwidth of 117000 Hz.

#define
SID_PAL_RADIO_FSK_BW_125KHZ SID_PAL_RADIO_FSK_BW_156200

Bandwidth of 125000 Hz.

#define
SID_PAL_RADIO_FSK_BW_150KHZ SID_PAL_RADIO_FSK_BW_156200

Bandwidth of 150000 Hz.

#define
SID_PAL_RADIO_FSK_BW_250KHZ SID_PAL_RADIO_FSK_BW_312000

Bandwidth of 250000 Hz.

#define
SID_PAL_RADIO_FSK_BW_500KHZ SID_PAL_RADIO_FSK_BW_467000

Bandwidth of 500000 Hz.

#define
SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_OFF 0x00

Radio Preamble detection.

#define
SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_08_BITS 0x04

Preamble detection of 8 bits.

#define
SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_16_BITS 0x05

Preamble detection of 16 bits.

#define
SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_24_BITS 0x06

Preamble detection of 24 bits.

#define
SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_32_BITS 0x07

Preamble detection of 32 bits.

#define
SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_OFF 0x00

Radio sync word correlators activated.

#define
SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE 0x01

Address comparison node.

#define
SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE_BROAD 0x02

Address comparison node and broadcast.

#define
SID_PAL_RADIO_FSK_RADIO_PACKET_FIXED_LENGTH 0x00

Radio packet length modes.

#define
SID_PAL_RADIO_FSK_RADIO_PACKET_VARIABLE_LENGTH 0x01

Variable length packet.

#define
SID_PAL_RADIO_FSK_CRC_OFF 0x01

packet params crc types

#define
SID_PAL_RADIO_FSK_CRC_1_BYTES 0x00

CRC 1 byte.

#define
SID_PAL_RADIO_FSK_CRC_2_BYTES 0x02

CRC 2 bytes.

#define
SID_PAL_RADIO_FSK_CRC_1_BYTES_INV 0x04

CRC 1 byte inverted.

#define
SID_PAL_RADIO_FSK_CRC_2_BYTES_INV 0x06

CRC 2 bytes inverted.

#define
SID_PAL_RADIO_FSK_CRC_2_BYTES_IBM 0xF1

CRC 2 bytes IBM.

#define
SID_PAL_RADIO_FSK_CRC_2_BYTES_CCIT 0xF2

CRC 2 bytes CCIT.

#define
SID_PAL_RADIO_FSK_DC_FREE_OFF 0x00

packet params Radio whitening mode

#define
SID_PAL_RADIO_FSK_DC_FREEWHITENING 0x01

DC free whitening.

#define
SID_PAL_RADIO_FSK_WHITENING_SEED 0x01FF

Default whitening seed.

#define
SID_PAL_RADIO_FSK_SYNC_WORD_LENGTH 8

Length of the sync word in bits.

#define
SECS_TO_MUS (X)

timeout duration in usec.

#define
SID_PAL_RADIO_FSK_DEFAULT_TX_TIMEOUT SECS_TO_MUS(5)

set max radio timeout to 5sec

#define
SID_PAL_RADIO_FSK_TIMEOUT_DURATION_1_SEC SECS_TO_MUS(1)

1 sec timeout used by diagnostics code

#define
SID_MAX_CUSTOM_PHYHDR_SZ 4

Defines the maximum size of the custom PHY header.

Enumeration Documentation#

sid_pal_radio_fsk_header_type#

sid_pal_radio_fsk_header_type

Sidewalk Phy FSK header type.

Enumerator
SID_PAL_RADIO_FSK_SIDEWALK_HEADER

Sidewalk-specific header

SID_PAL_RADIO_FSK_CUSTOM_HEADER

Custom header


radio_fsk_fcs_t#

radio_fsk_fcs_t

Radio FSK FCS enumeration definition.

Enumerator
RADIO_FSK_FCS_TYPE_0

4-octet FCS

RADIO_FSK_FCS_TYPE_1

2-octet FCS


Macro Definition Documentation#

SID_PAL_RADIO_FSK_MOD_SHAPING_OFF#

#define SID_PAL_RADIO_FSK_MOD_SHAPING_OFF
Value:
0x00

Radio Mod Shaping parameter.

No modulation shaping.


SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_03#

#define SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_03
Value:
0x08

Gaussian shaping with BT = 0.3.


SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_05#

#define SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_05
Value:
0x09

Gaussian shaping with BT = 0.5.


SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_07#

#define SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_07
Value:
0x0A

Gaussian shaping with BT = 0.7.


SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_1#

#define SID_PAL_RADIO_FSK_MOD_SHAPING_G_BT_1
Value:
0x0B

Gaussian shaping with BT = 1.0.


SID_PAL_RADIO_FSK_BW_4800#

#define SID_PAL_RADIO_FSK_BW_4800
Value:
0x1F

Bandwidth.

Bandwidth of 4800 Hz.


SID_PAL_RADIO_FSK_BW_5800#

#define SID_PAL_RADIO_FSK_BW_5800
Value:
0x07

Bandwidth of 5800 Hz.


SID_PAL_RADIO_FSK_BW_7300#

#define SID_PAL_RADIO_FSK_BW_7300
Value:
0x0F

Bandwidth of 7300 Hz.


SID_PAL_RADIO_FSK_BW_9700#

#define SID_PAL_RADIO_FSK_BW_9700
Value:
0x1E

Bandwidth of 9700 Hz.


SID_PAL_RADIO_FSK_BW_11700#

#define SID_PAL_RADIO_FSK_BW_11700
Value:
0x16

Bandwidth of 11700 Hz.


SID_PAL_RADIO_FSK_BW_14600#

#define SID_PAL_RADIO_FSK_BW_14600
Value:
0x0E

Bandwidth of 14600 Hz.


SID_PAL_RADIO_FSK_BW_19500#

#define SID_PAL_RADIO_FSK_BW_19500
Value:
0x1D

Bandwidth of 19500 Hz.


SID_PAL_RADIO_FSK_BW_23400#

#define SID_PAL_RADIO_FSK_BW_23400
Value:
0x15

Bandwidth of 23400 Hz.


SID_PAL_RADIO_FSK_BW_29300#

#define SID_PAL_RADIO_FSK_BW_29300
Value:
0x0D

Bandwidth of 29300 Hz.


SID_PAL_RADIO_FSK_BW_39000#

#define SID_PAL_RADIO_FSK_BW_39000
Value:
0x1C

Bandwidth of 39000 Hz.


SID_PAL_RADIO_FSK_BW_46900#

#define SID_PAL_RADIO_FSK_BW_46900
Value:
0x14

Bandwidth of 46900 Hz.


SID_PAL_RADIO_FSK_BW_58600#

#define SID_PAL_RADIO_FSK_BW_58600
Value:
0x0C

Bandwidth of 58600 Hz.


SID_PAL_RADIO_FSK_BW_78200#

#define SID_PAL_RADIO_FSK_BW_78200
Value:
0x1B

Bandwidth of 78200 Hz.


SID_PAL_RADIO_FSK_BW_93800#

#define SID_PAL_RADIO_FSK_BW_93800
Value:
0x13

Bandwidth of 93800 Hz.


SID_PAL_RADIO_FSK_BW_117300#

#define SID_PAL_RADIO_FSK_BW_117300
Value:
0x0B

Bandwidth of 117300 Hz.


SID_PAL_RADIO_FSK_BW_156200#

#define SID_PAL_RADIO_FSK_BW_156200
Value:
0x1A

Bandwidth of 156200 Hz.


SID_PAL_RADIO_FSK_BW_187200#

#define SID_PAL_RADIO_FSK_BW_187200
Value:
0x12

Bandwidth of 187200 Hz.


SID_PAL_RADIO_FSK_BW_234300#

#define SID_PAL_RADIO_FSK_BW_234300
Value:
0x0A

Bandwidth of 234300 Hz.


SID_PAL_RADIO_FSK_BW_312000#

#define SID_PAL_RADIO_FSK_BW_312000
Value:
0x19

Bandwidth of 312000 Hz.


SID_PAL_RADIO_FSK_BW_373600#

#define SID_PAL_RADIO_FSK_BW_373600
Value:
0x11

Bandwidth of 373600 Hz.


SID_PAL_RADIO_FSK_BW_467000#

#define SID_PAL_RADIO_FSK_BW_467000
Value:
0x09

Bandwidth of 467000 Hz.


SID_PAL_RADIO_FSK_BW_100KHZ#

#define SID_PAL_RADIO_FSK_BW_100KHZ
Value:
SID_PAL_RADIO_FSK_BW_93800

Bandwidth of 100000 Hz.


SID_PAL_RADIO_FSK_BW_117KHZ#

#define SID_PAL_RADIO_FSK_BW_117KHZ
Value:
SID_PAL_RADIO_FSK_BW_117300

Bandwidth of 117000 Hz.


SID_PAL_RADIO_FSK_BW_125KHZ#

#define SID_PAL_RADIO_FSK_BW_125KHZ
Value:
SID_PAL_RADIO_FSK_BW_156200

Bandwidth of 125000 Hz.


SID_PAL_RADIO_FSK_BW_150KHZ#

#define SID_PAL_RADIO_FSK_BW_150KHZ
Value:
SID_PAL_RADIO_FSK_BW_156200

Bandwidth of 150000 Hz.


SID_PAL_RADIO_FSK_BW_250KHZ#

#define SID_PAL_RADIO_FSK_BW_250KHZ
Value:
SID_PAL_RADIO_FSK_BW_312000

Bandwidth of 250000 Hz.


SID_PAL_RADIO_FSK_BW_500KHZ#

#define SID_PAL_RADIO_FSK_BW_500KHZ
Value:
SID_PAL_RADIO_FSK_BW_467000

Bandwidth of 500000 Hz.


SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_OFF#

#define SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_OFF
Value:
0x00

Radio Preamble detection.

Preamble detection off.


SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_08_BITS#

#define SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_08_BITS
Value:
0x04

Preamble detection of 8 bits.


SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_16_BITS#

#define SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_16_BITS
Value:
0x05

Preamble detection of 16 bits.


SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_24_BITS#

#define SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_24_BITS
Value:
0x06

Preamble detection of 24 bits.


SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_32_BITS#

#define SID_PAL_RADIO_FSK_PREAMBLE_DETECTOR_32_BITS
Value:
0x07

Preamble detection of 32 bits.


SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_OFF#

#define SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_OFF
Value:
0x00

Radio sync word correlators activated.

Address comparison off.


SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE#

#define SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE
Value:
0x01

Address comparison node.


SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE_BROAD#

#define SID_PAL_RADIO_FSK_ADDRESSCOMP_FILT_NODE_BROAD
Value:
0x02

Address comparison node and broadcast.


SID_PAL_RADIO_FSK_RADIO_PACKET_FIXED_LENGTH#

#define SID_PAL_RADIO_FSK_RADIO_PACKET_FIXED_LENGTH
Value:
0x00

Radio packet length modes.

Fixed length packet.


SID_PAL_RADIO_FSK_RADIO_PACKET_VARIABLE_LENGTH#

#define SID_PAL_RADIO_FSK_RADIO_PACKET_VARIABLE_LENGTH
Value:
0x01

Variable length packet.


SID_PAL_RADIO_FSK_CRC_OFF#

#define SID_PAL_RADIO_FSK_CRC_OFF
Value:
0x01

packet params crc types

CRC off.


SID_PAL_RADIO_FSK_CRC_1_BYTES#

#define SID_PAL_RADIO_FSK_CRC_1_BYTES
Value:
0x00

CRC 1 byte.


SID_PAL_RADIO_FSK_CRC_2_BYTES#

#define SID_PAL_RADIO_FSK_CRC_2_BYTES
Value:
0x02

CRC 2 bytes.


SID_PAL_RADIO_FSK_CRC_1_BYTES_INV#

#define SID_PAL_RADIO_FSK_CRC_1_BYTES_INV
Value:
0x04

CRC 1 byte inverted.


SID_PAL_RADIO_FSK_CRC_2_BYTES_INV#

#define SID_PAL_RADIO_FSK_CRC_2_BYTES_INV
Value:
0x06

CRC 2 bytes inverted.


SID_PAL_RADIO_FSK_CRC_2_BYTES_IBM#

#define SID_PAL_RADIO_FSK_CRC_2_BYTES_IBM
Value:
0xF1

CRC 2 bytes IBM.


SID_PAL_RADIO_FSK_CRC_2_BYTES_CCIT#

#define SID_PAL_RADIO_FSK_CRC_2_BYTES_CCIT
Value:
0xF2

CRC 2 bytes CCIT.


SID_PAL_RADIO_FSK_DC_FREE_OFF#

#define SID_PAL_RADIO_FSK_DC_FREE_OFF
Value:
0x00

packet params Radio whitening mode

DC free off.


SID_PAL_RADIO_FSK_DC_FREEWHITENING#

#define SID_PAL_RADIO_FSK_DC_FREEWHITENING
Value:
0x01

DC free whitening.


SID_PAL_RADIO_FSK_WHITENING_SEED#

#define SID_PAL_RADIO_FSK_WHITENING_SEED
Value:
0x01FF

Default whitening seed.


SID_PAL_RADIO_FSK_SYNC_WORD_LENGTH#

#define SID_PAL_RADIO_FSK_SYNC_WORD_LENGTH
Value:
8

Length of the sync word in bits.


SECS_TO_MUS#

#define SECS_TO_MUS
Value:
(X)

timeout duration in usec.

the conversion to semtec ticks is done by start_rx() start_tx()


SID_PAL_RADIO_FSK_DEFAULT_TX_TIMEOUT#

#define SID_PAL_RADIO_FSK_DEFAULT_TX_TIMEOUT
Value:
SECS_TO_MUS(5)

set max radio timeout to 5sec


SID_PAL_RADIO_FSK_TIMEOUT_DURATION_1_SEC#

#define SID_PAL_RADIO_FSK_TIMEOUT_DURATION_1_SEC
Value:
SECS_TO_MUS(1)

1 sec timeout used by diagnostics code


SID_MAX_CUSTOM_PHYHDR_SZ#

#define SID_MAX_CUSTOM_PHYHDR_SZ
Value:
4

Defines the maximum size of the custom PHY header.