wms_app.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_H_
#define APP_H_
 
#include <stdlib.h>
#include <stdint.h>
 
/* TODO: Move to a separate header */
#define __STATIC_INLINE static inline
 
#define APP_API_VERSION             0x200
 
#define APP_V2_TAG                  ("APP2\171\306\073\165" \
                                     "\263\303\334\322\035\266\006\115")
 
#define APP_V2_TAG_LENGTH           16
 
#define APP_V2_TAG_OFFSET           48
 
 
#define APP_V2_TAG_MIN_API_VERSION  0x200
 
#define APP_API_V1_VERSION          0x100
 
typedef union
{
    uint8_t bytes[APP_V2_TAG_LENGTH];
    uint32_t array[APP_V2_TAG_LENGTH / 4];
} app_v2_tag_t;
 
typedef struct
{
    uint32_t api_version;
    uint32_t start_address;
    uint32_t length;
    uint32_t start_ram_address;
} app_information_header_t;
 
typedef union
{
    struct
    {
        uint8_t devel;
        uint8_t maint;
        uint8_t minor;
        uint8_t major;
    };
    uint32_t    version;
} app_firmware_version_t;
 
typedef uint32_t (*app_get_api_version_f)(void);
 
typedef app_firmware_version_t (*app_get_stack_firmware_version_f)(void);
 
typedef const void * (*app_open_library_f)(uint32_t name, uint32_t version);
 
typedef struct
{
    app_get_api_version_f               getApiVersion;
    app_get_stack_firmware_version_f    getStackFirmwareVersion;
    app_open_library_f                  openLibrary;
} app_global_functions_t;
 
intptr_t App_entrypoint(const void * functions,
                        size_t reserved1,
                        const void ** reserved2,
                        void ** ram_top);
 
typedef uint32_t (*get_api_version_compatible_f)(void);
 
__STATIC_INLINE uint32_t App_getApiVersion(const void * const global_cb)
{
    uint32_t version =
        ((const get_api_version_compatible_f)*(const void **)global_cb)();
    if (version < APP_API_V1_VERSION)
    {
        // Called function was actually the getCurrentRole() function,
        // so the firmware only supports the v1 application API
        return APP_API_V1_VERSION;
    }
    return version;
}
 
typedef enum
{
    APP_RES_OK = 0,
    APP_RES_UNSPECIFIED_ERROR = 1,
    APP_RES_NOT_IMPLEMENTED = 2,
    APP_RES_INVALID_VALUE = 3,
    APP_RES_INVALID_NULL_POINTER = 4,
    APP_RES_INVALID_CONFIGURATION = 5,
    APP_RES_RESOURCE_UNAVAILABLE = 6,
    APP_RES_INVALID_STACK_STATE = 7,
    APP_RES_ACCESS_DENIED = 8,
} app_res_e;
 
typedef uint32_t app_addr_t;
 
typedef enum
{
    APP_ADDR_ANYSINK     = 0xfffffffeu,
    APP_ADDR_BROADCAST   = 0xffffffffu,
    APP_ADDR_MULTICAST   = 0x80000000u,
    APP_ADDR_MULTICAST_LAST = 0x80ffffffu,
} app_special_addr_e;
 
#endif  /* APP_H_ */