SWI Interface#

The SWI Interface module provides interfaces for implementing software interrupts (SWI) within the Sidewalk SDK. These interfaces enable developers to handle asynchronous events and improve the responsiveness of their applications by leveraging platform-specific SWI mechanisms.

⚠ WARNING ⚠: SWI thread priority in RTOS must stay high enough if you don't want to miss radio event

Typedefs#

typedef void(*
sid_pal_swi_cb_t)(void)

SWI callback.

Functions#

sid_error_t
sid_pal_swi_init(void)

Init the SWI handler for protocol processing.

sid_error_t
sid_pal_swi_trigger(void)

Trigger the SWI to run.

sid_error_t
sid_pal_swi_start(sid_pal_swi_cb_t event_callback)

Start the SWI.

sid_error_t
sid_pal_swi_stop(void)

Stop the SWI.

sid_error_t
sid_pal_swi_deinit(void)

Init the SWI handler for protocol processing.

Typedef Documentation#

sid_pal_swi_cb_t#

typedef void(* sid_pal_swi_cb_t) (void) )(void)

SWI callback.

Note

  • The callback which will be executed in SWI context


Definition at line 41 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h

Function Documentation#

sid_pal_swi_init#

sid_error_t sid_pal_swi_init (void )

Init the SWI handler for protocol processing.

Parameters
N/A

Function initializes SWI for triggering events.


Definition at line 50 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h

sid_pal_swi_trigger#

sid_error_t sid_pal_swi_trigger (void )

Trigger the SWI to run.

Parameters
N/A

Function triggers SWI to run.


Definition at line 59 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h

sid_pal_swi_start#

sid_error_t sid_pal_swi_start (sid_pal_swi_cb_t event_callback)

Start the SWI.

Parameters
[in]event_callback

Pointer to the callback function the SWI will trigger

Function triggers SWI to run.


Definition at line 70 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h

sid_pal_swi_stop#

sid_error_t sid_pal_swi_stop (void )

Stop the SWI.

Parameters
N/A

Function triggers SWI to run.


Definition at line 80 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h

sid_pal_swi_deinit#

sid_error_t sid_pal_swi_deinit (void )

Init the SWI handler for protocol processing.

Parameters
N/A

Function initializes SWI for triggering events.


Definition at line 90 of file /home/jenkins/workspace/pal-layer-using-doxygen-comments/component/amazon/projects/sid/sal/common/public/sid_pal_ifc/swi/sid_pal_swi_ifc.h