ewf_adapter_quectel_bg96.h

Go to the documentation of this file.

/************************************************************************/
#ifndef __ewf_adapter_quectel_bg96__h__included__
#define __ewf_adapter_quectel_bg96__h__included__
 
#include "ewf_adapter.h"
#include "ewf_allocator.h"
#include "ewf_interface.h"
#include "ewf_adapter_api_modem.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/************************************************************************/
#ifndef EWF_ADAPTER_QUECTEL_BG96_UFS_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_UFS_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_ENABLED (1)
#endif
 
#if !defined(EWF_ADAPTER_QUECTEL_BG96_TLS_ENABLED) && !defined(EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED)
#if 1
#define EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_TLS_BASIC_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_BG96_TLS_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_COMMON_TLS_ENABLED (0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_COMMON_TLS_BASIC_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_BG96_TLS_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_TLS_ENABLED (1)
#endif
#endif
 
#ifndef EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_TCP_ENABLED (1)
#endif
 
#ifndef EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_UDP_ENABLED (1)
#endif
 
#if !defined(EWF_ADAPTER_QUECTEL_BG96_MQTT_ENABLED) && !defined(EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED)
#if 1
#define EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_MQTT_BASIC_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_BG96_MQTT_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_COMMON_MQTT_ENABLED (0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_COMMON_MQTT_BASIC_ENABLED (0)
#define EWF_ADAPTER_QUECTEL_BG96_MQTT_ENABLED (1)
#define EWF_ADAPTER_QUECTEL_COMMON_MQTT_ENABLED (1)
#endif
#endif
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_ROOT_CA_CERTIFICATE_FILE_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_FILE_NAME      EWF_CONFIG_ADAPTER_QUECTEL_BG96_ROOT_CA_CERTIFICATE_FILE_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_USER_CA_CERTIFICATE_FILE_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_FILE_NAME      EWF_CONFIG_ADAPTER_QUECTEL_BG96_USER_CA_CERTIFICATE_FILE_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_CERTIFICATE_CA_FILE_NAME
#define EWF_CONFIG_ADAPTER_RENESAS_COMMON_CA_CERTIFICATE_FILE_NAME           EWF_CONFIG_ADAPTER_QUECTEL_BG96_CA_CERTIFICATE_FILE_NAME
#endif
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_CERTIFICATE_FILE_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_CERTIFICATE_FILE_NAME       EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_CERTIFICATE_FILE_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_PRIVATE_KEY_FILE_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_PRIVATE_KEY_FILE_NAME       EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_PRIVATE_KEY_FILE_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_ROOT_CA_CERTIFICATE_BUFFER_NAME
#undef EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_BUFFER_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_BUFFER_NAME    EWF_CONFIG_ADAPTER_QUECTEL_BG96_ROOT_CA_CERTIFICATE_BUFFER_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_USER_CA_CERTIFICATE_BUFFER_NAME
#undef EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_BUFFER_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_BUFFER_NAME    EWF_CONFIG_ADAPTER_QUECTEL_BG96_USER_CA_CERTIFICATE_BUFFER_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_CERTIFICATE_BUFFER_NAME
#undef EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_CERTIFICATE_BUFFER_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_CERTIFICATE_BUFFER_NAME     EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_CERTIFICATE_BUFFER_NAME
#endif 
 
#ifdef EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_PRIVATE_KEY_BUFFER_NAME
#undef EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_PRIVATE_KEY_BUFFER_NAME
#define EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_PRIVATE_KEY_BUFFER_NAME     EWF_CONFIG_ADAPTER_QUECTEL_BG96_CLIENT_PRIVATE_KEY_BUFFER_NAME
#endif 
 
/************************************************************************/
/* Include the Quectel common header here, to take the above configuration macros into account */
#include "ewf_adapter_quectel_common.h"
 
/************************************************************************/
extern ewf_adapter_api_control ewf_adapter_quectel_bg96_api_control;
 
ewf_result ewf_adapter_quectel_bg96_start(ewf_adapter* adapter_ptr);
ewf_result ewf_adapter_quectel_bg96_stop(ewf_adapter* adapter_ptr);
 
ewf_result ewf_adapter_quectel_bg96_urc_callback(ewf_interface* interface_ptr, uint8_t* buffer_ptr, uint32_t buffer_length);
 
#define ewf_adapter_quectel_bg96_info                       ewf_adapter_quectel_common_info
#define ewf_adapter_quectel_bg96_get_ipv4_address           ewf_adapter_quectel_common_get_ipv4_address
#define ewf_adapter_quectel_bg96_get_ipv4_netmask           ewf_adapter_quectel_common_get_ipv4_netmask
#define ewf_adapter_quectel_bg96_get_ipv4_gateway           ewf_adapter_quectel_common_get_ipv4_gateway
#define ewf_adapter_quectel_bg96_get_ipv4_dns               ewf_adapter_quectel_common_get_ipv4_dns
 
#define ewf_adapter_quectel_bg96_context_start              ewf_adapter_quectel_common_context_start
#define ewf_adapter_quectel_bg96_context_stop               ewf_adapter_quectel_common_context_stop
 
#define ewf_adapter_quectel_bg96_context_urc_callback       ewf_adapter_quectel_common_context_urc_callback
 
#define ewf_adapter_quectel_bg96_context_activate           ewf_adapter_quectel_common_context_activate
#define ewf_adapter_quectel_bg96_context_deactivate         ewf_adapter_quectel_common_context_deactivate
#define ewf_adapter_quectel_bg96_context_configure          ewf_adapter_quectel_common_context_configure
#define ewf_adapter_quectel_bg96_context_configure_dns      ewf_adapter_quectel_common_context_configure_dns
 
#if EWF_ADAPTER_QUECTEL_BG96_UFS_ENABLED
 
#define ewf_adapter_quectel_bg96_ufs_start                  ewf_adapter_quectel_common_ufs_start
#define ewf_adapter_quectel_bg96_ufs_stop                   ewf_adapter_quectel_common_ufs_stop
 
#define ewf_adapter_quectel_bg96_ufs_urc_callback           ewf_adapter_quectel_common_ufs_urc_callback
 
#define ewf_adapter_quectel_bg96_ufs_list                   ewf_adapter_quectel_common_ufs_list
#define ewf_adapter_quectel_bg96_ufs_delete                 ewf_adapter_quectel_common_ufs_delete
#define ewf_adapter_quectel_bg96_ufs_upload                 ewf_adapter_quectel_common_ufs_upload
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_UFS_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED
 
#define ewf_adapter_quectel_bg96_tls_basic_start            ewf_adapter_quectel_common_tls_basic_start
#define ewf_adapter_quectel_bg96_tls_basic_stop             ewf_adapter_quectel_common_tls_basic_stop
 
#define ewf_adapter_quectel_bg96_tls_basic_urc_callback     ewf_adapter_quectel_common_tls_basic_urc_callback
 
#define ewf_adapter_quectel_bg96_tls_basic_init             ewf_adapter_quectel_common_tls_basic_init
#define ewf_adapter_quectel_bg96_tls_basic_clean            ewf_adapter_quectel_common_tls_basic_clean
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED */
 
#define ewf_adapter_quectel_bg96_internet_start             ewf_adapter_quectel_common_internet_start
#define ewf_adapter_quectel_bg96_internet_stop              ewf_adapter_quectel_common_internet_stop
 
#define ewf_adapter_quectel_bg96_internet_urc_callback      ewf_adapter_quectel_common_internet_urc_callback
 
#if EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED
 
#define ewf_adapter_quectel_bg96_tcp_open                   ewf_adapter_quectel_common_tcp_open
#define ewf_adapter_quectel_bg96_tcp_close                  ewf_adapter_quectel_common_tcp_close
#define ewf_adapter_quectel_bg96_tcp_control                ewf_adapter_quectel_common_tcp_control
#define ewf_adapter_quectel_bg96_tcp_set_tls_configuration  ewf_adapter_quectel_common_tcp_set_tls_configuration
#define ewf_adapter_quectel_bg96_tcp_bind                   ewf_adapter_quectel_common_tcp_bind
#define ewf_adapter_quectel_bg96_tcp_listen                 ewf_adapter_quectel_common_tcp_listen
#define ewf_adapter_quectel_bg96_tcp_accept                 ewf_adapter_quectel_common_tcp_accept
#define ewf_adapter_quectel_bg96_tcp_connect                ewf_adapter_quectel_common_tcp_connect
#define ewf_adapter_quectel_bg96_tcp_shutdown               ewf_adapter_quectel_common_tcp_shutdown
#define ewf_adapter_quectel_bg96_tcp_send                   ewf_adapter_quectel_common_tcp_send
#define ewf_adapter_quectel_bg96_tcp_receive                ewf_adapter_quectel_common_tcp_receive
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED
 
#define ewf_adapter_quectel_bg96_udp_open                   ewf_adapter_quectel_common_udp_open
#define ewf_adapter_quectel_bg96_udp_close                  ewf_adapter_quectel_common_udp_close
#define ewf_adapter_quectel_bg96_udp_control                ewf_adapter_quectel_common_udp_control
#define ewf_adapter_quectel_bg96_udp_set_dtls_configuration ewf_adapter_quectel_common_udp_set_dtls_configuration
#define ewf_adapter_quectel_bg96_udp_bind                   ewf_adapter_quectel_common_udp_bind
#define ewf_adapter_quectel_bg96_udp_send_to                ewf_adapter_quectel_common_udp_send_to
#define ewf_adapter_quectel_bg96_udp_receive_from           ewf_adapter_quectel_common_udp_receive_from
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_MQTT_ENABLED
 
ewf_result ewf_adapter_quectel_bg96_mqtt_start(ewf_adapter* adapter_ptr);
ewf_result ewf_adapter_quectel_bg96_mqtt_stop(ewf_adapter* adapter_ptr);
 
ewf_result ewf_adapter_quectel_bg96_mqtt_urc_callback(ewf_interface* interface_ptr, uint8_t* buffer_ptr, uint32_t buffer_length);
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_MQTT_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED
 
#define ewf_adapter_quectel_bg96_mqtt_basic_start                           ewf_adapter_quectel_common_mqtt_basic_start
#define ewf_adapter_quectel_bg96_mqtt_basic_stop                            ewf_adapter_quectel_common_mqtt_basic_stop
 
#define ewf_adapter_quectel_bg96_mqtt_basic_urc_callback                    ewf_adapter_quectel_common_mqtt_basic_urc_callback
 
#define ewf_adapter_quectel_bg96_mqtt_basic_default_state_callback          ewf_adapter_quectel_common_mqtt_basic_default_state_callback
#define ewf_adapter_quectel_bg96_mqtt_basic_default_message_callback        ewf_adapter_quectel_common_mqtt_basic_default_message_callback
 
#define ewf_adapter_quectel_bg96_mqtt_basic_connect                         ewf_adapter_quectel_common_mqtt_basic_connect
#define ewf_adapter_quectel_bg96_mqtt_basic_disconnect                      ewf_adapter_quectel_common_mqtt_basic_disconnect
#define ewf_adapter_quectel_bg96_mqtt_basic_subscribe                       ewf_adapter_quectel_common_mqtt_basic_subscribe
#define ewf_adapter_quectel_bg96_mqtt_basic_unsubscribe                     ewf_adapter_quectel_common_mqtt_basic_unsubscribe
#define ewf_adapter_quectel_bg96_mqtt_basic_publish                         ewf_adapter_quectel_common_mqtt_basic_publish
 
#endif /* EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED */
 
/******************************************************************************
 *
 * Internal data
 *
 ******************************************************************************/
 
typedef struct _ewf_adapter_quectel_bg96
{
    ewf_adapter_quectel_common common_implementation_data;
 
} ewf_adapter_quectel_bg96;
 
#ifdef EWF_PARAMETER_CHECKING
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_HEADER(adapter_ptr)                                                                                                 \
do {                                                                                                                                                            \
(adapter_ptr)->struct_magic = EWF_ADAPTER_STRUCT_MAGIC;                                                                                                         \
(adapter_ptr)->struct_size = EWF_ADAPTER_STRUCT_SIZE;                                                                                                           \
(adapter_ptr)->struct_version = EWF_ADAPTER_VERSION;                                                                                                            \
(adapter_ptr)->struct_type = EWF_ADAPTER_TYPE_QUECTEL_BG96;                                                                                                     \
} while(0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_HEADER(adapter_ptr)
#endif /* EWF_PARAMETER_CHECKING */
 
#if EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TCP_API(adapter_ptr)                                                                                                \
do {                                                                                                                                                            \
adapter_ptr->tcp_api_ptr = &ewf_adapter_quectel_common_api_tcp;                                                                                                 \
} while(0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TCP_API(adapter_ptr)
#endif /* EWF_ADAPTER_QUECTEL_BG96_TCP_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_UDP_API(adapter_ptr)                                                                                                \
do {                                                                                                                                                            \
adapter_ptr->udp_api_ptr = &ewf_adapter_quectel_common_api_udp;                                                                                                 \
} while(0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_UDP_API(adapter_ptr)
#endif /* EWF_ADAPTER_QUECTEL_BG96_UDP_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TLS_BASIC_API(adapter_ptr)                                                                                          \
do {                                                                                                                                                            \
adapter_ptr->tls_basic_api_ptr = &ewf_adapter_quectel_common_api_tls_basic;                                                                                     \
} while(0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TLS_BASIC_API(adapter_ptr)
#endif /* EWF_ADAPTER_QUECTEL_BG96_TLS_BASIC_ENABLED */
 
#if EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_MQTT_BASIC_API(adapter_ptr)                                                                                         \
do {                                                                                                                                                            \
adapter_ptr->mqtt_basic_api_ptr = &ewf_adapter_quectel_common_api_mqtt_basic;                                                                                   \
} while(0)
#else
#define EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_MQTT_BASIC_API(adapter_ptr)
#endif /* EWF_ADAPTER_QUECTEL_BG96_MQTT_BASIC_ENABLED */
 
#define EWF_ADAPTER_QUECTEL_BG96_STATIC_DECLARE(adapter_ptr, adapter_name_symb, message_allocator_ptr_param, data_allocator_ptr_param, interface_ptr_param)     \
do {                                                                                                                                                            \
static ewf_adapter_quectel_bg96 ewf_adapter_quectel_bg96__implementation__##adapter_name_symb = {0};                                                            \
static ewf_adapter ewf_adapter_quectel_bg96__##adapter_name_symb = {0};                                                                                         \
interface_ptr_param->message_allocator_ptr = message_allocator_ptr_param;                                                                                       \
interface_ptr_param->data_allocator_ptr = data_allocator_ptr_param;                                                                                             \
interface_ptr_param->urc_callback = ewf_adapter_quectel_bg96_urc_callback;                                                                                      \
ewf_adapter_quectel_bg96__##adapter_name_symb.interface_ptr = interface_ptr_param;                                                                              \
ewf_adapter_quectel_bg96__##adapter_name_symb.implementation_ptr = &(ewf_adapter_quectel_bg96__implementation__##adapter_name_symb);                            \
adapter_ptr = &(ewf_adapter_quectel_bg96__##adapter_name_symb);                                                                                                 \
interface_ptr_param->adapter_ptr = adapter_ptr;                                                                                                                 \
EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_HEADER(adapter_ptr);                                                                                                        \
ewf_adapter_quectel_bg96__##adapter_name_symb.control_api_ptr = &ewf_adapter_quectel_bg96_api_control;                                                          \
ewf_adapter_quectel_bg96__##adapter_name_symb.info_api_ptr = &ewf_adapter_quectel_common_api_info;                                                              \
EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TCP_API(adapter_ptr);                                                                                                       \
EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_UDP_API(adapter_ptr);                                                                                                       \
EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_TLS_BASIC_API(adapter_ptr);                                                                                                 \
EWF_ADAPTER_QUECTEL_BG96_INITIALIZE_MQTT_BASIC_API(adapter_ptr);                                                                                                \
} while(0)
 
/************************************************************************/
#ifdef __cplusplus
}
#endif
 
#endif /* __ewf_adapter_quectel_bg96__h__included__ */