Sub-GHz Interface#

sid_pal_radio_init#

int32_t sid_pal_radio_init (sid_pal_radio_event_notify_t notify, sid_pal_radio_irq_handler_t dio_irq_handler, sid_pal_radio_rx_packet_t * rx_packet)

Initializes the radio.

Registers the radio event callback, interrupt callback and pointer to the protocol's receive packet buffer. Sets and enables the radio interrupts.

sid_pal_radio_deinit#

int32_t sid_pal_radio_deinit (void )

Deinitialize the radio.

Resets the radio and clear all configuration.

sid_pal_radio_configure_irq_mask#

sid_pal_radio_irq_mask_t sid_pal_radio_configure_irq_mask (sid_pal_radio_irq_mask_t irq_mask)

Configure irq mask.

Configure the interrupts that the low level driver has to generate. The protocol configures the interrupts it is interested in based on modem mode. The radio driver has a default mask that can be retrieved with sid_pal_radio_get_current_config_irq_mask.

sid_pal_radio_get_current_config_irq_mask#

sid_pal_radio_irq_mask_t sid_pal_radio_get_current_config_irq_mask (void )

Get current irq mask settings.

sid_pal_radio_irq_process#

int32_t sid_pal_radio_irq_process (void )

Radio irq processing.

The function reads the irq status register and reports radio event to the phy layer through the callback routine registered as part of sid_pal_radio_init. The protocol after being notified on receiving a radio interrupt switches from hardware isr to software isr context to continue with bottom half processing of the radio interrupt. sid_pal_radio_irq_process should determine the cause of interrupt and notify the protocol of the phy event through the event handler registered as part of sid_pal_radio_init. On packet reception, this API has to copy the received packet from radio buffers to the rx packet registered as part of sid_pal_radio_init

sid_pal_radio_set_frequency#

int32_t sid_pal_radio_set_frequency (uint32_t freq)

Set the frequency for the radio.

sid_pal_radio_set_tx_power#

int32_t sid_pal_radio_set_tx_power (int8_t power)

Set the radio transmit power.

sid_pal_radio_get_max_tx_power#

int32_t sid_pal_radio_get_max_tx_power (sid_pal_radio_data_rate_t data_rate, int8_t * tx_power)

Get the radio max transmit power setting for a given data rate.

sid_pal_radio_set_region#

int32_t sid_pal_radio_set_region (sid_pal_radio_region_code_t region)

Set the radio region.

sid_pal_radio_sleep#

int32_t sid_pal_radio_sleep (uint32_t sleep_us)

Set the radio to sleep.

The protocol expects the radio to be set in lowest power consumption state possible.

sid_pal_radio_standby#

int32_t sid_pal_radio_standby (void )

Set the radio to standby.

The protocol sets the radio to standby mode in the following scenarios: To wake the radio from sleep state To configure modulation parameters, packet parameters, cad, frequency, power etc

sid_pal_set_radio_busy#

int32_t sid_pal_set_radio_busy (void )

Set the radio to busy state.

Busy state is used for concurrent stacks operation. Set the state of radio to busy to block another stack from using the radio peripheral. Calling sid_pal_radio_sleep() replaces SID_PAL_RADIO_BUSY state with SID_PAL_RADIO_SLEEP state.

sid_pal_radio_start_carrier_sense#

int32_t sid_pal_radio_start_carrier_sense (const sid_pal_radio_fsk_cad_params_t * cad_params, sid_pal_radio_cad_param_exit_mode_t exit_mode)

Set the radio in preamble detect mode.

sid_pal_radio_start_rx#

int32_t sid_pal_radio_start_rx (uint32_t timeout)

Set the radio in receive mode.

sid_pal_radio_start_continuous_rx#

int32_t sid_pal_radio_start_continuous_rx (void )

Set the radio to continuous receive.

sid_pal_radio_set_rx_duty_cycle#

int32_t sid_pal_radio_set_rx_duty_cycle (uint32_t rx_time, uint32_t sleep_time)

Set the receive duty cycle.

Configures the radio receive duty cycle. The protocol uses this API to set the radio to alternate between receive and sleep states. The radio in this mode should not interrupt the protocol unless it detects a valid packet.

sid_pal_radio_set_tx_continuous_wave#

int32_t sid_pal_radio_set_tx_continuous_wave (uint32_t freq, int8_t power)

Set the transmit continuous wave.

Confiure the radio to transmit a continuous wave. This API is used for diagnostics mode only

sid_pal_radio_set_tx_payload#

int32_t sid_pal_radio_set_tx_payload (const uint8_t * buffer, uint8_t size)

Set transmit payload for the radio to transmit.

Writes the payload and payload length to radio buffers but the packet is not transmitted on the air.

sid_pal_radio_start_tx#

int32_t sid_pal_radio_start_tx (uint32_t timeout)

Start packet transmission.

Starts the packet transmission. This needs to be invoked after all the radio configuration viz modulation params, packet params, freq, power, payload and payload length are set atleast once. The radio should be able to transmit the packet within the timeout specfied through this API. If it fails to transmit the packet within the stipulated timeout value, the radio driver should generate a interrupt with tx timeout as the reason

sid_pal_radio_get_status#

uint8_t sid_pal_radio_get_status (void )

Get the radio state.

The protocol uses this API to query its current state

sid_pal_radio_get_modem_mode#

sid_pal_radio_modem_mode_t sid_pal_radio_get_modem_mode (void )

Get the current radio modem mode.

Supported modem modes are LoRa and FSK

sid_pal_radio_set_modem_mode#

int32_t sid_pal_radio_set_modem_mode (sid_pal_radio_modem_mode_t mode)

Set radio modem mode.

The driver should configure all the parameters to operate in the desired mode. Supported modem modes are LoRa and FSK

sid_pal_radio_is_channel_free#

int32_t sid_pal_radio_is_channel_free (uint32_t freq, int16_t threshold, uint32_t delay_us, bool * is_channel_free)

Check the channel noise level for a given rssi.

The radio should sense the medium in the frequency specified by parameter freq for a period specified by delay_us, compute the rssi, and compare the computed rssi with the passed threshold specified by the parameter threshold. If the computed rssi is greater than threshold, the parameter is_channel_free is set to false otherwise it is set to true. If any of the above operations fail, appropriate error value will be returned.

sid_pal_radio_get_chan_noise#

int32_t sid_pal_radio_get_chan_noise (uint32_t freq, int16_t * noise)

Compute the noise sensed by radio at a particular frequency.

sid_pal_radio_rssi#

int16_t sid_pal_radio_rssi (void )

Get RSSI at radio's current configured frequency.

The frequency on which RSSI needs to be measured needs to be set before calling this API.

sid_pal_radio_random#

int32_t sid_pal_radio_random (uint32_t * random)

Get a random number from radio.

sid_pal_radio_get_ant_dbi#

int16_t sid_pal_radio_get_ant_dbi (void )

Get antenna gain in dBi.

sid_pal_radio_get_cca_level_adjust#

int32_t sid_pal_radio_get_cca_level_adjust (sid_pal_radio_data_rate_t data_rate, int8_t * adj_level)

Get the cca adjustment in dB.

sid_pal_radio_get_radio_state_transition_delays#

int32_t sid_pal_radio_get_radio_state_transition_delays (sid_pal_radio_state_transition_timings_t * state_delay)

Get the delay in microseconds to switch between different radio states.

sid_pal_radio_is_cad_exit_mode#

int32_t sid_pal_radio_is_cad_exit_mode (sid_pal_radio_cad_param_exit_mode_t mode)

Check the CAD exit mode.

Check with supported CAD exit modes

sid_pal_radio_set_lora_symbol_timeout#

int32_t sid_pal_radio_set_lora_symbol_timeout (uint8_t num_of_symbols)

Radio LoRa Modulation specific APIs.

Set LoRa symbol timeout.

sid_pal_radio_set_lora_sync_word#

int32_t sid_pal_radio_set_lora_sync_word (uint16_t sync_word)

Set LoRa sync word.

sid_pal_radio_set_lora_modulation_params#

int32_t sid_pal_radio_set_lora_modulation_params (const sid_pal_radio_lora_modulation_params_t * mod_params)

Set LoRa modulation parameters.

sid_pal_radio_set_lora_packet_params#

int32_t sid_pal_radio_set_lora_packet_params (const sid_pal_radio_lora_packet_params_t * packet_params)

Set LoRa packet parameters.

sid_pal_radio_set_lora_cad_params#

int32_t sid_pal_radio_set_lora_cad_params (const sid_pal_radio_lora_cad_params_t * cad_params)

Set LoRa CAD parameters.

sid_pal_radio_lora_start_cad#

int32_t sid_pal_radio_lora_start_cad (void )

Set the radio in CAD mode.

sid_pal_radio_lora_mod_params_to_data_rate#

sid_pal_radio_data_rate_t sid_pal_radio_lora_mod_params_to_data_rate (const sid_pal_radio_lora_modulation_params_t * mod_params)

convert LoRa modulation params to data rate.

sid_pal_radio_lora_data_rate_to_mod_params#

int32_t sid_pal_radio_lora_data_rate_to_mod_params (sid_pal_radio_lora_modulation_params_t * mod_params, sid_pal_radio_data_rate_t data_rate, uint8_t li_enable)

Convert data rate to LoRa modulation parameters.

sid_pal_radio_lora_time_on_air#

uint32_t sid_pal_radio_lora_time_on_air (const sid_pal_radio_lora_modulation_params_t * mod_params, const sid_pal_radio_lora_packet_params_t * packet_params, uint8_t packet_len)

Get time on air for a LoRa packet.

sid_pal_radio_lora_cad_duration#

uint32_t sid_pal_radio_lora_cad_duration (uint8_t symbol, const sid_pal_radio_lora_modulation_params_t * mod_params)

get CAD duration for a given number of symbols and lora mod_params

sid_pal_radio_lora_get_lora_number_of_symbols#

uint32_t sid_pal_radio_lora_get_lora_number_of_symbols (const sid_pal_radio_lora_modulation_params_t * mod_params, uint32_t delay_micro_sec)

Calculates the minimum number of symbols that takes more than delay_micro_sec of air time.

In the case of a fractional number of symbols, the return value is rounded up to the next integer. Does not affect the radio state and can be executed without radio ownership. In the case of an error, 0 is returned.

sid_pal_radio_get_lora_rx_done_delay#

uint32_t sid_pal_radio_get_lora_rx_done_delay (const sid_pal_radio_lora_modulation_params_t * mod_params, const sid_pal_radio_lora_packet_params_t * pkt_params)

Get the time between the last bit sent (on Tx side) and the Rx done event (on Rx side)

sid_pal_radio_get_lora_tx_process_delay#

uint32_t sid_pal_radio_get_lora_tx_process_delay (void )

Get the time between Tx schedule and the first bit of Tx.

sid_pal_radio_get_lora_rx_process_delay#

uint32_t sid_pal_radio_get_lora_rx_process_delay (void )

Get the time of LoRa Rx processing delay.

sid_pal_radio_get_lora_symbol_timeout_us#

uint32_t sid_pal_radio_get_lora_symbol_timeout_us (sid_pal_radio_lora_modulation_params_t * mod_params, uint8_t number_of_symbol)

Get LoRa symbol timeout in us.

sid_pal_radio_set_fsk_sync_word#

int32_t sid_pal_radio_set_fsk_sync_word (const uint8_t * sync_word, uint8_t sync_word_length)

Radio FSK Modulation specific APIs.

Set fsk sync word

sid_pal_radio_set_fsk_whitening_seed#

int32_t sid_pal_radio_set_fsk_whitening_seed (uint16_t seed)

Set fsk whitening seed.

sid_pal_radio_set_fsk_modulation_params#

int32_t sid_pal_radio_set_fsk_modulation_params (const sid_pal_radio_fsk_modulation_params_t * mod_params)

Set fsk modulation parameters.

sid_pal_radio_set_fsk_packet_params#

int32_t sid_pal_radio_set_fsk_packet_params (const sid_pal_radio_fsk_packet_params_t * packet_params)

Set fsk packet parameters.

sid_pal_radio_fsk_mod_params_to_data_rate#

sid_pal_radio_data_rate_t sid_pal_radio_fsk_mod_params_to_data_rate (const sid_pal_radio_fsk_modulation_params_t * mp)

convert fsk modulation params to data rate.

sid_pal_radio_fsk_data_rate_to_mod_params#

int32_t sid_pal_radio_fsk_data_rate_to_mod_params (sid_pal_radio_fsk_modulation_params_t * mod_params, sid_pal_radio_data_rate_t data_rate)

Convert data rate to fsk modulation parameters.

sid_pal_radio_fsk_time_on_air#

uint32_t sid_pal_radio_fsk_time_on_air (const sid_pal_radio_fsk_modulation_params_t * mod_params, const sid_pal_radio_fsk_packet_params_t * packet_params, uint8_t packet_len)

Get time on air for a fsk packet.

sid_pal_radio_fsk_get_fsk_number_of_symbols#

uint32_t sid_pal_radio_fsk_get_fsk_number_of_symbols (const sid_pal_radio_fsk_modulation_params_t * mod_params, uint32_t delay_micro_secs)

Calculates the minimum number of symbols that takes more than delay_micro_secs of air time.

In the case of a fractional number of symbols, the return value is rounded up to the next integer. Does not affect the radio state and can be executed without radio ownership. In the case of an error, 0 is returned.

sid_pal_radio_get_fsk_tx_process_delay#

uint32_t sid_pal_radio_get_fsk_tx_process_delay (void )

Get the time between Tx schedule and the first bit of Tx.

sid_pal_radio_get_fsk_rx_process_delay#

uint32_t sid_pal_radio_get_fsk_rx_process_delay (void )

Get the time of FSK Rx processing delay.

sid_pal_radio_prepare_fsk_for_tx#

int32_t sid_pal_radio_prepare_fsk_for_tx (sid_pal_radio_fsk_pkt_cfg_t * tx_pkt_cfg)

Setup transmit in fsk mode.

This API is used to configure the sync word, packet params perform crc, and data whitening on the payload, and determine the packet length. This API needs to be called before calling sid_pal_radio_set_payload and sid_pal_radio_start_tx in FSK mode.

sid_pal_radio_prepare_fsk_for_rx#

int32_t sid_pal_radio_prepare_fsk_for_rx (sid_pal_radio_fsk_pkt_cfg_t * rx_pkt_cfg)

Setup receive in fsk mode.

This API is used to configure the sync word and packet params. This API needs to be called before calling sid_pal_radio_start_rx in FSK mode.

sid_pal_radio_set_fsk_crc_polynomial#

int32_t sid_pal_radio_set_fsk_crc_polynomial (uint16_t crc_polynomial, uint16_t crc_seed)

Configure crc parameters.

This API is used to configure the crc polynomial and seed. This API needs to be called before tx and rx in FSK mode.