131 lines
4.0 KiB
C
131 lines
4.0 KiB
C
/**
|
|
@file
|
|
quec_wifi_uart.h
|
|
|
|
@brief
|
|
Quectel wifi uart api header.
|
|
|
|
*/
|
|
/*============================================================================
|
|
Copyright (c) 2020 Quectel Wireless Solution, Co., Ltd. All Rights Reserved.
|
|
Quectel Wireless Solution Proprietary and Confidential.
|
|
=============================================================================*/
|
|
/*===========================================================================
|
|
|
|
EDIT HISTORY FOR MODULE
|
|
|
|
This section contains comments describing changes made to the module.
|
|
Notice that changes are listed in reverse chronological order.
|
|
|
|
|
|
WHEN WHO WHAT, WHERE, WHY
|
|
---------- ------------ ----------------------------------------------------
|
|
|
|
=============================================================================*/
|
|
#ifndef QUEC_WIFI_UART_H
|
|
#define QUEC_WIFI_UART_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*========================================================================
|
|
* Marco Definition
|
|
*========================================================================*/
|
|
|
|
#define QUEC_WIFI_UART_MAGIC0 0xAA
|
|
#define QUEC_WIFI_UART_MAGIC1 0x55
|
|
/*========================================================================
|
|
* Enumeration Definition
|
|
*========================================================================*/
|
|
typedef enum
|
|
{
|
|
QUEC_WIFI_UART_SUCCESS = 0,
|
|
QUEC_WIFI_UART_EXECUTE_ERR = 1,
|
|
QUEC_WIFI_UART_INVALID_PARAM_ERR,
|
|
QUEC_WIFI_UART_TASK_CREATE_ERR,
|
|
QUEC_WIFI_UART_MUTEX_CREATE_ERR,
|
|
QUEC_WIFI_UART_PORT_SET_ERR,
|
|
QUEC_WIFI_UART_PIN_SET_ERR,
|
|
QUEC_WIFI_UART_OPEN_ERR,
|
|
QUEC_WIFI_UART_CB_REG_ERR,
|
|
} quec_wifi_uart_errcode_e;
|
|
|
|
/*========================================================================
|
|
* Type Definition
|
|
*========================================================================*/
|
|
typedef int (*quec_wifi_uart_notify_cb)(void *ctx);
|
|
|
|
/*========================================================================
|
|
* function Definition
|
|
*========================================================================*/
|
|
|
|
unsigned char npto_CRC(void *src, int ilen);
|
|
/*****************************************************************
|
|
* Function: quec_wifi_uart_output_data_msg
|
|
*
|
|
* Description: Wi-Fi command output function.Use this function to send command.
|
|
*
|
|
* Parameters:
|
|
* ctx [in] See quec_wifi_msg_output_data_info_s in quec_wifi_msg.h
|
|
*
|
|
* Return:
|
|
* 0 success
|
|
* other error code
|
|
*
|
|
*****************************************************************/
|
|
int quec_wifi_uart_output_data_msg(void *ctx);
|
|
|
|
/*****************************************************************
|
|
* Function: quec_wifi_uart_notify_cb_register
|
|
*
|
|
* Description: Register UART notificatiion callback
|
|
*
|
|
* Parameters:
|
|
* cb [in] UART notificatiion callback
|
|
*
|
|
* Return:
|
|
* 0 success
|
|
* other error code
|
|
*
|
|
*****************************************************************/
|
|
quec_wifi_uart_errcode_e quec_wifi_uart_notify_cb_register(quec_wifi_uart_notify_cb cb);
|
|
|
|
/*****************************************************************
|
|
* Function: quec_wifi_uart_init
|
|
*
|
|
* Description: Initialize Wi-Fi uart engine.
|
|
*
|
|
* Parameters:
|
|
* argv [in] No defined yet.
|
|
*
|
|
* Return:
|
|
* 0 success
|
|
* other error code
|
|
*
|
|
*****************************************************************/
|
|
quec_wifi_uart_errcode_e quec_wifi_uart_init(void *argv);
|
|
|
|
/*****************************************************************
|
|
* Function: quec_wifi_uart_deinit
|
|
*
|
|
* Description: Deinitialize Wi-Fi uart engine.
|
|
*
|
|
* Parameters:
|
|
* argv [in] No defined yet.
|
|
*
|
|
* Return:
|
|
* 0 success
|
|
* other error code
|
|
*
|
|
*****************************************************************/
|
|
quec_wifi_uart_errcode_e quec_wifi_uart_deinit(void* argv);
|
|
|
|
int quec_wifi_uart_write(char *data, int data_len);
|
|
|
|
#ifdef __cplusplus
|
|
}/*"C" */
|
|
#endif
|
|
|
|
#endif
|