wms_system.h

Go to the documentation of this file.

/* Copyright 2017 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_SYSTEM_H_
#define APP_LIB_SYSTEM_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
 
#define APP_LIB_SYSTEM_NAME             0x77db1bd5 
 
 
#define APP_LIB_SYSTEM_VERSION          0x201
 
#define APP_LIB_SYSTEM_STOP_PERIODIC    UINT32_MAX
 
#define APP_LIB_SYSTEM_IRQ_PRIO_HI      0
#define APP_LIB_SYSTEM_IRQ_PRIO_LO      1
 
typedef enum
{
    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_RESERVED_8          = 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_e;
 
typedef enum
{
    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_RESERVED_8          = 8,
    APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_9          = 9,
    APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_10         = 10,
    APP_LIB_SYSTEM_PROTOCOL_PROFILE_RESERVED_11         = 11
} app_lib_system_protocol_profile_e;
 
typedef struct
{
    uint32_t hardware_magic;
    uint32_t protocol_profile;
} app_lib_system_radio_info_t;
 
typedef void (*app_lib_system_startup_cb_f)(void);
 
typedef void (*app_lib_system_shutdown_cb_f)(void);
 
typedef uint32_t (*app_lib_system_periodic_cb_f)(void);
 
typedef void (*app_lib_system_irq_handler_f)(void);
 
typedef app_res_e
    (*app_lib_system_set_startup_cb_f)(app_lib_system_startup_cb_f startup_cb);
 
typedef app_res_e
    (*app_lib_system_set_shutdown_cb_f)
    (app_lib_system_shutdown_cb_f shutdown_cb);
 
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);
 
typedef void (*app_lib_system_enter_critical_section_f)(void);
 
typedef void (*app_lib_system_exit_critical_section_f)(void);
 
typedef app_res_e (*app_lib_system_disable_deep_sleep)(bool disable);
 
typedef app_res_e
    (*app_lib_system_register_app_irq_table_f)
    (app_lib_system_irq_handler_f * table_p);
 
typedef app_res_e
    (*app_lib_system_enable_app_irq_f)(uint8_t irq_n);
 
typedef app_res_e
    (*app_lib_system_disable_app_irq_f)(uint8_t irq_n);
 
typedef app_res_e
    (*app_lib_system_enable_fast_app_irq_f)(uint8_t irq_n, uint8_t priority);
 
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);
 
typedef app_res_e
    (*app_lib_system_clear_pending_fast_app_irq_f)(uint8_t irq_n);
 
typedef uint32_t
    (*app_lib_system_get_bootloader_version_f)(void);
 
typedef app_res_e
    (*app_lib_system_get_radio_info_f)(app_lib_system_radio_info_t * info_p,
                                       size_t info_num_bytes);
 
typedef struct
{
    app_lib_system_set_startup_cb_f setStartupCb;
    app_lib_system_set_shutdown_cb_f setShutdownCb;
    app_lib_system_set_periodic_cb_f setPeriodicCb;
    app_lib_system_enter_critical_section_f enterCriticalSection;
    app_lib_system_exit_critical_section_f exitCriticalSection;
    app_lib_system_disable_deep_sleep disableDeepSleep;
    app_lib_system_enable_app_irq_with_handler_f enableAppIrq;
    app_lib_system_disable_app_irq_f disableAppIrq;
    app_lib_system_clear_pending_fast_app_irq_f clearPendingFastAppIrq;
    app_lib_system_get_bootloader_version_f getBootloaderVersion;
    app_lib_system_get_radio_info_f getRadioInfo;
} app_lib_system_t;
 
#endif /* APP_LIB_SYSTEM_H_ */