msap_frames.h

Go to the documentation of this file.

/* Copyright 2017 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef MSAP_FRAMES_H_
#define MSAP_FRAMES_H_
 
#include <stdbool.h>
#include "multicast.h"
 
#define APP_CONF_MAX    80
 
typedef uint8_t otap_seq_t;
 
#define MSAP_MAX_NBORS  8
 
#define MSAP_AUTOSTART  1
 
typedef enum
{
    NEIGHBOR_IS_NEXT_HOP,
    NEIGHBOR_IS_MEMBER,
    NEIGHBOR_IS_CLUSTER,
} msap_neighbor_type_e;
 
typedef struct __attribute__ ((__packed__))
{
    w_addr_t    addr;
    uint8_t     link_rel;
    int8_t      rssi_norm;
    uint8_t     cost_0;
    uint8_t     channel;
    uint8_t     type;
    int8_t      tx_power;
    int8_t      rx_power;
    uint16_t    last_update;
} msap_neighbor_entry_t;
 
/* MSAP attributes */
 
typedef enum
{
    /* Read only */
    MSAP_ATTR_STACK_STATUS = 1,
    MSAP_ATTR_PDU_BUFF_USAGE = 2,
    MSAP_ATTR_PDU_BUFF_CAPA = 3,
    MSAP_ATTR_NBOR_COUNT = 4,
    MSAP_ATTR_ROUTE_COUNT = 7,
    MSAP_ATTR_SYSTEM_TIME = 8,
    MSAP_ATTR_AC_LIMITS = 10,
    MSAP_ATTR_CURRENT_AC = 11,
    MSAP_ATTR_SCRATCHPAD_BLOCK_MAX = 12,
    MSAP_ATTR_SCRATCHPAD_NUM_BYTES = 14,
    /* Read / Write */
    MSAP_ATTR_RESERVED_1 = 5, /* Old MSAP_ATTR_ENERGY */
    MSAP_ATTR_AUTOSTART = 6,
    MSAP_ATTR_AC_RANGE = 9,
    MSAP_ATTR_MCAST_GROUPS = 13,
} msap_attr_e;
 
/* MSAP attributes lengths */
typedef enum
{
    MSAP_ATTR_STACK_STATUS_SIZE = 1,
    MSAP_ATTR_PDU_BUFF_USAGE_SIZE = 1,
    MSAP_ATTR_PDU_BUFF_CAP_SIZE = 1,
    MSAP_ATTR_NBOR_COUNT_SIZE = 1,
    MSAP_ATTR_RESERVED_1_SIZE = 1,
    MSAP_ATTR_AUTOSTART_SIZE = 1,
    MSAP_ATTR_ROUTE_COUNT_SIZE = 1,
    MSAP_ATTR_SYSTEM_TIME_SIZE = 4,
    MSAP_ATTR_AC_RANGE_SIZE = 4,
    MSAP_ATTR_AC_LIMITS_SIZE = 4,
    MSAP_ATTR_CURRENT_AC_SIZE = 2,
    MSAP_ATTR_SCRATCHPAD_BLOCK_MAX_SIZE = 1,
    MSAP_ATTR_MCAST_GROUPS_SIZE = \
        MULTICAST_ADDRESS_AMOUNT * sizeof(w_addr_t),
    MSAP_ATTR_SCRATCHPAD_NUM_BYTES_SIZE = 4,
} msap_attr_size_e;
 
/* FUNC_WAPS_MSAP_STACK_START_REQUEST */
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t     start_options;
} msap_start_req_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t queued_indications;
    uint8_t result;
} msap_state_ind_t;
 
/* FUNC_WAPS_MSAP_STACK_START_CONFIRMATION */
/* FUNC_WAPS_MSAP_STACK_STOP_CONFIRMATION  */
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t             queued_indications;
    uint8_t             seq;
    uint16_t            interval;
    uint8_t             config[APP_CONF_MAX];
} msap_int_ind_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t base_cost;
} msap_sink_cost_write_req_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t result;
    uint8_t base_cost;
} msap_sink_cost_read_cnf_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t             seq;
    uint16_t            interval;
    uint8_t             config[APP_CONF_MAX];
} msap_int_write_req_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t             result;
    uint8_t             seq;
    uint16_t            interval;
    uint8_t             config[APP_CONF_MAX];
} msap_int_read_cnf_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t         queued;
} msap_ind_poll_cnf_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_CLEAR_SUCCESS = 0,
    MSAP_SCRATCHPAD_CLEAR_INVALID_STATE = 1,
    MSAP_SCRATCHPAD_CLEAR_ACCESS_DENIED = 2,
} msap_scratchpad_clear_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t    num_bytes;
    otap_seq_t  seq;
} msap_scratchpad_start_req_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_START_SUCCESS = 0,
    MSAP_SCRATCHPAD_START_INVALID_STATE = 1,
    MSAP_SCRATCHPAD_START_INVALID_NUM_BYTES = 2,
    MSAP_SCRATCHPAD_START_INVALID_SEQ = 3,
    MSAP_SCRATCHPAD_START_ACCESS_DENIED = 4,
} msap_scratchpad_start_e;
 
#define MSAP_SCRATCHPAD_BLOCK_MAX_NUM_BYTES 112
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t        start_addr;
    uint8_t         num_bytes;
    uint8_t         bytes[MSAP_SCRATCHPAD_BLOCK_MAX_NUM_BYTES];
} msap_scratchpad_block_req_t;
 
#define FRAME_MSAP_SCRATCHPAD_BLOCK_REQ_HEADER_SIZE  \
    (sizeof(msap_scratchpad_block_req_t) - MSAP_SCRATCHPAD_BLOCK_MAX_NUM_BYTES)
 
typedef enum
{
    MSAP_SCRATCHPAD_BLOCK_SUCCESS = 0,
    MSAP_SCRATCHPAD_BLOCK_COMPLETED_OK = 1,
    MSAP_SCRATCHPAD_BLOCK_COMPLETED_ERROR = 2,
    MSAP_SCRATCHPAD_BLOCK_INVALID_STATE = 3,
    MSAP_SCRATCHPAD_BLOCK_NOT_ONGOING = 4,
    MSAP_SCRATCHPAD_BLOCK_INVALID_START_ADDR = 5,
    MSAP_SCRATCHPAD_BLOCK_INVALID_NUM_BYTES = 6,
    MSAP_SCRATCHPAD_BLOCK_INVALID_DATA = 7,
} msap_scratchpad_block_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t    num_bytes;
    uint16_t    crc;
    uint8_t     seq;
    uint8_t     type;
    uint8_t     status;
    uint32_t    processed_num_bytes;
    uint16_t    processed_crc;
    uint8_t     processed_seq;
    uint32_t    area_id;
    uint8_t     major_version;
    uint8_t     minor_version;
    uint8_t     maint_version;
    uint8_t     devel_version;
} msap_scratchpad_status_cnf_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_BOOTABLE_SUCCESS = 0,
    MSAP_SCRATCHPAD_BOOTABLE_INVALID_STATE = 1,
    MSAP_SCRATCHPAD_BOOTABLE_NO_SCRATCHPAD = 2,
    MSAP_SCRATCHPAD_BOOTABLE_ACCESS_DENIED = 3,
} msap_scratchpad_bootable_result_e;
 
typedef struct __attribute__ ((__packed__))
{
    w_addr_t        target;
} msap_remote_status_req_t;
 
typedef enum
{
    MSAP_REMOTE_STATUS_ACCESS_DENIED = 4,
} msap_remote_status_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t     queued_indications;
    w_addr_t    source;
    uint32_t    num_bytes;
    uint16_t    crc;
    uint8_t     seq;
    uint8_t     type;
    uint8_t     status;
    uint32_t    processed_num_bytes;
    uint16_t    processed_crc;
    uint8_t     processed_seq;
    uint32_t    area_id;
    uint8_t     major_version;
    uint8_t     minor_version;
    uint8_t     maint_version;
    uint8_t     devel_version;
    uint16_t    update_req_timeout;
} msap_remote_status_ind_t;
 
typedef enum
{
    MSAP_SCAN_NBORS_SUCCESS = 0,
    MSAP_SCAN_NBORS_INVALID_STATE = 1,
    MSAP_SCAN_NBORS_ACCESS_DENIED = 2,
} msap_scan_nbors_status_e;
 
typedef enum
{
    MSAP_NRLS_SLEEP_ACTIVE        = 1,
    MSAP_NRLS_SLEEP_NOT_STARTED   = 2
} msap_nrls_status_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t     queued_indications;
    uint8_t     scan_ready;
} msap_on_scanned_nbors_ind_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t                 result;
    msap_neighbor_entry_t   neighbors[MSAP_MAX_NBORS];
} msap_neighbors_cnf_t;
 
typedef enum
{
    MSAP_SLEEP_SUCCESS = 0,
    MSAP_SLEEP_INVALID_STATE = 1,
    MSAP_SLEEP_INVALID_ROLE = 2,
    MSAP_SLEEP_INVALID_VALUE = 5,
    MSAP_SLEEP_ACCESS_DENIED = 6,
} msap_sleep_update_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t    seconds;
    uint32_t    app_config_nrls;
} msap_sleep_start_req_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t     sleep_started;
    uint32_t    sleep_seconds;
 
} msap_sleep_state_rsp_t;
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t    gotoNRSL_seconds;
 
} msap_sleep_latest_gotosleep_rsp_t;
 
typedef struct
{
    uint8_t result;
    uint8_t quality;
    uint8_t error_codes;
} msap_install_quality_cnf_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_ACTION_NO_OTAP = 0,
    MSAP_SCRATCHPAD_ACTION_PROPAGATE_ONLY = 1,
    MSAP_SCRATCHPAD_ACTION_PROPAGATE_AND_PROCESS = 2,
    MSAP_SCRATCHPAD_ACTION_PROPAGATE_AND_PROCESS_WITH_DELAY = 3,
    MSAP_SCRATCHPAD_ACTION_LEGACY = 5,
} msap_scratchpad_action_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t  target_sequence;
    uint16_t target_crc;
    uint8_t  action;
    uint8_t  param;
} msap_scratchpad_target_write_req_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_TARGET_SUCCESS = 0,
    MSAP_SCRATCHPAD_TARGET_INVALID_ROLE = 1,
    MSAP_SCRATCHPAD_TARGET_INVALID_VALUE = 2,
    MSAP_SCRATCHPAD_TARGET_ACCESS_DENIED = 3,
} msap_scratchpad_target_write_res_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t result;
    uint8_t  target_sequence;
    uint16_t target_crc;
    uint8_t  action;
    uint8_t  param;
} msap_scratchpad_target_read_cnf_t;
 
#define MSAP_SCRATCHPAD_BLOCK_READ_MAX_NUM_BYTES (MSAP_SCRATCHPAD_BLOCK_MAX_NUM_BYTES)
 
typedef struct __attribute__ ((__packed__))
{
    uint32_t        start_addr;
    uint8_t         num_bytes;
} msap_scratchpad_block_read_req_t;
 
typedef enum
{
    MSAP_SCRATCHPAD_BLOCK_READ_SUCCESS = 0,
    MSAP_SCRATCHPAD_BLOCK_READ_INVALID_STATE = 1,
    MSAP_SCRATCHPAD_BLOCK_READ_INVALID_START_ADDR = 2,
    MSAP_SCRATCHPAD_BLOCK_READ_INVALID_NUM_BYTES = 3,
    MSAP_SCRATCHPAD_BLOCK_READ_NO_SCRATCHPAD = 4,
    MSAP_SCRATCHPAD_BLOCK_READ_ACCESS_DENIED = 5,
} msap_scratchpad_block_read_e;
 
typedef struct __attribute__ ((__packed__))
{
    uint8_t result;
    uint8_t bytes[MSAP_SCRATCHPAD_BLOCK_READ_MAX_NUM_BYTES];
} msap_scratchpad_block_read_cnf_t;
 
#define FRAME_MSAP_SCRATCHPAD_BLOCK_READ_CNF_HEADER_SIZE  \
    (sizeof(msap_scratchpad_block_read_cnf_t) - MSAP_SCRATCHPAD_BLOCK_READ_MAX_NUM_BYTES)
 
#define MSAP_NPD_PAYLOAD_MAX_LEN 80
 
typedef struct __attribute__((__packed__))
{
    uint16_t npd_endpoint;
    uint8_t npd_payload_len;
    uint8_t npd_payload[MSAP_NPD_PAYLOAD_MAX_LEN];
} msap_config_data_item_set_req_t;
 
typedef enum
{
    MSAP_CONFIG_DATA_ITEM_SET_SUCCESS = 0,
    MSAP_CONFIG_DATA_ITEM_SET_INVALID_ROLE = 1,
    MSAP_CONFIG_DATA_ITEM_SET_INVALID_ENDPOINT = 2,
    MSAP_CONFIG_DATA_ITEM_SET_OUT_OF_MEMORY = 3,
    MSAP_CONFIG_DATA_ITEM_SET_INVALID_CONTENT = 4,
    MSAP_CONFIG_DATA_ITEM_SET_NOT_SUPPORTED = 5,
} msap_config_data_item_set_e;
 
typedef struct __attribute__((__packed__))
{
    uint8_t result;
} msap_config_data_item_set_cnf_t;
 
typedef struct __attribute__((__packed__))
{
    uint16_t npd_endpoint;
} msap_config_data_item_get_req_t;
 
typedef enum
{
    MSAP_CONFIG_DATA_ITEM_GET_SUCCESS = 0,
    MSAP_CONFIG_DATA_ITEM_GET_INVALID_ENDPOINT = 1,
    MSAP_CONFIG_DATA_ITEM_GET_NOT_SUPPORTED = 2,
} msap_config_data_item_get_e;
 
#define MSAP_CONFIG_DATA_ITEM_GET_HEADER_SIZE (sizeof(msap_config_data_item_get_cnf_t) - MSAP_NPD_PAYLOAD_MAX_LEN)
 
typedef struct __attribute__((__packed__))
{
    uint8_t result;
    uint8_t npd_payload_len;
    uint8_t npd_payload[MSAP_NPD_PAYLOAD_MAX_LEN];
} msap_config_data_item_get_cnf_t;
 
typedef enum
{
    MSAP_CONFIG_DATA_LIST_ITEMS_SUCCESS = 0,
    MSAP_CONFIG_DATA_LIST_ITEMS_NOT_SUPPORTED = 1,
} msap_config_data_list_items_e;
 
#define MSAP_CONFIG_DATA_LIST_ITEMS_MAX_NUM_ENDPOINTS 16
 
#define MSAP_CONFIG_DATA_LIST_ITEMS_HEADER_SIZE (sizeof(msap_config_data_list_items_cnf_t) - sizeof(uint16_t) * MSAP_CONFIG_DATA_LIST_ITEMS_MAX_NUM_ENDPOINTS)
 
typedef struct __attribute__((__packed__))
{
    uint8_t result;
    uint8_t amount_endpoints;
    uint16_t endpoints[MSAP_CONFIG_DATA_LIST_ITEMS_MAX_NUM_ENDPOINTS];
} msap_config_data_list_items_cnf_t;
 
typedef struct __attribute__((__packed__))
{
    uint8_t command;
} msap_config_data_list_items_req_t;
 
typedef struct __attribute__((__packed__))
{
    uint8_t queued_indications;
    uint16_t npd_endpoint;
    uint8_t npd_payload_len;
    uint8_t npd_payload[MSAP_NPD_PAYLOAD_MAX_LEN];
} msap_config_data_item_ind_t;
 
typedef union
{
    msap_start_req_t                    start_req;
    msap_state_ind_t                    state_ind;
    msap_int_write_req_t                int_write_req;
    msap_int_read_cnf_t                 int_read_cnf;
    msap_sink_cost_write_req_t          cost_write_req;
    msap_sink_cost_read_cnf_t           cost_read_cnf;
    msap_neighbors_cnf_t                nbor_cnf;
    msap_int_ind_t                      int_ind;
    msap_ind_poll_cnf_t                 ind_poll_cnf;
    msap_scratchpad_start_req_t         scratchpad_start_req;
    msap_scratchpad_block_req_t         scratchpad_block_req;
    msap_scratchpad_status_cnf_t        scratchpad_status_cnf;
    msap_remote_status_req_t            remote_status_req;
    msap_remote_status_ind_t            remote_status_ind;
    msap_on_scanned_nbors_ind_t         on_scanned_nbors;
    msap_sleep_start_req_t              sleep_start_req;
    msap_sleep_state_rsp_t              sleep_state_rsp;
    msap_sleep_latest_gotosleep_rsp_t   sleep_gotosleep_rsp_t;
    msap_install_quality_cnf_t          inst_qual_cnf;
    msap_scratchpad_target_write_req_t  scratchpad_target_write_req;
    msap_scratchpad_target_read_cnf_t   scratchpad_target_read_cnf;
    msap_scratchpad_block_read_req_t    scratchpad_block_read_req;
    msap_scratchpad_block_read_cnf_t    scratchpad_block_read_cnf;
    msap_config_data_item_set_req_t     config_data_item_set_req;
    msap_config_data_item_set_cnf_t     config_data_item_set_cnf;
    msap_config_data_item_get_req_t     config_data_item_get_req;
    msap_config_data_item_get_cnf_t     config_data_item_get_cnf;
    msap_config_data_item_ind_t         config_data_item_ind;
    msap_config_data_list_items_req_t   config_data_list_items_req;
    msap_config_data_list_items_cnf_t   config_data_list_items_cnf;
} frame_msap;
 
#endif /* MSAP_FRAMES_H_ */