neuron/include/neu_adapter.h

/**
 * NEURON IIoT System for Industry 4.0
 * Copyright (C) 2020-2021 EMQ Technologies Co., Ltd All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 **/

#ifndef NEURON_ADAPTER_H
#define NEURON_ADAPTER_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <string.h>
#include <unistd.h>

#include "neu_datatag_table.h"
#include "neu_errcodes.h"
#include "neu_plugin_info.h"
#include "neu_tag_group_config.h"
#include "neu_types.h"

#define DEFAULT_TAG_GROUP_COUNT 8

typedef struct neu_adapter neu_adapter_t;

/**
 * definition enum and structure for neuron request and response
 */

typedef enum neu_reqresp_type {
    NEU_REQRESP_NOP,
    NEU_REQRESP_ERR_CODE, // result code of command
    NEU_REQRESP_READ_DATA,
    NEU_REQRESP_WRITE_DATA,
    NEU_REQRESP_TRANS_DATA,
    NEU_REQRESP_ADD_NODE,
    NEU_REQRESP_DEL_NODE,
    NEU_REQRESP_UPDATE_NODE,
    NEU_REQRESP_GET_NODES,
    NEU_REQRESP_NODES,
    NEU_REQRESP_ADD_GRP_CONFIG,
    NEU_REQRESP_DEL_GRP_CONFIG,
    NEU_REQRESP_UPDATE_GRP_CONFIG,
    NEU_REQRESP_GET_GRP_CONFIGS,
    NEU_REQRESP_GRP_CONFIGS,
    NEU_REQRESP_GET_DATATAGS,
    NEU_REQRESP_DATATAGS,
} neu_reqresp_type_e;

typedef uint32_t neu_node_id_t;

/* NEU_REQRESP_READ_DATA */
typedef struct neu_reqresp_read {
    neu_taggrp_config_t *grp_config;
    // TODO: use neu_variable_t to hold address information
    neu_node_id_t dst_node_id;
    uint32_t      addr;
} neu_reqresp_read_t;

/* NEU_REQRESP_WRITE_DATA */
typedef struct neu_reqresp_write {
    neu_taggrp_config_t *grp_config;
    neu_node_id_t        dst_node_id;
    uint32_t             addr;
    neu_variable_t *     data_var;
} neu_reqresp_write_t;

/* NEU_REQRESP_TRANS_DATA */
typedef struct neu_reqresp_data {
    neu_taggrp_config_t *grp_config;
    neu_variable_t *     data_var;
} neu_reqresp_data_t;

typedef enum neu_node_type {
    NEU_NODE_TYPE_UNKNOW,
    NEU_NODE_TYPE_DRIVER,
    NEU_NODE_TYPE_WEBSERVER,
    NEU_NODE_TYPE_MQTT,
    NEU_NODE_TYPE_STREAM_PROCESSOR,
    NEU_NODE_TYPE_APP,
    NEU_NODE_TYPE_MAX,
} neu_node_type_e;

typedef struct neu_node_info {
    neu_node_id_t node_id;
    char *        node_name;
    // TODO: add node attribute
} neu_node_info_t;

/* NEU_REQRESP_ADD_NODE */
typedef struct neu_cmd_add_node {
    neu_node_type_e node_type;
    const char *    adapter_name;
    const char *    plugin_name;
    // optional value, it is nothing when set to 0
    plugin_id_t plugin_id;
} neu_cmd_add_node_t;

/* NEU_REQRESP_DEL_NODE */
typedef struct neu_cmd_del_node {
    neu_node_id_t node_id;
} neu_cmd_del_node_t;

/* NEU_REQRESP_UPDATE_NODE */
typedef struct neu_cmd_update_node {
    neu_node_type_e node_type;
    const char *    adapter_name;
    const char *    plugin_name;
    // optional value, it is nothing when set to 0
    plugin_id_t plugin_id;
} neu_cmd_update_node_t;

/* NEU_REQRESP_GET_NODES */
typedef struct neu_cmd_get_nodes {
    neu_node_type_e node_type;
} neu_cmd_get_nodes_t;

/* NEU_REQRESP_NODES */
typedef struct neu_reqresp_nodes {
    vector_t nodes; // vector of neu_node_info_t
} neu_reqresp_nodes_t;

/* NEU_REQRESP_ADD_GRP_CONFIG */
typedef struct neu_cmd_add_grp_config {
    neu_node_id_t        src_node_id;
    neu_node_id_t        dst_node_id;
    neu_taggrp_config_t *grp_config;
} neu_cmd_add_grp_config_t;

/* NEU_REQRESP_DEL_GRP_CONFIG */
typedef struct neu_cmd_del_grp_config {
    neu_node_id_t node_id;
    char *        config_name;
} neu_cmd_del_grp_config_t;

/* NEU_REQRESP_UPDATE_GRP_CONFIG */
typedef struct neu_cmd_update_grp_config {
    neu_node_id_t        src_node_id;
    neu_node_id_t        dst_node_id;
    neu_taggrp_config_t *grp_config;
} neu_cmd_update_grp_config_t;

/* NEU_REQRESP_GET_GRP_CONFIGS */
typedef struct neu_cmd_get_grp_configs {
    neu_node_id_t node_id; // get group configs of this node
} neu_cmd_get_grp_configs_t;

/* NEU_REQRESP_GRP_CONFIGS */
typedef struct neu_reqresp_grp_configs {
    vector_t grp_configs; // vector of neu_taggrp_config_t pointer
} neu_reqresp_grp_configs_t;

/* NEU_REQRESP_GET_DATATAGS */
typedef struct neu_cmd_get_datatags {
    neu_node_id_t node_id; // get datatag table of this node
} neu_cmd_get_datatags_t;

/* NEU_REQRESP_DATATAGS */
typedef struct neu_reqresp_datatags {
    neu_datatag_table_t *datatag_tbl; // datatag table of a node
} neu_reqresp_datatags_t;

typedef struct neu_request {
    uint32_t           req_id;
    neu_reqresp_type_e req_type;
    uint32_t           buf_len;
    void *             buf;
} neu_request_t;

typedef struct neu_response {
    uint32_t           req_id;
    neu_reqresp_type_e resp_type;
    uint32_t           buf_len;
    void *             buf;
} neu_response_t;

/**
 * definition enum and structure for neuron event
 */
typedef enum neu_event_type {
    NEU_EVENT_NOP,
    NEU_EVENT_STATUS,
} neu_event_type_e;

typedef struct neu_event_notify {
    uint32_t         event_id;
    neu_event_type_e type;
    uint32_t         buf_len;
    void *           buf;
} neu_event_notify_t;

typedef struct neu_event_reply {
    uint32_t         event_id;
    neu_event_type_e type;
    uint32_t         buf_len;
    void *           buf;
} neu_event_reply_t;

/**
 * definition enum and structure for neuron config
 */
typedef enum neu_config_type {
    NEU_CONFIG_UNKNOW,
    NEU_CONFIG_ADDRESS,
} neu_config_type_e;

typedef struct neu_config {
    neu_config_type_e type;
    uint32_t          buf_len;
    void *            buf;
} neu_config_t;

typedef struct adapter_callbacks {
    int (*command)(neu_adapter_t *adapter, neu_request_t *cmd,
                   neu_response_t **p_result);
    int (*response)(neu_adapter_t *adapter, neu_response_t *resp);
    int (*event_notify)(neu_adapter_t *adapter, neu_event_notify_t *event);
} adapter_callbacks_t;

#ifdef __cplusplus
}
#endif

#endif