ewf_adapter_quectel_common.h File Reference

The Embedded Wireless Framework generic Quectel adapter functionality. More...

#include "ewf_adapter.h"

Go to the source code of this file.

Data Structures
struct	_ewf_adapter_quectel_common_internet_socket
	Internal structure for internet socket status More...
struct	_ewf_adapter_quectel_common_mqtt_socket
	Internal structure for MQTT socket status More...
struct	_ewf_adapter_quectel_common
	The Quectel common adapter data structure. More...

Macros
#define	EWF_ADAPTER_QUECTEL_COMMON_DEFAULT_TIMEOUT   (EWF_PLATFORM_TICKS_PER_SECOND * 10)
#define	EWF_ADAPTER_QUECTEL_COMMON_UFS_ENABLED   (1)
#define	EWF_ADAPTER_QUECTEL_COMMON_TLS_BASIC_ENABLED   (1)
#define	EWF_ADAPTER_QUECTEL_COMMON_TLS_ENABLED   (0)
#define	EWF_ADAPTER_QUECTEL_COMMON_TCP_ENABLED   (1)
#define	EWF_ADAPTER_QUECTEL_COMMON_UDP_ENABLED   (1)
#define	EWF_ADAPTER_QUECTEL_COMMON_MQTT_BASIC_ENABLED   (1)
#define	EWF_ADAPTER_QUECTEL_COMMON_MQTT_ENABLED   (0)
#define	EWF_ADAPTER_QUECTEL_COMMON_INTERNET_SOCKET_POOL_SIZE   (12)
	The total number of supported internet sockets in the adapter.
#define	EWF_ADAPTER_QUECTEL_COMMON_INTERNET_SOCKET_INVALID   (-1)
	The internet socket invalid value.
#define	EWF_ADAPTER_QUECTEL_COMMON_MQTT_SOCKET_POOL_SIZE   (12)
	The total number of supported MQTT sockets in the adapter.
#define	EWF_ADAPTER_QUECTEL_COMMON_MQTT_SOCKET_INVALID   (-1)
	The MQTT socket invalid value.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_FILE_NAME   ("root_ca_cert.pem")
	Trusted Certificate Authority certificate file name to be stored on the modem.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_FILE_NAME   ("ca_cert.pem")
	User Certificate Authority certificate file name to be stored on the modem.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CA_CERTIFICATE_FILE_NAME   ("root_ca_cert.pem")
	CA certificate index that will be used in the security/TLS profile configuration. This number will either be EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_FILE_NAME or EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_FILE_NAME Default to Root CA.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_CERTIFICATE_FILE_NAME   ("device_cert.pem")
	Client certificate file name to be stored on the modem.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_PRIVATE_KEY_FILE_NAME   ("device_key.pem")
	Client private key filename
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_ROOT_CA_CERTIFICATE_BUFFER_NAME   (root_ca_cert_pem)
	Trusted Certificate Authority certificate pointer name.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_USER_CA_CERTIFICATE_BUFFER_NAME   (ca_cert_pem)
	User Certificate Authority certificate pointing buffer name.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_CERTIFICATE_BUFFER_NAME   (device_cert_pem)
	Client certificate pointing buffer name.
#define	EWF_CONFIG_ADAPTER_QUECTEL_COMMON_CLIENT_PRIVATE_KEY_BUFFER_NAME   (device_key_pem)
	Client private key filename

Typedefs
typedef enum _ewf_adapter_common_internet_socket_service_type	ewf_adapter_quectel_common_internet_socket_service_type
	The socket service type
typedef struct _ewf_adapter_quectel_common_internet_socket	ewf_adapter_quectel_common_internet_socket
	Internal structure for internet socket status
typedef struct _ewf_adapter_quectel_common_mqtt_socket	ewf_adapter_quectel_common_mqtt_socket
	Internal structure for MQTT socket status
typedef struct _ewf_adapter_quectel_common	ewf_adapter_quectel_common
	The Quectel common adapter data structure.

Enumerations
enum	_ewf_adapter_common_internet_socket_service_type {   ewf_adapter_espressif_common_internet_socket_service_type_not_initialized , ewf_adapter_espressif_common_internet_socket_service_type_tcp , ewf_adapter_espressif_common_internet_socket_service_type_udp , ewf_adapter_espressif_common_internet_socket_service_type_tcp_listener ,   ewf_adapter_espressif_common_internet_socket_service_type_udp_listener , ewf_adapter_mxchip_common_internet_socket_service_type_not_initialized , ewf_adapter_mxchip_common_internet_socket_service_type_tcp , ewf_adapter_mxchip_common_internet_socket_service_type_udp ,   ewf_adapter_mxchip_common_internet_socket_service_type_tcp_listener , ewf_adapter_mxchip_common_internet_socket_service_type_udp_listener , ewf_adapter_quectel_common_internet_socket_service_type_not_initialized , ewf_adapter_quectel_common_internet_socket_service_type_tcp ,   ewf_adapter_quectel_common_internet_socket_service_type_udp , ewf_adapter_quectel_common_internet_socket_service_type_tcp_listener , ewf_adapter_quectel_common_internet_socket_service_type_udp_listener , ewf_adapter_thales_common_internet_socket_service_type_not_initialized ,   ewf_adapter_thales_common_internet_socket_service_type_tcp , ewf_adapter_thales_common_internet_socket_service_type_udp , ewf_adapter_thales_common_internet_socket_service_type_tcp_listener , ewf_adapter_thales_common_internet_socket_service_type_udp_listener }
	The socket service type

Functions
ewf_result	ewf_adapter_quectel_common_context_activate (ewf_adapter *adapter_ptr, uint32_t ctx)
	Activate a context. More...
ewf_result	ewf_adapter_quectel_common_context_deactivate (ewf_adapter *adapter_ptr, uint32_t ctx)
	Deactivate a context. More...
ewf_result	ewf_adapter_quectel_common_context_configure (ewf_adapter *adapter_ptr, uint32_t ctx, uint32_t type, const char *apn, const char *username, const char *password, uint32_t authentication)
	Configure a context. More...
ewf_result	ewf_adapter_quectel_common_context_configure_dns (ewf_adapter *adapter_ptr, uint32_t ctx, const char *primary_dns, const char *secondary_dns)
	Configure a context DNS. More...
ewf_result	ewf_adapter_quectel_common_ufs_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_ufs_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_ufs_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_ufs_list (ewf_adapter *adapter_ptr)
	List the files in the user file system. More...
ewf_result	ewf_adapter_quectel_common_ufs_delete (ewf_adapter *adapter_ptr, const char *filename_str)
	Delete a file from the user file system. More...
ewf_result	ewf_adapter_quectel_common_ufs_upload (ewf_adapter *adapter_ptr, const char *filename_str, const uint8_t *buffer_ptr, uint32_t buffer_length)
	Upload a file to the user file system. More...
ewf_result	ewf_adapter_quectel_common_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_info (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_get_ipv4_address (ewf_adapter *adapter_ptr, uint32_t *address_ptr)
ewf_result	ewf_adapter_quectel_common_get_ipv4_netmask (ewf_adapter *adapter_ptr, uint32_t *netmask_ptr)
ewf_result	ewf_adapter_quectel_common_get_ipv4_gateway (ewf_adapter *adapter_ptr, uint32_t *gateway_ptr)
ewf_result	ewf_adapter_quectel_common_get_ipv4_dns (ewf_adapter *adapter_ptr, uint32_t *dns)
ewf_result	ewf_adapter_quectel_common_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_internet_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_internet_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_internet_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_tcp_open (ewf_adapter *adapter_ptr, ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_close (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_control (ewf_socket_tcp *socket_ptr, const char *control_str, const uint8_t *buffer_ptr, uint32_t *buffer_length_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_set_tls_configuration (ewf_socket_tcp *socket_ptr, uint32_t tls_configuration_id)
ewf_result	ewf_adapter_quectel_common_tcp_bind (ewf_socket_tcp *socket_ptr, uint32_t local_port)
ewf_result	ewf_adapter_quectel_common_tcp_listen (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_accept (ewf_socket_tcp *socket_ptr, ewf_socket_tcp *socket_new_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_connect (ewf_socket_tcp *socket_ptr, const char *const server, uint32_t port)
ewf_result	ewf_adapter_quectel_common_tcp_shutdown (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_tcp_send (ewf_socket_tcp *socket_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_tcp_receive (ewf_socket_tcp *socket_ptr, uint8_t *buffer_ptr, uint32_t *buffer_length, bool wait)
ewf_result	ewf_adapter_quectel_common_udp_open (ewf_adapter *adapter_ptr, ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_udp_close (ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_udp_control (ewf_socket_udp *socket_ptr, const char *control_str, const uint8_t *buffer_ptr, uint32_t *buffer_length_ptr)
ewf_result	ewf_adapter_quectel_common_udp_set_dtls_configuration (ewf_socket_udp *socket_ptr, uint32_t dtls_configuration_id)
ewf_result	ewf_adapter_quectel_common_udp_bind (ewf_socket_udp *socket_ptr, uint32_t port)
ewf_result	ewf_adapter_quectel_common_udp_shutdown (ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_quectel_common_udp_send_to (ewf_socket_udp *socket_ptr, const char *remote_address_str, uint32_t remote_port, const uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_udp_receive_from (ewf_socket_udp *socket_ptr, char *remote_address, uint32_t *remote_address_length_ptr, uint32_t *remote_port_ptr, char *buffer_ptr, uint32_t *buffer_length_ptr, bool wait)
ewf_result	ewf_adapter_quectel_common_tls_basic_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_tls_basic_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_tls_basic_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_tls_basic_init (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_tls_basic_clean (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_default_state_callback (ewf_adapter *adapter_ptr, const char *state_cstr, const char *param_cstr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_default_message_callback (ewf_adapter *adapter_ptr, const char *topic_cstr, const char *payload_cstr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_connect (ewf_adapter *adapter_ptr, char const *server_str, uint32_t port, char const *clientid, char const *username, char const *password)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_disconnect (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_subscribe (ewf_adapter *adapter_ptr, char const *topic)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_unsubscribe (ewf_adapter *adapter_ptr, char const *topic)
ewf_result	ewf_adapter_quectel_common_mqtt_basic_publish (ewf_adapter *adapter_ptr, const char *topic, const char *msg_cstr)

Variables
ewf_adapter_api_control	ewf_adapter_quectel_common_api_control
ewf_adapter_api_info	ewf_adapter_quectel_common_api_info
ewf_adapter_api_tcp	ewf_adapter_quectel_common_api_tcp
ewf_adapter_api_udp	ewf_adapter_quectel_common_api_udp
ewf_adapter_api_tls_basic	ewf_adapter_quectel_common_api_tls_basic
ewf_adapter_api_mqtt_basic	ewf_adapter_quectel_common_api_mqtt_basic

Detailed Description

The Embedded Wireless Framework generic Quectel adapter functionality.

Version

Preview

Copyright

Copyright (c) Microsoft Corporation. All rights reserved. SPDX-License-Identifier: MIT