Wirepas SDK
wms_system.h File Reference

Detailed Description

The System library collects together low-level functions such as interrupt handling, critical sections and power management.

The System library also provides a simple periodic callback facility that applications can use in place of a typical main loop, to perform tasks alongside the protocol stack. The periodic callback facility also doubles as a "bottom-half" callback, also known as a slow/soft interrupt handler or deferred procedure call, which can be triggered from interrupts. This allows writing interrupt routines that react to external events quickly and then do the rest of the processing in an application callback whenever it is convenient to do so.

Library services are accessed via lib_system handle.

Definition in file wms_system.h.

Go to the source code of this file.

Typedefs

typedef void(* app_lib_system_startup_cb_f) (void)
 Startup callback. More...
 
typedef void(* app_lib_system_shutdown_cb_f) (void)
 Shutdown callback. More...
 
typedef uint32_t(* app_lib_system_periodic_cb_f) (void)
 Periodic callback. More...
 
typedef void(* app_lib_system_irq_handler_f) (void)
 Interrupt handler callback. More...
 
typedef app_res_e(* app_lib_system_set_startup_cb_f) (app_lib_system_startup_cb_f startup_cb)
 Set a callback to be called when the system starts up. More...
 
typedef app_res_e(* app_lib_system_set_shutdown_cb_f) (app_lib_system_shutdown_cb_f shutdown_cb)
 Set a callback to be called just before the system shuts down. More...
 
typedef app_res_e(* app_lib_system_set_periodic_cb_f) (app_lib_system_periodic_cb_f work_cb, uint32_t initial_delay_us, uint32_t execution_time_us)
 Set the periodic callback. More...
 
typedef void(* app_lib_system_enter_critical_section_f) (void)
 Enter a critical section. More...
 
typedef void(* app_lib_system_exit_critical_section_f) (void)
 Exit a critical section. More...
 
typedef app_res_e(* app_lib_system_disable_deep_sleep) (bool disable)
 Disable/Enable deep sleep on stack. More...
 
typedef app_res_e(* app_lib_system_register_app_irq_table_f) (app_lib_system_irq_handler_f *table_p)
 Register an interrupt handler table for the app. More...
 
typedef app_res_e(* app_lib_system_enable_app_irq_f) (uint8_t irq_n)
 Enable an app interrupt. More...
 
typedef app_res_e(* app_lib_system_disable_app_irq_f) (uint8_t irq_n)
 Disable an app interrupt. More...
 
typedef app_res_e(* app_lib_system_enable_fast_app_irq_f) (uint8_t irq_n, uint8_t priority)
 Enable a fast app interrupt. More...
 
typedef app_res_e(* app_lib_system_enable_app_irq_with_handler_f) (bool fast, uint8_t irq_n, uint8_t priority, app_lib_system_irq_handler_f handler)
 Enable a platform-specific interrupt with given handler and priority. More...
 
typedef app_res_e(* app_lib_system_clear_pending_fast_app_irq_f) (uint8_t irq_n)
 Clear fast interrupt flag from NVIC. More...
 
typedef uint32_t(* app_lib_system_get_bootloader_version_f) (void)
 Get bootloader version. More...
 
typedef app_res_e(* app_lib_system_get_radio_info_f) (app_lib_system_radio_info_t *info_p, size_t info_num_bytes)
 Return radio hardware and platform information. More...
 

Data Structures

struct  app_lib_system_radio_info_t
 Radio information structure. More...
 
struct  app_lib_system_t
 List of library functions. More...
 

Enumerations

enum  app_lib_system_hardware_magic_e {
  APP_LIB_SYSTEM_HARDWARE_MAGIC_UNKNOWN = 0, APP_LIB_SYSTEM_HARDWARE_RESERVED_1 = 1, APP_LIB_SYSTEM_HARDWARE_RESERVED_2 = 2, APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52832 = 3,
  APP_LIB_SYSTEM_HARDWARE_RESERVED_4 = 4, APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12 = 5, APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52840 = 6, APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12_512 = 7,
  APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG13 = 8, APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52833 = 9, APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG21 = 10, APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG22 = 11,
  APP_LIB_SYSTEM_HARDWARE_RESERVED_5 = 12, APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220PC22HNA = 13, APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220SC22HNA = 14, APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9160 = 15,
  APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG23 = 16, APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG24 = 17, APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9120 = 18
}
 Radio hardware magic number. More...
 
enum  app_lib_system_protocol_profile_e {
  APP_LIB_SYSTEM_PROTOCOL_PROFILE_UNKNOWN = 0, APP_LIB_SYSTEM_PROTOCOL_PROFILE_ISM_24GHZ = 1, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_2 = 2, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_3 = 3,
  APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_4 = 4, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_5 = 5, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_6 = 6, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_7 = 7,
  APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_INDIA865 = 8, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_9 = 9, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_10 = 10, APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_AUS915 = 11,
  APP_LIB_SYSTEM_PROTOCOL_PROFILE_DECT_TS_103_874_2 = 12, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_13 = 13, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_14 = 14, APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_15 = 15
}
 Protocol profiles. More...
 

Macros

#define APP_LIB_SYSTEM_NAME   0x77db1bd5
 Library symbolic name. More...
 
#define APP_LIB_SYSTEM_VERSION   0x201
 Maximum supported library version. More...
 
#define APP_LIB_SYSTEM_STOP_PERIODIC   UINT32_MAX
 Constant to stop periodic callback. More...
 
#define APP_LIB_SYSTEM_IRQ_PRIO_HI   0
 Interrupt priority levels for application. More...
 
#define APP_LIB_SYSTEM_IRQ_PRIO_LO   1
 

Typedef Documentation

◆ app_lib_system_clear_pending_fast_app_irq_f

typedef app_res_e(* app_lib_system_clear_pending_fast_app_irq_f) (uint8_t irq_n)

Clear fast interrupt flag from NVIC.

Clear platform-specific fast application interrupt irq_n in the interrupt controller. On most platforms it is also necessary to clear interrupt bits in the interrupting peripherals, which this function does not do.

Parameters
irq_nThe pending IRQ number to clear
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if irq_n is invalid, APP_RES_RESOURCE_UNAVAILABLE if irq_n is not available for the application

Definition at line 500 of file wms_system.h.

◆ app_lib_system_disable_app_irq_f

typedef app_res_e(* app_lib_system_disable_app_irq_f) (uint8_t irq_n)

Disable an app interrupt.

Disable a platform-specific interrupt irq_n. Calling this function is permitted even if the interrupt was not enabled previously.

Parameters
irq_nThe IRQ number to disable
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if irq_n is invalid, APP_RES_RESOURCE_UNAVAILABLE if irq_n is not available for the application

Definition at line 383 of file wms_system.h.

◆ app_lib_system_disable_deep_sleep

typedef app_res_e(* app_lib_system_disable_deep_sleep) (bool disable)

Disable/Enable deep sleep on stack.

Tell the stack if it is permissible to enter deep sleep or not. This can be used if the application is using a peripheral that cannot operate correctly if the stack turns off power to certain features of the hardware when sleeping.

A disable parameter value true disables deep sleep, at the expense of greatly increased power consumption. disable parameter value false, the default, will restore back normal operation. This function always returns APP_RES_OK.

Parameters
disableIf True, prevent the device from going to deep sleep. If False, enable the device to go to deep sleep state.
Returns
Result code, Always APP_RES_OK
Note
Disabling the deep sleep mode will increase the power consumption of the device. It must only be disable if needed (for example to keep using a peripheral not available in deep sleep mode: timer, ...)

Definition at line 344 of file wms_system.h.

◆ app_lib_system_enable_app_irq_f

typedef app_res_e(* app_lib_system_enable_app_irq_f) (uint8_t irq_n)

Enable an app interrupt.

Parameters
irq_nThe IRQ number to enable
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if irq_n is invalid, APP_RES_RESOURCE_UNAVAILABLE if irq_n is not available for the application or APP_RES_INVALID_CONFIGURATION if no interrupt handler or table set

Definition at line 367 of file wms_system.h.

◆ app_lib_system_enable_app_irq_with_handler_f

typedef app_res_e(* app_lib_system_enable_app_irq_with_handler_f) (bool fast, uint8_t irq_n, uint8_t priority, app_lib_system_irq_handler_f handler)

Enable a platform-specific interrupt with given handler and priority.

The fast parameter allows to choose between the two supported types of application interrupt modes.

Fast interrupt handlers should be kept very short as they are executed in interrupt context. Most of the handling should be done later, in a "bottom-half" handler, also known as a slow/soft interrupt handler, or deferred procedure call. To facilitate this, the interrupt handler can call the lib_system->setPeriodicCb() function with an initial delay of zero. This causes the periodic callback to be called as soon as possible.

If fast is false, the interrupt is considered as deferred interrupt. Then, the top half of the interrupt is handled by the stack and interrupt handler (bottom half) set by the application is called as normal application task context. Then, the top half does not need to be implemented in application. Con is that it calling of the bottom half may be too late and deferred interrupt is not necessarily feasible for all peripherals.

Not all interrupts are available for application use. Each supported platform reserves some interrupts for protocol stack use. Trying to enable a reserved interrupt will result in an error. Application interrupt handlers will never be called for reserved interrupts.

Parameters
fastTrue for a fast irq
irq_nThe IRQ number to enable
priorityInterrupt priority level (only for fast interrupt) Available levels depend on platform, but two levels are guaranteed: APP_LIB_SYSTEM_IRQ_PRIO_HI APP_LIB_SYSTEM_IRQ_PRIO_LO
handlerInterrupt handler to be called
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if irq_n is invalid, APP_RES_RESOURCE_UNAVAILABLE if irq_n is not available for the application or APP_RES_INVALID_CONFIGURATION if no interrupt handler or table set
Note
Fast interrupts and normal interrupts are disabled with the same function

Example:

static void temp_interrupt_handler(void)
{
NRF_TEMP->INTENCLR = 1;
if (NRF_TEMP->EVENTS_DATARDY != 0)
{
temperature = NRF_TEMP->TEMP;
}
else
{
temperature = 0;
}
}
void App_init(const app_global_functions_t * functions)
{
// Enable interrupt
lib_system->enableAppIrq(false,
TEMP_IRQn,
temp_interrupt_handler);
...
}

Definition at line 480 of file wms_system.h.

◆ app_lib_system_enable_fast_app_irq_f

typedef app_res_e(* app_lib_system_enable_fast_app_irq_f) (uint8_t irq_n, uint8_t priority)

Enable a fast app interrupt.

Parameters
irq_nThe IRQ number to enable
priorityInterrupt priority level. Available levels depend on platform, but two levels are guaranteed: APP_LIB_SYSTEM_IRQ_PRIO_HI APP_LIB_SYSTEM_IRQ_PRIO_LO
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if irq_n is invalid, APP_RES_RESOURCE_UNAVAILABLE if irq_n is not available for the application or APP_RES_INVALID_CONFIGURATION if no interrupt handler or table set
Note
Fast interrupts and normal interrupts are disabled with the same function

Definition at line 403 of file wms_system.h.

◆ app_lib_system_enter_critical_section_f

typedef void(* app_lib_system_enter_critical_section_f) (void)

Enter a critical section.

Interrupts are disabled for the duration of the critical section. This function and lib_system->exitCriticalSection() can be nested.

Code in critical sections must be kept extremely short and fast. Otherwise communication degradation or even total failure can result. The types of protocol timing bugs that arise from keeping interrupts disabled for too long are very difficult to diagnose.

Definition at line 309 of file wms_system.h.

◆ app_lib_system_exit_critical_section_f

typedef void(* app_lib_system_exit_critical_section_f) (void)

Exit a critical section.

Exit a critical section which was entered using the lib_system->enterCriticalSection() function. This function and lib_system->enterCriticalSection() can be nested. Interrupts are enabled again, if this was the outermost nesting level.

Definition at line 320 of file wms_system.h.

◆ app_lib_system_get_bootloader_version_f

typedef uint32_t(* app_lib_system_get_bootloader_version_f) (void)

Get bootloader version.

Return a small positive integer that represents the version of the bootloader. For platforms without bootloader, this function returns 0.

Returns
Bootloader version

Definition at line 511 of file wms_system.h.

◆ app_lib_system_get_radio_info_f

typedef app_res_e(* app_lib_system_get_radio_info_f) (app_lib_system_radio_info_t *info_p, size_t info_num_bytes)

Return radio hardware and platform information.

Parameters
info_ppointer to store system radio info result
num_bytesthe number of bytes of information to copy, at most the size of app_lib_system_radio_info_t. This allows making the information struct bigger in the future.
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if info_num_bytes is invalid, APP_RES_INVALID_NULL_POINTER if info_p is NULL

Definition at line 527 of file wms_system.h.

◆ app_lib_system_irq_handler_f

typedef void(* app_lib_system_irq_handler_f) (void)

Interrupt handler callback.

Interrupt handlers registered with lib_system->enableAppIrq().

Interrupt handlers have no parameters or return value.

Definition at line 228 of file wms_system.h.

◆ app_lib_system_periodic_cb_f

typedef uint32_t(* app_lib_system_periodic_cb_f) (void)

Periodic callback.

This function is called after a set delay. If the set delay is zero, this function is called as soon as possible.

Any code, including interrupts can use lib_system->setPeriodicCb() function to set or change the periodic callback. This can be used the defer processing to a "bottom half", also known as a slow/soft interrupt handler, or deferred procedure call.

The return value is used as the next delay value, in microseconds. If APP_LIB_SYSTEM_STOP_PERIODIC is returned, the callback is not called again.

Because of limited range of return value (32 bits) and the internal comparison made by the scheduler, the maximum delay before being scheduled cannot be higher than the value returned by the lib_time->getMaxHpDelay service (This value is around 30 minutes).

Returns
Delay in us, for this function to be called again or APP_LIB_SYSTEM_STOP_PERIODIC to stop

Definition at line 218 of file wms_system.h.

◆ app_lib_system_register_app_irq_table_f

typedef app_res_e(* app_lib_system_register_app_irq_table_f) (app_lib_system_irq_handler_f *table_p)

Register an interrupt handler table for the app.

Parameters
table_pPointer to the app interrupt handler table
Returns
Result code, Always APP_RES_OK

Definition at line 354 of file wms_system.h.

◆ app_lib_system_set_periodic_cb_f

typedef app_res_e(* app_lib_system_set_periodic_cb_f) (app_lib_system_periodic_cb_f work_cb, uint32_t initial_delay_us, uint32_t execution_time_us)

Set the periodic callback.

Set the periodic callback to the given function. If NULL is passed, the periodic callback is disabled. The periodic callback is also disabled if the callback function returns APP_LIB_SYSTEM_STOP_PERIODIC.

Parameter initial_delay_us is the amount of time to wait, in microseconds, before calling the callback. If set to zero, the callback is called immediately whenever there is enough time. Parameter execution_time_us tells the stack what is the longest amount of time the function call is expected to take, in microseconds. The stack will then schedule the callback to the next available slot that has enough time. If the callback overruns its allocated time slot and returns late, the protocol timing is compromised.

Returns APP_RES_INVALID_VALUE if execution_time_us is greater than 100000 (100 ms). Otherwise, returns APP_RES_OK.

Because of limited range of return value (32 bits) and the internal comparison made by the scheduler, the maximum delay before being scheduled cannot be higher than the value returned by the lib_time->getMaxHpDelay() service (This value is around 30 minutes).

For more information on scheduling, see cooperative_mcu_access.

Parameters
work_cbThe function to be executed, or NULL to unset
initial_delay_usDelay from now in us to call the work function
execution_time_usMaximum time for the work function to execute in us
Returns
Result code, APP_RES_OK if successful, APP_RES_INVALID_VALUE if execution_time_us is too high
Note
When the callback returns APP_LIB_SYSTEM_STOP_PERIODIC, it will not be called again
Unlike most services, this service is safe to be used from fast_interrupt "fast interrupt execution context"

Definition at line 292 of file wms_system.h.

◆ app_lib_system_set_shutdown_cb_f

typedef app_res_e(* app_lib_system_set_shutdown_cb_f) (app_lib_system_shutdown_cb_f shutdown_cb)

Set a callback to be called just before the system shuts down.

Parameters
shutdown_cbThe function to be executed, or NULL to unset
Returns
Result code, always APP_RES_OK

Definition at line 250 of file wms_system.h.

◆ app_lib_system_set_startup_cb_f

typedef app_res_e(* app_lib_system_set_startup_cb_f) (app_lib_system_startup_cb_f startup_cb)

Set a callback to be called when the system starts up.

Parameters
startup_cbThe function to be executed, or NULL to unset
Returns
Result code, always APP_RES_OK
Note
The callback will be called once after returning from app_init "App_init()" and then each time after an enabled interrupt handler is run, until the stack is started in the callback

Definition at line 240 of file wms_system.h.

◆ app_lib_system_shutdown_cb_f

typedef void(* app_lib_system_shutdown_cb_f) (void)

Shutdown callback.

This callback is called when the lib_state->stopStack() function in the State library ( wms_state.h) is called, or some other reason (e.g. OTAP, Remote API) is causing the stack to stop. The lib_system->setShutdownCb() function can be used to set or change the shutdown callback.

There is no return value from this function. Returning from the callback reboots the node.

Definition at line 193 of file wms_system.h.

◆ app_lib_system_startup_cb_f

typedef void(* app_lib_system_startup_cb_f) (void)

Startup callback.

This callback is called after every interrupt, until the stack is started by calling lib_state->startStack() function in the State library ( wms_state.h). If the stack is running initially, the startup callback is not called at all. Any code, including interrupts can use lib_system->setStartupCb() function to set or change the startup callback.

There is no return value from this function. Returning from this callback will cause the node to enter a low power sleep, until another interrupt will cause it to wake up again.

Definition at line 178 of file wms_system.h.


Data Structure Documentation

◆ app_lib_system_radio_info_t

struct app_lib_system_radio_info_t

Radio information structure.

Information returned by lib_system->getRadioInfo()

Definition at line 156 of file wms_system.h.

Data Fields
uint32_t hardware_magic

Radio hardware magic number, app_lib_system_hardware_magic_e

uint32_t protocol_profile

Protocol profile, app_lib_system_protocol_profile_e

◆ app_lib_system_t

struct app_lib_system_t

Enumeration Type Documentation

◆ app_lib_system_hardware_magic_e

Radio hardware magic number.

This number is returned by lib_system->getRadioInfo() function and can be used by the application to detect which radio platform it is running on.

Enumerator
APP_LIB_SYSTEM_HARDWARE_MAGIC_UNKNOWN 

Unknown radio (should never happen)

APP_LIB_SYSTEM_HARDWARE_RESERVED_1 

Obsolete reserved value

APP_LIB_SYSTEM_HARDWARE_RESERVED_2 

Obsolete reserved value

APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52832 

Nordic Semiconductor nRF52832

APP_LIB_SYSTEM_HARDWARE_RESERVED_4 

Obsolete reserved value

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12 

Silicon Labs EFR32XG12 1024 kB Flash, 128 kB RAM

APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52840 

Nordic Semiconductor nRF52840

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12_512 

Silicon Labs EFR32XG12 512 kB Flash, 64 kB RAM

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG13 

Silicon Labs EFR32xG13 512 kB Flash, 64 kB RAM

APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52833 

Nordic Semiconductor nRF52833

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG21 

Silicon Labs EFR32xG21

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG22 

Silicon Labs EFR32xG22, 512 kB Flash, 32 kB RAM

APP_LIB_SYSTEM_HARDWARE_RESERVED_5 

Reserved

APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220PC22HNA 

Silicon Labs BGM220PC22HNA

APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220SC22HNA 

Silicon Labs BGM220SC22HNA

APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9160 

Nordic Semiconductor nRF9160 (legacy)

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG23 

Silicon Labs EFR32xG23

APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG24 

Silicon Labs EFR32xG24

APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9120 

Nordic Semiconductor nRF9161 or nRF9131, a.k.a. nRF9120

Definition at line 64 of file wms_system.h.

◆ app_lib_system_protocol_profile_e

Protocol profiles.

Protocol profile, which is a value that depends on the radio band, regulatory domain and platform capabilities such as available modulation types, channel spacing, output power levels, etc. This number is returned by lib_system->getRadioInfo().

Enumerator
APP_LIB_SYSTEM_PROTOCOL_PROFILE_UNKNOWN 

Unknown protocol profile (should never happen)

APP_LIB_SYSTEM_PROTOCOL_PROFILE_ISM_24GHZ 

2.4 GHz with BLE Phy

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_2 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_3 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_4 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_5 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_6 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_7 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_INDIA865 

India 865 MHz with SubG Phy

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_9 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_10 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_AUS915 

Aus 915 MHz with SubG Phy

APP_LIB_SYSTEM_PROTOCOL_PROFILE_DECT_TS_103_874_2 

Smart metering

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_13 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_14 

Obsolete reserved value

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_15 

Obsolete reserved value

Definition at line 114 of file wms_system.h.

Macro Definition Documentation

◆ APP_LIB_SYSTEM_IRQ_PRIO_HI

#define APP_LIB_SYSTEM_IRQ_PRIO_HI   0

Interrupt priority levels for application.

Note
These do not correspond to NVIC priority levels, however, a lower number (higher priority) is guaranteed to have a higher NVIC priority as well

Definition at line 54 of file wms_system.h.

◆ APP_LIB_SYSTEM_IRQ_PRIO_LO

#define APP_LIB_SYSTEM_IRQ_PRIO_LO   1

Definition at line 55 of file wms_system.h.

◆ APP_LIB_SYSTEM_NAME

#define APP_LIB_SYSTEM_NAME   0x77db1bd5

Library symbolic name.

"SYSTEM"

Definition at line 35 of file wms_system.h.

◆ APP_LIB_SYSTEM_STOP_PERIODIC

#define APP_LIB_SYSTEM_STOP_PERIODIC   UINT32_MAX

Constant to stop periodic callback.

When this constant is returned from a periodic callback (app_lib_system_periodic_cb_f) , the stack will not call the callback again.

Definition at line 46 of file wms_system.h.

◆ APP_LIB_SYSTEM_VERSION

#define APP_LIB_SYSTEM_VERSION   0x201

Maximum supported library version.

Definition at line 38 of file wms_system.h.

APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_14
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_14
Definition: wms_system.h:145
APP_LIB_SYSTEM_PROTOCOL_PROFILE_UNKNOWN
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_UNKNOWN
Definition: wms_system.h:117
APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_INDIA865
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_INDIA865
Definition: wms_system.h:133
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_9
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_9
Definition: wms_system.h:135
APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52840
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52840
Definition: wms_system.h:79
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG23
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG23
Definition: wms_system.h:99
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12
Definition: wms_system.h:77
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG22
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG22
Definition: wms_system.h:89
APP_LIB_SYSTEM_HARDWARE_RESERVED_5
@ APP_LIB_SYSTEM_HARDWARE_RESERVED_5
Definition: wms_system.h:91
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG21
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG21
Definition: wms_system.h:87
APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9160
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9160
Definition: wms_system.h:97
APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220PC22HNA
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220PC22HNA
Definition: wms_system.h:93
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_15
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_15
Definition: wms_system.h:147
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12_512
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG12_512
Definition: wms_system.h:81
app_lib_system_hardware_magic_e
app_lib_system_hardware_magic_e
Radio hardware magic number.
Definition: wms_system.h:64
APP_LIB_SYSTEM_HARDWARE_RESERVED_1
@ APP_LIB_SYSTEM_HARDWARE_RESERVED_1
Definition: wms_system.h:69
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_5
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_5
Definition: wms_system.h:127
APP_LIB_SYSTEM_HARDWARE_MAGIC_UNKNOWN
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_UNKNOWN
Definition: wms_system.h:67
APP_LIB_SYSTEM_IRQ_PRIO_LO
#define APP_LIB_SYSTEM_IRQ_PRIO_LO
Definition: wms_system.h:55
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_2
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_2
Definition: wms_system.h:121
APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_AUS915
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_SUB_AUS915
Definition: wms_system.h:139
app_global_functions_t
List of global functions, passed to App_entrypoint()
Definition: wms_app.h:157
APP_LIB_SYSTEM_HARDWARE_RESERVED_2
@ APP_LIB_SYSTEM_HARDWARE_RESERVED_2
Definition: wms_system.h:71
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_7
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_7
Definition: wms_system.h:131
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_10
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_10
Definition: wms_system.h:137
APP_LIB_SYSTEM_PROTOCOL_PROFILE_ISM_24GHZ
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_ISM_24GHZ
Definition: wms_system.h:119
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG24
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG24
Definition: wms_system.h:101
APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220SC22HNA
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_BGM220SC22HNA
Definition: wms_system.h:95
app_lib_system_protocol_profile_e
app_lib_system_protocol_profile_e
Protocol profiles.
Definition: wms_system.h:114
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_6
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_6
Definition: wms_system.h:129
APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52832
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52832
Definition: wms_system.h:73
APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9120
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF9120
Definition: wms_system.h:103
APP_LIB_SYSTEM_HARDWARE_RESERVED_4
@ APP_LIB_SYSTEM_HARDWARE_RESERVED_4
Definition: wms_system.h:75
APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52833
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_NRF52833
Definition: wms_system.h:85
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_13
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_13
Definition: wms_system.h:143
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_3
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_3
Definition: wms_system.h:123
APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_4
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_4
Definition: wms_system.h:125
APP_LIB_SYSTEM_PROTOCOL_PROFILE_DECT_TS_103_874_2
@ APP_LIB_SYSTEM_PROTOCOL_PROFILE_DECT_TS_103_874_2
Definition: wms_system.h:141
APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG13
@ APP_LIB_SYSTEM_HARDWARE_MAGIC_EFR32XG13
Definition: wms_system.h:83