This document describes the Hardware Interface (HIF) for the Silicon Labs Wi-SUN Radio Co-Processor (RCP). The RCP implements IEEE 802.15.4 frame transmission and reception using Wi-SUN frequency hopping and this API allows a host to control it using commands sent on a serial bus.

In this specification, the prefix used in the command means:

• REQ (request): a command sent by the host to the device
• SET: special case of REQ to configure the device
• CNF (confirmation): a reply from the device to the host
• IND (indication): a spontaneous frame from the device to the host

By default, requests do not receive confirmations, the only exceptions are REQ_RADIO_LIST and REQ_DATA_TX.

All the types used are little endian.

The type bool is a uint8_t, but only the LSB is interpreted. All the other bits are reserved.

When a bit is reserved or unassigned, it must be set to 0 by the transmitter and must be ignored by the receiver.

All strings are null-terminated.

All the version numbers are encoded using uint32_t with the following mask:

• 0xFF000000 Major revision
• 0x00FFFF00 Minor revision
• 0x000000FF Patch

All timestamps are based on the RCP timebase, measured in microseconds, with the origin set at the device reset.

All channel numbers are defined as if there were no channel mask applied (ChanN = Chan0 + N * ChanSpacing).

The RCP can use the Native UART or the CPC protocol. With CPC, the frame structure is defined by the CPC specification.

With Native UART, frames use the following structure, and use a CRC-16 for error detection.

• uint16_t len
  Length of the payload field . Only the 11 least significant bits (0x07FF) are used. The 5 most significant bits (0xF800) must be ignored.

• uint16_t hcs
  CRC-16/MCRF4XX of the len field.

• uint8_t payload[]
  Frame payload.

• uint16_t fcs
  CRC-A of the payload field.

Regardless of the framing protocol used, the payload always has the following structure:

• uint8_t cmd
  Command number.

• uint8_t body[]
  Command body.

No-operation. Can be used to synchronize UART communication.

• uint8_t garbage[]
  Data after command is ignored.

No-operation. Can be used to synchronize UART communication.

• uint8_t garbage[]
  Extra data may be included. It must be ignored.

Hard reset the RCP. After this command, the host will receive IND_RESET.

• bool enter_bootloader
  If set to true, the bootloader will start instead of the RCP application. Use this option for flashing a new RCP firmware. For details on how to upload a firmware (typically using the XMODEM protocol over UART), refer to the bootloader documentation.

Sent on boot of the RCP. This command may be caused by a power on, REQ_RESET, a debugger, etc...

• uint32_t api_version
  Device API version

• uint32_t fw_version
  Device version

• char fw_version_str[]
  Device version string. It may include version annotation (ie. 1.5.0-5-ga91c352~bpo).

• uint8_t hw_eui64[8]
  EUI-64 flashed on the device

• uint8_t reserved[]
  Extra data may be included. For backward compatibility, it must be ignored.

Commands do not send a reply upon success. If the RCP is misconfigured or encounters a fatal error happens, it will reset. In such cases, a IND_RESET message will be sent after IND_FATAL, providing details about the error. This information can be used to display the error to the user for debugging purposes.

• uint16_t error_code
  Refer to the table below for the detailed list of errors.

• char error_string[]
  Human-readable error message.

Informs the RCP of the host API version. If this command is not sent, the RCP will assume that the API version is 2.0.0. This command should be sent after IND_RESET and before any other command.

• uint32_t api_version
  Must be at least 0x02000000.

Only a subset of the IEEE 802.15.4 frame formats are supported for the needs of Wi-SUN:

• Frame type must be either 1 (data) or 2 (ack, CNF_DATA_TX only).
• Frame version must be 2.
• Source address mode must be 3.
• Destination address mode must be either 0 or 3.
• See "Security" for limits on the auxiliary security header.

In Wi-SUN, all transmissions require the use of Clear Channel Assessment (CCA), but the way attempts are performed differs depending on the FHSS type used.

Unicast and broadcast to FFNs use the IEEE 802.15.4 CSMA-CA algorithm with the parameters described in SET_RADIO_CSMA:

Unicast and broadcast transmissions to LFNs can be conceived as if they use the CSMA-CA algorithm, where the backoff is not randomized but instead corresponds to the next available TX slot. This detail matters for counting CCA failures versus transmission failures.

Asynchronous transmissions use one CCA per channel, and skip the channel on failure without attempting any retries. No overall CCA failure is returned in CNF_DATA_TX for these transmissions.

Sends a IEEE 802.15.4 frame. All data requests are followed by a data confirmation (CNF_DATA_TX) once the transaction is complete, even in case of transmission failure or abort.

• uint8_t handle
  A unique arbitrary number used to identify a packet transmission in the RCP. Sent back in CNF_DATA_TX.

• uint16_t frame_len
  Length of the IEEE 802.15.4 frame to transmit.

• uint8_t frame[]
  An IEEE 802.15.4 frame without PHR and FCS. The RCP reads and interprets the header to determine what processing needs to be done. The frame must not be encrypted at this stage, see "Security" for more details.

  If the following fields are present, they are automatically filled by the RCP (their input value is ignored and overwritten):

  • Sequence number
  • Timing parameters in Wi-SUN IEs (UTT, BT, LBT, LTO) (see "FHSS Configuration")
  • Frame counter (see "Security")
  • Message Integrity Code (MIC) (see "Security")

• uint16_t flags
  A bitfield:

  • 0x0007 FHSS_TYPE_MASK: Type of frequency hopping algorithm to use (see "FHSS Configuration"):
    • 0x00 FHSS_TYPE_FFN_UC: Unicast to FFN
    • 0x01 FHSS_TYPE_FFN_BC: Broadcast to FFN
    • 0x02 FHSS_TYPE_LFN_UC: Unicast to LFN
    • 0x03 FHSS_TYPE_LFN_BC: Broadcast to LFN
    • 0x04 FHSS_TYPE_ASYNC: Asynchronous
    • 0x06 FHSS_TYPE_LFN_PA: LFN PAN Advertisement
  • 0x0010 FHSS_DEFAULT:
    • 0: Schedule information is passed explicitly in this request. Supported with FFN_UC, LFN_UC, LFN_PA.
    • 1: Use schedule information previously configured using a SET_FHSS command. Supported with FFN_BC, LFN_BC, ASYNC.
  • 0x0020 MODE_SWITCH: Attempt mode switch with a list of specified PHYs. Only supported with FHSS_TYPE_FFN_UC.
  • 0x1fc0 FRAME_COUNTERS: Bitmask of frame counters per key.
  • 0x2000 MODE_SWITCH_TYPE (API >= 2.1.0):
    • 0: PHY mode switch (PHR, default before API 2.1.0)
    • 1: MAC mode switch (MAC command frame)
  • 0x4000 FRAME_COUNTER_8 (API >= 2.5.0): Frame includes frame counter for key at index 8.
  • 0x8000 TX_DURATION (API >= 2.11.0): Report the current cumulated TX duration in CNF_DATA_TX.

Only present if FHSS_TYPE_FFN_UC:

• uint64_t utt_timestamp_us
  Timestamp associated with the last received UTT-IE from this node. The host will use the timestamp_us value from CNF_DATA_TX and IND_DATA_RX.
• uint24_t ufsi (from UTT-IE)
• uint8_t dwell_interval (from US-IE)

Only present if FHSS_TYPE_LFN_UC:

• uint64_t lutt_timestamp_us
  Timestamp associated with the last received LUTT-IE from this node. The host will use the timestamp_us value from CNF_DATA_TX and IND_DATA_RX.
• uint16_t slot (from LUTT-IE)
• uint24_t interval_offset_ms (from LUTT-IE)
• uint24_t interval_ms (from LUS-IE)

Only present if FHSS_TYPE_LFN_PA:

• uint64_t lnd_timestamp_us
  Timestamp associated with the last received LND-IE from this node. The host will use the timestamp_us value from IND_DATA_RX.
• uint24_t response_delay_ms (from LND-IE)
• uint8_t slot_duration_ms (from LND-IE)
• uint8_t slot_count (from LND-IE)
• uint16_t slot_first (from LND-IE)

Other FHSS types have no additional fields.

Only present if FHSS_DEFAULT == 0:

• struct chan_seq
  See "Channel Sequence".

For each bit set in FRAME_COUNTERS:

• uint32_t frame_counter
  Minimum frame counter to accept when verifying acknowlegment frames. The associated key index maps to the bit offset (from 1 to 7). See "Security".

Only present if MODE_SWITCH:

• struct rate_config[4]
  Fixed length and ordered array of rates to attempt until the transmission is successful, or all rates have been tried.
  • uint8_t phy_mode_id: Wi-SUN PhyModeId, must be in the group selected with SET_RADIO.
  • uint8_t bitfield
    • 0x1f tx_attempts: The maximum number of attempts allowed for this rate. Once this limit is exceeded, the next entry will be tried. Note that this valude overrides macMaxFrameRetries described in "Channel Access and Retries".
    • 0x80 alt_phy (API >= 2.10.0): Transmit using alternate PHY and skip mode switch PHR or MAC command. See the Silicon Labs concurrent mode documentation for more information.
  • int8_t tx_power_dbm: The TX power to use with this entry, saturates to the value configured with SET_RADIO_TX_POWER.

Only present if FRAME_COUNTER_8:

Same content as FRAME_COUNTERS, but only for key at index 8. See "Security" for more details.

Cancel a frame transmission previously initiated with REQ_DATA_TX. A CNF_DATA_TX message will be returned with status 6. Note that there is a race condition between successful frame transmission and cancellation, so the CNF_DATA_TX message associated with the frame handle may not be the consequence of this command, in which case the status can be different from 6. Because of this race condition, no error is returned on providing a invalid handle.

• uint8_t handle
  Frame handle, as provided in REQ_DATA_TX.

Status of an earlier data request (REQ_DATA_TX). Also returns the IEEE 802.15.4 acknowledgement frame if the request had the acknowledgement request bit set in the header.

• uint8_t handle
  Frame handle, as provided in REQ_DATA_TX.

• uint8_t status
  See the table below for a list of status codes. The fields below may be invalid if status != 0.

• uint16_t frame_len
  Length of the IEEE 802.15.4 acknowledgment frame if received.

• uint8_t frame[]
  Decrypted IEEE 802.15.4 acknowledgment frame (see "Security").

• uint64_t timestamp_us
  The timestamp (relative to the date of the RCP reset) when the frame has been received.

• uint8_t lqi
  Received Link Quality Indicator (LQI) as reported by RAIL (ACK received only).

• int8_t rx_power_dbm
  Received power in dBm as reported by RAIL (ACK received only).

• uint32_t frame_counter
  Frame counter used in the successful transmission (see frame_counter in SET_SEC_KEY). Only valid if the request included an auxiliary security header.

• uint16_t chan_num
  Channel number used in the successful transmission.

• uint8_t cca_failures
  Number of times channel access has failed consecutively (due to CCA failure or busy RX). For aknowledged frames, this counter is reset whenever the frame is transmitted on the radio but no acknowledgement is received.

• uint8_t tx_failures
  Number of transmission failures (does not account for CCA failures).

• uint32_t tx_duration_ms (API >= 2.11.0, optional)
  Cumulated TX duration over the last hour, in milliseconds. Only present if TX_DURATION is set in the associated REQ_DATA_TX command. See REQ_RADIO_TX_DURATION_RESET.

Status codes:

0x06..0xff are reserved for future errors. The host must accept these values and consider the frame has not been received by the destination.

This status indicates that a REQ_DATA_TX was not processed by the RCP within the expected time window:

Receive IEEE 802.15.4 frames. The RCP will start emitting these indications once the radio is started with SET_RADIO. See "Packet Filtering" to limit the amount of frames accepted.

• uint16_t frame_len
  Length of the received IEEE 802.15.4 frame.

• uint8_t frame[]
  Decrypted IEEE 802.15.4 frame, (see "Security").

• uint64_t timestamp_rx_us
  The timestamp (relative to the date of the RCP reset) when the frame has been received on the device.

• uint8_t lqi
  Received Link Quality Indicator (LQI) as reported by RAIL.

• int8_t rx_power_dbm
  Received power in dBm as reported by RAIL.

• uint8_t phy_mode_id
  Wi-SUN PhyModeId used during reception.

• uint16_t chan_num
  Channel number used during reception.

Configure Extended Directed Frame Exchange (EDFE). This mode of communication allows efficient data streaming between 2 nodes. Currently, the RCP does not support streaming its own data, but it does support receiving a stream of packets from a neighbor. Each received frame will be passed to the host through IND_DATA_RX like any other frame.

• bool enable
  If set, the RCP will respond to EDFE initial frames with EDFE response frames without any data, and be ready for receiving more frames if necessary. EDFE is enabled by default, but some regions disallow its usage so this setting allows to turn it off. Note that the deprecated SET_RADIO_REGULATION command overrides this setting.

• uint8_t format
  Wi-SUN defines 2 different frame formats for EDFE, which unfortunately creates interoperability issues between devices. Since the RCP generates response frames without any host involvment, it must be informed of the format to use.

  • 1 FAN 1.0 format: source address is elided from response frames, and sequence number is never included.
  • 2 FAN 1.1 format (default): source address is always included, and sequence number is included in EDFE frames containing data.

PHY configuration and RCP level regional regulation enforcement. For frequency hopping parameters, see "FHSS configuration".

Start the radio module. Before this, no packet can be transmitted (REQ_DATA_TX) nor received (IND_DATA_RX). Some configuration needs to be done before calling this command, typically a PHY must be selected with SET_RADIO, and a unicast schedule must be configured with SET_FHSS_UC.

Body of this command is empty.

Request the list of radio configuration supported by the device, typically issued by the host during a startup sequence before selecting a PHY configuration. The RCP will answer with a series of CNF_RADIO_LIST commands.

• bool include_alt_phy (API >= 2.10)
  If set, alternate PHYs are included in the response command, which lets the host know which PHYs it can use for concurrent mode TX with REQ_DATA_TX.

List of radio configuration supported by the RCP, as configured during project generation. Entries are defined in groups of mode-switch compatible PHYs. For OFDM configurations, all MCS are defined in the same entry.

• uint8_t entry_size
  Size of a radio configuration entry in bytes. This is meant to support API evolution.

• bool list_end
  If not set, the list will continue in another CNF_RADIO_LIST.

• uint8_t count
  Number of radio configuration entries in next field.

• struct rf_config[]

  • uint16_t flags
    • 0x0001: If set, this entry is in same group than the previous.
    • 0x01fe: Bitfield of supported OFDM MCS (from MCS0 to MCS7).
    • 0x0200: If set, this entry is an alternate PHY associated with the previous entry. Alternate PHY entries have the same content as regular entries but they must be handled a bit differently:
      • The "group" bit must be ignored, and the entry must not be considered part of any mode switch group. The following regular entry follows normal rules for mode switch groups, based on the previous regular entry.
      • The index passed to SET_RADIO does not count the alternate PHY entries. Only the base PHY can be selected. See the RAIL concurrent mode documentation for more information.
  • uint8_t rail_phy_mode_id
    Wi-SUN PhyModeId. For OFDM, only the PhyType is set, and MCS support is indicated in the flags field.
  • uint32_t chan_f0
    Frequency of the first channel in Hz.
  • uint32_t chan_spacing
    Channel spacing in Hz.
  • uint16_t chan_count
    Number of channels without holes in the spectrum.
  • uint16_t sensitivity (API >= 2.4.0)
    Minimum RX sensitivity in dBm for this PHY.

Configure the radio parameters.

• uint8_t index
  Index in the rf_config list. If the entry has an associated alternate PHY, it will be used for concurrent detection when receiving packets. See the RAIL concurrent mode documentation for more information.

• uint8_t mcs
  MCS to be used if index points to an OFDM modulation.

• bool enable_mode_switch (API >= 2.0.1)
  Enable mode switch in reception at PHY level (PHR), using all the PHY configurations available in the same group as the selected PHY. Note that mode switch cannot be disabled at MAC level (MAC command frame).

Enable specific radio regulation rules. Most regulations only make sense with specific channel configurations.

• uint32_t value
  • 0: None (disabled, default)
  • 2: Japan (ARIB)
  • 5: India (WPC)

• int8_t tx_power_dbm
  Maximum transmission power in dBm. The RCP may use a lower value based on internal decision making or hardware limitations but will never exceed the given value. The default value is 14dBm.

The RCP maintains a counter for the cumulated time spent transmitting packets over the air during the last hour. This value is reported in CNF_DATA_TX frames if requested, and can be used to implement duty cycle restrictions as imposed by regulation standards. This command resets the counter to 0 and clears records of previous transmission durations.

Body of this command is empty.

Configure channel access and retry parameters. The CSMA-CA algorithm is described in the IEEE 802.15.4 specification.

• uint16_t backoff_unit_us
  Base unit (in microseconds) used when computing the backoff duration in the CSMA algorithm (see macUnitBackoffPeriod). Set to 0 to use a default value based on the PHY selected by SET_RADIO.

• uint8_t min_be
  Minimum backoff exponent (see macMinBe). Defaults to 3.

• uint8_t max_be
  Maximum backoff exponent (see macMaxBe). Defaults to 5.

• uint8_t cca_retries
  Number of CCA retries to perform before declaring channel access failure (see macMaxCsmaBackoffs). Up to 1 + macMaxCsmaBackoffs CCA are attempted. Defaults to 8.

• uint8_t frame_retries
  Number of frame transmission retries to perform before declaring TX failure, only for acknowledged unicast frames (see macMaxFrameRetries). Up to 1 + macMaxFrameRetries frame transmissions are attempted. Defaults to 19.

Enable Adaptive Power Control as required by ETSI EN 300 200-1 for transmission of acknowledgement frames. For data frames, REQ_DATA_TX already provides the necessary fields to allow a host to adjust the transmission power.

• bool enable_apc
  When set, the RCP will maintain a small neighbor table with associated TX power. The power corresponds to the last value used when transmitting data to that neighbor. If an entry cannot be found, maximum power is used (see SET_RADIO_TX_POWER).

Several schemes are used in Wi-SUN to transmit or receive packets using frequency hopping. These are independently defined using a set of parameters and may differ between transmission and reception. The following table summarizes which commands configure the various FHSS parameters. Note that REQ_DATA_TX always needs to be called for transmission, but timing parameters are sometimes passed with the command, and sometimes stored in the RCP and configured once using a SET_FHSS command. See the description of these commands for a more detailed explanation.

In addition, the RCP is responsible for filling some timing related fields in transmitted packets, based on active schedules:

• UTT-IE (see SET_FHSS_UC):
  • Unicast Fractional Sequence Interval (UFSI)
• BT-IE (see SET_FHSS_FFN_BC):
  • Broadcast Slot Number
  • Broadcast Interval Offset
• LBT-IE (see SET_FHSS_LFN_BC):
  • LFN Broadcast Slot Number
  • LFN Broadcast Interval Offset
• LTO-IE:
  • Offset
    The host sets this field as an offset relative to the start of the LFN broadcast window (see SET_FHSS_LFN_BC). The RCP recomputes the offset to be relative to the destination LFN's unicast schedule, based on the timing information passed in REQ_DATA_TX.

Most SET_FHSS commands configure a channel sequence using the following variable-length structure:

• uint8_t chan_func
  Wi-SUN channel function, supported values are:
  • 0: Single fixed channel. (API >= 2.1.1)
  • 2: Direct Hash 1 (DH1CF) defined by Wi-SUN.

Only present if chan_func == 0:

• uint16_t chan_fixed
  Fixed channel number, valid range depends on the selected PHY.

Only present if chan_func == 2:

• uint8_t chan_mask_len
  Number of bytes in the following channel mask.

• uint8_t chan_mask[]
  Bitmask of used channels (1 for used, 0 for excluded). Channels are counted byte by byte, from least to most significant bit (channel n maps to chan_mask[n / 8] & (1 << (n % 8))). Integrators are responsible for meeting local regulation constraints by excluding disallowed channels from the selected PHY.

Configure unicast schedule for reception.

• uint8_t dwell_interval
  Unicast dwell interval in milliseconds (from US-IE). This value is used to calculate the UFSI (from UTT-IE) of transmitted frames. Because UFSI calculation depends on this field, dwell_interval cannot be set to 0.

• struct chan_seq
  See "Channel Sequence".

If API >= 2.6.0 (optional block):

• uint8_t ms_chan_mask_len
  Number of entries in the following ms_chan_mask array with one entry per channel spacing (i.e. per channel mask) supported for mode-switch.

• struct ms_chan_mask[]

  • uint32_t channel_spacing_hz
    Channel spacing associated with the mask in Hertz.
  • uint8_t chan_mask_len
    Number of bytes in the following channel mask.
  • uint8_t chan_mask[]
    Mode switch channel mask. See the same field in "Channel Sequence" for more details.

Configure broadcast schedule for reception and transmission from/to FFN.

• uint32_t interval
  Broadcast interval in milliseconds (from BS-IE).

• uint16_t bsi
  Broadcast Schedule ID (from BS-IE).

• uint16_t dwell_interval
  Broadcast dwell interval in milliseconds (from BS-IE).

• struct chan_seq
  See "Channel Sequence".

If API >= 2.3.0 (optional block):

• uint8_t eui64[8]
  MAC address of a neighboring node whose broadcast schedule should be followed (typically a RPL parent or an EAPoL target). The RCP will read the BT-IE of frames received from that source address to maintain its broadcast schedule synchronized, which prevents needing to regularly update RCP timing from the host. By default, the address is set to ff:ff:ff:ff:ff:ff:ff:ff, which disables the parent following. Not including this block in the command also disables parent following. The next parameters set up the initial timings.

• uint64_t bt_timestamp_us
  Timestamp associated with the last received BT-IE from this node. The host will use the timestamp_us value from CNF_DATA_TX and IND_DATA_RX.

• uint16_t slot
  Broadcast slot (from BT-IE).

• uint32_t interval_offset_ms
  Broadcast interval offset (from BT-IE).

• uint32_t frame_counters[4]
  Initial frame counters for this node for all keys (indices 1 through 4). As described in "Security", the RCP generally does not check for frame counters since it is the responsability of the host. However this makes it easy to break the RCP broadcast schedule by replaying a frame containing a BT-IE. Thus the RCP can track the frame counters for a single parent. These counters are not reset when installing a new key, so it is recommended to always call SET_FHSS_FFN_BC with updated counters right after calling SET_SEC_KEY.

Configure broadcast schedule for transmission to LFN.

• uint16_t interval
  LFN broadcast interval in milliseconds (from LBS-IE).

• uint16_t bsi
  LFN broadcast Schedule ID (from LBS-IE).

• struct chan_seq
  See "Channel Sequence".

Configure asynchronous transmissions for network discovery.

• uint32_t tx_duration_ms
  Maximum number of milliseconds the RCP is allowed to stay in continuous TX for an async transmission. If that duration is exceeded, the async transmission is split into chunks of that duration until all channels have been used. This mechanism makes the RCP radio available for other tasks between the async chunks, which becomes relevant for PHY configurations with many channels. By default, the value is set to 0xffffffff, which disables this feature.

• uint8_t chan_mask_len
  Number of bytes in the following channel mask.

• uint8_t chan_mask[]
  Bitmask of channels to use for transmission. See the same field in "Channel Sequence" for more details.

Update transmission timings of packets queued in the RCP using LFN unicast timings. This command is typically issued when a LFN neighbor decides to change schedule, to accelerate its authentication or after receiving a LTO-IE. Note that initial LFN timings are always passed to REQ_DATA_TX. This command is provided as an optimization to avoid requiring to cancel transmissions with REQ_DATA_TX_ABORT and request again the same transmissions with updated timings. This command does not reset the retry count for any active transmission, but future retransmissions will use the new timings.

• uint8_t handle_count
  Number of fields in the following array.

• uint8_t handle_list[]
  List of frame handles to update, as provided in REQ_DATA_TX with FHSS_TYPE_LFN_UC.

• uint64_t lutt_timestamp_us

• uint16_t slot

• uint24_t interval_offset_ms

• uint24_t interval_ms
  See REQ_DATA_TX with FHSS_TYPE_LFN_UC.

• struct chan_seq
  See "Channel Sequence".

To encrypt transmitted IEEE 802.15.4 frames, an auxiliary security header must be included in the buffer passed to REQ_DATA_TX, and space must be reserved at the end of the frame for the Message Integrity Code (MIC) depending on the security level. The packet payload is not yet encrypted when passed to the RCP. The RCP is responsible for reading the auxiliary security header, finding the associated key, filling the frame counter field, encrypting the payload, and filling the MIC.

Similarly, the RCP decrypts received packets and provides them to host in cleartext with IND_DATA_RX, with the auxiliary security header untouched so that the host can process it.

Acknowledgement frames are decrypted and sent to the host in the same manner with the exception that the RCP does perform a frame counter check based on the minimum values provided in the REQ_DATA_TX for that packet.

Install a security key for encrypting/decrypting IEEE 802.15.4 frames.

• uint8_t key_index
  Key index to use. For API >= 2.5.0, only values from 1 to 8 (inclusive) are supported. For any older API version, only values from 1 to 7 (inclusive) are supported. In the context of Wi-SUN, key at index 8 is reserved to Silicon Labs' Direct Connect feature, if used.

• uint8_t key[16]
  Key in cleartext. If all zeroes, the key is un-installed.

• uint32_t frame_counter
  The initial frame counter value (for transmission). Should be 0 at first installation, should be positive on re-installation (after a RCP reboot). The RCP is responsible for incrementing the frame counter, and the value is communicated to the host in CNF_DATA_TX after each encrypted transmission.

Filter out received packets in the RCP to prevent unecessary IND_DATA_RX indications.

Refuse frames with an explicit PAN ID different from this value. By default, the value is set to 0xffff which disables the filter.

• uint16_t pan_id

Refuse frames based on the source MAC address. This should only be used in specific testing scenarios to force network topologies. By default, the address list is empty.

• bool allowed_list
  Instead of setting a list of denied address, set a list of allowed addresses where unknown ones are refused. Both ways are mutually exclusive and this command always resets the address list.

• uint8_t count
  Number of MAC addresses in the next field.

• uint8_t eui64[8][]
  List of MAC addresses (big endian) to deny/allow.

Refuse unicast frames whose destination MAC address is not this EUI-64. By default, the EUI-64 returned in IND_RESET is used. This filter cannot be disabled currently.

• uint8_t eui64[8]
  MAC address (big endian).

Send some arbitrary data to the device. The device will reply with CNF_PING. Use this command to stress and debug the serial link with the device.

• uint16_t counter
  Arbitrary value (usually an incrementing counter that will be sent back in confirmation).

• uint16_t reply_payload_size
  Size of the payload in the CNF_PING.

• uint16_t payload_size
  Size of the payload field.

• uint8_t payload[]
  Arbitrary data. Data is not interpreted by the RCP.

Reply to REQ_PING with some arbitrary data.

• uint16_t counter
counter received in REQ_PING.

• uint16_t payload_size
  Size of the payload field. Same value as the reply_payload_size field in REQ_PING.

• uint8_t payload[]
  Arbitrary data.

Configure debug log enabled on the RCP. Logs can be read using Segger RTT. Note that enabling some verbose traces can mess up time critical operations such as mode switch or LFN communication.

• uint8_t count
  Number of trace groups to change. Trace groups not included are left untouched.

• struct trace_config[]

  • uint8_t id
    Trace group identifier as defined in sl_wisun_trace_group_t. The supported values for the RCP is a subset, as listed in the table below.
  • uint8_t level
    Trace level as defined in sl_wisun_trace_level_t.