Type definitions#

Modules#

Enumerations#

enum

sid_pal_radio_region_code_t {

SID_PAL_RADIO_RC_NONE = 0

SID_PAL_RADIO_RC_NA = 1

SID_PAL_RADIO_RC_EU = 2

SID_PAL_RADIO_RC_JP = 3

SID_PAL_RADIO_RC_MAX

}

Sidewalk Phy Radio Region For Regional Config.

enum

sid_pal_radio_modem_mode_t {

SID_PAL_RADIO_MODEM_MODE_FSK = 0

SID_PAL_RADIO_MODEM_MODE_LORA = 1

}

Sidewalk Phy Radio Modem Mode.

enum

sid_pal_radio_events_t {

SID_PAL_RADIO_EVENT_UNKNOWN = 0

SID_PAL_RADIO_EVENT_TX_DONE = 1

SID_PAL_RADIO_EVENT_RX_DONE = 2

SID_PAL_RADIO_EVENT_CAD_DONE = 3

SID_PAL_RADIO_EVENT_CAD_TIMEOUT = 4

SID_PAL_RADIO_EVENT_RX_ERROR = 5

SID_PAL_RADIO_EVENT_TX_TIMEOUT = 6

SID_PAL_RADIO_EVENT_RX_TIMEOUT = 7

SID_PAL_RADIO_EVENT_CS_DONE = 8

SID_PAL_RADIO_EVENT_CS_TIMEOUT = 9

SID_PAL_RADIO_EVENT_HEADER_ERROR = 10

SID_PAL_RADIO_EVENT_SYNC_DET = 11

}

Sidewalk Phy Radio Event.

enum

sid_pal_radio_data_rate_t {

SID_PAL_RADIO_DATA_RATE_INVALID = 0

SID_PAL_RADIO_DATA_RATE_2KBPS = 1

SID_PAL_RADIO_DATA_RATE_22KBPS = 2

SID_PAL_RADIO_DATA_RATE_50KBPS = 3

SID_PAL_RADIO_DATA_RATE_150KBPS = 4

SID_PAL_RADIO_DATA_RATE_250KBPS = 5

SID_PAL_RADIO_DATA_RATE_12_5KBPS = 6

SID_PAL_RADIO_DATA_RATE_CUSTOM = 7

SID_PAL_RADIO_DATA_RATE_MAX_NUM = SID_PAL_RADIO_DATA_RATE_CUSTOM

}

Sidewalk Phy Radio Data Rate.

enum

sid_pal_radio_cad_param_exit_mode_t {

SID_PAL_RADIO_CAD_EXIT_MODE_CS_ONLY = 0x00

SID_PAL_RADIO_CAD_EXIT_MODE_CS_RX = 0x01

SID_PAL_RADIO_CAD_EXIT_MODE_CS_LBT = 0x10

SID_PAL_RADIO_CAD_EXIT_MODE_CS_LBT_RX = 0x11

SID_PAL_RADIO_CAD_EXIT_MODE_ED_ONLY = 0x100

SID_PAL_RADIO_CAD_EXIT_MODE_ED_RX = 0x101

SID_PAL_RADIO_CAD_EXIT_MODE_ED_LBT = 0x110

SID_PAL_RADIO_CAD_EXIT_MODE_NONE = 0x10000

}

Sidewalk Phy Radio CAD (Channel Activity Detection) Exit Mode.

enum

sid_pal_radio_irq_mask_t {

RADIO_IRQ_NONE = (0 << 0)

RADIO_IRQ_TX_DONE = (1 << 0)

RADIO_IRQ_RX_DONE = (1 << 1)

RADIO_IRQ_PREAMBLE_DETECT = (1 << 2)

RADIO_IRQ_VALID_SYNC_WORD = (1 << 3)

RADIO_IRQ_VALID_HEADER = (1 << 4)

RADIO_IRQ_ERROR_HEADER = (1 << 5)

RADIO_IRQ_ERROR_CRC = (1 << 6)

RADIO_IRQ_CAD_DONE = (1 << 7)

RADIO_IRQ_CAD_DETECT = (1 << 8)

RADIO_IRQ_TXRX_TIMEOUT = (1 << 9)

RADIO_IRQ_ALL = ((1 << 10 ) - 1)

}

Radio IRQ MASK.

Typedefs#

typedef void(*

sid_pal_radio_event_notify_t)(sid_pal_radio_events_t events)

Radio event callback.

typedef void(*

sid_pal_radio_irq_handler_t)(void)

Radio interrupt callback.

Macros#

#define

SID_PAL_RADIO_RX_PAYLOAD_MAX_SIZE 255

#define

RADIO_ERROR_NONE 0

Radio Error Codes.

#define

RADIO_ERROR_NOT_SUPPORTED -1

#define

RADIO_ERROR_INVALID_PARAMS -2

#define

RADIO_ERROR_IO_ERROR -3

#define

RADIO_ERROR_BUSY -4

#define

RADIO_ERROR_NOMEM -5

#define

RADIO_ERROR_HARDWARE_ERROR -6

#define

RADIO_ERROR_INVALID_STATE -7

#define

RADIO_ERROR_GENERIC -8

#define

RADIO_ERROR_PKT_CHECK_DCR_LIMIT -9

#define

RADIO_ERROR_PKT_CHECK_REG_LIMIT -10

#define

RADIO_ERROR_VENDOR_FIRST -64

#define

RADIO_ERROR_VENDOR_LAST -255

#define

SID_PAL_RADIO_UNKNOWN 0

Sidewalk Phy Radio State.

#define

SID_PAL_RADIO_STANDBY 1

#define

SID_PAL_RADIO_SLEEP 2

#define

SID_PAL_RADIO_RX 3

#define

SID_PAL_RADIO_TX 4

#define

SID_PAL_RADIO_CAD 5

#define

SID_PAL_RADIO_STANDBY_XOSC 6

#define

SID_PAL_RADIO_RX_DC 7

#define

SID_PAL_RADIO_BUSY 8

Enumeration Documentation#

sid_pal_radio_region_code_t#

sid_pal_radio_region_code_t

Sidewalk Phy Radio Region For Regional Config.

Enumerator
SID_PAL_RADIO_RC_NONE	Region none
SID_PAL_RADIO_RC_NA	Region North America
SID_PAL_RADIO_RC_EU	Region EU
SID_PAL_RADIO_RC_JP	Region JP
SID_PAL_RADIO_RC_MAX	Region max

sid_pal_radio_modem_mode_t#

sid_pal_radio_modem_mode_t

Sidewalk Phy Radio Modem Mode.

Enumerator
SID_PAL_RADIO_MODEM_MODE_FSK	Frequency Shift Keying (FSK) modem mode
SID_PAL_RADIO_MODEM_MODE_LORA	Long Range (LoRa) modem mode

sid_pal_radio_events_t#

sid_pal_radio_events_t

Sidewalk Phy Radio Event.

Enumerator
SID_PAL_RADIO_EVENT_UNKNOWN	Unknown event
SID_PAL_RADIO_EVENT_TX_DONE	Transmission done event
SID_PAL_RADIO_EVENT_RX_DONE	Reception done event
SID_PAL_RADIO_EVENT_CAD_DONE	Channel Activity Detection (CAD) done event
SID_PAL_RADIO_EVENT_CAD_TIMEOUT	CAD timeout event
SID_PAL_RADIO_EVENT_RX_ERROR	Reception error event
SID_PAL_RADIO_EVENT_TX_TIMEOUT	Transmission timeout event
SID_PAL_RADIO_EVENT_RX_TIMEOUT	Reception timeout event
SID_PAL_RADIO_EVENT_CS_DONE	Carrier Sense (CS) done event
SID_PAL_RADIO_EVENT_CS_TIMEOUT	CS timeout event
SID_PAL_RADIO_EVENT_HEADER_ERROR	Header error event
SID_PAL_RADIO_EVENT_SYNC_DET	Sync detection event

sid_pal_radio_data_rate_t#

sid_pal_radio_data_rate_t

Sidewalk Phy Radio Data Rate.

Enumerator
SID_PAL_RADIO_DATA_RATE_INVALID	Invalid data rate
SID_PAL_RADIO_DATA_RATE_2KBPS	2 Kbps data rate
SID_PAL_RADIO_DATA_RATE_22KBPS	22 Kbps data rate
SID_PAL_RADIO_DATA_RATE_50KBPS	50 Kbps data rate
SID_PAL_RADIO_DATA_RATE_150KBPS	150 Kbps data rate
SID_PAL_RADIO_DATA_RATE_250KBPS	250 Kbps data rate
SID_PAL_RADIO_DATA_RATE_12_5KBPS	12.5 Kbps data rate
SID_PAL_RADIO_DATA_RATE_CUSTOM	Custom data rate
SID_PAL_RADIO_DATA_RATE_MAX_NUM	0 is not a valid data rate

sid_pal_radio_cad_param_exit_mode_t#

sid_pal_radio_cad_param_exit_mode_t

Sidewalk Phy Radio CAD (Channel Activity Detection) Exit Mode.

Enumerator
SID_PAL_RADIO_CAD_EXIT_MODE_CS_ONLY	Carrier sense only
SID_PAL_RADIO_CAD_EXIT_MODE_CS_RX	Carrier sense followed by Rx
SID_PAL_RADIO_CAD_EXIT_MODE_CS_LBT	Carrier sense followed by Tx
SID_PAL_RADIO_CAD_EXIT_MODE_CS_LBT_RX	Carrier sense followed by Tx then RX
SID_PAL_RADIO_CAD_EXIT_MODE_ED_ONLY	Energy detect only
SID_PAL_RADIO_CAD_EXIT_MODE_ED_RX	Energy detect followed by Rx
SID_PAL_RADIO_CAD_EXIT_MODE_ED_LBT	Energy detect followed by Tx
SID_PAL_RADIO_CAD_EXIT_MODE_NONE	No CAD mode set

sid_pal_radio_irq_mask_t#

sid_pal_radio_irq_mask_t

Radio IRQ MASK.

Enumerator
RADIO_IRQ_NONE	No interrupt
RADIO_IRQ_TX_DONE	Transmission done interrupt
RADIO_IRQ_RX_DONE	Reception done interrupt
RADIO_IRQ_PREAMBLE_DETECT	Preamble detection interrupt
RADIO_IRQ_VALID_SYNC_WORD	Valid sync word interrupt
RADIO_IRQ_VALID_HEADER	Valid header interrupt
RADIO_IRQ_ERROR_HEADER	Header error interrupt
RADIO_IRQ_ERROR_CRC	CRC error interrupt
RADIO_IRQ_CAD_DONE	Channel Activity Detection (CAD) done interrupt
RADIO_IRQ_CAD_DETECT	CAD detection interrupt
RADIO_IRQ_TXRX_TIMEOUT	Transmission or reception timeout interrupt
RADIO_IRQ_ALL	All interrupts

Typedef Documentation#

sid_pal_radio_event_notify_t#

typedef void(* sid_pal_radio_event_notify_t) (sid_pal_radio_events_t events) )(sid_pal_radio_events_t events)

Radio event callback.

sid_pal_radio_irq_handler_t#

typedef void(* sid_pal_radio_irq_handler_t) (void) )(void)

Radio interrupt callback.