swc_def.h

SPARK Wireless Core definitions.

Copyright

Copyright (C) 2026 SPARK Microsystems International Inc. All rights reserved.

License

This source code is proprietary and subject to the SPARK Microsystems Software EULA found in this package in file EULA.txt.

Author

SPARK FW Team.

Typedefs

typedef enum swc_role swc_role_t

Node’s Role.

typedef enum swc_sleep_level swc_sleep_level_t

Node’s Sleep Level.

typedef enum swc_irq_polarity swc_irq_polarity_t

Radio’s Interrupt Request Polarity.

typedef enum swc_spi_mode swc_spi_mode_t

Radio’s SPI mode.

typedef enum swc_modulation swc_modulation_t

Connection’s Modulation.

typedef enum swc_fec_ratio swc_fec_ratio_t

Connection’s Forward Error Correction Ratio.

typedef enum swc_cca_fail_action swc_cca_fail_action_t

Clear Channel Assessment Fail Action.

Note

Selects what the Wireless Core does when every CCA attempt fails, meaning the channel is still sensed busy after the last energy reading.

typedef enum swc_event swc_event_t

Wireless core events.

typedef enum swc_concurrency_mode swc_concurrency_mode_t

Concurrency modes.

Enums

enum swc_role

Node’s Role.

Values:

enumerator SWC_ROLE_COORDINATOR

Node acts as the Coordinator.

enumerator SWC_ROLE_NODE

Node has no special function.

enum swc_sleep_level

Node’s Sleep Level.

Values:

enumerator SWC_SLEEP_IDLE

Idle sleep level.

enumerator SWC_SLEEP_SHALLOW

Shallow sleep level.

enumerator SWC_SLEEP_DEEP

Deep sleep level.

enum swc_irq_polarity

Radio’s Interrupt Request Polarity.

Values:

enumerator SWC_IRQ_ACTIVE_LOW

Interrupt pin active in low state.

enumerator SWC_IRQ_ACTIVE_HIGH

Interrupt pin active in high state.

enum swc_spi_mode

Radio’s SPI mode.

Values:

enumerator SWC_SPI_STANDARD

SPI timings are standard.

enumerator SWC_SPI_FAST

SPI timings are optimized for high capacitive load on the bus.

enum swc_modulation

Connection’s Modulation.

Values:

enumerator SWC_MOD_IOOK

Inverted on-off keying.

enumerator SWC_MOD_2BITPPM

2-bit pulse position modulation.

enum swc_fec_ratio

Connection’s Forward Error Correction Ratio.

Values:

enumerator SWC_FEC_1_0_0

FEC ratio 1.00.

enumerator SWC_FEC_1_3_3

FEC ratio 1.33.

enumerator SWC_FEC_1_6_6

FEC ratio 1.66.

enumerator SWC_FEC_2_0_0

FEC ratio 2.00.

enum swc_cca_fail_action

Clear Channel Assessment Fail Action.

Note

Selects what the Wireless Core does when every CCA attempt fails, meaning the channel is still sensed busy after the last energy reading.

Values:

enumerator SWC_CCA_FORCE_TX

Transmit anyway. When all readings fail, the frame is forced out after one additional retry_time delay, transmitting directly instead of performing a final CCA check. Favors link availability at the cost of a higher risk of colliding with another transmission.

enumerator SWC_CCA_ABORT_TX

Abort the transmission. The frame is not sent and stays in the TX queue to be retried at the connection’s next timeslot. Avoids risking a collision with another device on the channel, at the cost of added latency.

enum swc_event

Wireless core events.

Values:

enumerator SWC_EVENT_NONE

No event.

enumerator SWC_EVENT_CONNECT

The connection is established between nodes.

enumerator SWC_EVENT_DISCONNECT

The connection is broken between nodes.

enumerator SWC_EVENT_ERROR

An error occurred on the wireless core.

enum swc_concurrency_mode

Concurrency modes.

Values:

enumerator SWC_CONCURRENCY_MODE_HIGH_PERFORMANCE

Concurrency mode for high performance MCU.

enumerator SWC_CONCURRENCY_MODE_LOW_PERFORMANCE

Concurrency mode for low performance MCU.