code stringlengths 1 1.05M | repo_name stringlengths 6 83 | path stringlengths 3 242 | language stringclasses 222
values | license stringclasses 20
values | size int64 1 1.05M |
|---|---|---|---|---|---|
/*
* Copyright (C) 2015-2017 Alibaba Group Holding Limited
*/
#ifndef _SYS_TYPES_H
#define _SYS_TYPES_H
#include <stdint.h>
#ifndef _PARAMS
#define _PARAMS(paramlist) paramlist
#endif
#define _CLOCK_T_ uint32_t
#define STDOUT_FILENO 1
#define STDERR_FILENO 2
typedef uint32_t clockid_t;
typedef uint32_t key_t; /* Used for interprocess communication. */
typedef uint32_t pid_t; /* Used for process IDs and process group IDs. */
typedef signed long ssize_t; /* Used for a count of bytes or an error indication. */
typedef long long off_t;
typedef long suseconds_t;
typedef uint32_t _off_t;
typedef uint32_t _ssize_t;
#ifndef PATH_MAX
#define PATH_MAX 1024
#endif
#if __BSD_VISIBLE
#include <sys/select.h>
#endif
#endif /* _SYS_TYPES_H */
| YifuLiu/AliOS-Things | components/libc_stub/compilers/iar/sys/types.h | C | apache-2.0 | 784 |
/*
* Copyright (C) 2015-2017 Alibaba Group Holding Limited
*/
#ifndef _SYS_UNISTD_H
#define _SYS_UNISTD_H
#endif /* _SYS_UNISTD_H */
| YifuLiu/AliOS-Things | components/libc_stub/compilers/iar/sys/unistd.h | C | apache-2.0 | 138 |
/*
* Copyright (C) 2015-2017 Alibaba Group Holding Limited
*/
#include "sys/unistd.h"
| YifuLiu/AliOS-Things | components/libc_stub/compilers/iar/unistd.h | C | apache-2.0 | 89 |
/*
* Copyright (C) 2015-2021 Alibaba Group Holding Limited
*/
#include <fcntl.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#if AOS_COMP_CLI
#include "aos/cli.h"
#endif
#ifdef AOS_COMP_RAMFS
#include "ramfs.h"
#endif
static void libc_stub_example(int argc, char **argv)
{
(void)argc;
(void)argv;
int fd;
int ret;
char teststring = "1234";
char readbuf[10];
void *paddr = NULL;
paddr = malloc(10);
if(paddr == NULL){
printf("libc_stub: malloc fail!\r\n");
return;
}else{
free(paddr);
printf("libc_stub: malloc OK!\r\n");
}
#ifdef AOS_COMP_RAMFS
ramfs_register("/test");
fd = open("/test/file1", O_RDWR);
if(fd < 0){
printf("libc_stub: ramfs open fail!\r\n");
return;
}
ret = write(fd, teststring, 5);
if(ret < 0){
printf("libc_stub: ramfs write fail!\r\n");
close(fd);
return;
}
lseek(fd, 0, SEEK_SET);
ret = read(fd, readbuf, 5);
if(ret < 0){
printf("libc_stub: ramfs read fail!\r\n");
close(fd);
return;
}
if(strncmp(readbuf, teststring, 5)){
printf("libc_stub: ramfs test fail! readbuf:%s\r\n",readbuf);
}else{
printf("libc_stub: ramfs test success!\r\n");
}
close(fd);
ramfs_unregister("/test");
#endif
printf("libc_stub comp test success!\r\n");
return;
}
#if AOS_COMP_CLI
/* reg args: fun, cmd, description*/
ALIOS_CLI_CMD_REGISTER(libc_stub_example, libc_example, lib stub component base example)
#endif
| YifuLiu/AliOS-Things | components/libc_stub/example/libc_stub_example.c | C | apache-2.0 | 1,553 |
/*
* Copyright (C) 2015-2017 Alibaba Group Holding Limited
*/
#include <reent.h>
#include <sys/errno.h>
#include <sys/unistd.h>
#include <sys/time.h>
#include <stdarg.h>
#include <k_api.h>
#include "aos/kernel.h"
#include "aos/vfs.h"
#include "aos/hal/uart.h"
#include "vfs_conf.h"
#include "sys/socket.h"
#ifdef CONFIG_AOS_LWIP
#ifdef TELNETD_ENABLED
#include "lwip/apps/telnetserver.h"
#endif
#endif
#define FD_VFS_START VFS_FD_OFFSET
#define FD_VFS_END (FD_VFS_START + VFS_MAX_FILE_NUM - 1)
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
#define FD_SOCKET_START FD_AOS_SOCKET_OFFSET
#define FD_SOCKET_END (FD_AOS_SOCKET_OFFSET + FD_AOS_NUM_SOCKETS - 1)
#define FD_EVENT_START FD_AOS_EVENT_OFFSET
#define FD_EVENT_END (FD_AOS_EVENT_OFFSET + FD_AOS_NUM_EVENTS - 1)
#endif
#endif
#define LIBC_CHECK_AOS_RET(ret) do {if ((ret) < 0) {ptr->_errno = -(ret); return -1; } } while (0)
int _execve_r(struct _reent *ptr, const char *name, char *const *argv,
char *const *env)
{
ptr->_errno = ENOSYS;
return -1;
}
int _fcntl_r(struct _reent *ptr, int fd, int cmd, int arg)
{
int ret;
if ((fd >= FD_VFS_START) && (fd <= FD_VFS_END)) {
ret = aos_fcntl(fd, cmd, arg);
LIBC_CHECK_AOS_RET(ret);
return ret;
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
} else if ((fd >= FD_SOCKET_START) && (fd <= FD_EVENT_END)) {
return lwip_fcntl(fd, cmd, arg);
#endif
#endif
} else {
ptr->_errno = EBADF;
return -1;
}
}
int _fork_r(struct _reent *ptr)
{
ptr->_errno = ENOSYS;
return -1;
}
int _getpid_r(struct _reent *ptr)
{
ptr->_errno = ENOSYS;
return 0;
}
int _isatty_r(struct _reent *ptr, int fd)
{
if (fd >= 0 && fd < 3) {
return 1;
}
ptr->_errno = ENOTTY;
return 0;
}
int _kill_r(struct _reent *ptr, int pid, int sig)
{
ptr->_errno = ENOSYS;
return -1;
}
_off_t _lseek_r(struct _reent *ptr, int fd, _off_t pos, int whence)
{
int ret = aos_lseek(fd, pos, whence);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
int _mkdir_r(struct _reent *ptr, const char *name, int mode)
{
int ret = aos_mkdir(name);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
int _open_r(struct _reent *ptr, const char *file, int flags, int mode)
{
int ret = aos_open(file, flags);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
int _close_r(struct _reent *ptr, int fd)
{
int ret;
if ((fd >= FD_VFS_START) && (fd <= FD_VFS_END)) {
ret = aos_close(fd);
LIBC_CHECK_AOS_RET(ret);
return ret;
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
} else if ((fd >= FD_SOCKET_START) && (fd <= FD_EVENT_END)) {
return lwip_close(fd);
#endif
#endif
} else {
ptr->_errno = EBADF;
return -1;
}
}
_ssize_t _read_r(struct _reent *ptr, int fd, void *buf, size_t nbytes)
{
int ret;
if ((fd >= FD_VFS_START) && (fd <= FD_VFS_END)) {
ret = aos_read(fd, buf, nbytes);
LIBC_CHECK_AOS_RET(ret);
return ret;
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
} else if ((fd >= FD_SOCKET_START) && (fd <= FD_EVENT_END)) {
return lwip_read(fd, buf, nbytes);
#endif
#endif
} else {
ptr->_errno = EBADF;
return -1;
}
}
_ssize_t _write_r(struct _reent *ptr, int fd, const void *buf, size_t nbytes)
{
int ret;
const char *tmp = buf;
int i = 0;
uart_dev_t uart_stdio;
if (buf == NULL) {
ptr->_errno = EINVAL;
return 0;
}
memset(&uart_stdio, 0, sizeof(uart_stdio));
uart_stdio.port = HAL_UART_STDIO_PORT;
if ((fd >= FD_VFS_START) && (fd <= FD_VFS_END)) {
ret = aos_write(fd, buf, nbytes);
LIBC_CHECK_AOS_RET(ret);
return ret;
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
} else if ((fd >= FD_SOCKET_START) && (fd <= FD_EVENT_END)) {
return lwip_write(fd, buf, nbytes);
#endif
#endif
} else if ((fd == STDOUT_FILENO) || (fd == STDERR_FILENO)) {
for (i = 0; i < nbytes; i++) {
if (*tmp == '\n' && !(i > 0 && *(tmp - 1) == '\r')) {
#ifdef TELNETD_ENABLED
TelnetWrite('\r');
#endif
hal_uart_send(&uart_stdio, (void *)"\r", 1, AOS_WAIT_FOREVER);
}
#ifdef TELNETD_ENABLED
TelnetWrite(*tmp);
#endif
hal_uart_send(&uart_stdio, (void *)tmp, 1, AOS_WAIT_FOREVER);
tmp++;
}
return nbytes;
} else {
ptr->_errno = EBADF;
return -1;
}
}
int ioctl(int fildes, int request, ... /* arg */)
{
va_list args;
int ret;
va_start(args, request);
if ((fildes >= VFS_FD_OFFSET) &&
(fildes <= (VFS_FD_OFFSET + VFS_MAX_FILE_NUM - 1))) {
unsigned long arg = va_arg(args, unsigned long);
ret = aos_ioctl(fildes, request, arg);
if (ret < 0) {
errno = -ret;
ret = -1;
}
#ifdef POSIX_DEVICE_IO_NEED
#ifdef CONFIG_AOS_LWIP
} else if ((fildes >= FD_AOS_SOCKET_OFFSET) &&
(fildes <= (FD_AOS_EVENT_OFFSET + FD_AOS_NUM_EVENTS - 1))) {
void *argp = va_arg(args, void *);
ret = lwip_ioctl(fildes, request, argp);
#endif
#endif
} else {
errno = EINVAL;
ret = -1;
}
va_end(args);
return ret;
}
int _rename_r(struct _reent *ptr, const char *oldname, const char *newname)
{
int ret = aos_rename(oldname, newname);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
void *_sbrk_r(struct _reent *ptr, ptrdiff_t incr)
{
ptr->_errno = ENOSYS;
return NULL;
}
int _stat_r(struct _reent *ptr, const char *file, struct stat *pstat)
{
int ret;
struct aos_stat stat;
if ((file == NULL) || (pstat == NULL)) {
ptr->_errno = EINVAL;
return -1;
}
ret = aos_stat(file, &stat);
LIBC_CHECK_AOS_RET(ret);
pstat->st_mode = stat.st_mode;
pstat->st_size = stat.st_size;
pstat->st_atime = stat.st_actime;
pstat->st_mtime = stat.st_modtime;
return ret;
}
int _fstat_r(struct _reent *ptr, int fd, struct stat *buf)
{
int ret;
struct aos_stat stat_temp;
if ((fd < 0) || (buf == NULL)) {
ptr->_errno = EINVAL;
return -1;
}
ret = aos_fstat(fd, &stat_temp);
LIBC_CHECK_AOS_RET(ret);
buf->st_mode = stat_temp.st_mode;
buf->st_size = stat_temp.st_size;
buf->st_atime = stat_temp.st_actime;
buf->st_mtime = stat_temp.st_modtime;
return ret;
}
_CLOCK_T_ _times_r(struct _reent *ptr, struct tms *ptms)
{
ptr->_errno = ENOSYS;
return -1;
}
int _link_r(struct _reent *ptr, const char *oldpath, const char *newpath)
{
int ret = aos_link(oldpath, newpath);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
int _unlink_r(struct _reent *ptr, const char *file)
{
int ret = aos_unlink(file);
LIBC_CHECK_AOS_RET(ret);
return ret;
}
int _wait_r(struct _reent *ptr, int *status)
{
ptr->_errno = ENOSYS;
return -1;
}
int _gettimeofday_r(struct _reent *ptr, struct timeval *tv, void *__tzp)
{
uint64_t t;
struct timezone *tz = __tzp;
if (tv) {
t = aos_calendar_time_get();
tv->tv_sec = t / 1000;
tv->tv_usec = (t % 1000) * 1000;
}
if (tz) {
/* Not supported. */
tz->tz_minuteswest = 0;
tz->tz_dsttime = 0;
}
return 0;
}
void *_malloc_r(struct _reent *ptr, size_t size)
{
void *mem;
#if (RHINO_CONFIG_MM_DEBUG > 0u)
mem = aos_malloc(size | AOS_UNSIGNED_INT_MSB);
aos_alloc_trace(mem, (size_t)__builtin_return_address(0));
#else
mem = aos_malloc(size);
#endif
return mem;
}
void *_realloc_r(struct _reent *ptr, void *old, size_t newlen)
{
void *mem;
#if (RHINO_CONFIG_MM_DEBUG > 0u)
mem = aos_realloc(old, newlen | AOS_UNSIGNED_INT_MSB);
aos_alloc_trace(mem, (size_t)__builtin_return_address(0));
#else
mem = aos_realloc(old, newlen);
#endif
return mem;
}
void *_calloc_r(struct _reent *ptr, size_t size, size_t len)
{
void *mem;
#if (RHINO_CONFIG_MM_DEBUG > 0u)
mem = aos_malloc((size * len) | AOS_UNSIGNED_INT_MSB);
aos_alloc_trace(mem, (size_t)__builtin_return_address(0));
#else
mem = aos_malloc(size * len);
#endif
if (mem) {
bzero(mem, size * len);
}
return mem;
}
void _free_r(struct _reent *ptr, void *addr)
{
aos_free(addr);
}
void _exit(int status)
{
while (1)
;
}
void exit(int status)
{
aos_task_exit(status);
/* This function declares the noreturn attribute, and execution should not return */
while (1)
;
}
__attribute__((weak)) void _fini()
{
return;
}
void _system(const char *s)
{
return;
}
void abort(void)
{
k_err_proc(RHINO_SYS_FATAL_ERR);
/* This function declares the noreturn attribute, and execution should not return */
while (1)
;
}
struct _reent *__getreent(void)
{
#if (RHINO_CONFIG_NEWLIBC_REENT > 0)
CPSR_ALLOC();
ktask_t *cur_task = NULL;
RHINO_CRITICAL_ENTER();
/* If in the interrupt context, use the global reent structure */
if (g_intrpt_nested_level[cpu_cur_get()] > 0u) {
RHINO_CRITICAL_EXIT();
goto ret_impure_ptr;
}
RHINO_CRITICAL_EXIT();
cur_task = krhino_cur_task_get();
if (cur_task == NULL)
goto ret_impure_ptr;
if (cur_task->newlibc_reent == NULL) {
cur_task->newlibc_reent = (struct _reent *)krhino_mm_alloc(sizeof(struct _reent));
if (cur_task->newlibc_reent == NULL)
goto ret_impure_ptr;
_REENT_INIT_PTR(cur_task->newlibc_reent);
}
return cur_task->newlibc_reent;
#endif
ret_impure_ptr:
if (_impure_ptr->__sdidinit == 0) {
__sinit(_impure_ptr);
}
return _impure_ptr;
}
| YifuLiu/AliOS-Things | components/libc_stub/newlib_stub.c | C | apache-2.0 | 9,727 |
/**
* @file aiot_bootstrap_api.c
* @brief Bootstrap模块的API接口实现, 提供获取阿里云物联网平台连接信息的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "bootstrap_private.h"
static void _bootstrap_exec_inc(bootstrap_handle_t *bootstrap_handle)
{
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
bootstrap_handle->exec_count++;
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
}
static void _bootstrap_exec_dec(bootstrap_handle_t *bootstrap_handle)
{
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
bootstrap_handle->exec_count--;
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
}
static void _bootstrap_http_recv_handler(void *handle, const aiot_http_recv_t *packet, void *userdata)
{
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)userdata;
switch (packet->type) {
case AIOT_HTTPRECV_STATUS_CODE: {
bootstrap_handle->response.code = packet->data.status_code.code;
}
break;
case AIOT_HTTPRECV_HEADER: {
if ((strlen(packet->data.header.key) == strlen("Content-Length")) &&
(memcmp(packet->data.header.key, "Content-Length", strlen(packet->data.header.key)) == 0)) {
core_str2uint(packet->data.header.value, (uint8_t)strlen(packet->data.header.value),
&bootstrap_handle->response.content_total_len);
}
}
break;
case AIOT_HTTPRECV_BODY: {
uint8_t *content = bootstrap_handle->sysdep->core_sysdep_malloc(bootstrap_handle->response.content_len +
packet->data.body.len + 1,
CORE_HTTP_MODULE_NAME);
if (content == NULL) {
return;
}
memset(content, 0, bootstrap_handle->response.content_len + packet->data.body.len + 1);
if (content != NULL) {
memcpy(content, bootstrap_handle->response.content, bootstrap_handle->response.content_len);
bootstrap_handle->sysdep->core_sysdep_free(bootstrap_handle->response.content);
}
memcpy(content + bootstrap_handle->response.content_len, packet->data.body.buffer, packet->data.body.len);
bootstrap_handle->response.content = content;
bootstrap_handle->response.content_len = bootstrap_handle->response.content_len + packet->data.body.len;
}
break;
default: {
}
break;
}
}
static int32_t _bootstrap_connection_info(bootstrap_handle_t *bootstrap_handle, char **host, uint16_t *port)
{
int32_t res = STATE_SUCCESS;
char *tmp_host = NULL, *host_key = "host", *port_key = "port", *ip_key = "ip";
char *host_value = NULL, *port_value = NULL, *ip_value = NULL;
uint32_t tmp_port = 0, host_value_len = 0, port_value_len = 0, ip_value_len = 0;
if (bootstrap_handle->response.code != 200) {
return STATE_BOOTSTRAP_INVALID_STATUS_CODE;
}
if (((res = core_json_value((char *)bootstrap_handle->response.content, bootstrap_handle->response.content_len,
host_key, strlen(host_key), &host_value, &host_value_len)) < STATE_SUCCESS) ||
((res = core_json_value((char *)bootstrap_handle->response.content, bootstrap_handle->response.content_len,
port_key, strlen(port_key), &port_value, &port_value_len)) < STATE_SUCCESS)) {
return STATE_BOOTSTRAP_INVALID_CONNECTION_INFO;
}
tmp_host = bootstrap_handle->sysdep->core_sysdep_malloc(host_value_len + 1, BOOTSTRAP_MODULE_NAME);
if (tmp_host == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(tmp_host, 0, host_value_len + 1);
memcpy(tmp_host, host_value, host_value_len);
core_str2uint(port_value, port_value_len, &tmp_port);
*host = tmp_host;
*port = tmp_port;
/* backup ip address */
if ((res = core_json_value((char *)bootstrap_handle->response.content, bootstrap_handle->response.content_len,
ip_key, strlen(ip_key), &ip_value, &ip_value_len)) >= STATE_SUCCESS &&
(ip_value_len < 16)) {
char ip[16] = {0};
memcpy(ip, ip_value, ip_value_len);
core_global_set_mqtt_backup_ip(bootstrap_handle->sysdep, ip);
}
return STATE_SUCCESS;
}
static int32_t _bootstrap_send_get_request(bootstrap_handle_t *bootstrap_handle)
{
int32_t res = STATE_SUCCESS;
char *path = NULL;
char *path_src[] = { bootstrap_handle->region_id };
char *path_fmt = BOOTSTRAP_PATH "/regionId/%s";
core_http_request_t request;
memset(&request, 0, sizeof(core_http_request_t));
res = core_sprintf(bootstrap_handle->sysdep, &path, path_fmt, path_src, sizeof(path_src) / sizeof(char *),
BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
request.method = "GET";
request.path = path;
request.header = "Accept: text/xml,text/javascript,text/html,application/json\r\n";
request.content = NULL;
request.content_len = 0;
res = core_http_send(bootstrap_handle->http_handle, &request);
bootstrap_handle->sysdep->core_sysdep_free(path);
if (res < STATE_SUCCESS) {
return res;
}
return STATE_SUCCESS;
}
static int32_t _bootstrap_send_post_request(bootstrap_handle_t *bootstrap_handle)
{
int32_t res = STATE_SUCCESS;
char *content = NULL;
char *content_fmt = "productKey=%s&deviceName=%s&clientId=%s.%s&resources=mqtt";
char *content_src[] = { bootstrap_handle->product_key, bootstrap_handle->device_name, bootstrap_handle->product_key, bootstrap_handle->device_name };
core_http_request_t request;
memset(&request, 0, sizeof(core_http_request_t));
res = core_sprintf(bootstrap_handle->sysdep, &content, content_fmt, content_src, sizeof(content_src) / sizeof(char *),
BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
request.method = "POST";
request.path = BOOTSTRAP_PATH;
request.header = "Accept: text/xml,text/javascript,text/html,application/json\r\n" \
"Content-Type: application/x-www-form-urlencoded;charset=utf-8\r\n";
request.content = (uint8_t *)content;
request.content_len = (uint32_t)strlen(content);
res = core_http_send(bootstrap_handle->http_handle, &request);
bootstrap_handle->sysdep->core_sysdep_free(content);
if (res < STATE_SUCCESS) {
return res;
}
return STATE_SUCCESS;
}
static void _bootstrap_alink_reply(bootstrap_handle_t *bootstrap_handle, char *id)
{
int32_t res = STATE_SUCCESS;
char *topic = NULL, *topic_fmt = BOOTSTRAP_NOTIFY_REPLY_TOPIC_FMT;
char *topic_src[] = { core_mqtt_get_product_key(bootstrap_handle->mqtt_handle), core_mqtt_get_device_name(bootstrap_handle->mqtt_handle) };
char *reply = NULL, *reply_fmt = "{\"id\":\"%s\",\"code\":200,\"data\":{}}";
char *reply_src[] = { id };
res = core_sprintf(bootstrap_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src)/sizeof(char *), BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return;
}
res = core_sprintf(bootstrap_handle->sysdep, &reply, reply_fmt, reply_src, sizeof(reply_src)/sizeof(char *), BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
bootstrap_handle->sysdep->core_sysdep_free(topic);
return;
}
aiot_mqtt_pub(bootstrap_handle->mqtt_handle, topic, (uint8_t *)reply, (uint32_t)strlen(reply), 0);
bootstrap_handle->sysdep->core_sysdep_free(reply);
bootstrap_handle->sysdep->core_sysdep_free(topic);
}
static void _bootstrap_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)userdata;
switch (packet->type) {
case AIOT_MQTTRECV_PUB: {
char *id_key = "id", *cmd_key = "cmd";
char *id_value = NULL, *cmd_value = NULL;
uint32_t id_value_len = 0, cmd_value_len = 0;
if (core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len, id_key, (uint32_t)strlen(id_key),
&id_value, &id_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len, cmd_key, (uint32_t)strlen(cmd_key),
&cmd_value, &cmd_value_len) == STATE_SUCCESS) {
uint32_t cmd = 0;
if (core_str2uint(cmd_value, cmd_value_len, &cmd) >= STATE_SUCCESS) {
if (bootstrap_handle->recv_handler != NULL) {
aiot_bootstrap_recv_t recv;
memset(&recv, 0, sizeof(aiot_bootstrap_recv_t));
recv.type = AIOT_BOOTSTRAPRECV_NOTIFY;
recv.data.notify.cmd = cmd;
bootstrap_handle->recv_handler(bootstrap_handle, &recv, bootstrap_handle->userdata);
}
char *id = bootstrap_handle->sysdep->core_sysdep_malloc(id_value_len + 1, BOOTSTRAP_MODULE_NAME);
if (id != NULL) {
memset(id, 0, id_value_len + 1);
memcpy(id, id_value, id_value_len);
_bootstrap_alink_reply(bootstrap_handle, id);
bootstrap_handle->sysdep->core_sysdep_free(id);
}
} else {
if (bootstrap_handle->event_handler != NULL) {
aiot_bootstrap_event_t event;
memset(&event, 0, sizeof(aiot_bootstrap_event_t));
event.type = AIOT_BOOTSTRAPEVT_INVALID_CMD;
bootstrap_handle->event_handler(bootstrap_handle, &event, bootstrap_handle->userdata);
}
}
} else {
if (bootstrap_handle->event_handler != NULL) {
aiot_bootstrap_event_t event;
memset(&event, 0, sizeof(aiot_bootstrap_event_t));
event.type = AIOT_BOOTSTRAPEVT_INVALID_RESPONSE;
bootstrap_handle->event_handler(bootstrap_handle, &event, bootstrap_handle->userdata);
}
}
}
break;
default: {
}
break;
}
}
static int32_t _bootstrap_operate_topic_map(bootstrap_handle_t *bootstrap_handle, aiot_mqtt_option_t option)
{
int32_t res = STATE_SUCCESS;
aiot_mqtt_topic_map_t map;
char *topic = NULL;
char *topic_src[] = { core_mqtt_get_product_key(bootstrap_handle->mqtt_handle), core_mqtt_get_device_name(bootstrap_handle->mqtt_handle) };
char *topic_fmt = BOOTSTRAP_NOTIFY_TOPIC_FMT;
memset(&map, 0, sizeof(aiot_mqtt_topic_map_t));
res = core_sprintf(bootstrap_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src) / sizeof(char *),
BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
map.topic = topic;
map.handler = _bootstrap_recv_handler;
map.userdata = (void *)bootstrap_handle;
res = aiot_mqtt_setopt(bootstrap_handle->mqtt_handle, option, &map);
bootstrap_handle->sysdep->core_sysdep_free(topic);
return res;
}
static void _bootstrap_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
bootstrap_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _bootstrap_core_mqtt_operate_process_handler(bootstrap_handle_t *bootstrap_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _bootstrap_core_mqtt_process_handler;
process_data.context = bootstrap_handle;
return core_mqtt_setopt(bootstrap_handle->mqtt_handle, option, &process_data);
}
void *aiot_bootstrap_init(void)
{
int32_t res = STATE_SUCCESS;
bootstrap_handle_t *bootstrap_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
res = core_global_init(sysdep);
if (res < STATE_SUCCESS) {
return NULL;
}
bootstrap_handle = sysdep->core_sysdep_malloc(sizeof(bootstrap_handle_t), BOOTSTRAP_MODULE_NAME);
if (bootstrap_handle == NULL) {
core_global_deinit(sysdep);
return NULL;
}
memset(bootstrap_handle, 0, sizeof(bootstrap_handle_t));
bootstrap_handle->sysdep = sysdep;
res = core_strdup(sysdep, &bootstrap_handle->host, BOOTSTRAP_DEFAULT_HOST, BOOTSTRAP_MODULE_NAME);
if (res < STATE_SUCCESS) {
core_global_deinit(sysdep);
return NULL;
}
bootstrap_handle->port = BOOTSTRAP_DEFAULT_PORT;
bootstrap_handle->response_body_len = BOOTSTRAP_RESPONSE_BODY_LEN;
bootstrap_handle->send_timeout_ms = BOOTSTRAP_DEFAULT_SEND_TIMEOUT;
bootstrap_handle->recv_timeout_ms = BOOTSTRAP_DEFAULT_RECV_TIMEOUT;
bootstrap_handle->timeout_ms = BOOTSTRAP_DEFAULT_TIMEOUT_MS;
bootstrap_handle->deinit_timeout_ms = BOOTSTRAP_DEFAULT_DEINIT_TIMEOUT_MS;
bootstrap_handle->data_mutex = bootstrap_handle->sysdep->core_sysdep_mutex_init();
bootstrap_handle->exec_enabled = 1;
return bootstrap_handle;
}
int32_t aiot_bootstrap_setopt(void *handle, aiot_bootstrap_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)handle;
if (bootstrap_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_BOOTSTRAPOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (bootstrap_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_bootstrap_exec_inc(bootstrap_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
switch (option) {
case AIOT_BOOTSTRAPOPT_MQTT_HANDLE: {
bootstrap_handle->mqtt_handle = data;
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
res = _bootstrap_operate_topic_map(bootstrap_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP);
if (res >= STATE_SUCCESS) {
res = _bootstrap_core_mqtt_operate_process_handler(bootstrap_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
}
break;
case AIOT_BOOTSTRAPOPT_NETWORK_CRED: {
if (bootstrap_handle->cred != NULL) {
bootstrap_handle->sysdep->core_sysdep_free(bootstrap_handle->cred);
bootstrap_handle->cred = NULL;
}
bootstrap_handle->cred = bootstrap_handle->sysdep->core_sysdep_malloc(sizeof(aiot_sysdep_network_cred_t),
BOOTSTRAP_MODULE_NAME);
if (bootstrap_handle->cred != NULL) {
memset(bootstrap_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(bootstrap_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
} else {
res = STATE_SYS_DEPEND_MALLOC_FAILED;
}
}
break;
case AIOT_BOOTSTRAPOPT_HOST: {
res = core_strdup(bootstrap_handle->sysdep, &bootstrap_handle->host, data, BOOTSTRAP_MODULE_NAME);
}
break;
case AIOT_BOOTSTRAPOPT_PORT: {
bootstrap_handle->port = *(uint16_t *)data;
}
break;
case AIOT_BOOTSTRAPOPT_PRODUCT_KEY: {
res = core_strdup(bootstrap_handle->sysdep, &bootstrap_handle->product_key, data, BOOTSTRAP_MODULE_NAME);
}
break;
case AIOT_BOOTSTRAPOPT_DEVICE_NAME: {
res = core_strdup(bootstrap_handle->sysdep, &bootstrap_handle->device_name, data, BOOTSTRAP_MODULE_NAME);
}
break;
case AIOT_BOOTSTRAPOPT_REGIONID: {
res = core_strdup(bootstrap_handle->sysdep, &bootstrap_handle->region_id, data, BOOTSTRAP_MODULE_NAME);
}
break;
case AIOT_BOOTSTRAPOPT_SEND_TIMEOUT_MS: {
bootstrap_handle->send_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_BOOTSTRAPOPT_RECV_TIMEOUT_MS: {
bootstrap_handle->recv_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_BOOTSTRAPOPT_RECV_HANDLER: {
bootstrap_handle->recv_handler = (aiot_bootstrap_recv_handler_t)data;
}
break;
case AIOT_BOOTSTRAPOPT_EVENT_HANDLER: {
bootstrap_handle->event_handler = (aiot_bootstrap_event_handler_t)data;
}
break;
case AIOT_BOOTSTRAPOPT_USERDATA: {
bootstrap_handle->userdata = data;
}
break;
case AIOT_BOOTSTRAPOPT_TIMEOUT_MS: {
bootstrap_handle->timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_BOOTSTRAPOPT_DEINIT_TIMEOUT_MS: {
bootstrap_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
int32_t aiot_bootstrap_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
bootstrap_handle_t *bootstrap_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
bootstrap_handle = *(bootstrap_handle_t **)handle;
sysdep = bootstrap_handle->sysdep;
if (bootstrap_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
bootstrap_handle->exec_enabled = 0;
_bootstrap_core_mqtt_operate_process_handler(bootstrap_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
_bootstrap_operate_topic_map(bootstrap_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP);
deinit_timestart = bootstrap_handle->sysdep->core_sysdep_time();
do {
if (bootstrap_handle->exec_count == 0) {
break;
}
bootstrap_handle->sysdep->core_sysdep_sleep(BOOTSTRAP_DEINIT_INTERVAL_MS);
} while ((bootstrap_handle->sysdep->core_sysdep_time() - deinit_timestart) < bootstrap_handle->deinit_timeout_ms);
if (bootstrap_handle->exec_count != 0) {
return STATE_BOOTSTRAP_DEINIT_TIMEOUT;
}
*handle = NULL;
if (bootstrap_handle->response.content != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->response.content);
}
memset(&bootstrap_handle->response, 0, sizeof(core_http_response_t));
if (bootstrap_handle->http_handle != NULL) {
core_http_deinit(&bootstrap_handle->http_handle);
}
if (bootstrap_handle->host != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->host);
}
if (bootstrap_handle->product_key != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->product_key);
}
if (bootstrap_handle->device_name != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->device_name);
}
if (bootstrap_handle->region_id != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->region_id);
}
if (bootstrap_handle->cred != NULL) {
sysdep->core_sysdep_free(bootstrap_handle->cred);
}
sysdep->core_sysdep_mutex_deinit(&bootstrap_handle->data_mutex);
core_global_deinit(sysdep);
sysdep->core_sysdep_free(bootstrap_handle);
return STATE_SUCCESS;
}
int32_t aiot_bootstrap_send_request(void *handle)
{
int32_t res = STATE_SUCCESS;
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)handle;
if (bootstrap_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (bootstrap_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
if (bootstrap_handle->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (bootstrap_handle->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (bootstrap_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_bootstrap_exec_inc(bootstrap_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
if (bootstrap_handle->response.content != NULL) {
bootstrap_handle->sysdep->core_sysdep_free(bootstrap_handle->response.content);
}
memset(&bootstrap_handle->response, 0, sizeof(core_http_response_t));
if (bootstrap_handle->http_handle != NULL) {
core_http_deinit(&bootstrap_handle->http_handle);
}
bootstrap_handle->http_handle = core_http_init();
if (bootstrap_handle->http_handle == NULL) {
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
if (((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_HOST,
(void *)bootstrap_handle->host)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_PORT,
(void *)&bootstrap_handle->port)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_NETWORK_CRED,
(void *)bootstrap_handle->cred)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_SEND_TIMEOUT_MS,
(void *)&bootstrap_handle->send_timeout_ms)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_RECV_TIMEOUT_MS,
(void *)&bootstrap_handle->recv_timeout_ms)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_BODY_BUFFER_MAX_LEN,
(void *)&bootstrap_handle->response_body_len)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_RECV_HANDLER,
(void *)_bootstrap_http_recv_handler)) < STATE_SUCCESS) ||
((res = core_http_setopt(bootstrap_handle->http_handle, CORE_HTTPOPT_USERDATA,
(void *)bootstrap_handle)) < STATE_SUCCESS)) {
core_http_deinit(&bootstrap_handle->http_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
res = core_http_connect(bootstrap_handle->http_handle);
if (res < STATE_SUCCESS) {
core_http_deinit(&bootstrap_handle->http_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
{
if (bootstrap_handle->region_id != NULL) {
res = _bootstrap_send_get_request(bootstrap_handle);
}else{
res = _bootstrap_send_post_request(bootstrap_handle);
}
if (res < STATE_SUCCESS) {
core_http_deinit(&bootstrap_handle->http_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
}
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
int32_t aiot_bootstrap_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint64_t timenow_ms = 0;
bootstrap_handle_t *bootstrap_handle = (bootstrap_handle_t *)handle;
char *host = NULL;
uint16_t port = 0;
aiot_bootstrap_recv_t packet;
if (bootstrap_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (bootstrap_handle->http_handle == NULL) {
return STATE_BOOTSTRAP_NEED_SEND_REQUEST;
}
if (bootstrap_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_bootstrap_exec_inc(bootstrap_handle);
bootstrap_handle->sysdep->core_sysdep_mutex_lock(bootstrap_handle->data_mutex);
timenow_ms = bootstrap_handle->sysdep->core_sysdep_time();
while (1) {
if (timenow_ms >= bootstrap_handle->sysdep->core_sysdep_time()) {
timenow_ms = bootstrap_handle->sysdep->core_sysdep_time();
}
if (bootstrap_handle->sysdep->core_sysdep_time() - timenow_ms >= bootstrap_handle->timeout_ms) {
break;
}
res = core_http_recv(bootstrap_handle->http_handle);
if (res < STATE_SUCCESS) {
break;
}
}
if (res < STATE_SUCCESS) {
if (res != STATE_HTTP_READ_BODY_FINISHED) {
if (bootstrap_handle->response.content != NULL) {
bootstrap_handle->sysdep->core_sysdep_free(bootstrap_handle->response.content);
memset(&bootstrap_handle->response, 0, sizeof(core_http_response_t));
}
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return res;
} else {
res = STATE_SUCCESS;
}
} else {
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
_bootstrap_exec_dec(bootstrap_handle);
return STATE_HTTP_RECV_NOT_FINISHED;
}
if (bootstrap_handle->recv_handler != NULL) {
packet.type = AIOT_BOOTSTRAPRECV_STATUS_CODE;
packet.data.status_code.code = bootstrap_handle->response.code;
bootstrap_handle->recv_handler(bootstrap_handle, &packet, bootstrap_handle->userdata);
}
res = _bootstrap_connection_info(bootstrap_handle, &host, &port);
bootstrap_handle->sysdep->core_sysdep_mutex_unlock(bootstrap_handle->data_mutex);
if (res < STATE_SUCCESS) {
_bootstrap_exec_dec(bootstrap_handle);
return res;
}
memset(&packet, 0, sizeof(aiot_bootstrap_recv_t));
if (bootstrap_handle->recv_handler != NULL) {
packet.type = AIOT_BOOTSTRAPRECV_CONNECTION_INFO;
packet.data.connection_info.host = host;
packet.data.connection_info.port = (uint16_t)port;
bootstrap_handle->recv_handler(bootstrap_handle, &packet, bootstrap_handle->userdata);
}
bootstrap_handle->sysdep->core_sysdep_free(host);
_bootstrap_exec_dec(bootstrap_handle);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/bootstrap/aiot_bootstrap_api.c | C | apache-2.0 | 27,240 |
/**
* @file aiot_bootstrap_api.h
* @brief Bootstrap模块头文件, 可用于获取阿里云物联网平台的连接信息
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#ifndef _AIOT_BOOTSTRAP_API_H_
#define _AIOT_BOOTSTRAP_API_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0700~-0x07FF表达SDK在 bootstrap 模块内的状态码
*/
#define STATE_BOOTSTRAP_BASE (-0x0700)
/**
* @brief 执行@ref aiot_bootstrap_deinit 时, 等待其他API执行结束的超过设定的超时时间, MQTT实例销毁失败
*/
#define STATE_BOOTSTRAP_DEINIT_TIMEOUT (-0x0701)
/**
* @brief 需要首先执行@ref aiot_bootstrap_send_request 发送bootstrap请求
*/
#define STATE_BOOTSTRAP_NEED_SEND_REQUEST (-0x0702)
/**
* @brief bootstrap 服务端返回了错误的http status code
*/
#define STATE_BOOTSTRAP_INVALID_STATUS_CODE (-0x0703)
/**
* @brief 收到非法的bootstrap连接信息
*/
#define STATE_BOOTSTRAP_INVALID_CONNECTION_INFO (-0x0704)
/**
* @brief bootstrap报文类型
*
* @details
*
* 传入 @ref aiot_bootstrap_recv_handler_t 的MQTT报文类型
*/
typedef enum {
/**
* @brief bootstrap 服务器返回的http status code
*/
AIOT_BOOTSTRAPRECV_STATUS_CODE,
/**
* @brief 物联网平台连接信息, 包含域名和端口号
*/
AIOT_BOOTSTRAPRECV_CONNECTION_INFO,
/**
* @brief bootstrap通知信息
*/
AIOT_BOOTSTRAPRECV_NOTIFY
} aiot_bootstrap_recv_type_t;
/**
* @brief bootstrap接收到的数据
*/
typedef struct {
/**
* @brief bootstrap报文类型, 更多信息请参考@ref aiot_bootstrap_recv_type_t
*/
aiot_bootstrap_recv_type_t type;
/**
* @brief bootstrap报文联合体, 内容根据type进行选择
*/
union {
/**
* @brief bootstrap 服务器返回的http status code
*/
struct {
uint32_t code;
} status_code;
/**
* @brief 物联网平台连接信息
*/
struct {
char *host;
uint16_t port;
} connection_info;
struct {
uint32_t cmd;
} notify;
} data;
} aiot_bootstrap_recv_t;
/**
* @brief bootstrap数据接收回调函数原型
*
* @param[in] handle bootstrap实例句柄
* @param[in] packet bootstrap数据结构体, 存放收到的bootstrap信息
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (*aiot_bootstrap_recv_handler_t)(void *handle, const aiot_bootstrap_recv_t *packet, void *userdata);
/**
* @brief bootstrap内部事件类型
*/
typedef enum {
/**
* @brief 收到的bootstrap应答中字段不合法
*/
AIOT_BOOTSTRAPEVT_INVALID_RESPONSE,
/**
* @brief 收到的bootstrap应答中cmd字段格式错误
*/
AIOT_BOOTSTRAPEVT_INVALID_CMD,
} aiot_bootstrap_event_type_t;
/**
* @brief bootstrap内部事件
*/
typedef struct {
/**
* @brief bootstrap内部事件类型. 更多信息请参考@ref aiot_bootstrap_event_type_t
*
*/
aiot_bootstrap_event_type_t type;
} aiot_bootstrap_event_t;
/**
* @brief bootstrap事件回调函数
*
* @details
*
* 当NTP内部事件被触发时, 调用此函数
*
*/
typedef void (*aiot_bootstrap_event_handler_t)(void *handle, const aiot_bootstrap_event_t *event, void *userdata);
typedef enum {
/**
* @brief bootstrap会话需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
*
* @details
*
* 数据类型: (void *)
*/
AIOT_BOOTSTRAPOPT_MQTT_HANDLE,
/**
* @brief bootstrap 服务器建联时, 网络使用的安全凭据
*
* @details
*
* 该配置项用于为底层网络配置@ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 应当把 @ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , 以tls方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_BOOTSTRAPOPT_NETWORK_CRED,
/**
* @brief bootstrap 服务器的域名地址或者ip地址
*
* @details
*
* 阿里云物联网平台 bootstrap 服务器域名地址列表:
*
* | 域名地址 | 区域 | 端口号
* |-------------------------------------------------|---------|---------
* | iot-auth-global.aliyuncs.com | 全球 | 443
*
* 数据类型: (char *) 默认值: iot-auth-global.aliyuncs.com
*/
AIOT_BOOTSTRAPOPT_HOST,
/**
* @brief bootstrap 服务器的端口号
*
* @details
*
* 连接阿里云物联网平台 bootstrap 服务器时:
*
* 必须使用tls方式建联, 端口号设置为443
*
* 数据类型: (uint16_t *) 默认值: 443
*/
AIOT_BOOTSTRAPOPT_PORT,
/**
* @brief 设备的product key, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_BOOTSTRAPOPT_PRODUCT_KEY,
/**
* @brief 设备的device name, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_BOOTSTRAPOPT_DEVICE_NAME,
/**
* @brief 配置设备所在的regionId
*
* @details
*
* | 地域名称 | RegionId | 地域名称 | RegionId |
* |-------------------------|-----------|----------------------|----------|
* | 华东2-上海 | 0 | 亚太东南 1-新加坡 | 1 |
* | 亚太东北 1-日本东京 | 2 | 美国东部 1-弗吉尼亚 | 3 |
* | 欧洲中部 1-德国法兰克福 | 4 | 美国西部 1-硅谷 | 5 |
* | 华东 1-杭州 | 6 | 华南 1-深圳 | 7 |
* | 华北 2-北京 | 8 | 华北 1-青岛 | 9 |
* | 华北 3-张家口 | 10 | 华北 5-呼和浩特 | 11 |
* | 华南 2-河源 | 12 | 西南 1-成都 | 13 |
* | 香港 | 14 | 亚太东南 2-澳大利亚悉尼 | 15 |
* | 亚太东南 3-马来西亚吉隆坡 | 16 | 亚太东南 5-印尼雅加达 | 17 |
* | 亚太南部 1-印度孟买 | 18 | 英国-伦敦 | 19 |
* | 中东东部 1-阿联酋迪拜 | 20 | | |
*
* 数据类型: (char *)
*/
AIOT_BOOTSTRAPOPT_REGIONID,
/**
* @brief bootstrap会话发送消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_BOOTSTRAPOPT_SEND_TIMEOUT_MS,
/**
* @brief bootstrap会话接收消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_BOOTSTRAPOPT_RECV_TIMEOUT_MS,
/**
* @brief 从 bootstrap 服务器收取的数据从此回调函数进行通知
*
* @details
*
*
* 数据类型: (aiot_bootstrap_recv_handler_t)
*/
AIOT_BOOTSTRAPOPT_RECV_HANDLER,
/**
* @brief bootstrap内部发生的事件会从此回调函数进行通知
*
* @details
*
* 数据类型: ( @ref aiot_bootstrap_event_handler_t )
*/
AIOT_BOOTSTRAPOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 该上下文会在 @ref AIOT_BOOTSTRAPOPT_RECV_HANDLER 注册的回调函数中传回给用户
*
* 数据类型: (void *)
*/
AIOT_BOOTSTRAPOPT_USERDATA,
/**
* @brief 等待bootstrap应答的超时时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_BOOTSTRAPOPT_TIMEOUT_MS,
/**
* @brief 销毁Bootstrap实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_bootstrap_deinit 销毁MQTT实例时, 若继续调用其他aiot_bootstrap_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_bootstrap_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_BOOTSTRAPOPT_DEINIT_TIMEOUT_MS,
AIOT_BOOTSTRAPOPT_MAX
} aiot_bootstrap_option_t;
/**
* @brief 初始化bootstrap实例并设置默认参数
*
* @return void*
* @retval 非NULL bootstrap实例句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_bootstrap_init(void);
/**
* @brief 设置bootstrap参数
*
* @param[in] handle bootstrap句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_bootstrap_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_bootstrap_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数设置失败
* @retval >=STATE_SUCCESS 参数设置成功
*
*/
int32_t aiot_bootstrap_setopt(void *handle, aiot_bootstrap_option_t option, void *data);
/**
* @brief 释放bootstrap实例句柄的资源
*
* @param[in] handle 指向bootstrap实例句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_bootstrap_deinit(void **handle);
/**
* @brief 向bootstrap服务器发送请求
*
* @param handle bootstrap句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_bootstrap_send_request(void *handle);
/**
* @brief 从bootstrap服务器接收应答
*
* @param handle bootstrap句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 数据接收失败
* @retval >=STATE_SUCCESS 数据接收成功
*/
int32_t aiot_bootstrap_recv(void *handle);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/components/bootstrap/aiot_bootstrap_api.h | C | apache-2.0 | 10,274 |
#ifndef _BOOTSTRAP_PRIVATE_H_
#define _BOOTSTRAP_PRIVATE_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_string.h"
#include "core_log.h"
#include "core_http.h"
#include "core_global.h"
#include "core_mqtt.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_bootstrap_api.h"
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *http_handle;
void *mqtt_handle;
core_http_response_t response;
uint32_t response_body_len;
char *host;
uint16_t port;
char *product_key;
char *device_name;
char *region_id;
aiot_sysdep_network_cred_t *cred;
uint8_t exec_enabled;
uint32_t exec_count;
uint32_t send_timeout_ms;
uint32_t recv_timeout_ms;
uint32_t timeout_ms;
uint32_t deinit_timeout_ms;
void *data_mutex;
aiot_bootstrap_recv_handler_t recv_handler;
aiot_bootstrap_event_handler_t event_handler;
void *userdata;
} bootstrap_handle_t;
#define BOOTSTRAP_MODULE_NAME "Bootstrap"
#define BOOTSTRAP_DEFAULT_HOST "iot-auth-global.aliyuncs.com"
#define BOOTSTRAP_DEFAULT_PORT (443)
#define BOOTSTRAP_DEFAULT_TIMEOUT_MS (5 * 1000)
#define BOOTSTRAP_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define BOOTSTRAP_DEFAULT_RECV_TIMEOUT (5 * 1000)
#define BOOTSTRAP_DEFAULT_SEND_TIMEOUT (5 * 1000)
#define BOOTSTRAP_PATH "/auth/bootstrap"
#define BOOTSTRAP_NOTIFY_TOPIC_FMT "/sys/%s/%s/thing/bootstrap/notify"
#define BOOTSTRAP_NOTIFY_REPLY_TOPIC_FMT "/sys/%s/%s/thing/bootstrap/notify_reply"
#define BOOTSTRAP_DEINIT_INTERVAL_MS (100)
#define BOOTSTRAP_RESPONSE_BODY_LEN (192)
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/components/bootstrap/bootstrap_private.h | C | apache-2.0 | 1,838 |
/**
* @file aiot_dm_api.c
* @brief 数据模型模块接口实现文件, 包含了支持物模型数据格式通信的所有接口实现
* @date 2020-01-20
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "dm_private.h"
static int32_t _dm_send_property_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_event_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_property_set_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_async_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_sync_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_raw_data(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_raw_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_desired_get(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_desired_delete(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static int32_t _dm_send_property_batch_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
static void _dm_recv_generic_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_property_set_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_async_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_sync_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_raw_data_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_raw_sync_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _dm_recv_up_raw_reply_data_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static const dm_send_topic_map_t g_dm_send_topic_mapping[AIOT_DMMSG_MAX] = {
{
"/sys/%s/%s/thing/event/property/post",
_dm_send_property_post
},
{
"/sys/%s/%s/thing/event/%s/post",
_dm_send_event_post
},
{
"/sys/%s/%s/thing/service/property/set_reply",
_dm_send_property_set_reply
},
{
"/sys/%s/%s/thing/service/%s_reply",
_dm_send_async_service_reply
},
{
"/ext/rrpc/%s/sys/%s/%s/thing/service/%s",
_dm_send_sync_service_reply
},
{
"/sys/%s/%s/thing/model/up_raw",
_dm_send_raw_data
},
{
"/ext/rrpc/%s/sys/%s/%s/thing/model/down_raw",
_dm_send_raw_service_reply
},
{
"/sys/%s/%s/thing/property/desired/get",
_dm_send_desired_get
},
{
"/sys/%s/%s/thing/property/desired/delete",
_dm_send_desired_delete
},
{
"/sys/%s/%s/thing/event/property/batch/post",
_dm_send_property_batch_post
},
};
static const dm_recv_topic_map_t g_dm_recv_topic_mapping[] = {
{
"/sys/+/+/thing/event/+/post_reply",
_dm_recv_generic_reply_handler,
},
{
"/sys/+/+/thing/service/property/set",
_dm_recv_property_set_handler,
},
{
"/sys/+/+/thing/service/+",
_dm_recv_async_service_invoke_handler,
},
{
"/ext/rrpc/+/sys/+/+/thing/service/+",
_dm_recv_sync_service_invoke_handler,
},
{
"/sys/+/+/thing/model/down_raw",
_dm_recv_raw_data_handler,
},
{
"/sys/+/+/thing/model/up_raw_reply",
_dm_recv_up_raw_reply_data_handler,
},
{
"/ext/rrpc/+/sys/+/+/thing/model/down_raw",
_dm_recv_raw_sync_service_invoke_handler,
},
{
"/sys/+/+/thing/property/desired/get_reply",
_dm_recv_generic_reply_handler,
},
{
"/sys/+/+/thing/property/desired/delete_reply",
_dm_recv_generic_reply_handler,
},
{
"/sys/+/+/thing/event/property/batch/post_reply",
_dm_recv_generic_reply_handler,
},
};
static void _append_diag_data(dm_handle_t *dm_handle, uint8_t msg_type, int32_t msg_id)
{
/* append diagnose data */
uint8_t diag_data[] = { 0x00, 0x30, 0x01, 0x00, 0x00, 0x31, 0x04, 0x00, 0x00, 0x00, 0x00 };
diag_data[3] = msg_type;
diag_data[7] = (msg_id >> 24) & 0xFF;
diag_data[8] = (msg_id >> 16) & 0xFF;
diag_data[9] = (msg_id >> 8) & 0xFF;
diag_data[10] = msg_id & 0xFF;
core_diag(dm_handle->sysdep, STATE_DM_BASE, diag_data, sizeof(diag_data));
}
static int32_t _dm_setup_topic_mapping(void *mqtt_handle, void *dm_handle)
{
uint32_t i = 0;
int32_t res = STATE_SUCCESS;
for (i = 0; i < sizeof(g_dm_recv_topic_mapping) / sizeof(dm_recv_topic_map_t); i++) {
aiot_mqtt_topic_map_t topic_mapping;
topic_mapping.topic = g_dm_recv_topic_mapping[i].topic;
topic_mapping.handler = g_dm_recv_topic_mapping[i].func;
topic_mapping.userdata = dm_handle;
res = aiot_mqtt_setopt(mqtt_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP, &topic_mapping);
if (res < 0) {
break;
}
}
return res;
}
static int32_t _dm_prepare_send_topic(dm_handle_t *dm_handle, const aiot_dm_msg_t *msg, char **topic)
{
char *src[4];
uint8_t src_count = 0;
char *pk = NULL;
char *dn = NULL;
if (NULL == msg->product_key && NULL == core_mqtt_get_product_key(dm_handle->mqtt_handle)) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (NULL == msg->device_name && NULL == core_mqtt_get_device_name(dm_handle->mqtt_handle)) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
pk = (msg->product_key != NULL) ? msg->product_key : core_mqtt_get_product_key(dm_handle->mqtt_handle);
dn = (msg->device_name != NULL) ? msg->device_name : core_mqtt_get_device_name(dm_handle->mqtt_handle);
switch (msg->type) {
case AIOT_DMMSG_PROPERTY_POST:
case AIOT_DMMSG_PROPERTY_BATCH_POST:
case AIOT_DMMSG_PROPERTY_SET_REPLY:
case AIOT_DMMSG_GET_DESIRED:
case AIOT_DMMSG_DELETE_DESIRED:
case AIOT_DMMSG_RAW_DATA: {
src[0] = pk;
src[1] = dn;
src_count = 2;
}
break;
case AIOT_DMMSG_EVENT_POST: {
if (msg->data.event_post.event_id == NULL) {
return STATE_DM_EVENT_ID_IS_NULL;
}
src[0] = pk;
src[1] = dn;
src[2] = msg->data.event_post.event_id;
src_count = 3;
}
break;
case AIOT_DMMSG_ASYNC_SERVICE_REPLY: {
if (msg->data.async_service_reply.service_id == NULL) {
return STATE_DM_SERVICE_ID_IS_NULL;
}
src[0] = pk;
src[1] = dn;
src[2] = msg->data.async_service_reply.service_id;
src_count = 3;
}
break;
case AIOT_DMMSG_SYNC_SERVICE_REPLY: {
if (msg->data.sync_service_reply.rrpc_id == NULL) {
return STATE_DM_RRPC_ID_IS_NULL;
}
if (msg->data.sync_service_reply.service_id == NULL) {
return STATE_DM_SERVICE_ID_IS_NULL;
}
src[0] = msg->data.sync_service_reply.rrpc_id;
src[1] = pk;
src[2] = dn;
src[3] = msg->data.sync_service_reply.service_id;
src_count = 4;
}
break;
case AIOT_DMMSG_RAW_SERVICE_REPLY: {
if (msg->data.raw_service_reply.rrpc_id == NULL) {
return STATE_DM_RRPC_ID_IS_NULL;
}
src[0] = msg->data.raw_service_reply.rrpc_id;
src[1] = pk;
src[2] = dn;
src_count = 3;
}
break;
default:
return STATE_USER_INPUT_OUT_RANGE;
}
return core_sprintf(dm_handle->sysdep, topic, g_dm_send_topic_mapping[msg->type].topic, src, src_count,
DATA_MODEL_MODULE_NAME);
}
static int32_t _dm_send_alink_req(dm_handle_t *handle, const char *topic, char *params)
{
char *payload = NULL;
int32_t id = 0;
char id_string[11] = { 0 };
char *src[3] = { NULL };
int32_t res = STATE_SUCCESS;
if (NULL == params) {
return STATE_DM_MSG_PARAMS_IS_NULL;
}
core_global_alink_id_next(handle->sysdep, &id);
core_int2str(id, id_string, NULL);
_append_diag_data(handle, DM_DIAG_MSG_TYPE_REQ, id);
src[0] = id_string;
src[1] = params;
src[2] = (0 == handle->post_reply) ? "0" : "1";
res = core_sprintf(handle->sysdep, &payload, ALINK_REQUEST_FMT, src, sizeof(src) / sizeof(char *),
DATA_MODEL_MODULE_NAME);
if (res < 0) {
return res;
}
res = aiot_mqtt_pub(handle->mqtt_handle, (char *)topic, (uint8_t *)payload, strlen(payload), 0);
handle->sysdep->core_sysdep_free(payload);
if (STATE_SUCCESS == res) {
return id;
}
return res;
}
static int32_t _dm_send_alink_rsp(dm_handle_t *handle, const char *topic, uint64_t msg_id, uint32_t code,
char *data)
{
char *payload = NULL;
char id_string[21] = { 0 };
char code_string[11] = { 0 };
char *src[3] = { NULL };
int32_t res = STATE_SUCCESS;
if (NULL == data) {
return STATE_DM_MSG_DATA_IS_NULL;
}
core_uint642str(msg_id, id_string, NULL);
core_uint2str(code, code_string, NULL);
src[0] = id_string;
src[1] = code_string;
src[2] = data;
res = core_sprintf(handle->sysdep, &payload, ALINK_RESPONSE_FMT, src, sizeof(src) / sizeof(char *),
DATA_MODEL_MODULE_NAME);
if (res < 0) {
return res;
}
res = aiot_mqtt_pub(handle->mqtt_handle, (char *)topic, (uint8_t *)payload, strlen(payload), 0);
handle->sysdep->core_sysdep_free(payload);
return res;
}
/*** dm send function start ***/
static int32_t _dm_send_property_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_req(handle, topic, msg->data.property_post.params);
}
static int32_t _dm_send_event_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_req(handle, topic, msg->data.event_post.params);
}
static int32_t _dm_send_property_set_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_rsp(handle, topic, msg->data.property_set_reply.msg_id,
msg->data.property_set_reply.code,
msg->data.property_set_reply.data);
}
static int32_t _dm_send_async_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_rsp(handle, topic, msg->data.async_service_reply.msg_id,
msg->data.async_service_reply.code,
msg->data.async_service_reply.data);
}
static int32_t _dm_send_sync_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_rsp(handle, topic, msg->data.sync_service_reply.msg_id,
msg->data.sync_service_reply.code,
msg->data.sync_service_reply.data);
}
static int32_t _dm_send_raw_data(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return aiot_mqtt_pub(handle->mqtt_handle, (char *)topic, msg->data.raw_data.data, msg->data.raw_data.data_len, 0);
}
static int32_t _dm_send_raw_service_reply(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return aiot_mqtt_pub(handle->mqtt_handle, (char *)topic, msg->data.raw_service_reply.data,
msg->data.raw_service_reply.data_len, 0);
}
static int32_t _dm_send_desired_get(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_req(handle, topic, msg->data.get_desired.params);
}
static int32_t _dm_send_desired_delete(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_req(handle, topic, msg->data.delete_desired.params);
}
static int32_t _dm_send_property_batch_post(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg)
{
return _dm_send_alink_req(handle, topic, msg->data.property_post.params);
}
/*** dm send function end ***/
/*** dm recv handler functions start ***/
static int32_t _dm_get_topic_level(aiot_sysdep_portfile_t *sysdep, char *topic, uint32_t topic_len, uint8_t level,
char **level_name)
{
uint32_t i = 0;
uint16_t level_curr = 0;
char *p_open = NULL;
char *p_close = NULL;
char *p_name = NULL;
uint16_t name_len = 0;
for (i = 0; i < (topic_len - 1); i++) {
if (topic[i] == '/') {
level_curr++;
if (level_curr == level && p_open == NULL) {
p_open = topic + i + 1;
}
if (level_curr == (level + 1) && p_close == NULL) {
p_close = topic + i;
}
}
}
if (p_open == NULL) {
return STATE_DM_INTERNAL_TOPIC_ERROR;
}
if (p_close == NULL) {
p_close = topic + topic_len;
}
name_len = p_close - p_open;
p_name = sysdep->core_sysdep_malloc(name_len + 1, DATA_MODEL_MODULE_NAME);
if (p_name == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(p_name, 0, name_len + 1);
memcpy(p_name, p_open, name_len);
*level_name = p_name;
return STATE_SUCCESS;
}
static int32_t _dm_parse_alink_request(const char *payload, uint32_t payload_len, uint64_t *msg_id, char **params,
uint32_t *params_len)
{
char *value = NULL;
uint32_t value_len = 0;
int32_t res = STATE_SUCCESS;
if ((res = core_json_value((char *)payload, payload_len, ALINK_JSON_KEY_ID, strlen(ALINK_JSON_KEY_ID),
&value, &value_len)) < 0 ||
(res = core_str2uint64(value, value_len, msg_id) < 0)) {
return res;
}
if ((res = core_json_value((char *)payload, payload_len, ALINK_JSON_KEY_PARAMS, strlen(ALINK_JSON_KEY_PARAMS),
&value, &value_len)) < 0) {
return res;
}
*params = value;
*params_len = value_len;
return res;
}
static void _dm_recv_generic_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
char *value = NULL;
uint32_t value_len = 0;
int32_t res = STATE_SUCCESS;
if (NULL == dm_handle->recv_handler) {
return;
}
/* construct recv message */
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_GENERIC_REPLY;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv generic reply\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 2, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3, &recv.device_name) < 0) {
break; /* must be malloc failed */
}
if ((res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
ALINK_JSON_KEY_ID, strlen(ALINK_JSON_KEY_ID), &value, &value_len)) < 0 ||
(res = core_str2uint(value, value_len, &recv.data.generic_reply.msg_id)) < 0 ||
(res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
ALINK_JSON_KEY_CODE, strlen(ALINK_JSON_KEY_CODE), &value, &value_len)) < 0 ||
(res = core_str2uint(value, value_len, &recv.data.generic_reply.code) < 0) ||
(res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
ALINK_JSON_KEY_DATA, strlen(ALINK_JSON_KEY_DATA),
&recv.data.generic_reply.data,
&recv.data.generic_reply.data_len)) < 0) {
core_log(dm_handle->sysdep, SATAE_DM_LOG_PARSE_RECV_MSG_FAILED, "DM parse generic reply failed\r\n");
break;
}
res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
ALINK_JSON_KEY_MESSAGE, strlen(ALINK_JSON_KEY_MESSAGE),
&recv.data.generic_reply.message,
&recv.data.generic_reply.message_len);
if (res < 0) {
core_log(dm_handle->sysdep, SATAE_DM_LOG_PARSE_RECV_MSG_FAILED, "DM parse generic reply failed\r\n");
break;
}
_append_diag_data(handle, DM_DIAG_MSG_TYPE_RSP, recv.data.generic_reply.msg_id);
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
}
static void _dm_recv_property_set_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
int32_t res = STATE_SUCCESS;
if (NULL == dm_handle->recv_handler) {
return;
}
/* construct recv message */
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_PROPERTY_SET;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv property set\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 2, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3, &recv.device_name) < 0) {
break; /* must be malloc failed */
}
if ((res = _dm_parse_alink_request((char *)msg->data.pub.payload, msg->data.pub.payload_len,
&recv.data.property_set.msg_id,
&recv.data.property_set.params,
&recv.data.property_set.params_len)) < 0) {
core_log(dm_handle->sysdep, SATAE_DM_LOG_PARSE_RECV_MSG_FAILED, "DM parse property set failed\r\n");
break;
}
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
}
static void _dm_recv_async_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
int32_t res = STATE_SUCCESS;
if (NULL == dm_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_ASYNC_SERVICE_INVOKE;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv async service invoke\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 2, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3, &recv.device_name) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 6,
&recv.data.async_service_invoke.service_id) < 0) {
break;
}
if ((res = _dm_parse_alink_request((char *)msg->data.pub.payload, msg->data.pub.payload_len,
&recv.data.async_service_invoke.msg_id,
&recv.data.async_service_invoke.params,
&recv.data.async_service_invoke.params_len)) < 0) {
/* core_log(dm_handle->sysdep, SATAE_DM_LOG_PARSE_RECV_MSG_FAILED, "DM parse async servicey failed\r\n"); */
break;
}
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
DM_FREE(recv.data.async_service_invoke.service_id);
}
static void _dm_recv_sync_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
int32_t res = STATE_SUCCESS;
if (NULL == dm_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_SYNC_SERVICE_INVOKE;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv sync service invoke\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 5, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 6, &recv.device_name) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3,
&recv.data.sync_service_invoke.rrpc_id) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 9,
&recv.data.sync_service_invoke.service_id) < 0) {
break;
}
if ((res = _dm_parse_alink_request((char *)msg->data.pub.payload, msg->data.pub.payload_len,
&recv.data.sync_service_invoke.msg_id,
&recv.data.sync_service_invoke.params,
&recv.data.sync_service_invoke.params_len)) < 0) {
core_log(dm_handle->sysdep, SATAE_DM_LOG_PARSE_RECV_MSG_FAILED, "DM parse sync service failed\r\n");
break;
}
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.data.sync_service_invoke.rrpc_id);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
DM_FREE(recv.data.sync_service_invoke.service_id);
}
static void _dm_recv_raw_data_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
if (NULL == dm_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_RAW_DATA;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv raw data\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 2, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3, &recv.device_name) < 0) {
break;
}
recv.data.raw_data.data = msg->data.pub.payload;
recv.data.raw_data.data_len = msg->data.pub.payload_len;
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
}
static void _dm_recv_up_raw_reply_data_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
if (NULL == dm_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_RAW_DATA_REPLY;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv raw data\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 2, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3, &recv.device_name) < 0) {
break;
}
recv.data.raw_data.data = msg->data.pub.payload;
recv.data.raw_data.data_len = msg->data.pub.payload_len;
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
}
static void _dm_recv_raw_sync_service_invoke_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
dm_handle_t *dm_handle = (dm_handle_t *)userdata;
aiot_dm_recv_t recv;
if (NULL == dm_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_dm_recv_t));
recv.type = AIOT_DMRECV_RAW_SYNC_SERVICE_INVOKE;
core_log(dm_handle->sysdep, STATE_DM_LOG_RECV, "DM recv raw sync service invoke\r\n");
do {
if (_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 3,
&recv.data.raw_service_invoke.rrpc_id) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 5, &recv.product_key) < 0 ||
_dm_get_topic_level(dm_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, 6, &recv.device_name) < 0) {
break;
}
recv.data.raw_service_invoke.data = msg->data.pub.payload;
recv.data.raw_service_invoke.data_len = msg->data.pub.payload_len;
dm_handle->recv_handler(dm_handle, &recv, dm_handle->userdata);
} while (0);
DM_FREE(recv.data.raw_service_invoke.rrpc_id);
DM_FREE(recv.product_key);
DM_FREE(recv.device_name);
}
static void _dm_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
dm_handle_t *dm_handle = (dm_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
dm_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _dm_core_mqtt_operate_process_handler(dm_handle_t *dm_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _dm_core_mqtt_process_handler;
process_data.context = dm_handle;
return core_mqtt_setopt(dm_handle->mqtt_handle, option, &process_data);
}
void *aiot_dm_init(void)
{
aiot_sysdep_portfile_t *sysdep = aiot_sysdep_get_portfile();
dm_handle_t *dm_handle = NULL;
if (NULL == sysdep) {
return NULL;
}
dm_handle = sysdep->core_sysdep_malloc(sizeof(dm_handle_t), DATA_MODEL_MODULE_NAME);
if (NULL == dm_handle) {
return NULL;
}
memset(dm_handle, 0, sizeof(dm_handle_t));
dm_handle->sysdep = sysdep;
dm_handle->post_reply = 1;
core_global_init(sysdep);
return dm_handle;
}
int32_t aiot_dm_setopt(void *handle, aiot_dm_option_t option, void *data)
{
dm_handle_t *dm_handle;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == data) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_DMOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
dm_handle = (dm_handle_t *)handle;
switch (option) {
case AIOT_DMOPT_MQTT_HANDLE: {
dm_handle->mqtt_handle = data;
/* setup mqtt topic mapping */
res = _dm_setup_topic_mapping(data, dm_handle);
if (res >= STATE_SUCCESS) {
res = _dm_core_mqtt_operate_process_handler(dm_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
}
break;
case AIOT_DMOPT_RECV_HANDLER: {
dm_handle->recv_handler = (aiot_dm_recv_handler_t)data;
}
break;
case AIOT_DMOPT_USERDATA: {
dm_handle->userdata = data;
}
break;
case AIOT_DMOPT_POST_REPLY: {
dm_handle->post_reply = *(uint8_t *)data;
}
break;
default:
break;
}
return res;
}
int32_t aiot_dm_send(void *handle, const aiot_dm_msg_t *msg)
{
dm_handle_t *dm_handle = NULL;
char *topic = NULL;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == msg) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (msg->type >= AIOT_DMMSG_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
dm_handle = (dm_handle_t *)handle;
if (NULL == dm_handle->mqtt_handle) {
return STATE_DM_MQTT_HANDLE_IS_NULL;
}
res = _dm_prepare_send_topic(dm_handle, msg, &topic);
if (res < 0) {
return res;
}
res = g_dm_send_topic_mapping[msg->type].func(dm_handle, topic, msg);
dm_handle->sysdep->core_sysdep_free(topic);
return res;
}
int32_t aiot_dm_deinit(void **p_handle)
{
dm_handle_t *dm_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
uint8_t i = 0;
if (NULL == p_handle || NULL == *p_handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
dm_handle = *p_handle;
sysdep = dm_handle->sysdep;
*p_handle = NULL;
_dm_core_mqtt_operate_process_handler(dm_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
/* remove mqtt topic mapping */
for (i = 0; i < sizeof(g_dm_recv_topic_mapping) / sizeof(dm_recv_topic_map_t); i++) {
aiot_mqtt_topic_map_t topic_mapping;
memset(&topic_mapping, 0, sizeof(aiot_mqtt_topic_map_t));
topic_mapping.topic = g_dm_recv_topic_mapping[i].topic;
topic_mapping.handler = g_dm_recv_topic_mapping[i].func;
aiot_mqtt_setopt(dm_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, &topic_mapping);
}
sysdep->core_sysdep_free(dm_handle);
core_global_deinit(sysdep);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/data-model/aiot_dm_api.c | C | apache-2.0 | 29,553 |
/**
* @file aiot_dm_api.h
* @brief 数据模型模块头文件, 提供了物模型数据格式的上云能力, 包括属性, 事件, 服务和物模型二进制格式的数据上下行能力
* @date 2020-01-20
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
* 请按照以下流程使用API
*
* 1. 在使用物模型模块前, 用户应首先创建好一个MQTT实例
*
* 2. 调用`aiot_dm_init`创建一个物模型实例, 保存实例句柄
*
* 3. 调用`aiot_dm_setopt`配置`AIOT_DMOPT_MQTT_HANDLE`选项以设置MQTT句柄, 此选项为强制配置选项
*
* 4. 调用`aiot_dm_setopt`配置`AIOT_DMOPT_RECV_HANDLER`和`AIOT_DMOPT_USERDATA`选项以注册数据接受回调函数和用户上下文数据指针
*
* 5. 在使用`aiot_dm_send`发送消息前, 应先完成MQTT实例的建连
*
* 6. 调动`aiot_dm_send`发送不同类型的消息到云平台, 在注册的回调函数中处理各种类型的云平台下行消息
*
*/
#ifndef __AIOT_DM_API_H__
#define __AIOT_DM_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0A00~-0x0AFF表达SDK在data-model模块内的状态码
*/
#define STATE_DM_BASE (-0x0A00)
/**
* @brief 用户发送@ref AIOT_DMMSG_EVENT_POST 消息时, 消息数据中的event_id为NULL
*/
#define STATE_DM_EVENT_ID_IS_NULL (-0x0A01)
/**
* @brief 用户发送@ref AIOT_DMMSG_ASYNC_SERVICE_REPLY 或@ref AIOT_DMMSG_SYNC_SERVICE_REPLY 消息时, 消息数据中的event_id为NULL
*/
#define STATE_DM_SERVICE_ID_IS_NULL (-0x0A02)
/**
* @brief 用户发送@ref AIOT_DMMSG_SYNC_SERVICE_REPLY 消息时, 消息数据中的rrpc_id为NULL
*/
#define STATE_DM_RRPC_ID_IS_NULL (-0x0A03)
/**
* @brief 用户发送请求类消息时, 消息数据中的param为NULL
*/
#define STATE_DM_MSG_PARAMS_IS_NULL (-0X0A04)
/**
* @brief 用户发送应答类消息时, 消息数据中的data为NULL
*/
#define STATE_DM_MSG_DATA_IS_NULL (-0X0A05)
/**
* @brief 解析下行数据对应的topic时发生错误
*/
#define STATE_DM_INTERNAL_TOPIC_ERROR (-0x0A06)
/**
* @brief 用户未调用@ref aiot_dm_setopt 配置MQTT句柄
*/
#define STATE_DM_MQTT_HANDLE_IS_NULL (-0x0A07)
/**
* @brief 接收到服务器下行消息时的日志状态码
*/
#define STATE_DM_LOG_RECV (-0x0A08)
/**
* @brief 解析服务器下行消息失败时的日志状态码
*/
#define SATAE_DM_LOG_PARSE_RECV_MSG_FAILED (-0x0A09)
/**
* @brief data-model模块的配置选项枚举类型定义. @ref aiot_dm_setopt 函数入数data的数据类型根据不同的选项而不同
*
*/
typedef enum {
/**
* @brief 模块依赖的MQTT句柄
*
* @details
*
* data-model模块依赖底层的MQTT模块, 用户必需配置正确的MQTT句柄, 否则无法正常工作
*
* 数据类型: (void *)
*/
AIOT_DMOPT_MQTT_HANDLE,
/**
* @brief 数据接收回调函数, data-model接收物联网平台的下行消息后调用此回调函数
*
* @details
*
* 数据类型: (aiot_dm_recv_handler_t), 详细查看@ref aiot_dm_recv_handler_t 回调函数原型
*/
AIOT_DMOPT_RECV_HANDLER,
/**
* @brief 指向用户上下文数据的指针
*
* @details
*
* 在用户注册的@ref aiot_dm_recv_handler_t 数据接收回调函数中会同过userdata参数将此指针返回给用户
*
* 数据类型: (void *)
*/
AIOT_DMOPT_USERDATA,
/**
* @brief 用户是否希望接收post消息后的reply
*
* @details
*
* 是否要接收云端的reply消息. 1表示要接收, 0表示不要.
*
* 数据类型: (uint8_t) *)
*/
AIOT_DMOPT_POST_REPLY,
/**
* @brief 配置选项数量最大值, 不可用作配置参数
*/
AIOT_DMOPT_MAX,
} aiot_dm_option_t;
/**
* @brief data-model模块发送消息类型
*
* @details
*
* 这个枚举类型包括了dm模块支持发送的所有数据类型, 不同的消息类型将对于不同的消息结构体
* 用户可查看网页文档<a href="https://help.aliyun.com/document_detail/89301.html">设备属性/事件/服务</a>进一步了解各种数据类型
*
*/
typedef enum {
/**
* @brief 属性上报, 消息结构体参考@ref aiot_dm_msg_property_post_t \n
* 成功发送此消息后, 将会收到@ref AIOT_DMRECV_GENERIC_REPLY 类型的应答消息
*/
AIOT_DMMSG_PROPERTY_POST,
/**
* @brief 事件上报, 消息结构体参考@ref aiot_dm_msg_event_post_t \n
* 成功发送此消息后, 将会收到@ref AIOT_DMRECV_GENERIC_REPLY 类型的应答消息
*/
AIOT_DMMSG_EVENT_POST,
/**
* @brief 属性设置应答, 消息结构体参考@ref aiot_dm_msg_property_set_reply_t
*/
AIOT_DMMSG_PROPERTY_SET_REPLY,
/**
* @brief 异步服务应答, 消息结构体参考@ref aiot_dm_msg_async_service_reply_t
*/
AIOT_DMMSG_ASYNC_SERVICE_REPLY,
/**
* @brief 同步服务应答, 消息结构体参考@ref aiot_dm_msg_sync_service_reply_t
*/
AIOT_DMMSG_SYNC_SERVICE_REPLY,
/**
* @brief 二进制格式的物模型上行数据, 消息结构体参考@ref aiot_dm_msg_raw_data_t
*/
AIOT_DMMSG_RAW_DATA,
/**
* @brief 二进制格式的同步服务应答, 消息结构体参考@ref aiot_dm_msg_raw_service_reply_t
*/
AIOT_DMMSG_RAW_SERVICE_REPLY,
/**
* @brief 获取期望属性值, 消息结构体请参考@ref aiot_dm_msg_get_desired_t, \n
* 成功发送此消息后, 将会收到@ref AIOT_DMRECV_GENERIC_REPLY 类型的应答消息
*/
AIOT_DMMSG_GET_DESIRED,
/**
* @brief 清除指定的期望值, 消息结构体请参考@ref aiot_dm_msg_delete_desired_t \n
* 成功发送此消息后, 将会收到@ref AIOT_DMRECV_GENERIC_REPLY 类型的应答消息
*/
AIOT_DMMSG_DELETE_DESIRED,
/**
* @brief 清除指定的期望值, 消息结构体请参考@ref aiot_dm_msg_delete_desired_t \n
* 成功发送此消息后, 将会收到@ref AIOT_DMRECV_GENERIC_REPLY 类型的应答消息
*/
AIOT_DMMSG_PROPERTY_BATCH_POST,
/**
* @brief 消息数量最大值, 不可用作消息类型
*/
AIOT_DMMSG_MAX,
} aiot_dm_msg_type_t;
/**
* @brief <b>物模型属性上报</b>消息结构体
*/
typedef struct {
/**
* @brief 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>. 包含用户要上报的属性数据, 如<i>"{\"LightSwitch\":0}"</i>
*/
char *params;
} aiot_dm_msg_property_post_t;
/**
* @brief <b>物模型事件上报</b>消息结构体
*/
typedef struct {
/**
* @brief 事件标示符, <b>必须为以结束符'\0'结尾的字符串</b>
*/
char *event_id;
/**
* @brief 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>. 包含用户要上报的事件数据, 如<i>"{\"ErrorNum\":0}"</i>
*/
char *params;
} aiot_dm_msg_event_post_t;
/**
* @brief <b>属性设置应答</b>消息结构体, 用户在收到@ref AIOT_DMRECV_PROPERTY_SET 类型的属性设置后, 可发送此消息进行回复
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数, <b>必须与属性设置的消息标示符一致</b>
*/
uint64_t msg_id;
/**
* @brief 设备端状态码, 200-请求成功, 更多状态码查看<a href="https://help.aliyun.com/document_detail/89309.html">设备端通用code</a>
*/
uint32_t code;
/**
* @brief 设备端应答数据, 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>, 如<i>"{}"</i>表示应答数据为空
*/
char *data;
} aiot_dm_msg_property_set_reply_t;
/**
* @brief <b>异步服务应答</b>消息结构体, 用户在收到@ref AIOT_DMRECV_ASYNC_SERVICE_INVOKE 类型的异步服务调用消息后, 应发送此消息进行应答
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数, <b>必须与异步服务调用的消息标示符一致</b>
*/
uint64_t msg_id;
/**
* @brief 服务标示符, 标识了要响应服务
*/
char *service_id;
/**
* @brief 设备端状态码, 200-请求成功, 更多状态码查看<a href="https://help.aliyun.com/document_detail/89309.html">设备端通用code</a>
*/
uint32_t code;
/**
* @brief 设备端应答数据, 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>, 如<i>"{}"</i>表示应答数据为空
*/
char *data;
} aiot_dm_msg_async_service_reply_t;
/**
* @brief <b>同步服务应答</b>消息结构体, 用户在收到@ref AIOT_DMRECV_SYNC_SERVICE_INVOKE 类型的同步服务调用消息后, 应在超时时间(默认7s)内进行应答
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数, <b>必须与同步服务调用的消息标示符一致</b>
*/
uint64_t msg_id;
/**
* @brief RRPC标示符, 用于唯一标识每一个同步服务的字符串, <b>必须与同步服务调用消息的RRPC标示符一致</b>
*/
char *rrpc_id;
/**
* @brief 服务标示符, 标识了要响应服务
*/
char *service_id;
/**
* @brief 设备端状态码, 200-请求成功, 更多状态码查看<a href="https://help.aliyun.com/document_detail/89309.html">设备端通用code</a>
*/
uint32_t code;
/**
* @brief 设备端应答数据, 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>, 如<i>"{}"</i>表示应答数据为空
*/
char *data;
} aiot_dm_msg_sync_service_reply_t;
/**
* @brief <b>物模型二进制数据</b>消息结构体, 发送的二进制数据将通过物联网平台的JavaScript脚本转化为JSON格式数据, 用户发送此消息前应确保已正确启用云端解析脚本
*/
typedef struct {
/**
* @brief 指向待发送二进制数据的指针
*/
uint8_t *data;
/**
* @brief 待发送数据的长度
*/
uint32_t data_len;
} aiot_dm_msg_raw_data_t;
/**
* @brief <b>二进制格式的同步服务应答</b>消息结构体, 用户在收到@ref AIOT_DMRECV_RAW_SYNC_SERVICE_INVOKE 类型消息后, 应在超时时间(默认7s)内进行应答\n
* 用户在使用此消息前应确保已启用云端解析脚本, 并且脚本工作正常
*/
typedef struct {
/**
* @brief RRPC标示符, 特殊字符串, <b>必须与同步服务调用消息的RRPC标示符一致</b>
*/
char *rrpc_id;
/**
* @brief 指向待发送二进制数据的指针
*/
uint8_t *data;
/**
* @brief 待发送数据的长度
*/
uint32_t data_len;
} aiot_dm_msg_raw_service_reply_t;
/**
* @brief <b>获取期望属性值</b>消息结构体, 发送
*/
typedef struct {
/**
* @brief 字符串形式的JSON<b>数组</b>, <b>必须以结束符'\0'结尾</b>. 应包含用户要获取的期望属性的ID, 如<i>"[\"LightSwitch\"]"</i>
*/
char *params;
} aiot_dm_msg_get_desired_t;
/**
* @brief <b>删除指定期望值</b>消息结构体
*/
typedef struct {
/**
* @brief 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>. 应包含用户要删除的期望属性的ID和期望值版本号, 如<i>"{\"LightSwitch\":{\"version\":1},\"Color\":{}}"</i>
*/
char *params;
} aiot_dm_msg_delete_desired_t;
/**
* @brief <b>物模型属性上报</b>消息结构体
*/
typedef struct {
/**
* @brief 字符串形式的JSON结构体, <b>必须以结束符'\0'结尾</b>. 包含用户要批量上报的属性和事件数据, 如 {"properties":{"Power": [ { "value": "on", "time": 1524448722000 },
* { "value": "off", "time": 1524448722001 } ], "WF": [ { "value": 3, "time": 1524448722000 }]}, "events": {"alarmEvent": [{ "value": { "Power": "on", "WF": "2"},
* "time": 1524448722000}]}}
*/
char *params;
} aiot_dm_msg_property_batch_post_t;
/**
* @brief data-model模块发送消息的消息结构体
*/
typedef struct {
/**
* @brief 消息所属设备的product_key, 若为NULL则使用通过aiot_dm_setopt配置的product_key\n
* 在网关子设备场景下, 可通过指定为子设备的product_key来发送子设备的消息到云端
*/
char *product_key;
/**
* @brief 消息所属设备的device_name, 若为NULL则使用通过aiot_dm_setopt配置的device_name\n
* 在网关子设备场景下, 可通过指定为子设备的product_key来发送子设备的消息到云端
*/
char *device_name;
/**
* @brief 消息类型, 可参考@ref aiot_dm_msg_type_t
*/
aiot_dm_msg_type_t type;
/**
* @brief 消息数据联合体, 不同的消息类型将使用不同的消息结构体
*/
union {
aiot_dm_msg_property_post_t property_post;
aiot_dm_msg_event_post_t event_post;
aiot_dm_msg_property_set_reply_t property_set_reply;
aiot_dm_msg_sync_service_reply_t sync_service_reply;
aiot_dm_msg_async_service_reply_t async_service_reply;
aiot_dm_msg_raw_data_t raw_data;
aiot_dm_msg_raw_service_reply_t raw_service_reply;
aiot_dm_msg_get_desired_t get_desired;
aiot_dm_msg_delete_desired_t delete_desired;
} data;
} aiot_dm_msg_t;
/**
* @brief data-model模块接受消息类型枚举
*
* @details
*
* 这个枚举类型包括了dm模块支持接收的所有数据类型, 不同的消息类型将对于不同的消息结构体
* 用户可查看网页文档<a href="https://help.aliyun.com/document_detail/89301.html">设备属性/事件/服务</a>进一步了解各种数据类型
*
*/
typedef enum {
/**
* @brief 上报属性/实践后服务器返回的应答消息, 消息数据结构体参考@ref aiot_dm_recv_generic_reply_t
*/
AIOT_DMRECV_GENERIC_REPLY,
/**
* @brief 服务器下发的属性设置消息, 消息数据结构体参考@ref aiot_dm_recv_property_set_t
*/
AIOT_DMRECV_PROPERTY_SET,
/**
* @brief 服务器下发的异步服务调用消息, 消息数据结构体参考@ref aiot_dm_recv_async_service_invoke_t
*/
AIOT_DMRECV_ASYNC_SERVICE_INVOKE,
/**
* @brief 服务器下发的同步服务调用消息, 消息数据结构体参考@ref aiot_dm_recv_sync_service_invoke_t
*/
AIOT_DMRECV_SYNC_SERVICE_INVOKE,
/**
* @brief 服务器对设备上报的二进制数据应答, 消息数据结构体参考@ref aiot_dm_recv_raw_data_t
*/
AIOT_DMRECV_RAW_DATA_REPLY,
/**
* @brief 服务器下发的物模型二进制数据, 消息数据结构体参考@ref aiot_dm_recv_raw_data_t
*/
AIOT_DMRECV_RAW_DATA,
/**
* @brief 服务器下发的二进制格式的同步服务调用消息, 消息数据结构体参考@ref aiot_dm_recv_raw_service_invoke_t
*/
AIOT_DMRECV_RAW_SYNC_SERVICE_INVOKE,
/**
* @brief 消息数量最大值, 不可用作消息类型
*/
AIOT_DMRECV_MAX,
} aiot_dm_recv_type_t;
/**
* @brief <b>云端通用应答</b>消息结构体, 设备端上报@ref AIOT_DMMSG_PROPERTY_POST, @ref AIOT_DMMSG_EVENT_POST 或者@ref AIOT_DMMSG_GET_DESIRED 等消息后, 服务器会应答此消息
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数, 与属性上报或事件上报的消息标示符一致
*/
uint32_t msg_id;
/**
* @brief 设备端错误码, 200-请求成功, 更多错误码码查看<a href="https://help.aliyun.com/document_detail/120329.html">设备端错误码</a>
*/
uint32_t code;
/**
* @brief 指向云端应答数据的指针
*/
char *data;
/**
* @brief 云端应答数据的长度
*/
uint32_t data_len;
/**
* @brief 指向状态消息字符串的指针, 当设备端上报请求成功时对应的应答消息为"success", 若请求失败则应答消息中包含错误信息
*/
char *message;
/**
* @brief 消息字符串的长度
*/
uint32_t message_len;
} aiot_dm_recv_generic_reply_t;
/**
* @brief <b>属性设置</b>消息结构体
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数
*/
uint64_t msg_id;
/**
* @brief 服务器下发的属性数据, 为字符串形式的JSON结构体, 此字符串<b>不</b>以结束符'\0'结尾, 如<i>"{\"LightSwitch\":0}"</i>
*/
char *params;
/**
* @brief 属性数据的字符串长度
*/
uint32_t params_len;
} aiot_dm_recv_property_set_t;
/**
* @brief <b>同步服务调用</b>消息结构体, 用户收到同步服务后, 必须在超时时间(默认7s)内进行应答
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数
*/
uint64_t msg_id;
/**
* @brief RRPC标识符, 用于唯一标识每一个同步服务的特殊字符串
*/
char *rrpc_id;
/**
* @brief 服务标示符, 字符串内容由用户定义的物模型决定
*/
char *service_id;
/**
* @brief 服务调用的输入参数数据, 为字符串形式的JSON结构体, 此字符串<b>不</b>以结束符'\0'结尾, 如<i>"{\"LightSwitch\":0}"</i>
*/
char *params;
/**
* @brief 输入参数的字符串长度
*/
uint32_t params_len;
} aiot_dm_recv_sync_service_invoke_t;
/**
* @brief <b>同步服务调用</b>消息结构体
*/
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数
*/
uint64_t msg_id;
/**
* @brief 服务标示符, 字符串内容由用户定义的物模型决定
*/
char *service_id;
/**
* @brief 服务调用的输入参数数据, 为字符串形式的JSON结构体, 此字符串<b>不</b>以结束符'\0'结尾, 如<i>"{\"LightSwitch\":0}"</i>
*/
char *params;
/**
* @brief 输入参数的字符串长度
*/
uint32_t params_len;
} aiot_dm_recv_async_service_invoke_t;
/**
* @brief <b>物模型二进制数据</b>消息结构体, 服务器的JSON格式物模型数据将通过物联网平台的JavaScript脚本转化为二进制数据, 用户在接收此消息前应确保已正确启用云端解析脚本
*/
typedef struct {
/**
* @brief 指向接受数据缓冲区的指针
*/
uint8_t *data;
/**
* @brief 二进制数据的长度
*/
uint32_t data_len;
} aiot_dm_recv_raw_data_t;
/**
* @brief <b>二进制数据的同步服务调用</b>消息结构体, 服务器的JSON格式物模型数据将通过物联网平台的JavaScript脚本转化为二进制数据, 用户在接收此消息前应确保已正确启用云端解析脚本
*/
typedef struct {
/**
* @brief RRPC标识符, 用于唯一标识每一个同步服务的特殊字符串
*/
char *rrpc_id;
/**
* @brief 指向接受数据缓冲区的指针
*/
uint8_t *data;
/**
* @brief 二进制数据的长度
*/
uint32_t data_len;
} aiot_dm_recv_raw_service_invoke_t;
/**
* @brief data-model模块接收消息的结构体
*/
typedef struct {
/**
* @brief 消息所属设备的product_key, 不配置则默认使用MQTT模块配置的product_key
*/
char *product_key;
/**
* @brief 消息所属设备的device_name, 不配置则默认使用MQTT模块配置的device_name
*/
char *device_name;
/**
* @brief 接收消息的类型, 可参考@ref aiot_dm_recv_type_t
*/
aiot_dm_recv_type_t type;
/**
* @brief 消息数据联合体, 不同的消息类型将使用不同的消息结构体
*/
union {
aiot_dm_recv_generic_reply_t generic_reply;
aiot_dm_recv_property_set_t property_set;
aiot_dm_recv_async_service_invoke_t async_service_invoke;
aiot_dm_recv_sync_service_invoke_t sync_service_invoke;
aiot_dm_recv_raw_data_t raw_data;
aiot_dm_recv_raw_service_invoke_t raw_service_invoke;
} data;
} aiot_dm_recv_t;
/**
* @brief data-model模块消息接收回调函数的函数原型定义, 当模块接收到服务器下行数据后将调用此回调函数, 并将消息数据通过<i>recv</i>参数输入给用户, \n
* 同时将用户上下文数据指针通过<i>userdata</i>参数返回给用户
*
* @param[in] handle data-model实例句柄
* @param[in] recv 服务下发的消息数据, <b>消息结构体中的所有数据指针在离开回调函数后将失效, 保存消息数据必须使用内存复制的方式</b>
* @param[in] userdata 指向用户上下文数据的指针, 这个指针由用户通过调用@ref aiot_dm_setopt 配置@ref AIOT_DMOPT_USERDATA 选项设置
*
* @return void
*/
typedef void (*aiot_dm_recv_handler_t)(void *handle, const aiot_dm_recv_t *recv, void *userdata);
/**
* @brief 初始化data-model实例
*
* @return void*
* @retval 非NULL data-model实例句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*/
void *aiot_dm_init(void);
/**
* @brief 设置data-model参数
*
* @param[in] handle data-model实例句柄
* @param[in] option 配置选项, 更多信息请查看@ref aiot_dm_option_t
* @param[in] data 配置数据, 更多信息请查看@ref aiot_dm_option_t
*
* @return int32_t
* @retval STATE_SUCCESS 参数配置成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参handle或data为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参optioin的枚举值>=AIOT_DMOPT_MAX
* @retval others 参考@ref aiot_state_api.h
*
*/
int32_t aiot_dm_setopt(void *handle, aiot_dm_option_t option, void *data);
/**
* @brief 发送一条data-model消息到物联网平台, 消息类型和消息数据由msg入参决定
*
* @param[in] handle data-model实例句柄
* @param[in] msg 消息结构体, 可指定发送消息的设备<i>productKey</i>, <i>deviceName</i>; 消息类型, 消息数据等, 更多信息请参考@ref aiot_dm_msg_t
*
* @return int32_t
* @retval >=STATE_SUCCESS 消息发送成功, 对于@ref AIOT_DMMSG_PROPERTY_POST, @ref AIOT_DMMSG_EVENT_POST, @ref AIOT_DMMSG_GET_DESIRED 和@ref AIOT_DMMSG_DELETE_DESIRED 消息, \n
* 发送成功返回值为>STATE_SUCCESS的消息标示符<i>msg_id</i>值
* @retval STATE_USER_INPUT_NULL_POINTER 入参<i>handle</i>或<i>msg</i>为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参<i>msg</i>的结构体成员<i>type</i> >= AIOT_DMMSG_MAX
* @retval STATE_SYS_DEPEND_MALLOC_FAILED 内存分配失败
* @retval STATE_DM_MQTT_HANDLE_IS_NULL 用户未调用@ref aiot_dm_setopt 配置MQTT句柄
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_DM_BASE 中对应的错误码说明
*
*/
int32_t aiot_dm_send(void *handle, const aiot_dm_msg_t *msg);
/**
* @brief 销毁data-model实例, 释放资源
*
* @param[in] p_handle 指向data-model实例句柄的指针
* @return int32_t
* @retval STATE_SUCCESS 执行成功
* @retval <STATE_SUCCESS 执行失败
*
*/
int32_t aiot_dm_deinit(void **p_handle);
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef __AIOT_DM_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/data-model/aiot_dm_api.h | C | apache-2.0 | 23,476 |
/**
* @file dm_private.h
* @brief 数据模型模块内部头文件
* @date 2020-01-20
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __DM_PRIVATE_H__
#define __DM_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_string.h"
#include "core_log.h"
#include "core_diag.h"
#include "core_global.h"
#include "core_mqtt.h"
#include "aiot_sysdep_api.h"
#include "aiot_state_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_dm_api.h"
/* 模块内部名 */
#define DATA_MODEL_MODULE_NAME "dm"
/* ALINK请求的JSON格式 */
#define ALINK_REQUEST_FMT "{\"id\":\"%s\",\"version\":\"1.0\",\"params\":%s,\"sys\":{\"ack\":%s}}"
/* ALINK应答的JSON格式 */
#define ALINK_RESPONSE_FMT "{\"id\":\"%s\",\"code\":%s,\"data\":%s}"
#define ALINK_JSON_KEY_ID "id"
#define ALINK_JSON_KEY_CODE "code"
#define ALINK_JSON_KEY_PARAMS "params"
#define ALINK_JSON_KEY_DATA "data"
#define ALINK_JSON_KEY_MESSAGE "message"
/* 诊断消息类型 */
#define DM_DIAG_MSG_TYPE_REQ (0x00)
#define DM_DIAG_MSG_TYPE_RSP (0x01)
#define DM_FREE(ptr) do {if (ptr) {dm_handle->sysdep->core_sysdep_free(ptr); ptr = NULL;}} while (0)
/* data-model模块的上下文结构体定义 */
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *mqtt_handle;
aiot_dm_recv_handler_t recv_handler;
void *userdata;
uint8_t post_reply;
} dm_handle_t;
/* data-model内部发送函数原型定义 */
typedef int32_t (*dm_msg_send_func_t)(dm_handle_t *handle, const char *topic, const aiot_dm_msg_t *msg);
/* 包含上行topic和对应处理函数的结构体定义 */
typedef struct {
char *topic;
dm_msg_send_func_t func;
} dm_send_topic_map_t;
/* 包含下行topic和对应处理函数的结构体定义 */
typedef struct {
char *topic;
aiot_mqtt_recv_handler_t func;
} dm_recv_topic_map_t;
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef __DM_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/data-model/dm_private.h | C | apache-2.0 | 2,086 |
/**
* @file aiot_devinfo_api.c
* @brief devinfo模块的API接口实现, 提供更新和删除设备标签的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "devinfo_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_global.h"
#include "core_mqtt.h"
static void _core_devinfo_exec_inc(devinfo_handle_t *devinfo_handle)
{
devinfo_handle->sysdep->core_sysdep_mutex_lock(devinfo_handle->data_mutex);
devinfo_handle->exec_count++;
devinfo_handle->sysdep->core_sysdep_mutex_unlock(devinfo_handle->data_mutex);
}
static void _core_devinfo_exec_dec(devinfo_handle_t *devinfo_handle)
{
devinfo_handle->sysdep->core_sysdep_mutex_lock(devinfo_handle->data_mutex);
devinfo_handle->exec_count--;
devinfo_handle->sysdep->core_sysdep_mutex_unlock(devinfo_handle->data_mutex);
}
static void _devinfo_find_pk_dn(devinfo_handle_t *devinfo_handle, char *topic, uint16_t topic_len, char **product_key, char **device_name)
{
uint16_t idx = 0, prev_slash = 0, slash = 0, pk_len = 0, dn_len = 0;
char *pk_pos = NULL, *dn_pos = NULL, *tmp_pk = NULL, *tmp_dn = NULL;
for (idx = 0;idx < topic_len;idx++) {
if (topic[idx] == '/') {
slash++;
if (slash == 2) {
pk_pos = &topic[idx + 1];
prev_slash = idx;
} else if (slash == 3) {
dn_pos = &topic[idx + 1];
pk_len = idx - prev_slash - 1;
prev_slash = idx;
} else if (slash == 4) {
dn_len = idx - prev_slash - 1;
break;
}
}
}
if (pk_len == 0 || dn_len == 0) {
return;
}
tmp_pk = devinfo_handle->sysdep->core_sysdep_malloc(pk_len + 1, DEVINFO_MODULE_NAME);
if (tmp_pk == NULL) {
return;
}
memset(tmp_pk, 0, pk_len + 1);
memcpy(tmp_pk, pk_pos, pk_len);
tmp_dn = devinfo_handle->sysdep->core_sysdep_malloc(dn_len + 1, DEVINFO_MODULE_NAME);
if (tmp_dn == NULL) {
devinfo_handle->sysdep->core_sysdep_free(tmp_pk);
return;
}
memset(tmp_dn, 0, dn_len + 1);
memcpy(tmp_dn, dn_pos, dn_len);
*product_key = tmp_pk;
*device_name = tmp_dn;
}
static void _devinfo_mqtt_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
devinfo_handle_t *devinfo_handle = (devinfo_handle_t *)userdata;
aiot_devinfo_event_t event;
char *product_key = NULL, *device_name = NULL;
char *code_key = "code", *id_key = "id", *data_key = "data", *message_key = "message";
char *code_value = NULL, *id_value = NULL, *data_value = NULL, *message_value = NULL;
uint32_t code_value_len = 0, id_value_len = 0, data_value_len = 0, message_value_len = 0;
if (devinfo_handle->recv_handler == NULL) {
return;
}
_devinfo_find_pk_dn(devinfo_handle, packet->data.pub.topic, packet->data.pub.topic_len, &product_key, &device_name);
if (product_key == NULL || device_name == NULL) {
if (devinfo_handle->event_handler != NULL) {
memset(&event, 0, sizeof(aiot_devinfo_event_t));
event.type = AIOT_DEVINFOEVT_INVALID_DEVINFO;
devinfo_handle->event_handler(devinfo_handle, &event, devinfo_handle->userdata);
}
return;
}
if (core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len,
code_key, (uint32_t)strlen(code_key) ,&code_value, &code_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len,
id_key, (uint32_t)strlen(id_key) ,&id_value, &id_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len,
data_key, (uint32_t)strlen(data_key) ,&data_value, &data_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len,
message_key, (uint32_t)strlen(message_key) ,&message_value, &message_value_len) == STATE_SUCCESS) {
uint32_t code = 0, id = 0;
if (core_str2uint(code_value, code_value_len, &code) == STATE_SUCCESS &&
core_str2uint(id_value, id_value_len, &id) == STATE_SUCCESS) {
aiot_devinfo_recv_t recv;
memset(&recv, 0, sizeof(aiot_devinfo_recv_t));
recv.product_key = product_key;
recv.device_name = device_name;
recv.type = AIOT_DEVINFORECV_GENERIC_REPLY;
recv.data.generic_reply.code = code;
recv.data.generic_reply.msg_id = id;
recv.data.generic_reply.data = data_value;
recv.data.generic_reply.data_len = data_value_len;
recv.data.generic_reply.message = message_value;
recv.data.generic_reply.message_len = message_value_len;
devinfo_handle->recv_handler(devinfo_handle, &recv, devinfo_handle->userdata);
} else {
if (devinfo_handle->event_handler != NULL) {
memset(&event, 0, sizeof(aiot_devinfo_event_t));
event.type = AIOT_DEVINFOEVT_INVALID_RESPONSE_FORMAT;
devinfo_handle->event_handler(devinfo_handle, &event, devinfo_handle->userdata);
}
}
} else {
if (devinfo_handle->event_handler != NULL) {
memset(&event, 0, sizeof(aiot_devinfo_event_t));
event.type = AIOT_DEVINFOEVT_INVALID_RESPONSE;
devinfo_handle->event_handler(devinfo_handle, &event, devinfo_handle->userdata);
}
}
devinfo_handle->sysdep->core_sysdep_free(product_key);
devinfo_handle->sysdep->core_sysdep_free(device_name);
}
static int32_t _devinfo_operate_topic_map(devinfo_handle_t *devinfo_handle, aiot_mqtt_option_t option)
{
int32_t res = STATE_SUCCESS;
aiot_mqtt_topic_map_t map;
if (option == AIOT_MQTTOPT_NETWORK_CRED) {
return STATE_USER_INPUT_OUT_RANGE;
}
memset(&map, 0, sizeof(aiot_mqtt_topic_map_t));
map.topic = DEVINFO_UPDATE_REPLY_TOPIC;
map.handler = _devinfo_mqtt_recv_handler;
map.userdata = devinfo_handle;
res = aiot_mqtt_setopt(devinfo_handle->mqtt_handle, option, &map);
if (res < STATE_SUCCESS) {
return res;
}
map.topic = DEVINFO_DELETE_REPLY_TOPIC;
map.handler = _devinfo_mqtt_recv_handler;
map.userdata = devinfo_handle;
res = aiot_mqtt_setopt(devinfo_handle->mqtt_handle, option, &map);
if (res < STATE_SUCCESS) {
return res;
}
return STATE_SUCCESS;
}
static int32_t _devinfo_send(devinfo_handle_t *devinfo_handle, char *product_key, char *device_name, aiot_devinfo_msg_data_t *data, char *topic_fmt)
{
int32_t res = STATE_SUCCESS, alink_id = 0;
char *topic = NULL, *payload = NULL;
char *topic_src[] = { product_key, device_name };
char alink_id_str[11] = {0}, *payload_src[] = { alink_id_str, data->params };
char *payload_fmt = "{\"id\":\"%s\",\"version\":\"1.0\",\"params\":%s}";
res = core_global_alink_id_next(devinfo_handle->sysdep, &alink_id);
if (res < STATE_SUCCESS) {
return res;
}
res = core_int2str(alink_id, alink_id_str, NULL);
if (res < STATE_SUCCESS) {
return res;
}
res = core_sprintf(devinfo_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src)/sizeof(char *), DEVINFO_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
res = core_sprintf(devinfo_handle->sysdep, &payload, payload_fmt, payload_src, sizeof(payload_src)/sizeof(char *), DEVINFO_MODULE_NAME);
if (res < STATE_SUCCESS) {
devinfo_handle->sysdep->core_sysdep_free(topic);
return res;
}
res = aiot_mqtt_pub(devinfo_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), 0);
devinfo_handle->sysdep->core_sysdep_free(topic);
devinfo_handle->sysdep->core_sysdep_free(payload);
if (res >= STATE_SUCCESS) {
res = alink_id;
}
return res;
}
static void _devinfo_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
devinfo_handle_t *devinfo_handle = (devinfo_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
devinfo_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _devinfo_core_mqtt_operate_process_handler(devinfo_handle_t *devinfo_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _devinfo_core_mqtt_process_handler;
process_data.context = devinfo_handle;
return core_mqtt_setopt(devinfo_handle->mqtt_handle, option, &process_data);
}
void *aiot_devinfo_init(void)
{
int32_t res = STATE_SUCCESS;
devinfo_handle_t *devinfo_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
res = core_global_init(sysdep);
if (res < STATE_SUCCESS) {
return NULL;
}
devinfo_handle = sysdep->core_sysdep_malloc(sizeof(devinfo_handle_t), DEVINFO_MODULE_NAME);
if (devinfo_handle == NULL) {
core_global_deinit(sysdep);
return NULL;
}
memset(devinfo_handle, 0, sizeof(devinfo_handle_t));
devinfo_handle->sysdep = sysdep;
devinfo_handle->deinit_timeout_ms = DEVINFO_DEFAULT_DEINIT_TIMEOUT_MS;
devinfo_handle->data_mutex = sysdep->core_sysdep_mutex_init();
devinfo_handle->exec_enabled = 1;
return devinfo_handle;
}
int32_t aiot_devinfo_setopt(void *handle, aiot_devinfo_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
devinfo_handle_t *devinfo_handle = (devinfo_handle_t *)handle;
if (handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_DEVINFOOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (devinfo_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_devinfo_exec_inc(devinfo_handle);
devinfo_handle->sysdep->core_sysdep_mutex_lock(devinfo_handle->data_mutex);
switch (option) {
case AIOT_DEVINFOOPT_MQTT_HANDLE: {
devinfo_handle->mqtt_handle = data;
devinfo_handle->sysdep->core_sysdep_mutex_unlock(devinfo_handle->data_mutex);
res = _devinfo_operate_topic_map(devinfo_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP);
if (res >= STATE_SUCCESS) {
res = _devinfo_core_mqtt_operate_process_handler(devinfo_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
devinfo_handle->sysdep->core_sysdep_mutex_lock(devinfo_handle->data_mutex);
}
break;
case AIOT_DEVINFOOPT_RECV_HANDLER: {
devinfo_handle->recv_handler = (aiot_devinfo_recv_handler_t)data;
}
break;
case AIOT_DEVINFOOPT_EVENT_HANDLER: {
devinfo_handle->event_handler = (aiot_devinfo_event_handler_t)data;
}
break;
case AIOT_DEVINFOOPT_USERDATA: {
devinfo_handle->userdata = data;
}
break;
case AIOT_DEVINFOOPT_DEINIT_TIMEOUT_MS: {
devinfo_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
}
devinfo_handle->sysdep->core_sysdep_mutex_unlock(devinfo_handle->data_mutex);
_core_devinfo_exec_dec(devinfo_handle);
return res;
}
int32_t aiot_devinfo_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
devinfo_handle_t *devinfo_handle = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
devinfo_handle = *(devinfo_handle_t **)handle;
if (devinfo_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
devinfo_handle->exec_enabled = 0;
_devinfo_core_mqtt_operate_process_handler(devinfo_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
_devinfo_operate_topic_map(devinfo_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP);
deinit_timestart = devinfo_handle->sysdep->core_sysdep_time();
do {
if (devinfo_handle->exec_count == 0) {
break;
}
devinfo_handle->sysdep->core_sysdep_sleep(DEVINFO_DEINIT_INTERVAL_MS);
} while ((devinfo_handle->sysdep->core_sysdep_time() - deinit_timestart) < devinfo_handle->deinit_timeout_ms);
if (devinfo_handle->exec_count != 0) {
return STATE_MQTT_DEINIT_TIMEOUT;
}
*handle = NULL;
devinfo_handle->sysdep->core_sysdep_mutex_deinit(&devinfo_handle->data_mutex);
core_global_deinit(devinfo_handle->sysdep);
devinfo_handle->sysdep->core_sysdep_free(devinfo_handle);
return STATE_SUCCESS;
}
int32_t aiot_devinfo_send(void *handle, aiot_devinfo_msg_t *msg)
{
int32_t res = STATE_SUCCESS;
devinfo_handle_t *devinfo_handle = (devinfo_handle_t *)handle;
if (handle == NULL || msg == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (devinfo_handle->mqtt_handle == NULL) {
return STATE_DEVINFO_MISSING_MQTT_HANDLE;
}
if (msg->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (msg->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
switch (msg->type) {
case AIOT_DEVINFO_MSG_UPDATE: {
if (msg->data.update.params == NULL) {
res = STATE_USER_INPUT_NULL_POINTER;
}else{
res = _devinfo_send(devinfo_handle, msg->product_key, msg->device_name, &msg->data.update, DEVINFO_UPDATE_TOPIC_FMT);
}
}
break;
case AIOT_DEVINFO_MSG_DELETE: {
if (msg->data.delete.params == NULL) {
res = STATE_USER_INPUT_NULL_POINTER;
}else{
res = _devinfo_send(devinfo_handle, msg->product_key, msg->device_name, &msg->data.delete, DEVINFO_DELETE_TOPIC_FMT);
}
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
}
return res;
}
| YifuLiu/AliOS-Things | components/linksdk/components/devinfo/aiot_devinfo_api.c | C | apache-2.0 | 14,381 |
/**
* @file aiot_devinfo_api.h
* @brief devinfo模块头文件, 提供更新和删除设备标签的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
* Devinfo模块用于向阿里云物联网平台更新或删除设备的标签, API的使用流程如下:
*
* 1. 首先参考 @ref aiot_mqtt_api.h 的说明, 保证成功建立与物联网平台的`MQTT`连接
*
* 2. 调用 @ref aiot_devinfo_init 初始化devinfo会话, 获取会话句柄
*
* 3. 调用 @ref aiot_devinfo_setopt 配置devinfo会话的参数, 常用配置项见 @ref aiot_devinfo_setopt 的说明
*
* 4. 调用 @ref aiot_devinfo_send 发送标签变更的请求, 比如更新或删除
*
* 5. 收到的应答经SDK处理后会调用由 @ref aiot_devinfo_setopt 配置的 @ref AIOT_DEVINFOOPT_RECV_HANDLER 回调函数, 通知用户云端的应答
*
*/
#ifndef __AIOT_DEVINFO_API_H__
#define __AIOT_DEVINFO_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x1200~-0x12FF表达SDK在devinfo模块内的状态码
*/
#define STATE_DEVINFO_BASE (-0x1200)
/**
* @brief MQTT会话句柄未设置, 请通过 @ref aiot_devinfo_setopt 设置MQTT会话句柄
*/
#define STATE_DEVINFO_MISSING_MQTT_HANDLE (-0x1201)
/**
* @brief devinfo模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
AIOT_DEVINFORECV_GENERIC_REPLY,
} aiot_devinfo_recv_type_t;
typedef struct {
/**
* @brief 消息标识符, uint64_t类型的整数, 与属性上报或事件上报的消息标示符一致
*/
uint32_t msg_id;
/**
* @brief 设备端错误码, 200-请求成功, 更多错误码码查看<a href="https://help.aliyun.com/document_detail/120329.html">设备端错误码</a>
*/
uint32_t code;
/**
* @brief 指向云端应答数据的指针
*/
char *data;
/**
* @brief 云端应答数据的长度
*/
uint32_t data_len;
/**
* @brief 指向状态消息字符串的指针, 当设备端上报请求成功时对应的应答消息为"success", 若请求失败则应答消息中包含错误信息
*/
char *message;
/**
* @brief 消息字符串的长度
*/
uint32_t message_len;
} aiot_devinfo_recv_generic_reply_t;
/**
* @brief devinfo模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
char *product_key;
char *device_name;
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_devinfo_recv_type_t
*/
aiot_devinfo_recv_type_t type;
union {
/**
* @brief 从云端收到的更新或删除设备标签的应答
*/
aiot_devinfo_recv_generic_reply_t generic_reply;
} data;
} aiot_devinfo_recv_t;
/**
* @brief devinfo模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle devinfo会话句柄
* @param[in] packet devinfo消息结构体, 存放收到的devinfo报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_devinfo_recv_handler_t)(void *handle, const aiot_devinfo_recv_t *packet, void *userdata);
/**
* @brief devinfo模块内部发生值得用户关注的状态变化时, 通知用户的事件类型
*/
typedef enum {
/**
* @brief 收到的应答中设备信息不合法, 无法获取product key和device name
*/
AIOT_DEVINFOEVT_INVALID_DEVINFO,
/**
* @brief 收到的应答中字段不合法
*/
AIOT_DEVINFOEVT_INVALID_RESPONSE,
/**
* @brief 收到的应答中字段格式错误
*/
AIOT_DEVINFOEVT_INVALID_RESPONSE_FORMAT,
} aiot_devinfo_event_type_t;
/**
* @brief devinfo模块内部发生值得用户关注的状态变化时, 通知用户的事件内容
*/
typedef struct {
/**
* @brief 事件内容所对应的事件类型, 更多信息请参考@ref aiot_devinfo_event_type_t
*/
aiot_devinfo_event_type_t type;
} aiot_devinfo_event_t;
/**
* @brief devinfo模块内部发生值得用户关注的状态变化时, 通知用户所调用的事件回调函数
*
* @param[in] handle, devinfo会话句柄
* @param[in] event, devinfo模块中发生的事件的内容
* @param[in] userdata, 用户上下文
*
* @return void
*/
typedef void (*aiot_devinfo_event_handler_t)(void *handle, const aiot_devinfo_event_t *event, void *userdata);
/**
* @brief @ref aiot_devinfo_msg_t 中的发送消息类型
*
* @details
*
* 消息类型有两个, 分别是更新设备标签和删除设备标签
*/
typedef enum {
/**
* @brief 更新设备标签
*/
AIOT_DEVINFO_MSG_UPDATE,
/**
* @brief 删除设备标签
*/
AIOT_DEVINFO_MSG_DELETE
} aiot_devinfo_msg_type_t;
/**
* @brief 更新或删除设备标签的params内容
*/
typedef struct {
char *params;
} aiot_devinfo_msg_data_t;
typedef struct {
/**
* @brief 设备的product key
*/
char *product_key;
/**
* @brief 设备的device name
*/
char *device_name;
/**
* @brief 消息类型, 更多信息请参考@ref aiot_devinfo_msg_type_t
*/
aiot_devinfo_msg_type_t type;
union {
/**
* @brief 更新设备标签, 格式："[{\"attrKey\":\"xxx\",\"attrValue\":\"yyy\"}]"
*
* @details
*
* 从上述格式可以看出，更新设备标签的格式是一个JSON数组，一次可按attrKey和attrValue上报多组设备标签
*/
aiot_devinfo_msg_data_t update;
/**
* @brief 删除设备标签, 格式："[{\"attrKey\":\"xxx\"}]"
*
* @details
*
* 从上述格式可以看出，删除设备标签的格式是一个JSON数组，一次可按attrKey删除多组设备标签
*/
aiot_devinfo_msg_data_t delete;
} data;
} aiot_devinfo_msg_t;
/**
* @brief @ref aiot_devinfo_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_devinfo_setopt 中, data参数的数据类型
*
* 1. data的数据类型是void *时, 以配置@ref AIOT_DEVINFOOPT_MQTT_HANDLE 为例:
*
* void *mqtt_handle = aiot_mqtt_init();
* aiot_devinfo_setopt(devinfo_handle, AIOT_DEVINFOOPT_MQTT_HANDLE, mqtt_handle);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_DEVINFOOPT_DEINIT_TIMEOUT_MS 为例:
*
* uint32_t deinit_timeout_ms = 443;
* aiot_devinfo_setopt(devinfo_handle, AIOT_DEVINFOOPT_DEINIT_TIMEOUT_MS, (void *)&deinit_timeout_ms);
*/
typedef enum {
/**
* @brief devinfo会话 需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
*/
AIOT_DEVINFOOPT_MQTT_HANDLE,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户
*
* @details
*
* 数据类型: ( @ref aiot_devinfo_recv_handler_t)
*/
AIOT_DEVINFOOPT_RECV_HANDLER,
/**
* @brief 设置回调, 它在SDK发生内部状态变更时被调用, 告知用户
*
* @details
*
* 数据类型: ( @ref aiot_devinfo_event_handler_t)
*/
AIOT_DEVINFOOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文, 数据类型为(void *)
*
* @details 这个上下文指针会在 AIOT_DEVINFOOPT_RECV_HANDLER 和 AIOT_DEVINFOOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*/
AIOT_DEVINFOOPT_USERDATA,
/**
* @brief 销毁devinfo实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_devinfo_deinit 销毁devinfo实例时, 若继续调用其他aiot_devinfo_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_devinfo_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_DEVINFOOPT_DEINIT_TIMEOUT_MS,
AIOT_DEVINFOOPT_MAX
} aiot_devinfo_option_t;
/**
* @brief 创建devinfo会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL devinfo实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_devinfo_init(void);
/**
* @brief 配置devinfo会话
*
* @param[in] handle devinfo会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_devinfo_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_devinfo_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_devinfo_setopt(void *handle, aiot_devinfo_option_t option, void *data);
/**
* @brief 结束devinfo会话, 销毁实例并回收资源
*
* @param[in] handle 指向devinfo会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_devinfo_deinit(void **handle);
/**
* @brief 向devinfo服务器发送devinfo消息请求
*
* @param handle devinfo会话句柄
* @param msg devinfo发送给云端的删除/更新设备标签信息的报文
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_devinfo_send(void *handle, aiot_devinfo_msg_t *msg);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_DEVINFO_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/devinfo/aiot_devinfo_api.h | C | apache-2.0 | 9,495 |
/**
* @file devinfo_private.h
* @brief devinfo模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __DEVINFO_PRIVATE_H__
#define __DEVINFO_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
/* TODO: 这一段列出需要包含SDK其它模块头文件, 与上一段落以1个空行隔开 */
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_devinfo_api.h" /* 内部头文件是用户可见头文件的超集 */
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
void *mqtt_handle;
aiot_devinfo_event_handler_t event_handler; /* 组件内部运行状态变更时, 通知用户的回调 */
aiot_devinfo_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
void *userdata; /* 组件调用以上2个 devinfo_handler 时的入参之一 */
uint32_t deinit_timeout_ms;
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是DEVINFO在内部使用, 用户无感知 ----*/
void *data_mutex; /* 保护本地的数据结构 */
uint8_t exec_enabled;
uint32_t exec_count;
} devinfo_handle_t;
#define DEVINFO_MODULE_NAME "devinfo" /* 用于内存统计的模块名字符串 */
#define DEVINFO_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define DEVINFO_UPDATE_TOPIC_FMT "/sys/%s/%s/thing/deviceinfo/update"
#define DEVINFO_UPDATE_REPLY_TOPIC "/sys/+/+/thing/deviceinfo/update_reply"
#define DEVINFO_DELETE_TOPIC_FMT "/sys/%s/%s/thing/deviceinfo/delete"
#define DEVINFO_DELETE_REPLY_TOPIC "/sys/+/+/thing/deviceinfo/delete_reply"
#define DEVINFO_DEINIT_INTERVAL_MS (100)
#if defined(__cplusplus)
}
#endif
#endif /* __DEVINFO_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/devinfo/devinfo_private.h | C | apache-2.0 | 2,053 |
/**
* @file aiot_diag_api.c
* @brief diag模块的API接口实现, 提供诊断SDK的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "diag_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_global.h"
#include "core_mqtt.h"
#include "core_diag.h"
static void _diag_mqtt_conn_hb_extra_clean(void *handle, void *extra_data);
static int32_t _diag_mqtt_conn_hb_extra_stop(void *handle, diag_running_state_node_t *node, uint32_t stat_idx, uint32_t stat_number, void *extra_data);
static int32_t _diag_mqtt_conn_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc);
static int32_t _diag_mqtt_hb_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc);
static void _diag_alink_uplink_extra_clean(void *handle, void *extra_data);
static int32_t _diag_alink_uplink_extra_stop(void *handle, diag_running_state_node_t *node, uint32_t stat_idx, uint32_t stat_number, void *extra_data);
static int32_t _diag_alink_uplink_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc);
static diag_config_t g_diag_config[] = {
{
DIAG_MQTT_CONNECTION_STAT_INDEX,
DIAG_MQTT_CONNECTION_NAME_STR,
DIAG_TLV_MQTT_CONNECTION,
{
DIAG_DEFAULT_MQTT_CONN_ENABLED,
DIAG_DEFAULT_MQTT_CONN_INTERVAL_MS,
DIAG_DEFAULT_MQTT_CONN_WARNING_THRESHOLD,
DIAG_DEFAULT_MQTT_CONN_FATAL_THRESHOLD,
},
DIAG_DEFAULT_MQTT_CONN_MAX_STAT_NUMBER,
{
_diag_mqtt_conn_hb_extra_clean,
_diag_mqtt_conn_hb_extra_stop,
_diag_mqtt_conn_report_desc_append
},
1
},
{
DIAG_MQTT_HEARTBEAT_STAT_INDEX,
DIAG_MQTT_HEARTBEAT_NAME_STR,
DIAG_TLV_MQTT_HEARTBEAT,
{
DIAG_DEFAULT_MQTT_HB_ENABLED,
DIAG_DEFAULT_MQTT_HB_INTERVAL_MS,
DIAG_DEFAULT_MQTT_HB_WARNING_THRESHOLD,
DIAG_DEFAULT_MQTT_HB_FATAL_THRESHOLD
},
DIAG_DEFAULT_MQTT_HB_MAX_STAT_NUMBER,
{
_diag_mqtt_conn_hb_extra_clean,
_diag_mqtt_conn_hb_extra_stop,
_diag_mqtt_hb_report_desc_append,
},
0
},
{
DIAG_ALINK_UPLINK_STAT_INDEX,
DIAG_ALINK_UPLINK_NAME_STR,
DIAG_TLV_ALINK_UPLINK,
{
DIAG_DEFAULT_ALINK_UPLINK_ENABLED,
DIAG_DEFAULT_ALINK_UPLINK_INTERVAL_MS,
DIAG_DEFAULT_ALINK_UPLINK_WARNING_THRESHOLD,
DIAG_DEFAULT_ALINK_UPLINK_FATAL_THRESHOLD
},
DIAG_DEFAULT_ALINK_UPLINK_MAX_STAT_NUMBER,
{
_diag_alink_uplink_extra_clean,
_diag_alink_uplink_extra_stop,
_diag_alink_uplink_report_desc_append
},
0
}
};
static void _core_diag_exec_inc(diag_handle_t *diag_handle)
{
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
diag_handle->exec_count++;
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
}
static void _core_diag_exec_dec(diag_handle_t *diag_handle)
{
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
diag_handle->exec_count--;
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
}
static void _diag_desc_list_append(diag_handle_t *diag_handle, diag_stat_t *stat, diag_running_state_node_t *running_state_node, struct core_list_head *desc_list)
{
int32_t res = STATE_SUCCESS;
char *desc = NULL;
diag_desc_node_t *node = NULL;
res = stat->stat_cb.desc_append_cb(diag_handle, &stat->running_state, running_state_node, &desc);
if (res < STATE_SUCCESS) {
return;
}
node = diag_handle->sysdep->core_sysdep_malloc(sizeof(diag_desc_node_t), DIAG_MODULE_NAME);
if (node == NULL) {
diag_handle->sysdep->core_sysdep_free(desc);
return;
}
memset(node, 0, sizeof(diag_desc_node_t));
node->timestamp = core_log_get_timestamp(diag_handle->sysdep);
node->code = stat->running_state.code;
node->module_name = stat->running_state.name;
node->level = (stat->running_state.is_reported == 0)?(running_state_node->level):(DIAG_REPORT_LEVEL_WARNING_STR);
node->desc = desc;
node->qos = stat->running_state.qos;
CORE_INIT_LIST_HEAD(&node->linked_node);
core_list_add_tail(&node->linked_node, desc_list);
}
static void _diag_desc_list_send(diag_handle_t *diag_handle, struct core_list_head *desc_list)
{
diag_desc_node_t *node = NULL;
core_list_for_each_entry(node, desc_list, linked_node, diag_desc_node_t) {
/* local event notify */
if ((diag_handle->event_handler != NULL) && (diag_handle->local_report_enabled == 1)) {
aiot_diag_event_t event;
memset(&event, 0, sizeof(aiot_diag_event_t));
event.type = AIOT_DIAGEVT_ALERT;
event.data.alert.module_name = node->module_name;
event.data.alert.level = node->level;
event.data.alert.desc = node->desc;
diag_handle->event_handler(diag_handle, &event, diag_handle->userdata);
}
/* cloud event report */
if (diag_handle->cloud_report_enabled == 1) {
int32_t res = STATE_SUCCESS;
char *topic = NULL, *topic_fmt = DIAG_REPORT_TOPIC_FMT;
char *topic_src[] = { core_mqtt_get_product_key(diag_handle->mqtt_handle), core_mqtt_get_device_name(diag_handle->mqtt_handle) };
int32_t alink_id = 0;
char alink_id_str[11] = {0}, utc_time_str[21] = {0}, code_str[11] = {0};
char *payload = NULL, *payload_fmt = DIAG_REPORT_PAYLOAD_FMT;
char *payload_src[] = { alink_id_str, utc_time_str, node->level, node->module_name, code_str, alink_id_str, node->desc };
res = core_sprintf(diag_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src)/sizeof(char *), DIAG_MODULE_NAME);
if (res < STATE_SUCCESS) {
continue;
}
core_global_alink_id_next(diag_handle->sysdep, &alink_id);
core_int2str(alink_id, alink_id_str, NULL);
core_uint642str(node->timestamp, utc_time_str, NULL);
core_uint2str(node->code, code_str, NULL);
res = core_sprintf(diag_handle->sysdep, &payload, payload_fmt, payload_src, sizeof(payload_src)/sizeof(char *), DIAG_MODULE_NAME);
if (res < STATE_SUCCESS) {
diag_handle->sysdep->core_sysdep_free(topic);
continue;
}
aiot_mqtt_pub(diag_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), node->qos);
diag_handle->sysdep->core_sysdep_free(topic);
diag_handle->sysdep->core_sysdep_free(payload);
}
}
}
static void _diag_desc_list_destroy(diag_handle_t *diag_handle, struct core_list_head *desc_list)
{
diag_desc_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, desc_list, linked_node, diag_desc_node_t) {
core_list_del(&node->linked_node);
diag_handle->sysdep->core_sysdep_free(node->desc);
diag_handle->sysdep->core_sysdep_free(node);
}
}
static void _diag_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
uint32_t stat_idx = 0;
diag_handle_t *diag_handle = (diag_handle_t *)context;
uint64_t timenow_ms = core_log_get_timestamp(diag_handle->sysdep);
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
diag_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
if (diag_handle->mqtt_process.last_check_time > timenow_ms) {
diag_handle->mqtt_process.last_check_time = timenow_ms;
}
if (timenow_ms - diag_handle->mqtt_process.last_check_time >= DIAG_MQTT_PROCESS_CHECK_INTERVAL_MS) {
diag_running_state_node_t *node = NULL;
struct core_list_head desc_list;
CORE_INIT_LIST_HEAD(&desc_list);
for (stat_idx = 0;stat_idx < DIAG_STAT_ITEM_NUMBER;stat_idx++) {
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->diag_stat[stat_idx].running_state.mutex);
diag_handle->diag_stat[stat_idx].running_state.alert_counts = 0;
core_list_for_each_entry(node, &diag_handle->diag_stat[stat_idx].running_state.linked_list,
linked_node, diag_running_state_node_t) {
if ((node->stop_time != 0) && (node->start_time > node->stop_time)) {
node->start_time = node->stop_time;
}
if (node->is_diag == 1) {
if (node->start_time > timenow_ms) {
node->start_time = timenow_ms;
}
if (node->stop_time == 0 && (timenow_ms - node->start_time >= diag_handle->diag_stat[stat_idx].config.fatal_threshold)) {
node->stop_time = node->start_time + diag_handle->diag_stat[stat_idx].config.fatal_threshold;
}
if (node->stop_time != 0) {
if ((node->stop_time - node->start_time >= diag_handle->diag_stat[stat_idx].config.warning_threashold) &&
(node->stop_time - node->start_time < diag_handle->diag_stat[stat_idx].config.fatal_threshold)) {
node->level = DIAG_REPORT_LEVEL_WARNING_STR;
} else if (node->stop_time - node->start_time >= diag_handle->diag_stat[stat_idx].config.fatal_threshold) {
node->level = DIAG_REPORT_LEVEL_FATAL_STR;
}
node->is_diag = 0;
}
if ((diag_handle->diag_stat[stat_idx].running_state.is_reported == 0) && (node->level != NULL)) {
/* report first in current period*/
_diag_desc_list_append(diag_handle, &diag_handle->diag_stat[stat_idx], node, &desc_list);
diag_handle->diag_stat[stat_idx].running_state.is_reported = 1;
diag_handle->diag_stat[stat_idx].running_state.report_start_time = timenow_ms;
}
}
if ((node->start_time >= diag_handle->diag_stat[stat_idx].running_state.report_start_time) && node->level != NULL) {
diag_handle->diag_stat[stat_idx].running_state.alert_counts++;
}
if (diag_handle->diag_stat[stat_idx].running_state.report_start_time > timenow_ms) {
diag_handle->diag_stat[stat_idx].running_state.report_start_time = timenow_ms;
}
if ((diag_handle->diag_stat[stat_idx].running_state.is_reported == 1) &&
(timenow_ms - diag_handle->diag_stat[stat_idx].running_state.report_start_time >= diag_handle->diag_stat[stat_idx].config.interval_ms) &&
(node->linked_node.next == &diag_handle->diag_stat[stat_idx].running_state.linked_list)) {
/* report alert counts in this period */
if (diag_handle->diag_stat[stat_idx].running_state.alert_counts > 0) {
_diag_desc_list_append(diag_handle, &diag_handle->diag_stat[stat_idx], node, &desc_list);
}
diag_handle->diag_stat[stat_idx].running_state.is_reported = 0;
diag_handle->diag_stat[stat_idx].running_state.report_start_time = timenow_ms;
}
}
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->diag_stat[stat_idx].running_state.mutex);
}
_diag_desc_list_send(diag_handle, &desc_list);
_diag_desc_list_destroy(diag_handle, &desc_list);
diag_handle->mqtt_process.last_check_time = timenow_ms;
}
}
static int32_t _diag_core_mqtt_operate_process_handler(diag_handle_t *diag_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _diag_core_mqtt_process_handler;
process_data.context = diag_handle;
return core_mqtt_setopt(diag_handle->mqtt_handle, option, &process_data);
}
static void _diag_mqtt_conn_hb_extra_clean(void *handle, void *extra_data)
{
}
static int32_t _diag_mqtt_conn_hb_extra_stop(void *handle, diag_running_state_node_t *node, uint32_t stat_idx, uint32_t stat_number, void *extra_data)
{
if (node->stop_time != 0) {
return STATE_DIAG_STOP_NODE_NOT_MATCH;
}
return STATE_SUCCESS;
}
static int32_t _diag_mqtt_conn_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc)
{
char *tmp_desc = NULL;
diag_handle_t *diag_handle = (diag_handle_t *)handle;
uint64_t timenow_ms = core_log_get_timestamp(diag_handle->sysdep);
if (running_state->is_reported == 0) {
/* report first time */
uint64_t time_elapsed = node->stop_time - node->start_time;
char time_elapsed_str[21] = {0};
char *desc_fmt = "MQTT connection establish time %s ms";
char *desc_src[] = { time_elapsed_str };
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
} else if (running_state->is_reported == 1) {
/* report period stat data */
uint64_t time_elapsed = timenow_ms - running_state->report_start_time;
char time_elapsed_str[21] = {0};
char alert_counts_str[11] = {0};
char *desc_fmt = "MQTT connection has been alert extra %s times in past %s ms";
char *desc_src[] = { alert_counts_str, time_elapsed_str };
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_uint2str(running_state->alert_counts, alert_counts_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
}
if (tmp_desc == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
*desc = tmp_desc;
return STATE_SUCCESS;
}
static int32_t _diag_mqtt_hb_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc)
{
char *tmp_desc = NULL;
diag_handle_t *diag_handle = (diag_handle_t *)handle;
uint64_t timenow_ms = core_log_get_timestamp(diag_handle->sysdep);
if (running_state->is_reported == 0) {
/* report first time */
uint64_t time_elapsed = node->stop_time - node->start_time;
char time_elapsed_str[21] = {0};
char *desc_fmt = "MQTT lost heartbeat 1 times in %s ms";
char *desc_src[] = { time_elapsed_str };
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
} else if (running_state->is_reported == 1) {
/* report period stat data */
uint64_t time_elapsed = timenow_ms - running_state->report_start_time;
char time_elapsed_str[21] = {0};
char alert_counts_str[11] = {0};
char *desc_fmt = "MQTT lost heartbeat has been alert extra %s times in past %s ms";
char *desc_src[] = { alert_counts_str, time_elapsed_str };
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_uint2str(running_state->alert_counts, alert_counts_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
}
if (tmp_desc == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
*desc = tmp_desc;
return STATE_SUCCESS;
}
static void _diag_alink_uplink_extra_clean(void *handle, void *extra_data)
{
diag_handle_t *diag_handle = (diag_handle_t *)handle;
diag_handle->sysdep->core_sysdep_free(extra_data);
}
static int32_t _diag_alink_uplink_extra_stop(void *handle, diag_running_state_node_t *node, uint32_t stat_idx, uint32_t stat_number, void *extra_data)
{
if (*(uint32_t *)node->extra_data != *(uint32_t *)extra_data) {
return STATE_DIAG_STOP_NODE_NOT_MATCH;
}
return STATE_SUCCESS;
}
static int32_t _diag_alink_uplink_report_desc_append(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc)
{
char *tmp_desc = NULL;
diag_handle_t *diag_handle = (diag_handle_t *)handle;
uint64_t timenow_ms = core_log_get_timestamp(diag_handle->sysdep);
if (running_state->is_reported == 0) {
/* report first time */
char alink_id_str[11] = {0};
uint64_t time_elapsed = node->stop_time - node->start_time;
char time_elapsed_str[21] = {0};
char *desc_fmt = "Alink message %s waiting for reply has already exceed %s ms";
char *desc_src[] = { alink_id_str, time_elapsed_str };
core_uint2str(*(uint32_t *)node->extra_data, alink_id_str, NULL);
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
} else if (running_state->is_reported == 1) {
/* report period stat data */
uint64_t time_elapsed = timenow_ms - running_state->report_start_time;
char time_elapsed_str[21] = {0};
char alert_counts_str[11] = {0};
char *desc_fmt = "Alink message reply too slow has been alert extra %s times in past %s ms";
char *desc_src[] = { alert_counts_str, time_elapsed_str };
core_uint642str(time_elapsed, time_elapsed_str, NULL);
core_uint2str(running_state->alert_counts, alert_counts_str, NULL);
core_sprintf(diag_handle->sysdep, &tmp_desc, desc_fmt, desc_src, sizeof(desc_src)/sizeof(char *), DIAG_MODULE_NAME);
}
if (tmp_desc == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
*desc = tmp_desc;
return STATE_SUCCESS;
}
static void _diag_running_state_start(diag_handle_t *diag_handle, diag_stat_t *stat, uint64_t timestamp, void *extra_data)
{
diag_running_state_node_t *node = NULL;
diag_handle->sysdep->core_sysdep_mutex_lock(stat->running_state.mutex);
if (stat->running_state.stat_number == stat->running_state.max_stat_number) {
node = core_list_entry(stat->running_state.linked_list.next, diag_running_state_node_t, linked_node);
core_list_del(&node->linked_node);
stat->running_state.stat_number--;
stat->stat_cb.extra_clean_cb(diag_handle, node->extra_data);
diag_handle->sysdep->core_sysdep_free(node);
}
node = diag_handle->sysdep->core_sysdep_malloc(sizeof(diag_running_state_node_t), DIAG_MODULE_NAME);
if (node == NULL) {
diag_handle->sysdep->core_sysdep_mutex_unlock(stat->running_state.mutex);
return;
}
memset(node, 0, sizeof(diag_running_state_node_t));
node->is_diag = 1;
node->start_time = timestamp;
node->extra_data = extra_data;
CORE_INIT_LIST_HEAD(&node->linked_node);
core_list_add_tail(&node->linked_node, &stat->running_state.linked_list);
stat->running_state.stat_number++;
diag_handle->sysdep->core_sysdep_mutex_unlock(stat->running_state.mutex);
}
static void _diag_running_state_stop(diag_handle_t *diag_handle, diag_stat_t *stat, uint64_t timestamp, void *extra_data)
{
uint32_t stat_idx = 0;
diag_running_state_node_t *node = NULL;
diag_handle->sysdep->core_sysdep_mutex_lock(stat->running_state.mutex);
core_list_for_each_entry(node, &stat->running_state.linked_list,
linked_node, diag_running_state_node_t) {
if (stat->stat_cb.extra_stop_cb(diag_handle, node,
stat_idx, stat->running_state.stat_number, extra_data) >= STATE_SUCCESS) {
node->stop_time = timestamp;
break;
}
stat_idx++;
}
stat->stat_cb.extra_clean_cb(diag_handle, extra_data);
diag_handle->sysdep->core_sysdep_mutex_unlock(stat->running_state.mutex);
}
static int32_t _diag_get_extra_data(diag_handle_t *diag_handle, diag_raw_data_t *raw_data, uint32_t code, void **out_extra_data)
{
if (code == DIAG_TLV_ALINK_UPLINK) {
uint32_t tlv_sub_type1 = (raw_data->data[4] << 8) | (raw_data->data[5]);
if (tlv_sub_type1 == DIAG_TLV_ALINK_MSGID) {
uint32_t *extra_data = NULL;
extra_data = diag_handle->sysdep->core_sysdep_malloc(sizeof(uint32_t), DIAG_MODULE_NAME);
if (extra_data == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(extra_data, 0, sizeof(uint32_t));
*extra_data = ((raw_data->data[7] << 24) | (raw_data->data[8] << 16) | (raw_data->data[9] << 8) | (raw_data->data[10]));
*(uint32_t **)out_extra_data = extra_data;
}
}
return STATE_SUCCESS;
}
static void _diag_raw_data(diag_handle_t *diag_handle, diag_raw_data_t *raw_data)
{
uint32_t code = (raw_data->data[0] << 8) | (raw_data->data[1]);
uint32_t stat_idx = 0;
void *extra_data = NULL;
for (stat_idx = 0;stat_idx < DIAG_STAT_ITEM_NUMBER;stat_idx++) {
if (g_diag_config[stat_idx].code == code) {
if (_diag_get_extra_data(diag_handle, raw_data, code, &extra_data) < STATE_SUCCESS) {
return;
}
if (raw_data->data[3] == 0x00) {
_diag_running_state_start(diag_handle, &diag_handle->diag_stat[stat_idx], raw_data->timestamp, extra_data);
} else if (raw_data->data[3] == 0x01) {
_diag_running_state_stop(diag_handle, &diag_handle->diag_stat[stat_idx], raw_data->timestamp, extra_data);
}
}
}
}
static void _diag_core_diag_callback(void *handle, uint64_t timestamp, int32_t code, uint8_t *data, uint32_t data_len)
{
diag_raw_data_t raw_data;
memset(&raw_data, 0, sizeof(diag_raw_data_t));
raw_data.timestamp = timestamp;
raw_data.code = code;
raw_data.data = data;
raw_data.data_len = data_len;
_diag_raw_data((diag_handle_t *)handle, &raw_data);
}
static void _diag_running_state_clean(diag_handle_t *diag_handle)
{
uint32_t stat_idx = 0;
diag_running_state_node_t *node = NULL, *next = NULL;
for (stat_idx = 0;stat_idx < DIAG_STAT_ITEM_NUMBER;stat_idx++) {
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->diag_stat[stat_idx].running_state.mutex);
core_list_for_each_entry_safe(node, next, &diag_handle->diag_stat[stat_idx].running_state.linked_list,
linked_node, diag_running_state_node_t) {
core_list_del(&node->linked_node);
diag_handle->diag_stat[stat_idx].stat_cb.extra_clean_cb(diag_handle, node->extra_data);
diag_handle->sysdep->core_sysdep_free(node);
}
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->diag_stat[stat_idx].running_state.mutex);
diag_handle->sysdep->core_sysdep_mutex_deinit(&diag_handle->diag_stat[stat_idx].running_state.mutex);
}
}
void *aiot_diag_init(void)
{
int32_t res = STATE_SUCCESS;
uint32_t stat_idx = 0;
diag_handle_t *diag_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
res = core_global_init(sysdep);
if (res < STATE_SUCCESS) {
return NULL;
}
diag_handle = sysdep->core_sysdep_malloc(sizeof(diag_handle_t), DIAG_MODULE_NAME);
if (diag_handle == NULL) {
return NULL;
}
memset(diag_handle, 0, sizeof(diag_handle_t));
diag_handle->sysdep = sysdep;
diag_handle->local_report_enabled = DIAG_DAFAULT_LOCAL_REPORT_ENABLED;
diag_handle->cloud_report_enabled = DIAG_DAFAULT_CLOUD_REPORT_ENABLED;
for (stat_idx = 0; stat_idx < DIAG_STAT_ITEM_NUMBER; stat_idx++) {
diag_handle->diag_stat[stat_idx].running_state.code = g_diag_config[stat_idx].code;
diag_handle->diag_stat[stat_idx].running_state.name = g_diag_config[stat_idx].name;
memcpy(&diag_handle->diag_stat[stat_idx].config, &g_diag_config[stat_idx].def_config, sizeof(aiot_diag_config_t));
diag_handle->diag_stat[stat_idx].running_state.max_stat_number = g_diag_config[stat_idx].def_max_stat_number;
memcpy(&diag_handle->diag_stat[stat_idx].stat_cb, &g_diag_config[stat_idx].def_stat_cb, sizeof(diag_stat_callback_t));
diag_handle->diag_stat[stat_idx].running_state.qos = g_diag_config[stat_idx].qos;
CORE_INIT_LIST_HEAD(&diag_handle->diag_stat[stat_idx].running_state.linked_list);
diag_handle->diag_stat[stat_idx].running_state.mutex = diag_handle->sysdep->core_sysdep_mutex_init();
}
diag_handle->deinit_timeout_ms = DIAG_DEFAULT_DEINIT_TIMEOUT_MS;
diag_handle->data_mutex = sysdep->core_sysdep_mutex_init();
diag_handle->exec_enabled = 1;
core_diag_set_cb(diag_handle, _diag_core_diag_callback);
return diag_handle;
}
int32_t aiot_diag_setopt(void *handle, aiot_diag_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
diag_handle_t *diag_handle = (diag_handle_t *)handle;
if (diag_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_DIAGOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (diag_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_diag_exec_inc(diag_handle);
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
switch (option) {
case AIOT_DIAGOPT_MQTT_HANDLE: {
diag_handle->mqtt_handle = data;
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
res = _diag_core_mqtt_operate_process_handler(diag_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
}
break;
case AIOT_DIAGOPT_LOCAL_REPORT_ENABLED: {
diag_handle->local_report_enabled = *(uint8_t *)data;
}
break;
case AIOT_DIAGOPT_CLOUD_REPORT_ENABLED: {
diag_handle->cloud_report_enabled = *(uint8_t *)data;
}
break;
case AIOT_DIAGOPT_MQTT_CONNECTION: {
memcpy(&diag_handle->diag_stat[DIAG_MQTT_CONNECTION_STAT_INDEX].config, (aiot_diag_config_t *)data, sizeof(aiot_diag_config_t));
}
break;
case AIOT_DIAGOPT_MQTT_HEARTBEAT: {
memcpy(&diag_handle->diag_stat[DIAG_MQTT_HEARTBEAT_STAT_INDEX].config, (aiot_diag_config_t *)data, sizeof(aiot_diag_config_t));
}
break;
case AIOT_DIAGOPT_ALINK_UPLINK: {
memcpy(&diag_handle->diag_stat[DIAG_ALINK_UPLINK_STAT_INDEX].config, (aiot_diag_config_t *)data, sizeof(aiot_diag_config_t));
}
break;
case AIOT_DIAGOPT_RECV_HANDLER: {
diag_handle->recv_handler = (aiot_diag_recv_handler_t)data;
}
break;
case AIOT_DIAGOPT_EVENT_HANDLER: {
diag_handle->event_handler = (aiot_diag_event_handler_t)data;
}
break;
case AIOT_DIAGOPT_USERDATA: {
diag_handle->userdata = data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
_core_diag_exec_dec(diag_handle);
return res;
}
int32_t aiot_diag_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
diag_handle_t *diag_handle = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
diag_handle = *(diag_handle_t **)handle;
if (diag_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
core_diag_set_cb(diag_handle, NULL);
_diag_core_mqtt_operate_process_handler(diag_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
diag_handle->exec_enabled = 0;
deinit_timestart = diag_handle->sysdep->core_sysdep_time();
do {
if (diag_handle->exec_count == 0) {
break;
}
diag_handle->sysdep->core_sysdep_sleep(DIAG_DEINIT_INTERVAL_MS);
} while ((diag_handle->sysdep->core_sysdep_time() - deinit_timestart) < diag_handle->deinit_timeout_ms);
if (diag_handle->exec_count != 0) {
return STATE_MQTT_DEINIT_TIMEOUT;
}
*handle = NULL;
_diag_running_state_clean(diag_handle);
diag_handle->sysdep->core_sysdep_mutex_deinit(&diag_handle->data_mutex);
core_global_deinit(diag_handle->sysdep);
diag_handle->sysdep->core_sysdep_free(diag_handle);
return STATE_SUCCESS;
}
int32_t aiot_diag_start(void *handle)
{
diag_handle_t *diag_handle = (diag_handle_t *)handle;
if (diag_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
diag_handle->diag_status = 1;
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
return STATE_SUCCESS;
}
int32_t aiot_diag_stop(void *handle)
{
diag_handle_t *diag_handle = (diag_handle_t *)handle;
if (diag_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
diag_handle->sysdep->core_sysdep_mutex_lock(diag_handle->data_mutex);
diag_handle->diag_status = 0;
diag_handle->sysdep->core_sysdep_mutex_unlock(diag_handle->data_mutex);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/diag/aiot_diag_api.c | C | apache-2.0 | 29,930 |
/**
* @file aiot_diag_api.h
* @brief diag模块头文件, 提供诊断SDK的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __AIOT_DIAG_API_H__
#define __AIOT_DIAG_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0.00~-0x0.FF表达SDK在diag模块内的状态码
*/
#define STATE_DIAG_BASE (-0x1400)
/**
* @brief STATE_DIAG_CODE1的说明
*/
#define STATE_DIAG_LOG_UNKNOWN_STATE_CODE_BASE (-0x1401)
/**
* @brief STATE_DIAG_CODE2的说明
*/
#define STATE_DIAG_CODE2 (-0x1402)
/**
* @brief diag模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
AIOT_DIAGRECV_DIAG_CONTROL
} aiot_diag_recv_type_t;
/**
* @brief diag模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_diag_recv_type_t
*/
aiot_diag_recv_type_t type;
union {
/**
* @brief 收到的云端控制指令
*/
struct {
/**
* @brief 0: 关闭诊断功能，1: 打开诊断功能
*/
uint32_t data;
} diag_control;
} data;
} aiot_diag_recv_t;
/**
* @brief diag模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle diag会话句柄
* @param[in] packet diag消息结构体, 存放收到的diag报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_diag_recv_handler_t)(void *handle, const aiot_diag_recv_t *packet, void *userdata);
/**
* @brief diag模块内部发生值得用户关注的状态变化时, 通知用户的事件类型
*/
typedef enum {
/**
* @brief 诊断模块产生的告警信息
*/
AIOT_DIAGEVT_ALERT
} aiot_diag_event_type_t;
/**
* @brief diag模块内部发生值得用户关注的状态变化时, 通知用户的事件内容
*/
typedef struct {
/**
* @brief 事件内容所对应的事件类型, 更多信息请参考@ref aiot_diag_event_type_t
*/
aiot_diag_event_type_t type;
union {
struct {
/**
* @brief 告警模块名
*/
char *module_name;
/**
* @brief 告警级别
*/
char *level;
/**
* @brief 告警信息描述字符串
*/
char *desc;
} alert;
} data;
} aiot_diag_event_t;
/**
* @brief diag模块内部发生值得用户关注的状态变化时, 通知用户所调用的事件回调函数
*
* @param[in] handle, diag会话句柄
* @param[in] event, diag模块中发生的事件的内容
* @param[in] userdata, 用户上下文
*
* @return void
*/
typedef void (*aiot_diag_event_handler_t)(void *handle, const aiot_diag_event_t *event, void *userdata);
/**
* @brief 诊断项的配置参数
*/
typedef struct {
/**
* @brief 对当前诊断项是否进行诊断的开关
*
* @details
*
* 0: 关闭对当前诊断项的诊断, 1: 打开对当前诊断项的诊断
*/
uint8_t enabled;
/**
* @brief 对当前诊断项连续两次告警的最小时间间隔
*/
uint32_t interval_ms;
/**
* @brief warning级别告警的阈值
*/
int64_t warning_threashold;
/**
* @brief fatal级别告警的阈值
*/
int64_t fatal_threshold;
} aiot_diag_config_t;
/**
* @brief @ref aiot_diag_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_diag_setopt 中, data参数的数据类型
*
* 1. data的数据类型是void *时, 以配置@ref AIOT_DIAGOPT_MQTT_HANDLE 为例:
*
* void *mqtt_handle = aiot_mqtt_init();
* aiot_diag_setopt(diag_handle, AIOT_DIAGOPT_MQTT_HANDLE, mqtt_handle);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_DIAGOPT_LOCAL_REPORT_ENABLED 为例:
*
* uint8_t local_report_enabled = 1;
* aiot_mqtt_setopt(diag_handle, AIOT_DIAGOPT_LOCAL_REPORT_ENABLED, (void *)&local_report_enabled);
*/
typedef enum {
/**
* @brief diag会话 需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
*
* @details
*
* 数据类型: (void *)
*/
AIOT_DIAGOPT_MQTT_HANDLE,
/**
* @brief 是否需要从事件回调函数中输出告警信息
*
* @details
*
* 0: 不从事件回调函数中输出告警信息, 1: 从事件回调函数中输出告警信息
*
* 数据类型: (uint8_t *)
*/
AIOT_DIAGOPT_LOCAL_REPORT_ENABLED,
/**
* @brief 是否需要上报告警信息至云端
*
* @details
*
* 0: 不上报告警信息至云端, 1: 上报告警信息至云端
*
* 数据类型: (uint8_t *)
*/
AIOT_DIAGOPT_CLOUD_REPORT_ENABLED,
/**
* @brief MQTT建联时长告警配置
*
* @details
*
* 数据类型: ( @ref aiot_diag_config_t )
*/
AIOT_DIAGOPT_MQTT_CONNECTION,
/**
* @brief MQTT心跳丢失告警配置
*
* @details
*
* 数据类型: ( @ref aiot_diag_config_t )
*/
AIOT_DIAGOPT_MQTT_HEARTBEAT,
/**
* @brief Alink协议上行报文的回复速度告警配置
*
* @details
*
* 数据类型: ( @ref aiot_diag_config_t )
*/
AIOT_DIAGOPT_ALINK_UPLINK,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户
*
* @details
*
* 数据类型: ( @ref aiot_diag_recv_handler_t )
*/
AIOT_DIAGOPT_RECV_HANDLER,
/**
* @brief diag内部发生的事件会从此回调函数进行通知
*
* @details
*
* 数据类型: ( @ref aiot_diag_event_handler_t )
*/
AIOT_DIAGOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details 这个上下文指针会在 AIOT_DIAGOPT_RECV_HANDLER 和 AIOT_DIAGOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_DIAGOPT_USERDATA,
AIOT_DIAGOPT_MAX
} aiot_diag_option_t;
/**
* @brief 创建diag会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL diag实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_diag_init(void);
/**
* @brief 配置diag会话
*
* @param[in] handle diag会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_diag_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_diag_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_diag_setopt(void *handle, aiot_diag_option_t option, void *data);
/**
* @brief 结束diag会话, 销毁实例并回收资源
*
* @param[in] handle 指向diag会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_diag_deinit(void **handle);
/**
* @brief 开始诊断SDK内部信息
*
* @param handle diag会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_diag_start(void *handle);
/**
* @brief 停止诊断SDK内部信息
*
* @param handle diag会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 数据接收失败
* @retval >=STATE_SUCCESS 数据接收成功
*/
int32_t aiot_diag_stop(void *handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_DIAG_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/diag/aiot_diag_api.h | C | apache-2.0 | 7,848 |
/**
* @file diag_private.h
* @brief diag模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __DIAG_PRIVATE_H__
#define __DIAG_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_list.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_diag_api.h"
typedef struct {
uint64_t last_check_time;
} diag_mqtt_process_t;
typedef struct {
uint64_t timestamp;
int32_t code;
uint8_t *data;
uint32_t data_len;
} diag_raw_data_t;
typedef struct {
uint64_t timestamp;
uint16_t code;
char *module_name;
char *level;
char *desc;
uint8_t qos;
struct core_list_head linked_node;
} diag_desc_node_t;
typedef struct {
uint8_t is_diag; /* 该诊断项是否处于诊断状态 */
char *level; /* 告警级别 */
uint64_t start_time; /* 统计开始时间 */
uint64_t stop_time; /* 统计结束时间 */
void *extra_data; /* 统计节点附加数据 */
struct core_list_head linked_node;
} diag_running_state_node_t;
typedef struct {
uint32_t code; /* 诊断项代号 */
char *name; /* 诊断项名 */
uint8_t is_reported; /* 当前统计周期内是否上报过 */
uint64_t report_start_time; /* 当前统计周期开始时间 */
uint32_t alert_counts; /* 当前统计周期累计产生告警次数 */
uint32_t stat_number; /* 当前节点数量 */
uint32_t max_stat_number; /* 统计节点最大数量 */
uint8_t qos; /* 使用MQTT发送告警报文至云端时，使用的QoS值 */
void *mutex; /* 数据保护锁 */
struct core_list_head linked_list;
} diag_running_state_t;
typedef void (*diag_running_state_node_extra_clean_t)(void *handle, void *extra_data);
typedef int32_t (*diag_running_state_node_extra_stop_t)(void *handle, diag_running_state_node_t *node, uint32_t stat_idx, uint32_t stat_number, void *extra_data);
typedef int32_t (*diag_report_desc_append_t)(void *handle, diag_running_state_t *running_state, diag_running_state_node_t *node, char **desc);
typedef struct {
diag_running_state_node_extra_clean_t extra_clean_cb;
diag_running_state_node_extra_stop_t extra_stop_cb;
diag_report_desc_append_t desc_append_cb;
} diag_stat_callback_t;
typedef struct {
aiot_diag_config_t config;
diag_running_state_t running_state;
diag_stat_callback_t stat_cb;
} diag_stat_t;
typedef struct {
uint32_t msgid;
} diag_alink_uplink_extra_data_t;
#define DIAG_STAT_ITEM_NUMBER (3)
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
void *mqtt_handle;
uint8_t local_report_enabled;
uint8_t cloud_report_enabled;
diag_stat_t diag_stat[DIAG_STAT_ITEM_NUMBER];
uint32_t deinit_timeout_ms;
aiot_diag_event_handler_t event_handler; /* 组件内部运行状态变更时, 通知用户的回调 */
aiot_diag_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
void *userdata; /* 组件调用以上2个 diag_handler 时的入参之一 */
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是DIAG在内部使用, 用户无感知 ----*/
void *data_mutex; /* 保护本地的数据结构 */
uint8_t diag_status; /* 本地诊断模块状态, 0: stop, 1: start */
uint8_t cloud_switch;
diag_mqtt_process_t mqtt_process;
uint8_t exec_enabled;
uint32_t exec_count;
} diag_handle_t;
typedef struct {
uint32_t stat_idx;
char *name;
uint32_t code;
aiot_diag_config_t def_config;
uint32_t def_max_stat_number;
diag_stat_callback_t def_stat_cb;
uint8_t qos;
} diag_config_t;
#define DIAG_MODULE_NAME "diag" /* 用于内存统计的模块名字符串 */
#define DIAG_DAFAULT_LOCAL_REPORT_ENABLED (1)
#define DIAG_DAFAULT_CLOUD_REPORT_ENABLED (1)
#define DIAG_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
/* MQTT connection diag default configuration */
#define DIAG_DEFAULT_MQTT_CONN_ENABLED (1)
#define DIAG_DEFAULT_MQTT_CONN_INTERVAL_MS (30 * 1000)
#define DIAG_DEFAULT_MQTT_CONN_WARNING_THRESHOLD (200)
#define DIAG_DEFAULT_MQTT_CONN_FATAL_THRESHOLD (500)
#define DIAG_DEFAULT_MQTT_CONN_MAX_STAT_NUMBER (20)
/* MQTT heartbeag diag default configuration */
#define DIAG_DEFAULT_MQTT_HB_ENABLED (1)
#define DIAG_DEFAULT_MQTT_HB_INTERVAL_MS (30 * 1000)
#define DIAG_DEFAULT_MQTT_HB_WARNING_THRESHOLD (800)
#define DIAG_DEFAULT_MQTT_HB_FATAL_THRESHOLD (1500)
#define DIAG_DEFAULT_MQTT_HB_MAX_STAT_NUMBER (20)
/* MQTT alink uplink default configuration */
#define DIAG_DEFAULT_ALINK_UPLINK_ENABLED (1)
#define DIAG_DEFAULT_ALINK_UPLINK_INTERVAL_MS (30 * 1000)
#define DIAG_DEFAULT_ALINK_UPLINK_WARNING_THRESHOLD (600)
#define DIAG_DEFAULT_ALINK_UPLINK_FATAL_THRESHOLD (1000)
#define DIAG_DEFAULT_ALINK_UPLINK_MAX_STAT_NUMBER (20)
#define DIAG_REPORT_TOPIC_FMT "/sys/%s/%s/thing/log/post"
#define DIAG_REPORT_PAYLOAD_FMT "{\"id\":\"%s\",\"version\":\"1.0\",\"params\":[{\"utcTime\":\"%s\"," \
"\"logLevel\":\"%s\",\"module\":\"%s\",\"code\":\"%s\",\"traceContext\":\"%s\",\"logContent\":\"%s\"}]}"
#define DIAG_DEINIT_INTERVAL_MS (100)
#define DIAG_MQTT_PROCESS_CHECK_INTERVAL_MS (2000)
#define DIAG_REPORT_LEVEL_WARNING_STR "WARN"
#define DIAG_REPORT_LEVEL_FATAL_STR "FATAL"
#define DIAG_STATE_MQTT_BASE (STATE_MQTT_BASE)
#define DIAG_STATE_DM_BASE (-0x0A00)
/* MQTT connection diag constant */
#define DIAG_MQTT_CONNECTION_STAT_INDEX (0)
#define DIAG_MQTT_CONNECTION_NAME_STR "DiagMqttConnection"
#define DIAG_TLV_MQTT_CONNECTION (0x0010)
/* MQTT heartbeat diag constant */
#define DIAG_MQTT_HEARTBEAT_STAT_INDEX (1)
#define DIAG_MQTT_HEARTBEAT_NAME_STR "DiagMqttHeartbeat"
#define DIAG_TLV_MQTT_HEARTBEAT (0x0020)
/* MQTT alink uplink diag constant */
#define DIAG_ALINK_UPLINK_STAT_INDEX (2)
#define DIAG_ALINK_UPLINK_NAME_STR "DiagAlinkUplink"
#define DIAG_TLV_ALINK_UPLINK (0x0030)
#define DIAG_TLV_ALINK_MSGID (0x0031)
/* internal state code */
#define STATE_DIAG_STOP_NODE_NOT_MATCH (-0x14FF)
#if defined(__cplusplus)
}
#endif
#endif /* __DIAG_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/diag/diag_private.h | C | apache-2.0 | 7,516 |
/**
* @file aiot_dynregmq_api.c
* @brief dynregmq模块的API接口实现, 提供获取设备信息的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "dynregmq_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_auth.h"
static void _dynregmq_exec_inc(dynregmq_handle_t *dynregmq_handle)
{
dynregmq_handle->sysdep->core_sysdep_mutex_lock(dynregmq_handle->data_mutex);
dynregmq_handle->exec_count++;
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
}
static void _dynregmq_exec_dec(dynregmq_handle_t *dynregmq_handle)
{
dynregmq_handle->sysdep->core_sysdep_mutex_lock(dynregmq_handle->data_mutex);
dynregmq_handle->exec_count--;
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
}
static void _dynregmq_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
dynregmq_handle_t *dynregmq_handle = (dynregmq_handle_t *)userdata;
int err = 0;
if (dynregmq_handle->recv_handler == NULL) {
return;
}
switch (packet->type) {
case AIOT_MQTTRECV_PUB: {
char *topic = packet->data.pub.topic;
uint32_t topic_len = packet->data.pub.topic_len;
char *payload = (char *)packet->data.pub.payload;
uint32_t payload_len = packet->data.pub.payload_len;
const char *topic_register = "/ext/register";
const char *topic_regnwl = "/ext/regnwl";
if (strlen(topic_register) == topic_len && !memcmp(topic_register, topic, topic_len)) {
const char *key_ds = "deviceSecret";
char *ds = NULL;
uint32_t ds_len = 0;
err = core_json_value(payload, payload_len, key_ds, strlen(key_ds),
&ds, &ds_len);
if (ds == NULL || ds_len == 0 || err < 0) {
break;
}
dynregmq_handle->flag_completed = 1;
if (dynregmq_handle->recv_handler) {
aiot_dynregmq_recv_t recv_data;
memset(&recv_data, 0, sizeof(aiot_dynregmq_recv_t));
*(ds + ds_len) = 0;
recv_data.type = AIOT_DYNREGMQRECV_DEVICEINFO_WL;
recv_data.data.deviceinfo_wl.device_secret = ds;
dynregmq_handle->recv_handler(dynregmq_handle, &recv_data, dynregmq_handle->userdata);
}
} else if (strlen(topic_regnwl) == topic_len && !memcmp(topic_regnwl, topic, topic_len)) {
const char *key_clientid = "clientId";
const char *key_devicetoken = "deviceToken";
char *client_id = NULL;
char *device_token = NULL;
uint32_t client_id_len = 0;
uint32_t device_token_len = 0;
err = core_json_value(payload, payload_len, key_clientid, strlen(key_clientid), &client_id, &client_id_len);
err += core_json_value(payload, payload_len, key_devicetoken, strlen(key_devicetoken), &device_token, &device_token_len);
if (client_id == NULL || device_token == NULL || client_id_len == 0 || device_token_len == 0 || err < 0) {
break;
}
dynregmq_handle->flag_completed = 1;
if (dynregmq_handle->recv_handler) {
aiot_dynregmq_recv_t recv_data;
char *conn_clientid = NULL;
char *conn_username = NULL;
char *conn_username_fmt[] = { dynregmq_handle->device_name, dynregmq_handle->product_key };
*(client_id + client_id_len) = 0;
*(device_token + device_token_len) = 0;
core_sprintf(dynregmq_handle->sysdep, &conn_clientid, "%s|authType=connwl,securemode=-2,_ss=1,ext=3,_v="CORE_AUTH_SDK_VERSION"|",
&client_id, 1, DYNREGMQ_MODULE_NAME);
core_sprintf(dynregmq_handle->sysdep, &conn_username, "%s&%s",
conn_username_fmt, sizeof(conn_username_fmt) / sizeof(char *), DYNREGMQ_MODULE_NAME);
memset(&recv_data, 0, sizeof(aiot_dynregmq_recv_t));
recv_data.type = AIOT_DYNREGMQRECV_DEVICEINFO_NWL;
recv_data.data.deviceinfo_nwl.clientid = conn_clientid;
recv_data.data.deviceinfo_nwl.username = conn_username;
recv_data.data.deviceinfo_nwl.password = device_token;
dynregmq_handle->recv_handler(dynregmq_handle, &recv_data, dynregmq_handle->userdata);
dynregmq_handle->sysdep->core_sysdep_free(conn_clientid);
dynregmq_handle->sysdep->core_sysdep_free(conn_username);
}
}
}
break;
default: break;
}
}
void *aiot_dynregmq_init(void)
{
dynregmq_handle_t *dynregmq_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
dynregmq_handle = sysdep->core_sysdep_malloc(sizeof(dynregmq_handle_t), DYNREGMQ_MODULE_NAME);
if (dynregmq_handle == NULL) {
return NULL;
}
memset(dynregmq_handle, 0, sizeof(dynregmq_handle_t));
dynregmq_handle->sysdep = sysdep;
dynregmq_handle->timeout_ms = DYNREGMQ_DEFAULT_TIMEOUT_MS;
dynregmq_handle->deinit_timeout_ms = DYNREGMQ_DEFAULT_DEINIT_TIMEOUT_MS;
dynregmq_handle->send_timeout_ms = DYNREGMQ_DEFAULT_SEND_TIMEOUT;
dynregmq_handle->recv_timeout_ms = DYNREGMQ_DEFAULT_RECV_TIMEOUT;
dynregmq_handle->data_mutex = dynregmq_handle->sysdep->core_sysdep_mutex_init();
dynregmq_handle->exec_enabled = 1;
return dynregmq_handle;
}
int32_t aiot_dynregmq_setopt(void *handle, aiot_dynregmq_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
dynregmq_handle_t *dynregmq_handle = (dynregmq_handle_t *)handle;
if (dynregmq_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_DYNREGMQOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (dynregmq_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynregmq_exec_inc(dynregmq_handle);
dynregmq_handle->sysdep->core_sysdep_mutex_lock(dynregmq_handle->data_mutex);
switch (option) {
case AIOT_DYNREGMQOPT_NETWORK_CRED: {
if (dynregmq_handle->cred != NULL) {
dynregmq_handle->sysdep->core_sysdep_free(dynregmq_handle->cred);
dynregmq_handle->cred = NULL;
}
dynregmq_handle->cred = dynregmq_handle->sysdep->core_sysdep_malloc(sizeof(aiot_sysdep_network_cred_t),
DYNREGMQ_MODULE_NAME);
if (dynregmq_handle->cred != NULL) {
memset(dynregmq_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(dynregmq_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
} else {
res = STATE_SYS_DEPEND_MALLOC_FAILED;
}
}
break;
case AIOT_DYNREGMQOPT_HOST: {
res = core_strdup(dynregmq_handle->sysdep, &dynregmq_handle->host, data, DYNREGMQ_MODULE_NAME);
}
break;
case AIOT_DYNREGMQOPT_PORT: {
dynregmq_handle->port = *(uint16_t *)data;
}
break;
case AIOT_DYNREGMQOPT_PRODUCT_KEY: {
res = core_strdup(dynregmq_handle->sysdep, &dynregmq_handle->product_key, data, DYNREGMQ_MODULE_NAME);
}
break;
case AIOT_DYNREGMQOPT_PRODUCT_SECRET: {
res = core_strdup(dynregmq_handle->sysdep, &dynregmq_handle->product_secret, data, DYNREGMQ_MODULE_NAME);
}
break;
case AIOT_DYNREGMQOPT_DEVICE_NAME: {
res = core_strdup(dynregmq_handle->sysdep, &dynregmq_handle->device_name, data, DYNREGMQ_MODULE_NAME);
}
break;
case AIOT_DYNREGMQOPT_SEND_TIMEOUT_MS: {
dynregmq_handle->send_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGMQOPT_RECV_TIMEOUT_MS: {
dynregmq_handle->recv_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGMQOPT_RECV_HANDLER: {
dynregmq_handle->recv_handler = (aiot_dynregmq_recv_handler_t)data;
}
break;
case AIOT_DYNREGMQOPT_USERDATA: {
dynregmq_handle->userdata = data;
}
break;
case AIOT_DYNREGMQOPT_TIMEOUT_MS: {
dynregmq_handle->timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGMQOPT_DEINIT_TIMEOUT_MS: {
dynregmq_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGMQOPT_NO_WHITELIST: {
dynregmq_handle->flag_nowhitelist = *(uint8_t *)data;
}
break;
case AIOT_DYNREGMQOPT_INSTANCE_ID: {
res = core_strdup(dynregmq_handle->sysdep, &dynregmq_handle->instance_id, data, DYNREGMQ_MODULE_NAME);
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
_dynregmq_exec_dec(dynregmq_handle);
return res;
}
int32_t aiot_dynregmq_deinit(void **handle)
{
uint32_t deinit_timeout_ms = 0;
dynregmq_handle_t *dynregmq_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
dynregmq_handle = *(dynregmq_handle_t **)handle;
sysdep = dynregmq_handle->sysdep;
if (dynregmq_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
dynregmq_handle->exec_enabled = 0;
deinit_timeout_ms = dynregmq_handle->deinit_timeout_ms;
do {
if (dynregmq_handle->exec_count == 0) {
break;
}
dynregmq_handle->sysdep->core_sysdep_sleep(DYNREGMQ_DEINIT_INTERVAL_MS);
} while ((deinit_timeout_ms > DYNREGMQ_DEINIT_INTERVAL_MS) && (deinit_timeout_ms - DYNREGMQ_DEINIT_INTERVAL_MS > 0));
if (dynregmq_handle->exec_count != 0) {
return STATE_DYNREGMQ_DEINIT_TIMEOUT;
}
*handle = NULL;
if (dynregmq_handle->mqtt_handle != NULL) {
aiot_mqtt_deinit(&dynregmq_handle->mqtt_handle);
}
if (dynregmq_handle->host != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->host);
}
if (dynregmq_handle->product_key != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->product_key);
}
if (dynregmq_handle->product_secret != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->product_secret);
}
if (dynregmq_handle->device_name != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->device_name);
}
if (dynregmq_handle->cred != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->cred);
}
if (dynregmq_handle->instance_id != NULL) {
sysdep->core_sysdep_free(dynregmq_handle->instance_id);
}
sysdep->core_sysdep_mutex_deinit(&dynregmq_handle->data_mutex);
sysdep->core_sysdep_free(dynregmq_handle);
return STATE_SUCCESS;
}
int32_t aiot_dynregmq_send_request(void *handle)
{
int32_t res = STATE_SUCCESS;
dynregmq_handle_t *dynregmq_handle = (dynregmq_handle_t *)handle;
char *auth_clientid = NULL;
char *auth_username = NULL;
char auth_password[65] = {0};
char *sign_input = NULL;
uint32_t random_num = 0;
char random[11] = {0};
char *auth_type = NULL;
uint8_t reconnect = 0;
if (dynregmq_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dynregmq_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
if (dynregmq_handle->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dynregmq_handle->product_secret == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_SECRET;
}
if (dynregmq_handle->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (dynregmq_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynregmq_exec_inc(dynregmq_handle);
dynregmq_handle->sysdep->core_sysdep_mutex_lock(dynregmq_handle->data_mutex);
if (dynregmq_handle->mqtt_handle != NULL) {
aiot_mqtt_deinit(&dynregmq_handle->mqtt_handle);
}
dynregmq_handle->mqtt_handle = aiot_mqtt_init();
if (dynregmq_handle->mqtt_handle == NULL) {
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
_dynregmq_exec_dec(dynregmq_handle);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
/* setup auth_type */
auth_type = (dynregmq_handle->flag_nowhitelist) ? "regnwl" : "register";
/* generate random string */
dynregmq_handle->sysdep->core_sysdep_rand((uint8_t *)&random_num, 4);
core_uint2str(random_num, random, NULL);
/* assamble clientid, username and password */
{
uint8_t has_instance_id = (dynregmq_handle->flag_nowhitelist && dynregmq_handle->instance_id != NULL) ? 1 : 0;
char *client_fmt = (has_instance_id) ?
"%s.%s|random=%s,authType=%s,securemode=2,signmethod=hmacsha256,instanceId=%s|" :
"%s.%s|random=%s,authType=%s,securemode=2,signmethod=hmacsha256|";
char *client_src[] = { dynregmq_handle->device_name, dynregmq_handle->product_key,
random, auth_type, dynregmq_handle->instance_id
};
char *username_fmt = "%s&%s";
char *username_src[] = { dynregmq_handle->device_name, dynregmq_handle->product_key };
char *sign_input_fmt = "deviceName%sproductKey%srandom%s";
uint8_t sign_output[32] = {0};
core_sprintf(dynregmq_handle->sysdep, &auth_clientid, client_fmt, client_src,
has_instance_id ? 5 : 4, DYNREGMQ_MODULE_NAME);
core_sprintf(dynregmq_handle->sysdep, &auth_username, username_fmt, username_src,
sizeof(username_src) / sizeof(char *), DYNREGMQ_MODULE_NAME);
core_sprintf(dynregmq_handle->sysdep, &sign_input, sign_input_fmt, client_src,
3, DYNREGMQ_MODULE_NAME);
core_hmac_sha256((const uint8_t *)sign_input, (uint32_t)strlen(sign_input),
(const uint8_t *)dynregmq_handle->product_secret,
(uint32_t)strlen(dynregmq_handle->product_secret), sign_output);
core_hex2str(sign_output, sizeof(sign_output), auth_password, 0);
}
if (((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_HOST,
(void *)dynregmq_handle->host)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_PORT,
(void *)&dynregmq_handle->port)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_CLIENTID,
(void *)auth_clientid)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_USERNAME,
(void *)auth_username)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_PASSWORD,
(void *)auth_password)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_NETWORK_CRED,
(void *)dynregmq_handle->cred)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_SEND_TIMEOUT_MS,
(void *)&dynregmq_handle->send_timeout_ms)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_RECV_TIMEOUT_MS,
(void *)&dynregmq_handle->recv_timeout_ms)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_RECV_HANDLER,
(void *)_dynregmq_recv_handler)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_USERDATA,
(void *)dynregmq_handle)) < STATE_SUCCESS) ||
((res = aiot_mqtt_setopt(dynregmq_handle->mqtt_handle, AIOT_MQTTOPT_RECONN_ENABLED,
(void *)&reconnect)) < STATE_SUCCESS)) {
aiot_mqtt_deinit(&dynregmq_handle->mqtt_handle);
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
_dynregmq_exec_dec(dynregmq_handle);
dynregmq_handle->sysdep->core_sysdep_free(auth_clientid);
dynregmq_handle->sysdep->core_sysdep_free(auth_username);
dynregmq_handle->sysdep->core_sysdep_free(sign_input);
return res;
}
res = aiot_mqtt_connect(dynregmq_handle->mqtt_handle);
if (res < STATE_SUCCESS) {
aiot_mqtt_deinit(&dynregmq_handle->mqtt_handle);
}
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
_dynregmq_exec_dec(dynregmq_handle);
dynregmq_handle->sysdep->core_sysdep_free(auth_clientid);
dynregmq_handle->sysdep->core_sysdep_free(auth_username);
dynregmq_handle->sysdep->core_sysdep_free(sign_input);
return res;
}
int32_t aiot_dynregmq_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint64_t timenow_ms = 0;
dynregmq_handle_t *dynregmq_handle = (dynregmq_handle_t *)handle;
if (dynregmq_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dynregmq_handle->mqtt_handle == NULL) {
return STATE_DYNREGMQ_NEED_SEND_REQUEST;
}
if (dynregmq_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynregmq_exec_inc(dynregmq_handle);
dynregmq_handle->sysdep->core_sysdep_mutex_lock(dynregmq_handle->data_mutex);
timenow_ms = dynregmq_handle->sysdep->core_sysdep_time();
while (1) {
if (timenow_ms >= dynregmq_handle->sysdep->core_sysdep_time()) {
timenow_ms = dynregmq_handle->sysdep->core_sysdep_time();
}
if (dynregmq_handle->sysdep->core_sysdep_time() - timenow_ms >= dynregmq_handle->timeout_ms) {
res = STATE_DYNREGMQ_AUTH_TIMEOUT;
break;
}
res = aiot_mqtt_recv(dynregmq_handle->mqtt_handle);
if (res < 0) {
break;
}
if (dynregmq_handle->flag_completed == 1) {
dynregmq_handle->flag_completed = 0;
res = STATE_SUCCESS;
break;
}
}
dynregmq_handle->sysdep->core_sysdep_mutex_unlock(dynregmq_handle->data_mutex);
_dynregmq_exec_dec(dynregmq_handle);
return res;
}
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg-mqtt/aiot_dynregmq_api.c | C | apache-2.0 | 19,082 |
/**
* @file aiot_dynregmq_api.h
* @brief dynregmq模块头文件, 提供了基于MQTT的设备信息动态注册能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __AIOT_DYNREGMQ_API_H__
#define __AIOT_DYNREGMQ_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0500~-0x05FF表达SDK在dynregmq模块内的状态码
*/
#define STATE_DYNREGMQ_BASE (-0x0500)
/**
* @brief 执行@ref aiot_dynregmq_deinit 时, 等待其他API执行结束的超过设定的超时时间, DYNREGMQ实例销毁失败
*/
#define STATE_DYNREGMQ_DEINIT_TIMEOUT (-0x0501)
/**
* @brief 需要首先执行@ref aiot_dynregmq_send_request 发送动态注册请求
*/
#define STATE_DYNREGMQ_NEED_SEND_REQUEST (-0x0502)
/**
* @brief 接收服务器应答超时
*/
#define STATE_DYNREGMQ_AUTH_TIMEOUT (-0x0503)
/**
* @brief @ref aiot_dynregmq_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_dynregmq_setopt 中, data参数的数据类型
*
* 1. data的数据类型是char *时, 以配置@ref AIOT_DYNREGMQOPT_HOST 为例:
*
* char *host = "xxx";
* aiot_dynregmq_setopt(dynregmq_handle, AIOT_DYNREGMQOPT_HOST, host);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_DYNREGMQOPT_PORT 为例:
*
* uint16_t port = 443;
* aiot_mqtt_setopt(dynregmq_handle, AIOT_DYNREGMQOPT_PORT, (void *)&port);
*/
typedef enum {
/**
* @brief mqtt动态注册 服务器建联时, 网络使用的安全凭据, 动态注册必需使用TLS方式建连
*
* @details
*
* 该配置项用于为底层网络配置@ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 应当把 @ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , 以tls方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_DYNREGMQOPT_NETWORK_CRED,
/**
* @brief mqtt动态注册 服务器的域名地址或者ip地址
*
* @details
*
* 阿里云物联网平台域名地址列表(必须使用自己的product key替换${pk}):
*
* 使用tls证书方式建联:
*
* | 域名地址 | 区域 | 端口号
* |-------------------------------------------------|---------|---------
* | ${pk}.iot-as-mqtt.cn-shanghai.aliyuncs.com | 上海 | 443
* | ${pk}.iot-as-mqtt.ap-southeast-1.aliyuncs.com | 新加坡 | 443
* | ${pk}.iot-as-mqtt.ap-northeast-1.aliyuncs.com | 日本 | 443
* | ${pk}.iot-as-mqtt.us-west-1.aliyuncs.com | 美西 | 443
* | ${pk}.iot-as-mqtt.eu-central-1.aliyuncs.com | 德国 | 443
*
* 数据类型: (char *)
*/
AIOT_DYNREGMQOPT_HOST,
/**
* @brief mqtt动态注册 服务器的端口号
*
* @details
*
* 连接阿里云物联网平台 mqtt动态注册 服务器时:
*
* 必须使用tls方式建联, 端口号设置为443
*
* 数据类型: (uint16_t *)
*/
AIOT_DYNREGMQOPT_PORT,
/**
* @brief 设备的productKey, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGMQOPT_PRODUCT_KEY,
/**
* @brief 设备的productSecret, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGMQOPT_PRODUCT_SECRET,
/**
* @brief 设备的deviceName, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGMQOPT_DEVICE_NAME,
/**
* @brief dynregmq会话发送消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGMQOPT_SEND_TIMEOUT_MS,
/**
* @brief dynregmq会话接收消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGMQOPT_RECV_TIMEOUT_MS,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户
*
* @details
*
* 数据类型: (aiot_dynregmq_http_recv_handler_t)
*/
AIOT_DYNREGMQOPT_RECV_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 这个上下文指针会在 AIOT_DYNREGMQOPT_RECV_HANDLER 和 AIOT_DYNREGMQOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_DYNREGMQOPT_USERDATA,
/**
* @brief dynregmq模块接收消息的超时时间
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGMQOPT_TIMEOUT_MS,
/**
* @brief 销毁dynregmq实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_dynregmq_deinit 销毁MQTT实例时, 若继续调用其他aiot_dynregmq_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_dynregmq_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_DYNREGMQOPT_DEINIT_TIMEOUT_MS,
/**
* @brief 是否使用免白名单功能
*
* @details
*
* 1. 配置为 0 则为白名单模式, 使用这种模式用户必须提前在控制台录入deviceName, 动态注册完成后服务会返回deviceSecret, 用户可通过
* AIOT_DYNREGMQRECV_DEVICEINFO_WL类型数据回调获取到deviceSecret.
* 2. 配置为 1 则为免白名单模式, 使用这种模式用户无需提前在控制台录入deviceName, 动态注册完成后服务会返回MQTT建连信息, 用户可通过
* AIOT_DYNREGMQRECV_DEVICEINFO_NWL类型数据回调获取到clientid, username, password. 用户需要将这三个参数通过
* aiot_mqtt_setopt接口以AIOT_MQTTOPT_CLIENTID, AIOT_MQTTOPT_USERNAME, AIOT_MQTTOPT_PASSWORD配置选项
* 配置到MQTT句柄中。
*
* 数据类型: (uint8_t *) 默认值: (0)
*
*/
AIOT_DYNREGMQOPT_NO_WHITELIST,
/**
* @brief 用户购买的物联网平台实例ID. 当用户使用自购实例, 且使用免白名单方式时, 必须设置实例ID
*
* @details
*
* 数据类型: (char *)
*
*/
AIOT_DYNREGMQOPT_INSTANCE_ID,
AIOT_DYNREGMQOPT_MAX
} aiot_dynregmq_option_t;
/**
* @brief dynregmq模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
/**
* @brief 白名单模式下服务器返回的设备信息
*/
AIOT_DYNREGMQRECV_DEVICEINFO_WL,
/**
* @brief 免白名单模式下服务器返回的设备信息
*/
AIOT_DYNREGMQRECV_DEVICEINFO_NWL,
} aiot_dynregmq_recv_type_t;
/**
* @brief dynregmq模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_dynregmq_recv_type_t
*/
aiot_dynregmq_recv_type_t type;
union {
/**
* @brief 白名单模式下服务器返回的设备信息
*/
struct {
char *device_secret;
} deviceinfo_wl;
/**
* @brief 免白名单模式下服务器返回的设备信息
*/
struct {
char *clientid;
char *username;
char *password;
} deviceinfo_nwl;
} data;
} aiot_dynregmq_recv_t;
/**
* @brief dynregmq模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle dynregmq会话句柄
* @param[in] packet dynregmq消息结构体, 存放收到的dynregmq报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_dynregmq_recv_handler_t)(void *handle,
const aiot_dynregmq_recv_t *packet, void *userdata);
/**
* @brief 创建dynregmq会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL dynregmq实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_dynregmq_init(void);
/**
* @brief 配置dynregmq会话
*
* @param[in] handle dynregmq会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_dynregmq_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_dynregmq_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_dynregmq_setopt(void *handle, aiot_dynregmq_option_t option, void *data);
/**
* @brief 结束dynregmq会话, 销毁实例并回收资源
*
* @param[in] handle 指向dynregmq会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_dynregmq_deinit(void **handle);
/**
* @brief 向dynregmq服务器发送dynregmq消息请求
*
* @param handle dynregmq会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_dynregmq_send_request(void *handle);
/**
* @brief 从网络上收取dynregmq消息
*
* @param handle dynregmq会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 数据接收失败
* @retval >=STATE_SUCCESS 数据接收成功
*/
int32_t aiot_dynregmq_recv(void *handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_DYNREGMQMQ_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg-mqtt/aiot_dynregmq_api.h | C | apache-2.0 | 9,939 |
/**
* @file dynregmq_private.h
* @brief dynregmq模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __DYNREGMQ_PRIVATE_H__
#define __DYNREGMQ_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_dynregmq_api.h" /* 内部头文件是用户可见头文件的超集 */
typedef struct {
uint32_t code;
uint8_t *content;
uint32_t content_len;
uint32_t content_total_len;
} core_mqtt_response_t;
/* 定义dynregmq模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
aiot_sysdep_network_cred_t *cred; /* 指向当前连接使用的安全凭据 */
char *host; /* 会话目标服务器域名 */
uint16_t port; /* 会话目标服务器端口 */
char *product_key;
char *product_secret;
char *device_name;
uint8_t flag_nowhitelist; /* 是否使用免白名单功能 */
char
*instance_id; /* 实例ID，当用户使用自购实例，且使用免白名单方式时，需设置实例ID */
aiot_dynregmq_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
void *userdata; /* 组件调用以上2个 dynregmq_handler 时的入参之一 */
uint32_t recv_timeout_ms; /* 从协议栈收包时最长等待时间 */
uint32_t send_timeout_ms; /* 向协议栈写入时最长花费时间 */
uint32_t timeout_ms;
uint32_t deinit_timeout_ms;
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是DYNREGMQ在内部使用, 用户无感知 ----*/
void *mqtt_handle;
uint8_t flag_completed;
uint8_t exec_enabled;
uint32_t exec_count;
void *data_mutex; /* 保护本地的数据结构 */
} dynregmq_handle_t;
#define DYNREGMQ_MODULE_NAME "dynregmq" /* 用于内存统计的模块名字符串 */
#define DYNREGMQ_DEFAULT_TIMEOUT_MS (5 * 1000)
#define DYNREGMQ_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define DYNREGMQ_DEFAULT_RECV_TIMEOUT (5 * 1000)
#define DYNREGMQ_DEFAULT_SEND_TIMEOUT (5 * 1000)
#define DYNREGMQ_DEINIT_INTERVAL_MS (100)
#if defined(__cplusplus)
}
#endif
#endif /* __DYNREGMQ_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg-mqtt/dynregmq_private.h | C | apache-2.0 | 2,859 |
/**
* @file aiot_dynreg_api.c
* @brief dynreg模块的API接口实现, 提供获取设备信息的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "dynreg_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_auth.h"
static void _dynreg_exec_inc(dynreg_handle_t *dynreg_handle)
{
dynreg_handle->sysdep->core_sysdep_mutex_lock(dynreg_handle->data_mutex);
dynreg_handle->exec_count++;
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
}
static void _dynreg_exec_dec(dynreg_handle_t *dynreg_handle)
{
dynreg_handle->sysdep->core_sysdep_mutex_lock(dynreg_handle->data_mutex);
dynreg_handle->exec_count--;
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
}
static int32_t _dynreg_sign(dynreg_handle_t *dynreg_handle, char *random, char sign_str[65])
{
int32_t res = STATE_SUCCESS;
uint8_t sign_hex[32] = {0};
char *src_fmt = "deviceName%sproductKey%srandom%s";
char *src[] = {dynreg_handle->device_name, dynreg_handle->product_key, random};
char *plain_text = NULL;
res = core_sprintf(dynreg_handle->sysdep, &plain_text, src_fmt, src, sizeof(src) / sizeof(char *), DYNREG_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
core_hmac_sha256((const uint8_t *)plain_text, (uint32_t)strlen(plain_text),
(const uint8_t *)dynreg_handle->product_secret, (uint32_t)strlen(dynreg_handle->product_secret), sign_hex);
core_hex2str(sign_hex, 32, sign_str, 0);
dynreg_handle->sysdep->core_sysdep_free(plain_text);
return STATE_SUCCESS;
}
static void _dynreg_recv_handler(void *handle, const aiot_http_recv_t *packet, void *userdata)
{
dynreg_handle_t *dynreg_handle = (dynreg_handle_t *)userdata;
if (dynreg_handle->recv_handler == NULL) {
return;
}
switch (packet->type) {
case AIOT_HTTPRECV_STATUS_CODE: {
dynreg_handle->response.code = packet->data.status_code.code;
}
break;
case AIOT_HTTPRECV_HEADER: {
if ((strlen(packet->data.header.key) == strlen("Content-Length")) &&
(memcmp(packet->data.header.key, "Content-Length", strlen(packet->data.header.key)) == 0)) {
core_str2uint(packet->data.header.value, (uint8_t)strlen(packet->data.header.value),
&dynreg_handle->response.content_total_len);
}
}
break;
case AIOT_HTTPRECV_BODY: {
uint8_t *content = dynreg_handle->sysdep->core_sysdep_malloc(dynreg_handle->response.content_len + packet->data.body.len
+ 1,
CORE_HTTP_MODULE_NAME);
if (content == NULL) {
return;
}
memset(content, 0, dynreg_handle->response.content_len + packet->data.body.len + 1);
if (content != NULL) {
memcpy(content, dynreg_handle->response.content, dynreg_handle->response.content_len);
dynreg_handle->sysdep->core_sysdep_free(dynreg_handle->response.content);
}
memcpy(content + dynreg_handle->response.content_len, packet->data.body.buffer, packet->data.body.len);
dynreg_handle->response.content = content;
dynreg_handle->response.content_len = dynreg_handle->response.content_len + packet->data.body.len;
}
break;
default: {
}
break;
}
}
static int32_t _dynreg_device_info(dynreg_handle_t *dynreg_handle, char **device_secret)
{
int32_t res = STATE_SUCCESS;
char *tmp_ds = NULL, *ds_key = "deviceSecret";
char *ds_value = NULL;
uint32_t ds_value_len = 0;
if (dynreg_handle->response.code != 200) {
return STATE_DYNREG_INVALID_STATUS_CODE;
}
if ((res = core_json_value((char *)dynreg_handle->response.content, dynreg_handle->response.content_len, ds_key,
strlen(ds_key), &ds_value, &ds_value_len)) < STATE_SUCCESS) {
return STATE_DYNREG_INVALID_DEVICE_SECRET;
}
tmp_ds = dynreg_handle->sysdep->core_sysdep_malloc(ds_value_len + 1, DYNREG_MODULE_NAME);
if (tmp_ds == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(tmp_ds, 0, ds_value_len + 1);
memcpy(tmp_ds, ds_value, ds_value_len);
*device_secret = tmp_ds;
return STATE_SUCCESS;
}
void *aiot_dynreg_init(void)
{
dynreg_handle_t *dynreg_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
dynreg_handle = sysdep->core_sysdep_malloc(sizeof(dynreg_handle_t), DYNREG_MODULE_NAME);
if (dynreg_handle == NULL) {
return NULL;
}
memset(dynreg_handle, 0, sizeof(dynreg_handle_t));
dynreg_handle->sysdep = sysdep;
dynreg_handle->response_body_len = DYNREG_RESPONSE_BODY_LEN;
dynreg_handle->timeout_ms = DYNREG_DEFAULT_TIMEOUT_MS;
dynreg_handle->deinit_timeout_ms = DYNREG_DEFAULT_DEINIT_TIMEOUT_MS;
dynreg_handle->send_timeout_ms = DYNREG_DEFAULT_SEND_TIMEOUT;
dynreg_handle->recv_timeout_ms = DYNREG_DEFAULT_RECV_TIMEOUT;
dynreg_handle->data_mutex = dynreg_handle->sysdep->core_sysdep_mutex_init();
dynreg_handle->exec_enabled = 1;
return dynreg_handle;
}
int32_t aiot_dynreg_setopt(void *handle, aiot_dynreg_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
dynreg_handle_t *dynreg_handle = (dynreg_handle_t *)handle;
if (dynreg_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_DYNREGOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (dynreg_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynreg_exec_inc(dynreg_handle);
dynreg_handle->sysdep->core_sysdep_mutex_lock(dynreg_handle->data_mutex);
switch (option) {
case AIOT_DYNREGOPT_NETWORK_CRED: {
if (dynreg_handle->cred != NULL) {
dynreg_handle->sysdep->core_sysdep_free(dynreg_handle->cred);
dynreg_handle->cred = NULL;
}
dynreg_handle->cred = dynreg_handle->sysdep->core_sysdep_malloc(sizeof(aiot_sysdep_network_cred_t), DYNREG_MODULE_NAME);
if (dynreg_handle->cred != NULL) {
memset(dynreg_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(dynreg_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
} else {
res = STATE_SYS_DEPEND_MALLOC_FAILED;
}
}
break;
case AIOT_DYNREGOPT_HOST: {
res = core_strdup(dynreg_handle->sysdep, &dynreg_handle->host, data, DYNREG_MODULE_NAME);
}
break;
case AIOT_DYNREGOPT_PORT: {
dynreg_handle->port = *(uint16_t *)data;
}
break;
case AIOT_DYNREGOPT_PRODUCT_KEY: {
res = core_strdup(dynreg_handle->sysdep, &dynreg_handle->product_key, data, DYNREG_MODULE_NAME);
}
break;
case AIOT_DYNREGOPT_PRODUCT_SECRET: {
res = core_strdup(dynreg_handle->sysdep, &dynreg_handle->product_secret, data, DYNREG_MODULE_NAME);
}
break;
case AIOT_DYNREGOPT_DEVICE_NAME: {
res = core_strdup(dynreg_handle->sysdep, &dynreg_handle->device_name, data, DYNREG_MODULE_NAME);
}
break;
case AIOT_DYNREGOPT_SEND_TIMEOUT_MS: {
dynreg_handle->send_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGOPT_RECV_TIMEOUT_MS: {
dynreg_handle->recv_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGOPT_RECV_HANDLER: {
dynreg_handle->recv_handler = (aiot_dynreg_recv_handler_t)data;
}
break;
case AIOT_DYNREGOPT_USERDATA: {
dynreg_handle->userdata = data;
}
break;
case AIOT_DYNREGOPT_TIMEOUT_MS: {
dynreg_handle->timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_DYNREGOPT_DEINIT_TIMEOUT_MS: {
dynreg_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
int32_t aiot_dynreg_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
dynreg_handle_t *dynreg_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
dynreg_handle = *(dynreg_handle_t **)handle;
sysdep = dynreg_handle->sysdep;
if (dynreg_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
dynreg_handle->exec_enabled = 0;
deinit_timestart = dynreg_handle->sysdep->core_sysdep_time();
do {
if (dynreg_handle->exec_count == 0) {
break;
}
dynreg_handle->sysdep->core_sysdep_sleep(DYNREG_DEINIT_INTERVAL_MS);
} while ((dynreg_handle->sysdep->core_sysdep_time() - deinit_timestart) < dynreg_handle->deinit_timeout_ms);
if (dynreg_handle->exec_count != 0) {
return STATE_DYNREG_DEINIT_TIMEOUT;
}
*handle = NULL;
if (dynreg_handle->response.content != NULL) {
sysdep->core_sysdep_free(dynreg_handle->response.content);
}
memset(&dynreg_handle->response, 0, sizeof(core_http_response_t));
if (dynreg_handle->http_handle != NULL) {
core_http_deinit(&dynreg_handle->http_handle);
}
if (dynreg_handle->host != NULL) {
sysdep->core_sysdep_free(dynreg_handle->host);
}
if (dynreg_handle->product_key != NULL) {
sysdep->core_sysdep_free(dynreg_handle->product_key);
}
if (dynreg_handle->product_secret != NULL) {
sysdep->core_sysdep_free(dynreg_handle->product_secret);
}
if (dynreg_handle->device_name != NULL) {
sysdep->core_sysdep_free(dynreg_handle->device_name);
}
if (dynreg_handle->cred != NULL) {
sysdep->core_sysdep_free(dynreg_handle->cred);
}
sysdep->core_sysdep_mutex_deinit(&dynreg_handle->data_mutex);
sysdep->core_sysdep_free(dynreg_handle);
return STATE_SUCCESS;
}
int32_t aiot_dynreg_send_request(void *handle)
{
int32_t res = STATE_SUCCESS;
dynreg_handle_t *dynreg_handle = (dynreg_handle_t *)handle;
if (dynreg_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dynreg_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
if (dynreg_handle->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dynreg_handle->product_secret == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_SECRET;
}
if (dynreg_handle->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (dynreg_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynreg_exec_inc(dynreg_handle);
dynreg_handle->sysdep->core_sysdep_mutex_lock(dynreg_handle->data_mutex);
if (dynreg_handle->response.content != NULL) {
dynreg_handle->sysdep->core_sysdep_free(dynreg_handle->response.content);
}
memset(&dynreg_handle->response, 0, sizeof(core_http_response_t));
if (dynreg_handle->http_handle != NULL) {
core_http_deinit(&dynreg_handle->http_handle);
}
dynreg_handle->http_handle = core_http_init();
if (dynreg_handle->http_handle == NULL) {
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
if (((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_HOST,
(void *)dynreg_handle->host)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_PORT, (void *)&dynreg_handle->port)) < STATE_SUCCESS)
||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_NETWORK_CRED,
(void *)dynreg_handle->cred)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_SEND_TIMEOUT_MS,
(void *)&dynreg_handle->send_timeout_ms)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_RECV_TIMEOUT_MS,
(void *)&dynreg_handle->recv_timeout_ms)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_BODY_BUFFER_MAX_LEN,
(void *)&dynreg_handle->response_body_len)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_RECV_HANDLER,
(void *)_dynreg_recv_handler)) < STATE_SUCCESS) ||
((res = core_http_setopt(dynreg_handle->http_handle, CORE_HTTPOPT_USERDATA, (void *)dynreg_handle)) < STATE_SUCCESS)) {
core_http_deinit(&dynreg_handle->http_handle);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
res = core_http_connect(dynreg_handle->http_handle);
if (res < STATE_SUCCESS) {
core_http_deinit(&dynreg_handle->http_handle);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
{
uint32_t random_num = 0;
char random[11] = {0};
char sign_str[65] = {0};
char *content = NULL;
char *content_fmt = "productKey=%s&deviceName=%s&random=%s&sign=%s&signMethod=hmacsha256";
char *content_src[] = { dynreg_handle->product_key, dynreg_handle->device_name, (char *)random, sign_str };
core_http_request_t request;
dynreg_handle->sysdep->core_sysdep_rand((uint8_t *)&random_num, 4);
core_uint2str(random_num, random, NULL);
res = _dynreg_sign(dynreg_handle, (char *)random, sign_str);
if (res < STATE_SUCCESS) {
core_http_deinit(&dynreg_handle->http_handle);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
memset(&request, 0, sizeof(core_http_request_t));
res = core_sprintf(dynreg_handle->sysdep, &content, content_fmt, content_src, sizeof(content_src) / sizeof(char *),
DYNREG_MODULE_NAME);
if (res < STATE_SUCCESS) {
core_http_deinit(&dynreg_handle->http_handle);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
request.method = "POST";
request.path = DYNREG_PATH;
request.header = "Accept: text/xml,text/javascript,text/html,application/json\r\n" \
"Content-Type: application/x-www-form-urlencoded\r\n";
request.content = (uint8_t *)content;
request.content_len = (uint32_t)strlen(content);
res = core_http_send(dynreg_handle->http_handle, &request);
dynreg_handle->sysdep->core_sysdep_free(content);
if (res < STATE_SUCCESS) {
core_http_deinit(&dynreg_handle->http_handle);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
}
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
}
int32_t aiot_dynreg_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint64_t timenow_ms = 0;
dynreg_handle_t *dynreg_handle = (dynreg_handle_t *)handle;
char *device_secret = NULL;
aiot_dynreg_recv_t packet;
if (dynreg_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dynreg_handle->http_handle == NULL) {
return STATE_DYNREG_NEED_SEND_REQUEST;
}
if (dynreg_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_dynreg_exec_inc(dynreg_handle);
dynreg_handle->sysdep->core_sysdep_mutex_lock(dynreg_handle->data_mutex);
timenow_ms = dynreg_handle->sysdep->core_sysdep_time();
while (1) {
if (timenow_ms >= dynreg_handle->sysdep->core_sysdep_time()) {
timenow_ms = dynreg_handle->sysdep->core_sysdep_time();
}
if (dynreg_handle->sysdep->core_sysdep_time() - timenow_ms >= dynreg_handle->timeout_ms) {
break;
}
res = core_http_recv(dynreg_handle->http_handle);
if (res < STATE_SUCCESS) {
break;
}
}
if (res < STATE_SUCCESS) {
if (res != STATE_HTTP_READ_BODY_FINISHED) {
if (dynreg_handle->response.content != NULL) {
dynreg_handle->sysdep->core_sysdep_free(dynreg_handle->response.content);
memset(&dynreg_handle->response, 0, sizeof(core_http_response_t));
}
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return res;
} else {
res = STATE_SUCCESS;
}
} else {
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
_dynreg_exec_dec(dynreg_handle);
return STATE_HTTP_RECV_NOT_FINISHED;
}
if (dynreg_handle->recv_handler != NULL) {
packet.type = AIOT_DYNREGRECV_STATUS_CODE;
packet.data.status_code.code = dynreg_handle->response.code;
dynreg_handle->recv_handler(dynreg_handle, &packet, dynreg_handle->userdata);
}
res = _dynreg_device_info(dynreg_handle, &device_secret);
dynreg_handle->sysdep->core_sysdep_mutex_unlock(dynreg_handle->data_mutex);
if (res < STATE_SUCCESS) {
_dynreg_exec_dec(dynreg_handle);
return res;
}
memset(&packet, 0, sizeof(aiot_dynreg_recv_t));
if (dynreg_handle->recv_handler != NULL) {
packet.type = AIOT_DYNREGRECV_DEVICE_INFO;
packet.data.device_info.device_secret = device_secret;
dynreg_handle->recv_handler(dynreg_handle, &packet, dynreg_handle->userdata);
}
dynreg_handle->sysdep->core_sysdep_free(device_secret);
_dynreg_exec_dec(dynreg_handle);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg/aiot_dynreg_api.c | C | apache-2.0 | 18,768 |
/**
* @file aiot_dynreg_api.h
* @brief dynreg模块头文件, 提供获取设备信息的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __AIOT_DYNREG_API_H__
#define __AIOT_DYNREG_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0600~-0x06FF表达SDK在dynreg模块内的状态码
*/
#define STATE_DYNREG_BASE (-0x0600)
/**
* @brief 执行@ref aiot_dynreg_deinit 时, 等待其他API执行结束的超过设定的超时时间, MQTT实例销毁失败
*/
#define STATE_DYNREG_DEINIT_TIMEOUT (-0x0601)
/**
* @brief 需要首先执行@ref aiot_dynreg_send_request 发送dynreg请求
*/
#define STATE_DYNREG_NEED_SEND_REQUEST (-0x0602)
/**
* @brief dynreg模块返回了错误的http status code
*/
#define STATE_DYNREG_INVALID_STATUS_CODE (-0x0603)
/**
* @brief 收到非法的device secret
*/
#define STATE_DYNREG_INVALID_DEVICE_SECRET (-0x0604)
/**
* @brief dynreg模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
/**
* @brief dynreg模块返回的http status code
*/
AIOT_DYNREGRECV_STATUS_CODE,
/**
* @brief dynreg模块返回的设备信息
*/
AIOT_DYNREGRECV_DEVICE_INFO,
} aiot_dynreg_recv_type_t;
/**
* @brief dynreg模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_dynreg_recv_type_t
*/
aiot_dynreg_recv_type_t type;
union {
/**
* @brief dynreg模块返回的http status code
*/
struct {
uint32_t code;
} status_code;
/**
* @brief dynreg模块返回的设备信息
*/
struct {
char *device_secret;
} device_info;
} data;
} aiot_dynreg_recv_t;
/**
* @brief dynreg模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle dynreg会话句柄
* @param[in] packet dynreg消息结构体, 存放收到的dynreg报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_dynreg_recv_handler_t)(void *handle,
const aiot_dynreg_recv_t *packet, void *userdata);
/**
* @brief @ref aiot_dynreg_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_dynreg_setopt 中, data参数的数据类型
*
* 1. data的数据类型是char *时, 以配置@ref AIOT_DYNREGOPT_HOST 为例:
*
* char *host = "xxx";
* aiot_dynreg_setopt(dynreg_handle, AIOT_DYNREGOPT_HOST, host);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_DYNREGOPT_PORT 为例:
*
* uint16_t port = 443;
* aiot_mqtt_setopt(dynreg_handle, AIOT_DYNREGOPT_PORT, (void *)&port);
*/
typedef enum {
/**
* @brief http动态注册 服务器建联时, 网络使用的安全凭据
*
* @details
*
* 该配置项用于为底层网络配置@ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 应当把 @ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , 以tls方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_DYNREGOPT_NETWORK_CRED,
/**
* @brief http动态注册 服务器的域名地址或者ip地址
*
* @details
*
* 阿里云物联网平台 http动态注册 服务器域名地址列表:
*
* | 域名地址 | 区域 | 端口号
* |-------------------------------------------------|---------|---------
* | iot-auth.cn-shanghai.aliyuncs.com | 国内 | 443
* | iot-auth.ap-southeast-1.aliyuncs.com | 海外 | 443
*
* 数据类型: (char *)
*/
AIOT_DYNREGOPT_HOST,
/**
* @brief http动态注册 服务器的端口号
*
* @details
*
* 连接阿里云物联网平台 http动态注册 服务器时:
*
* 必须使用tls方式建联, 端口号设置为443
*
* 数据类型: (uint16_t *)
*/
AIOT_DYNREGOPT_PORT,
/**
* @brief 设备的productKey, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGOPT_PRODUCT_KEY,
/**
* @brief 设备的productSecret, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGOPT_PRODUCT_SECRET,
/**
* @brief 设备的deviceName, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_DYNREGOPT_DEVICE_NAME,
/**
* @brief dynreg会话发送消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGOPT_SEND_TIMEOUT_MS,
/**
* @brief dynreg会话接收消息时可消费的最长时间间隔
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGOPT_RECV_TIMEOUT_MS,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户
*
* @details
*
* 数据类型: (aiot_dynreg_http_recv_handler_t)
*/
AIOT_DYNREGOPT_RECV_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 这个上下文指针会在 AIOT_DYNREGOPT_RECV_HANDLER 和 AIOT_DYNREGOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_DYNREGOPT_USERDATA,
/**
* @brief dynreg模块接收消息的超时时间
*
* @details
*
* 数据类型: (uint32_t) 默认值: (5 * 1000) ms
*/
AIOT_DYNREGOPT_TIMEOUT_MS,
/**
* @brief 销毁dynreg实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_dynreg_deinit 销毁MQTT实例时, 若继续调用其他aiot_dynreg_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_dynreg_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_DYNREGOPT_DEINIT_TIMEOUT_MS,
AIOT_DYNREGOPT_MAX
} aiot_dynreg_option_t;
/**
* @brief 创建dynreg会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL dynreg实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_dynreg_init(void);
/**
* @brief 配置dynreg会话
*
* @param[in] handle dynreg会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_dynreg_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_dynreg_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_dynreg_setopt(void *handle, aiot_dynreg_option_t option, void *data);
/**
* @brief 结束dynreg会话, 销毁实例并回收资源
*
* @param[in] handle 指向dynreg会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_dynreg_deinit(void **handle);
/**
* @brief 向dynreg服务器发送dynreg消息请求
*
* @param handle dynreg会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_dynreg_send_request(void *handle);
/**
* @brief 从网络上收取dynreg消息
*
* @param handle dynreg会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 数据接收失败
* @retval >=STATE_SUCCESS 数据接收成功
*/
int32_t aiot_dynreg_recv(void *handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_DYNREG_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg/aiot_dynreg_api.h | C | apache-2.0 | 8,274 |
/**
* @file dynreg_private.h
* @brief dynreg模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __DYNREG_PRIVATE_H__
#define __DYNREG_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
/* TODO: 这一段列出需要包含SDK其它模块头文件, 与上一段落以1个空行隔开 */
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "core_http.h"
#include "aiot_dynreg_api.h" /* 内部头文件是用户可见头文件的超集 */
/* TODO: 定义dynreg模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
aiot_sysdep_network_cred_t *cred; /* 指向当前连接使用的安全凭据 */
char *host; /* 会话目标服务器域名 */
uint16_t port; /* 会话目标服务器端口 */
char *product_key;
char *product_secret;
char *device_name;
aiot_dynreg_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
void *userdata; /* 组件调用以上2个 dynreg_handler 时的入参之一 */
uint32_t recv_timeout_ms; /* 从协议栈收包时最长等待时间 */
uint32_t send_timeout_ms; /* 向协议栈写入时最长花费时间 */
uint32_t timeout_ms;
uint32_t deinit_timeout_ms;
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是DYNREG在内部使用, 用户无感知 ----*/
void *http_handle;
core_http_response_t response;
uint32_t response_body_len;
uint8_t exec_enabled;
uint32_t exec_count;
void *data_mutex; /* 保护本地的数据结构 */
} dynreg_handle_t;
#define DYNREG_MODULE_NAME "dynreg" /* 用于内存统计的模块名字符串 */
#define DYNREG_DEFAULT_TIMEOUT_MS (5 * 1000)
#define DYNREG_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define DYNREG_DEFAULT_RECV_TIMEOUT (5 * 1000)
#define DYNREG_DEFAULT_SEND_TIMEOUT (5 * 1000)
#define DYNREG_PATH "/auth/register/device"
#define DYNREG_DEINIT_INTERVAL_MS (100)
#define DYNREG_RESPONSE_BODY_LEN (192)
#if defined(__cplusplus)
}
#endif
#endif /* __DYNREG_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/dynreg/dynreg_private.h | C | apache-2.0 | 2,714 |
/**
* @file aiot_logpost_api.c
* @brief logpost模块的API接口实现, 提供设备端日志上云的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "logpost_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_mqtt.h"
#include "core_global.h"
#include "aiot_mqtt_api.h"
#define LOGPOST_JSON_KEY_MODE "mode"
const char *logpost_loglevel[] = {
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
};
static void _logpost_config_data_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
logpost_handle_t *logpost_handle = (logpost_handle_t *)userdata;
aiot_logpost_event_t event;
char *value = NULL;
uint32_t value_len = 0;
uint32_t log_switch = 0;
int32_t res = STATE_SUCCESS;
/* construct event message */
memset(&event, 0, sizeof(aiot_logpost_event_t));
event.type = AIOT_LOGPOSTEVT_CONFIG_DATA;
core_log(logpost_handle->sysdep, STATE_LOGPOST_LOG_RECV, "LOGPOST user log config arrived\r\n");
if ((res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
LOGPOST_JSON_KEY_MODE, strlen(LOGPOST_JSON_KEY_MODE), &value, &value_len)) < 0 ||
(res = core_str2uint(value, value_len, &log_switch)) < 0) {
core_log(logpost_handle->sysdep, SATAE_LOGPOST_LOG_PARSE_MSG_FAILED, "LOGPOST parse log config failed\r\n");
return;
}
/* update log config */
logpost_handle->user_log_switch = log_switch;
/* invoke user callback */
if (logpost_handle->event_handler != NULL) {
event.data.config_data.on_off = log_switch;
logpost_handle->event_handler(logpost_handle, &event, logpost_handle->userdata);
}
}
static void _logpost_get_config(logpost_handle_t *logpost_handle)
{
char *topic = NULL;
char *payload = NULL;
char *fmt = "{\"id\":\"%s\",\"version\":\"1.0\",\"params\":{\"getType\":\"content\",\"configScope\":\"device\"}}";
int32_t res = STATE_SUCCESS;
int32_t id = 0;
char *pk = NULL, *dn = NULL;
char id_string[11] = { 0 };
if (NULL == logpost_handle || NULL == logpost_handle->mqtt_handle) {
return;
}
if (NULL == (pk = core_mqtt_get_product_key(logpost_handle->mqtt_handle))) {
return;
}
if (NULL == (dn = core_mqtt_get_device_name(logpost_handle->mqtt_handle))) {
return;
}
core_global_alink_id_next(logpost_handle->sysdep, &id);
core_int2str(id, id_string, NULL);
/* construct topic */
{
char *src[2] = { pk, dn };
res = core_sprintf(logpost_handle->sysdep, &topic, LOGPOST_CONFIG_GET_TOPIC_FMT, src, sizeof(src) / sizeof(char *),
LOGPOST_MODULE_NAME);
if (NULL == topic) {
return;
}
}
/* construct payload */
{
char *src[1] = { id_string };
res = core_sprintf(logpost_handle->sysdep, &payload, fmt,
src, sizeof(src) / sizeof(char *), LOGPOST_MODULE_NAME);
if (res < STATE_SUCCESS) {
logpost_handle->sysdep->core_sysdep_free(topic);
return;
}
}
res = aiot_mqtt_pub(logpost_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), 0);
logpost_handle->sysdep->core_sysdep_free(topic);
logpost_handle->sysdep->core_sysdep_free(payload);
}
int32_t _logpost_send_nwkstats_rtt(logpost_handle_t *handle)
{
int32_t res = STATE_SUCCESS;
aiot_logpost_msg_t msg;
core_mqtt_nwkstats_info_t nwkstats_info;
char *content_fmt = NWKSTAT_RTT_INFO_FMT;
char timestamp_str[22] = {0};
char rtt_str[22] = {0};
char *content = NULL;
char *content_src[] = {timestamp_str, rtt_str};
core_mqtt_get_nwkstats(handle->mqtt_handle, &nwkstats_info);
core_uint642str(nwkstats_info.rtt, rtt_str, NULL);
core_uint642str(handle->sysdep->core_sysdep_time(), timestamp_str, NULL);
res = core_sprintf(handle->sysdep, &content, content_fmt, content_src, 2, LOGPOST_MODULE_NAME);
if (res < 0) {
return res;
}
memset(&msg, 0, sizeof(aiot_logpost_msg_t));
msg.timestamp = 0; /* 单位为ms的时间戳, 填写0则SDK将使用当前的时间戳 */
msg.loglevel = AIOT_LOGPOST_LEVEL_INFO; /* 日志级别 */
msg.module_name = NWKSTAT_NET_RT; /* 日志对应的模块 */
msg.code = 200; /* 状态码 */
msg.msg_id = 0;
msg.content = content; /* 日志内容 */
res = aiot_logpost_send(handle, &msg);
handle->sysdep->core_sysdep_free(content);
return res;
}
int32_t _logpost_send_nwkstats_conn(logpost_handle_t *handle)
{
int32_t res = STATE_SUCCESS;
aiot_logpost_msg_t msg;
core_mqtt_nwkstats_info_t nwkstats_info;
char *content_fmt = NULL;
char success_time[22] = {0};
char conn_time_str[22] = {0};
char failed_time[22] = {0};
char conn_code[12] = {0};
char *content = NULL;
char *content_src[] = {success_time, NULL, conn_time_str, failed_time, NULL, conn_code};
uint8_t content_src_cnt = 0;
core_mqtt_get_nwkstats(handle->mqtt_handle, &nwkstats_info);
if (nwkstats_info.connect_time_used == 0) {
return res;
}
core_uint642str(nwkstats_info.connect_timestamp, success_time, NULL);
content_src[1] = (nwkstats_info.network_type == 0) ? "TCP" : "TLS";
content_src[4] = (nwkstats_info.network_type == 0) ? "TCP" : "TLS";
core_uint642str(nwkstats_info.connect_time_used, conn_time_str, NULL);
core_uint642str(nwkstats_info.failed_timestamp, failed_time, NULL);
core_int2str(nwkstats_info.failed_error_code, conn_code, NULL);
/* check if connect failure happened */
if (nwkstats_info.failed_error_code != 0) {
content_fmt = NWKSTAT_CONN_INFO_FMT2;
content_src_cnt = sizeof(content_src) / sizeof(content_src[0]);
} else {
content_fmt = NWKSTAT_CONN_INFO_FMT;
content_src_cnt = 3;
}
res = core_sprintf(handle->sysdep, &content, content_fmt, content_src, content_src_cnt, LOGPOST_MODULE_NAME);
if (res < 0) {
return res;
}
memset(&msg, 0, sizeof(aiot_logpost_msg_t));
msg.timestamp = 0; /* 单位为ms的时间戳, 填写0则SDK将使用当前的时间戳 */
msg.loglevel = AIOT_LOGPOST_LEVEL_INFO; /* 日志级别 */
msg.module_name = NWKSTAT_NET_CONN; /* 日志对应的模块 */
msg.code = 200; /* 状态码 */
msg.msg_id = 0;
msg.content = content; /* 日志内容 */
res = aiot_logpost_send(handle, &msg);
handle->sysdep->core_sysdep_free(content);
return res;
}
int32_t _should_report_sys_log(logpost_handle_t *logpost_handle, char *module_name)
{
int result = 0;
if (0 == logpost_handle->sys_log_switch) {
return result;
}
if (0 == memcmp(NWKSTAT_NET_CONN, module_name, strlen(NWKSTAT_NET_CONN)) ||
0 == memcmp(NWKSTAT_NET_RT, module_name, strlen(NWKSTAT_NET_RT))) {
result = 1;
core_log(logpost_handle->sysdep, STATE_LOGPOST_LOG_RECV,
"sys log config is on, toggle it using AIOT_LOGPOSTOPT_SYS_LOG.\r\n");
}
return result;
}
void _logpost_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
logpost_handle_t *logpost_handle = (logpost_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
logpost_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
if (NULL == context || NULL == event) {
if (logpost_handle->sys_log_switch == 0) {
return;
}
_logpost_send_nwkstats_conn(logpost_handle);
if ((logpost_handle->sysdep->core_sysdep_time() - logpost_handle->last_post_time) \
> LOGPOST_NWKSTATS_POST_INTERVAL) {
logpost_handle->last_post_time = logpost_handle->sysdep->core_sysdep_time();
_logpost_send_nwkstats_rtt(logpost_handle);
}
return;
}
if (event->type == AIOT_MQTTEVT_CONNECT) {
_logpost_get_config(logpost_handle);
}
}
void *aiot_logpost_init(void)
{
aiot_sysdep_portfile_t *sysdep = aiot_sysdep_get_portfile();
logpost_handle_t *logpost_handle = NULL;
if (NULL == sysdep) {
return NULL;
}
logpost_handle = sysdep->core_sysdep_malloc(sizeof(logpost_handle_t), LOGPOST_MODULE_NAME);
if (NULL == logpost_handle) {
return NULL;
}
memset(logpost_handle, 0, sizeof(logpost_handle_t));
logpost_handle->sysdep = sysdep;
logpost_handle->user_log_switch = LOGPOST_DEFAULT_LOG_ONOFF;
logpost_handle->sys_log_switch = LOGPOST_DEFAULT_LOG_ONOFF;
core_global_init(sysdep);
return logpost_handle;
}
int32_t aiot_logpost_setopt(void *handle, aiot_logpost_option_t option, void *data)
{
logpost_handle_t *logpost_handle;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == data) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_LOGPOSTOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
logpost_handle = (logpost_handle_t *)handle;
switch (option) {
case AIOT_LOGPOSTOPT_MQTT_HANDLE: {
aiot_mqtt_topic_map_t topic_mapping;
logpost_handle->mqtt_handle = data;
core_mqtt_process_data_t process_data;
/* setup mqtt topic mapping */
memset(&topic_mapping, 0, sizeof(aiot_mqtt_topic_map_t));
topic_mapping.topic = LOGPOST_CONFIG_PUSH_TOPIC;
topic_mapping.handler = _logpost_config_data_handler;
topic_mapping.userdata = handle;
res = aiot_mqtt_setopt(data, AIOT_MQTTOPT_APPEND_TOPIC_MAP, &topic_mapping);
if (res < 0) {
break;
}
topic_mapping.topic = LOGPOST_CONFIG_GET_REPLY_TOPIC;
res = aiot_mqtt_setopt(data, AIOT_MQTTOPT_APPEND_TOPIC_MAP, &topic_mapping);
if (res < 0) {
break;
}
/* setup mqtt process handler */
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _logpost_process_handler;
process_data.context = logpost_handle;
res = core_mqtt_setopt(data, CORE_MQTTOPT_APPEND_PROCESS_HANDLER, &process_data);
}
break;
case AIOT_LOGPOSTOPT_EVENT_HANDLER: {
logpost_handle->event_handler = (aiot_logpost_event_handler_t)data;
}
break;
case AIOT_LOGPOSTOPT_USERDATA: {
logpost_handle->userdata = data;
}
break;
case AIOT_LOGPOSTOPT_SYS_LOG: {
logpost_handle->sys_log_switch = *(uint8_t *)data;
}
break;
default:
break;
}
return res;
}
int32_t aiot_logpost_send(void *handle, aiot_logpost_msg_t *msg)
{
logpost_handle_t *logpost_handle = NULL;
char *topic = NULL;
char *payload = NULL;
char *fmt = "{\"id\":\"%s\",\"version\":\"1.0\",\"params\":" \
"[{\"utcTime\":\"%s\",\"logLevel\":\"%s\",\"module\":\"%s\",\"code\":\"%s\",\"traceContext\":\"%s\",\"logContent\":\"%s\"}]}";
char *pk = NULL, *dn = NULL;
int32_t id = 0;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == msg) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (msg->loglevel > AIOT_LOGPOST_LEVEL_DEBUG) {
return STATE_LOGPOST_LOGLEVEL_ERROR;
}
if (NULL == msg->module_name) {
return STATE_LOGPOST_LOG_MODULE_NAME_IS_NULL;
}
if (NULL == msg->content) {
return STATE_LOGPOST_LOG_CONTENT_IS_NULL;
}
if (strlen(msg->content) > LOGPOST_CONTENT_MAXIMUM_LEN) {
return STATE_LOGPOST_LOG_CONTENT_TOO_LONG;
}
if (msg->timestamp > 100000000000000) {
return STATE_USER_INPUT_OUT_RANGE;
}
logpost_handle = (logpost_handle_t *)handle;
if (NULL == logpost_handle->mqtt_handle) {
return STATE_LOGPOST_MQTT_HANDLE_IS_NULL;
}
if (NULL == (pk = core_mqtt_get_product_key(logpost_handle->mqtt_handle))) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (NULL == (dn = core_mqtt_get_device_name(logpost_handle->mqtt_handle))) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (1 != _should_report_sys_log(logpost_handle, msg->module_name) && logpost_handle->user_log_switch == 0) {
return STATE_LOGPOST_POST_TURN_OFF;
}
/* construct topic */
{
char *src[2] = {pk, dn};
res = core_sprintf(logpost_handle->sysdep, &topic, LOGPOST_POST_TOPIC_FMT, src, sizeof(src) / sizeof(char *),
LOGPOST_MODULE_NAME);
if (NULL == topic) {
return res;
}
}
/* construct payload */
{
char id_string[11] = { 0 };
char utc[32] = { 0 };
char code[11] = { 0 };
char msg_id[22] = { 0 };
const char *src[] = { id_string, utc, logpost_loglevel[msg->loglevel], msg->module_name, code, msg_id, msg->content };
core_global_alink_id_next(logpost_handle->sysdep, &id);
core_int2str(id, id_string, NULL);
if (msg->timestamp == 0) {
_core_log_append_date(logpost_handle->sysdep, core_log_get_timestamp(logpost_handle->sysdep), utc);
} else {
_core_log_append_date(logpost_handle->sysdep, msg->timestamp, utc);
}
core_int2str(msg->code, code, NULL);
core_uint642str(msg->msg_id, msg_id, NULL);
res = core_sprintf(logpost_handle->sysdep, &payload, fmt,
(char **)src, sizeof(src) / sizeof(char *), LOGPOST_MODULE_NAME);
if (res < STATE_SUCCESS) {
logpost_handle->sysdep->core_sysdep_free(topic);
return res;
}
}
res = aiot_mqtt_pub(logpost_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), 0);
logpost_handle->sysdep->core_sysdep_free(topic);
logpost_handle->sysdep->core_sysdep_free(payload);
if (res >= STATE_SUCCESS) {
res = id;
}
return res;
}
int32_t aiot_logpost_deinit(void **p_handle)
{
logpost_handle_t *logpost_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
aiot_mqtt_topic_map_t topic_mapping;
core_mqtt_process_data_t process_data;
if (NULL == p_handle || NULL == *p_handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
logpost_handle = *p_handle;
sysdep = logpost_handle->sysdep;
*p_handle = NULL;
/* remove mqtt precess handler */
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _logpost_process_handler;
core_mqtt_setopt(logpost_handle->mqtt_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER, &process_data);
/* remove mqtt topic mapping */
memset(&topic_mapping, 0, sizeof(aiot_mqtt_topic_map_t));
topic_mapping.topic = LOGPOST_CONFIG_PUSH_TOPIC;
topic_mapping.handler = _logpost_config_data_handler;
aiot_mqtt_setopt(logpost_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, &topic_mapping);
topic_mapping.topic = LOGPOST_CONFIG_GET_REPLY_TOPIC;
aiot_mqtt_setopt(logpost_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, &topic_mapping);
sysdep->core_sysdep_free(logpost_handle);
core_global_deinit(sysdep);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/logpost/aiot_logpost_api.c | C | apache-2.0 | 15,623 |
/**
* @file aiot_logpost_api.h
* @brief logpost模块头文件, 提供设备端日志上云的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
* 1. 在使用日志上云模块前, 用户应首先创建好一个MQTT实例
*
* 2. 调用`aiot_logpost_init`创建一个日志上云实例, 保存实例句柄
*
* 3. 调用`aiot_logpost_setopt`配置`AIOT_LOGPOSTOPT_MQTT_HANDLE`选项以设置MQTT句柄, 此选项为强制配置选项
*
* 4. 调用`aiot_logpost_setopt`配置`AIOT_LOGPOSTOPT_EVENT_HANDLER`和`AIOT_LOGPOSTOPT_USER_DATA`选项以注册事件接收回调函数和用户上下文数据指针
*
* 5. 在使用`aiot_logpost_send`发送日志消息前, 应先完成MQTT实例的建连
*
*/
#ifndef __AIOT_LOGPOST_API_H__
#define __AIOT_LOGPOST_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x1500~-0x15FF表达SDK在logpost模块内的状态码
*/
#define STATE_LOGPOST_BASE (-0x1500)
/**
* @brief 用户未调用@ref aiot_logpost_setopt 配置MQTT句柄
*/
#define STATE_LOGPOST_MQTT_HANDLE_IS_NULL (-0x1501)
/**
* @brief 日志上报被云端配置为关闭状态
*/
#define STATE_LOGPOST_POST_TURN_OFF (-0x1502)
/**
* @brief 日志消息的日志级别有误
*/
#define STATE_LOGPOST_LOGLEVEL_ERROR (-0x1503)
/**
* @brief 日志消息的模块名称字段为NULL
*/
#define STATE_LOGPOST_LOG_MODULE_NAME_IS_NULL (-0x1504)
/**
* @brief 日志消息的日志内容字段为NULL
*/
#define STATE_LOGPOST_LOG_CONTENT_IS_NULL (-0x1505)
/**
* @brief 日志消息的日志内容字段字符串长度大于4096个字节
*/
#define STATE_LOGPOST_LOG_CONTENT_TOO_LONG (-0x1506)
/**
* @brief 接收到服务器下行消息时的内部日志状态码
*/
#define STATE_LOGPOST_LOG_RECV (-0x1507)
/**
* @brief 解析服务器下行消息失败时的内部日志状态码
*/
#define SATAE_LOGPOST_LOG_PARSE_MSG_FAILED (-0x1508)
/**
* @brief @ref aiot_logpost_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_logpost_setopt 中, data参数的数据类型
*/
typedef enum {
/**
* @brief 模块依赖的MQTT句柄
*
* @details
*
* LOGPOST模块依赖底层的MQTT模块, 用户必需配置正确的MQTT句柄, 否则无法正常工作, 数据类型为(void *)
*/
AIOT_LOGPOSTOPT_MQTT_HANDLE,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户, 数据类型为(aiot_logpost_recv_handler_t)
*/
AIOT_LOGPOSTOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文, 数据类型为(void *)
*
* @details 这个上下文指针会在 AIOT_LOGPOSTOPT_RECV_HANDLER 设置的回调被调用时, 由SDK传给用户
*/
AIOT_LOGPOSTOPT_USERDATA,
/**
* @brief 系统日志的开关.
*
* @detail 设置为1表示要上报系统日志, 设置为0表示不上报系统日志. 这里的系统日志是指建连耗时和网络延时
*/
AIOT_LOGPOSTOPT_SYS_LOG,
/**
* @brief 配置选项数量最大值, 不可用作配置参数
*/
AIOT_LOGPOSTOPT_MAX,
} aiot_logpost_option_t;
/**
* @brief 日志级别枚举类型定义
*/
typedef enum {
AIOT_LOGPOST_LEVEL_FATAL,
AIOT_LOGPOST_LEVEL_ERR,
AIOT_LOGPOST_LEVEL_WARN,
AIOT_LOGPOST_LEVEL_INFO,
AIOT_LOGPOST_LEVEL_DEBUG,
} aiot_logpost_level_t;
/**
* @brief 日志数据结构体定义
*
*/
typedef struct {
/**
* @brief utc时间戳, 单位为ms, 此数值会直接展示在云端控制台设备日志页面
*/
uint64_t timestamp;
/**
* @brief 日志级别, 请查看@ref aiot_logpost_level_t 定义
*/
aiot_logpost_level_t loglevel;
/**
* @brief 模块名称, <b>必须为以结束符'\0'结尾的字符串</b>
*/
char *module_name;
/**
* @brief 状态码, 可用于标识日志对应的状态
*/
int32_t code;
/**
* @brief 消息标示符, 用于标识云端下行消息, 可从data-module模块的消息接收回调函数中获得对应的标识符, 如果用户设置为0, 此字段将不上传。
*/
uint64_t msg_id;
/**
* @brief 日志内容, <b>必须为以结束符'\0'结尾的字符串</b>
*/
char *content;
} aiot_logpost_msg_t;
/**
* @brief logpost模块内部发生值得用户关注的状态变化时, 通知用户的事件类型
*/
typedef enum {
/**
* @brief 接受到云端下发的日志配置数据
*/
AIOT_LOGPOSTEVT_CONFIG_DATA,
} aiot_logpost_event_type_t;
/**
* @brief logpost模块内部发生值得用户关注的状态变化时, 通知用户的事件内容
*/
typedef struct {
/**
* @brief 事件内容所对应的事件类型, 更多信息请参考@ref aiot_logpost_event_type_t
*/
aiot_logpost_event_type_t type;
union {
/**
* @brief 日志配置数据结构体
*/
struct {
/**
* @brief 日志开关状态, 0: 关闭日志上传; 1: 打开日志上传
*/
uint8_t on_off;
} config_data;
} data;
} aiot_logpost_event_t;
/**
* @brief logpost模块内部发生值得用户关注的状态变化时, 通知用户所调用的事件回调函数
*
* @param[in] handle logpost会话句柄
* @param[in] event logpost模块中发生的事件的内容
* @param[in] userdata 指向用户上下文数据的指针, 这个指针由用户通过调用@ref aiot_logpost_setopt 配置@ref AIOT_LOGPOSTOPT_USERDATA 选项设置
*
* @return void
*/
typedef void (*aiot_logpost_event_handler_t)(void *handle,
const aiot_logpost_event_t *event, void *userdata);
/**
* @brief 创建logpost会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL logpost实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*/
void *aiot_logpost_init(void);
/**
* @brief 配置logpost会话
*
* @param[in] handle logpost会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_logpost_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_logpost_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval STATE_SUCCESS 参数配置成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参handle或data为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参optioin的枚举值>=AIOT_LOGPOSTOPT_MAX
* @retval others 参考@ref aiot_state_api.h
*/
int32_t aiot_logpost_setopt(void *handle, aiot_logpost_option_t option, void *data);
/**
* @brief 向服务器发送日志消息
*
* @param[in] handle logpost会话句柄
* @param[in] msg 消息结构体, 可指定日志对应模块, 日志级别等, 更多信息请参考@ref aiot_logpost_msg_t
*
* @return int32_t
* @retval STATE_SUCCESS 请求发送成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参<i>handle</i>或<i>msg</i>为NULL
* @retval STATE_SYS_DEPEND_MALLOC_FAILED 内存分配失败
* @retval STATE_LOGPOST_MQTT_HANDLE_IS_NULL 用户未调用@ref aiot_logpost_setopt 配置MQTT句柄
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_SHADOW_BASE 中对应的错误码说明
*
*/
int32_t aiot_logpost_send(void *handle, aiot_logpost_msg_t *msg);
/**
* @brief 结束logpost会话, 销毁实例并回收资源
*
* @param[in] handle 指向logpost会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_logpost_deinit(void **handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_LOGPOST_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/logpost/aiot_logpost_api.h | C | apache-2.0 | 8,008 |
/**
* @file logpost_private.h
* @brief logpost模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __LOGPOST_PRIVATE_H__
#define __LOGPOST_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_logpost_api.h"
/* logpost模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *mqtt_handle;
uint8_t user_log_switch;
uint8_t sys_log_switch;
aiot_logpost_event_handler_t event_handler;
void *userdata;
/* network info stats */
uint64_t last_post_time;
} logpost_handle_t;
#define LOGPOST_MODULE_NAME "logpost" /* 用于内存统计的模块名字符串 */
#define LOGPOST_DEFAULT_LOG_ONOFF (0)
#define LOGPOST_CONTENT_MAXIMUM_LEN (4096)
#define LOGPOST_NWKSTATS_POST_INTERVAL (1800000)
/* 上下行topic定义 */
#define LOGPOST_POST_TOPIC_FMT "/sys/%s/%s/thing/log/post"
#define LOGPOST_CONFIG_GET_TOPIC_FMT "/sys/%s/%s/thing/config/log/get"
#define LOGPOST_CONFIG_PUSH_TOPIC "/sys/+/+/thing/config/log/push"
#define LOGPOST_CONFIG_GET_REPLY_TOPIC "/sys/+/+/thing/config/log/get_reply"
#define NWKSTAT_RTT_INFO_FMT "time=%s^rtt=%s"
#define NWKSTAT_CONN_INFO_FMT "time=%s^conn_type=%s^conn_cost=%s^conn_ret=0"
#define NWKSTAT_CONN_INFO_FMT2 "time=%s^conn_type=%s^conn_cost=%s^conn_ret=0,time=%s^conn_type=%s^conn_cost=0^conn_ret=%s"
#define NWKSTAT_NET_RT "net_rt"
#define NWKSTAT_NET_CONN "net_conn"
#if defined(__cplusplus)
}
#endif
#endif /* __LOGPOST_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/logpost/logpost_private.h | C | apache-2.0 | 1,916 |
/**
* @file aiot_mqtt_upload_api.c
* @brief MQTT UPLOAD模块头文件, 提供通过mqtt进行文件上传的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "mqtt_upload_private.h"
#define UPLOAD_GET_U16BIT(h, l) (((h << 8) | l) & 0xFFFF)
#define UPLOAD_GET_U16BIT_HIGH(n) ((n & 0xFF00) >> 8)
#define UPLOAD_GET_U16BIT_LOW(n) (n & 0x00FF)
static int32_t _mqtt_upload_filelist_insert(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task);
static void _mqtt_upload_filelist_destroy(mqtt_upload_handle_t *up_handle);
static int32_t _mqtt_upload_resend_pub(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task);
static void _mqtt_upload_up_task_free(aiot_sysdep_portfile_t *sysdep, upload_file_task_handle_t *up_task);
static void _mqtt_upload_receive_init_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata);
static void _mqtt_upload_receive_upload_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata);
static void _mqtt_upload_receive_cancel_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata);
typedef struct {
char *topic_fmt;
aiot_mqtt_recv_handler_t func;
} _upload_sub_topic_map_t;
static _upload_sub_topic_map_t g_upload_sub_topic_map[MQTT_UPLOAD_DEFAULT_SUBTOPIC_NUM] = {
{
MQTT_UPLOAD_UPLOAD_INIT_REPLY,
_mqtt_upload_receive_init_response_handler
},
{
MQTT_UPLOAD_UPLOAD_FILE_REPLY,
_mqtt_upload_receive_upload_response_handler
},
{
MQTT_UPLOAD_UPLOAD_CANCEL_REPLY,
_mqtt_upload_receive_cancel_response_handler
}
};
/*
* CRC lookup table for bytes, generating polynomial is 0x8005
* input: reflexed (LSB first)
* output: reflexed also...
*/
const static uint16_t crc_ibm_table[256] = {
0x0000, 0xc0c1, 0xc181, 0x0140, 0xc301, 0x03c0, 0x0280, 0xc241,
0xc601, 0x06c0, 0x0780, 0xc741, 0x0500, 0xc5c1, 0xc481, 0x0440,
0xcc01, 0x0cc0, 0x0d80, 0xcd41, 0x0f00, 0xcfc1, 0xce81, 0x0e40,
0x0a00, 0xcac1, 0xcb81, 0x0b40, 0xc901, 0x09c0, 0x0880, 0xc841,
0xd801, 0x18c0, 0x1980, 0xd941, 0x1b00, 0xdbc1, 0xda81, 0x1a40,
0x1e00, 0xdec1, 0xdf81, 0x1f40, 0xdd01, 0x1dc0, 0x1c80, 0xdc41,
0x1400, 0xd4c1, 0xd581, 0x1540, 0xd701, 0x17c0, 0x1680, 0xd641,
0xd201, 0x12c0, 0x1380, 0xd341, 0x1100, 0xd1c1, 0xd081, 0x1040,
0xf001, 0x30c0, 0x3180, 0xf141, 0x3300, 0xf3c1, 0xf281, 0x3240,
0x3600, 0xf6c1, 0xf781, 0x3740, 0xf501, 0x35c0, 0x3480, 0xf441,
0x3c00, 0xfcc1, 0xfd81, 0x3d40, 0xff01, 0x3fc0, 0x3e80, 0xfe41,
0xfa01, 0x3ac0, 0x3b80, 0xfb41, 0x3900, 0xf9c1, 0xf881, 0x3840,
0x2800, 0xe8c1, 0xe981, 0x2940, 0xeb01, 0x2bc0, 0x2a80, 0xea41,
0xee01, 0x2ec0, 0x2f80, 0xef41, 0x2d00, 0xedc1, 0xec81, 0x2c40,
0xe401, 0x24c0, 0x2580, 0xe541, 0x2700, 0xe7c1, 0xe681, 0x2640,
0x2200, 0xe2c1, 0xe381, 0x2340, 0xe101, 0x21c0, 0x2080, 0xe041,
0xa001, 0x60c0, 0x6180, 0xa141, 0x6300, 0xa3c1, 0xa281, 0x6240,
0x6600, 0xa6c1, 0xa781, 0x6740, 0xa501, 0x65c0, 0x6480, 0xa441,
0x6c00, 0xacc1, 0xad81, 0x6d40, 0xaf01, 0x6fc0, 0x6e80, 0xae41,
0xaa01, 0x6ac0, 0x6b80, 0xab41, 0x6900, 0xa9c1, 0xa881, 0x6840,
0x7800, 0xb8c1, 0xb981, 0x7940, 0xbb01, 0x7bc0, 0x7a80, 0xba41,
0xbe01, 0x7ec0, 0x7f80, 0xbf41, 0x7d00, 0xbdc1, 0xbc81, 0x7c40,
0xb401, 0x74c0, 0x7580, 0xb541, 0x7700, 0xb7c1, 0xb681, 0x7640,
0x7200, 0xb2c1, 0xb381, 0x7340, 0xb101, 0x71c0, 0x7080, 0xb041,
0x5000, 0x90c1, 0x9181, 0x5140, 0x9301, 0x53c0, 0x5280, 0x9241,
0x9601, 0x56c0, 0x5780, 0x9741, 0x5500, 0x95c1, 0x9481, 0x5440,
0x9c01, 0x5cc0, 0x5d80, 0x9d41, 0x5f00, 0x9fc1, 0x9e81, 0x5e40,
0x5a00, 0x9ac1, 0x9b81, 0x5b40, 0x9901, 0x59c0, 0x5880, 0x9841,
0x8801, 0x48c0, 0x4980, 0x8941, 0x4b00, 0x8bc1, 0x8a81, 0x4a40,
0x4e00, 0x8ec1, 0x8f81, 0x4f40, 0x8d01, 0x4dc0, 0x4c80, 0x8c41,
0x4400, 0x84c1, 0x8581, 0x4540, 0x8701, 0x47c0, 0x4680, 0x8641,
0x8201, 0x42c0, 0x4380, 0x8341, 0x4100, 0x81c1, 0x8081, 0x4040,
};
static uint16_t crc_ibm(uint8_t const *buffer, size_t len)
{
uint16_t crc = 0x0000;
uint8_t lut;
while (len--) {
lut = (crc ^ (*buffer++)) & 0xFF;
crc = (crc >> 8) ^ crc_ibm_table[lut];
}
return crc;
}
void _mqtt_upload_get_uuid(aiot_sysdep_portfile_t *sysdep, char *uuid) {
uint32_t rand_value = 0;
char uuid_temp[MQTT_UPLOAD_DEFAULT_UUID_SIZE] = {0};
uint8_t len = 0;
sysdep->core_sysdep_rand((uint8_t *)&rand_value, sizeof(rand_value));
memset(uuid_temp, 0, sizeof(uuid_temp));
rand_value = rand_value % 100;
core_uint642str(sysdep->core_sysdep_time(), uuid_temp, &len);
if (len > 13) {
core_int2str(rand_value, &uuid_temp[13], NULL);
} else {
core_int2str(rand_value, &uuid_temp[len], NULL);
}
if (uuid != NULL) {
// Limit length 1 to 15
memcpy(uuid, uuid_temp, 15);
}
}
static int32_t _mqtt_upload_get_payload(aiot_sysdep_portfile_t *sysdep, char *params, char **out)
{
char *payload;
int32_t id = 0;
char id_string[11] = { 0 };
char *src[2] = { NULL };
if (sysdep == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
core_global_alink_id_next(sysdep, &id);
core_int2str(id, id_string, NULL);
src[0] = id_string;
src[1] = params;
int res = core_sprintf(sysdep, &payload, MQTT_UPLOAD_DEFAULT_BASE_FMT, src, sizeof(src) / sizeof(char *),
MQTT_UPLOAD_MODULE_NAME);
*out = payload;
return res;
}
static int32_t _mqtt_upload_get_topic(mqtt_upload_handle_t *up_handle, char **topic, char *fmt)
{
char *topic_string[2] = {NULL};
char *temp_topic = NULL;
int32_t res = STATE_SUCCESS;
if (topic == NULL || fmt == NULL) {
return STATE_MQTT_UPLOAD_PARAMS_IS_NULL;
}
if (up_handle == NULL || up_handle->mqtt_handle == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
topic_string[0] = core_mqtt_get_product_key(up_handle->mqtt_handle);
topic_string[1] = core_mqtt_get_device_name(up_handle->mqtt_handle);
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
res = core_sprintf(sysdep, &temp_topic, fmt, topic_string, sizeof(topic_string) / sizeof(char *),
MQTT_UPLOAD_MODULE_NAME);
*topic = temp_topic;
return res;
}
static int32_t _mqtt_upload_data_encode_package(uint8_t *data, uint32_t data_len, char *head_payload, uint8_t *payload) {
int32_t res = STATE_SUCCESS;
uint16_t crc16 = 0;
if (data == NULL || head_payload == NULL || payload == NULL) {
return STATE_MQTT_UPLOAD_PARAMS_IS_NULL;
}
uint32_t head_len = strlen(head_payload);
uint8_t *pos = payload;
*pos++ = UPLOAD_GET_U16BIT_HIGH(head_len);
*pos++ = UPLOAD_GET_U16BIT_LOW(head_len);
memcpy(pos, head_payload, head_len);
memcpy(pos + head_len, data, data_len);
crc16 = crc_ibm(data, data_len);
*(pos + head_len + data_len) = UPLOAD_GET_U16BIT_LOW(crc16);
*(pos + head_len + data_len + 1) = UPLOAD_GET_U16BIT_HIGH(crc16);
return res;
}
static int32_t _mqtt_upload_creat_string_malloc(aiot_sysdep_portfile_t *sysdep, const char *ch, uint32_t size, char **out) {
if (*out != NULL) {
sysdep->core_sysdep_free(*out);
*out = NULL;
}
*out = sysdep->core_sysdep_malloc(size + 1, MQTT_UPLOAD_MODULE_NAME);
memset(*out, 0, size + 1);
if (ch != NULL) {
memcpy(*out, ch, size);
}
return 0;
}
static int32_t _mqtt_upload_file_task_init(aiot_sysdep_portfile_t *sysdep, upload_file_task_handle_t *up_task, const char *file_name,
const uint32_t file_size, const char *mode, const char *digest, const char *uuid, aiot_mqtt_upload_read_handler_t read_data_handler, void *userdata) {
if (sysdep == NULL || up_task == NULL) {
return STATE_MQTT_UPLOAD_UPTASK_IS_NULL;
}
if (file_name == NULL) {
return STATE_MQTT_UPLOAD_FILENAME_IS_NULL;
}
up_task->file_size = file_size;
up_task->failed_count = 0;
up_task->file_offset = 0;
up_task->status = STATE_MQTT_UPLOAD_REQUEST_INIT;
up_task->read_data_handler = read_data_handler;
up_task->userdata = userdata;
up_task->is_rsp = 0;
up_task->is_destory = 1;
up_task->send_last_time = 0;
_mqtt_upload_creat_string_malloc(sysdep, file_name, strlen(file_name), (char **)&(up_task->file_name));
_mqtt_upload_creat_string_malloc(sysdep, mode, MQTT_UPLOAD_DEFAULT_MODE_MAX_SIZE, (char **)&(up_task->mode));
_mqtt_upload_creat_string_malloc(sysdep, digest, MQTT_UPLOAD_DEFAULT_CRC64_LEN, (char **)&(up_task->crc64));
_mqtt_upload_creat_string_malloc(sysdep, uuid, MQTT_UPLOAD_DEFAULT_UUID_SIZE, (char **)&(up_task->uuid));
_mqtt_upload_creat_string_malloc(sysdep, NULL, MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE, (char **)&(up_task->upload_id));
return STATE_SUCCESS;
}
static int32_t _mqtt_upload_send_request_init(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task, char *file_name,
uint32_t file_size, const char *mode, const char *digest, const char *uuid) {
char *params = NULL, *payload = NULL, *topic = NULL;
char size_string[11] = { 0 };
char *src[6];
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
if (up_handle == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
if (NULL == file_name || mode == NULL) {
return STATE_MQTT_UPLOAD_PARAMS_IS_NULL;
}
sysdep = up_handle->sysdep;
core_int2str(file_size, size_string, NULL);
src[0] = file_name;
src[1] = size_string;
src[2] = (char *)mode;
if (digest == NULL || strlen(digest) == 0) {
src[3] = (char *)uuid;
src[4] = "";
src[5] = "";
if ((res = core_sprintf(sysdep, ¶ms, MQTT_UPLOAD_OPEN_STREAM_PARAM_FMT, src,
sizeof(src) / sizeof(char *) - 2, MQTT_UPLOAD_MODULE_NAME)) != STATE_SUCCESS) {
goto exit;
}
} else {
src[3] = "crc64";
src[4] = (char *)digest;
src[5] = (char *)uuid;
if ((res = core_sprintf(sysdep, ¶ms, MQTT_UPLOAD_OPEN_STREAM_PARAM_FMT_MD5, src,
sizeof(src) / sizeof(char *), MQTT_UPLOAD_MODULE_NAME)) != STATE_SUCCESS) {
goto exit;
}
}
if ((res = _mqtt_upload_get_payload(sysdep, params, &payload)) != STATE_SUCCESS) {
goto exit;
}
_mqtt_upload_get_topic(up_handle, &topic, MQTT_UPLOAD_UPLOAD_INIT);
res = aiot_mqtt_pub(up_handle->mqtt_handle, topic, (uint8_t *)payload, strlen(payload), CORE_MQTT_QOS0);
up_task->send_last_time = sysdep->core_sysdep_time();
exit:
if(topic != NULL) {
sysdep->core_sysdep_free(topic);
}
if(payload != NULL) {
sysdep->core_sysdep_free(payload);
}
if(params != NULL) {
sysdep->core_sysdep_free(params);
}
return res;
}
static int32_t _mqtt_upload_send_block_file(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task, uint8_t *data,
const uint32_t block_size, const uint32_t offset, const uint8_t is_complete)
{
char *params = NULL, *head_payload = NULL, *topic = NULL, *payload = NULL;
char bsize_string[11] = {0}, boffset_string[11] = {0};
char *src[4] = { NULL };
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
uint32_t payload_len = 0;
if (up_handle == NULL || up_handle->mqtt_handle == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
if (data == NULL) {
return STATE_MQTT_UPLOAD_FILE_DATA_IS_NULL;
}
if (up_task == NULL) {
return STATE_MQTT_UPLOAD_UPTASK_IS_NULL;
}
sysdep = up_handle->sysdep;
core_uint2str(block_size, bsize_string, NULL);
core_uint2str(offset, boffset_string, NULL);
src[0] = up_task->upload_id;
src[1] = boffset_string;
src[2] = bsize_string;
if (is_complete == 1) {
src[3] = "true";
} else {
src[3] = "false";
}
if ((res = core_sprintf(sysdep, ¶ms, MQTT_UPLOAD_SEND_DATA_PARAM_FMT, src, sizeof(src) / sizeof(char *),
MQTT_UPLOAD_MODULE_NAME)) != STATE_SUCCESS ) {
goto exit;
}
if ((res = _mqtt_upload_get_payload(sysdep, params, &head_payload)) != STATE_SUCCESS ) {
goto exit;
}
_mqtt_upload_get_topic(up_handle, &topic, MQTT_UPLOAD_UPLOAD_FILE);
payload_len = block_size + strlen(head_payload) + sizeof(uint16_t) + sizeof(uint16_t);
payload = sysdep->core_sysdep_malloc( payload_len, MQTT_UPLOAD_MODULE_NAME);
if (payload == NULL) {
goto exit;
}
memset(payload, 0x00, payload_len);
_mqtt_upload_data_encode_package(data, block_size, head_payload, (uint8_t *)payload);
res = aiot_mqtt_pub(up_handle->mqtt_handle, topic, (uint8_t *)payload, payload_len, CORE_MQTT_QOS0);
up_task->send_last_time = sysdep->core_sysdep_time();
exit:
if(topic != NULL) {
sysdep->core_sysdep_free(topic);
}
if(head_payload != NULL) {
sysdep->core_sysdep_free(head_payload);
}
if(params != NULL) {
sysdep->core_sysdep_free(params);
}
if (payload != NULL) {
sysdep->core_sysdep_free(payload);
}
return res;
}
static int32_t _mqtt_upload_send_request_cancel(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task)
{
char *params = NULL, *payload = NULL, *topic = NULL;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
if (up_handle == NULL || up_task == NULL || up_handle->mqtt_handle == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
sysdep = up_handle->sysdep;
if ((res = core_sprintf(sysdep, ¶ms, MQTT_UPLOAD_CLOSE_STREAM_PARAM_FMT,
&up_task->upload_id, 1, MQTT_UPLOAD_MODULE_NAME)) != STATE_SUCCESS) {
goto exit;
}
if ((res = _mqtt_upload_get_payload(sysdep, params, &payload)) != STATE_SUCCESS) {
goto exit;
}
if ((_mqtt_upload_get_topic(up_handle, &topic, MQTT_UPLOAD_UPLOAD_CANCEL)) != STATE_SUCCESS) {
goto exit;
}
res = aiot_mqtt_pub(up_handle->mqtt_handle, topic, (uint8_t *)payload, strlen(payload), CORE_MQTT_QOS0);
up_task->send_last_time = sysdep->core_sysdep_time();
exit:
if(topic != NULL) {
sysdep->core_sysdep_free(topic);
}
if(payload != NULL) {
sysdep->core_sysdep_free(payload);
}
if(params != NULL) {
sysdep->core_sysdep_free(params);
}
return res;
}
static void _mqtt_upload_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
up_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _mqtt_upload_mqtt_operate_process_handler(mqtt_upload_handle_t *up_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _mqtt_upload_core_mqtt_process_handler;
process_data.context = up_handle;
return core_mqtt_setopt(up_handle->mqtt_handle, option, &process_data);
}
static int32_t _mqtt_upload_parse_json(aiot_sysdep_portfile_t *sysdep, void *input, uint32_t input_len, char *key_word,
char **out)
{
int32_t res = STATE_SUCCESS;
char *value = NULL, *buffer = NULL;
uint32_t value_len = 0, buffer_len = 0;
res = core_json_value((const char *)input, input_len, key_word, strlen(key_word), &value, &value_len);
if (res != STATE_SUCCESS) {
return STATE_MQTT_UPLOAD_PARSE_JSON_FAILED;
}
buffer_len = value_len + 1;
buffer = sysdep->core_sysdep_malloc(buffer_len, MQTT_UPLOAD_MODULE_NAME);
if (NULL == buffer) {
return STATE_MQTT_UPLOAD_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len);
memcpy(buffer, value, value_len);
*out = buffer;
return res;
}
static uint8_t _mqtt_upload_block_size_is_valid(uint32_t block_size, uint8_t is_final) {
/* 长度0无效 */
if (block_size == 0) {
return 0;
}
if (is_final) {
/* 最后一包不大于 MAX Size */
return (block_size > MQTT_UPLOAD_DEFAULT_SEND_MAX_SIZE ? 0 : 1);
} else {
/* Uploading 不能小于256B */
return (block_size < MQTT_UPLOAD_DEFAULT_SEND_MIN_SIZE || block_size > MQTT_UPLOAD_DEFAULT_SEND_MAX_SIZE) ? 0 : 1;
}
}
static void _mqtt_upload_recv_response_process(void *handle, aiot_mqtt_upload_recv_t *packet, upload_file_task_handle_t *up_task)
{
uint8_t *data = NULL;
uint32_t data_len = 0;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
if (handle == NULL || packet == NULL) {
return;
}
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
sysdep = up_handle->sysdep;
switch (packet->type) {
case AIOT_MQTT_UPLOADRECV_CANCEL_REPLY :
/* 取消是否成功 */
if (packet->desc.code == UPLOAD_FILE_OK) {
up_task->status = STATE_MQTT_UPLOAD_CANCEL_SUCCESS;
up_task->failed_count = 0;
} else if (packet->desc.code == UPLOAD_FILE_FILE_BLOCK_DUPLICATION) {
/* 重发cancel */
if (_mqtt_upload_resend_pub(up_handle, up_task) != STATE_SUCCESS) {
up_task->status = STATE_MQTT_UPLOAD_CANCEL_FAILED;
}
} else {
up_task->status = STATE_MQTT_UPLOAD_CANCEL_FAILED;
}
/* 返回取消结果 */
if (up_task->read_data_handler != NULL &&
(up_task->status == STATE_MQTT_UPLOAD_CANCEL_FAILED || up_task->status == STATE_MQTT_UPLOAD_CANCEL_SUCCESS)) {
up_task->read_data_handler(packet, NULL, 0, up_task->userdata);
} else {
return;
}
core_log(sysdep, AIOT_MQTT_UPLOADRECV_CANCEL_REPLY, "AIOT_MQTT_UPLOADRECV_CANCEL_REPLY.\r\n");
break;
case AIOT_MQTT_UPLOADRECV_INIT_REPLY :
case AIOT_MQTT_UPLOADRECV_UPLOAD_REPLY :
if (packet->desc.code == UPLOAD_FILE_OK) {
up_task->is_rsp = 1;
up_task->failed_count = 0;
up_task->file_offset = packet->desc.file_offset + packet->desc.block_size;
if (packet->desc.complete == 1) {
up_task->status = STATE_MQTT_UPLOAD_FINISHED;
core_log1(sysdep, up_task->status,
"Complete upload total size:%d\r\n", &up_task->file_offset);
return;
}
up_task->status = STATE_MQTT_UPLOAD_IS_UPLOADING;
packet->desc.file_offset += packet->desc.block_size;
if (up_task->data == NULL) {
up_task->data = sysdep->core_sysdep_malloc(up_handle->default_block_size, MQTT_UPLOAD_MODULE_NAME);
}
data = up_task->data;
data_len = 0;
if (up_task->read_data_handler != NULL) {
data_len = up_task->read_data_handler(packet, data, up_handle->default_block_size, up_task->userdata);
} else {
return;
}
core_log1(sysdep, STATE_MQTT_UPLOAD_PROCESS_REPLY_ERROR, "Read data_len:%d\r\n", &data_len);
if (data_len != 0 && data != NULL &&
(_mqtt_upload_block_size_is_valid(data_len, ((up_task->file_offset + data_len) >= up_task->file_size) ? 1 : 0))) {
if ((res = _mqtt_upload_send_block_file(up_handle, up_task, data, data_len, up_task->file_offset, 0)) == STATE_SUCCESS) {
up_task->block_size = data_len;
} else {
up_task->status = STATE_MQTT_UPLOAD_FAILED;
}
} else {
up_task->status = STATE_MQTT_UPLOAD_FAILED;
}
return;
} else if (packet->desc.code == UPLOAD_FILE_FAILED_BLOCK_CRC) {
/* CRC校验失败重新发送当前blcok */
_mqtt_upload_resend_pub(up_handle, up_task);
} else {
if (packet->desc.code == UPLOAD_FILE_FAILED_WHOLE_CHECK) {
up_task->status = STATE_MQTT_UPLOAD_FAILED_WHOLE_CHECK;
} else if(packet->desc.code == UPLOAD_FILE_HAVE_FINISHED) {
up_task->status = STATE_MQTT_UPLOAD_FINISHED;
} else {
up_task->status = STATE_MQTT_UPLOAD_FAILED;
}
/* 其他异常发送失败，结束发送 */
if (up_task->read_data_handler != NULL) {
up_task->read_data_handler(packet, NULL, 0, up_handle);
}
}
break;
default:
break;
}
}
static void _mqtt_upload_desc_free(aiot_sysdep_portfile_t *sysdep, aiot_mqtt_upload_recv_t *msg) {
if (msg->desc.file_name != NULL) {
sysdep->core_sysdep_free(msg->desc.file_name);
}
if (msg->desc.upload_id != NULL) {
sysdep->core_sysdep_free(msg->desc.upload_id);
}
if (msg->desc.message != NULL) {
sysdep->core_sysdep_free(msg->desc.message);
}
}
static void _mqtt_upload_desc_new(aiot_sysdep_portfile_t *sysdep, aiot_mqtt_upload_recv_t *packet,
aiot_mqtt_upload_recv_t *out_packet) {
if (packet->desc.file_name != NULL) {
if (out_packet->desc.file_name == NULL) {
_mqtt_upload_creat_string_malloc(sysdep, packet->desc.file_name, strlen(packet->desc.file_name),
(char **)&(out_packet->desc.file_name));
} else {
memcpy(out_packet->desc.file_name, packet->desc.file_name, strlen(packet->desc.file_name));
}
}
if (packet->desc.upload_id != NULL) {
if (out_packet->desc.upload_id == NULL) {
_mqtt_upload_creat_string_malloc(sysdep, packet->desc.upload_id, strlen(packet->desc.upload_id),
(char **)&(out_packet->desc.upload_id));
} else {
memcpy(out_packet->desc.upload_id, packet->desc.upload_id, strlen(packet->desc.upload_id));
}
}
out_packet->desc.file_size = packet->desc.file_size;
out_packet->desc.file_offset = packet->desc.file_offset;
out_packet->desc.block_size = packet->desc.block_size;
out_packet->desc.code = packet->desc.code;
}
static void _mqtt_upload_desc_copy(aiot_sysdep_portfile_t *sysdep, aiot_mqtt_upload_recv_t *packet,
aiot_mqtt_upload_recv_t *out_packet) {
if (packet->desc.file_name != NULL) {
out_packet->desc.file_name = packet->desc.file_name;
}
if (packet->desc.upload_id != NULL) {
out_packet->desc.upload_id = packet->desc.upload_id;
}
out_packet->desc.file_size = packet->desc.file_size;
out_packet->desc.file_offset = packet->desc.file_offset;
out_packet->desc.block_size = packet->desc.block_size;
out_packet->desc.code = packet->desc.code;
}
static void _mqtt_upload_receive_init_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata) {
mqtt_upload_handle_t *up_handle = NULL;
char *value = NULL, *code_string = NULL, *offset_string = NULL, *filesize_string = NULL;
uint32_t value_len = 0;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
upload_file_task_handle_t *up_task = NULL;
uint32_t payload_len = 0;
char *payload = NULL;
aiot_mqtt_upload_recv_t msg = {
.type = AIOT_MQTT_UPLOADRECV_INIT_REPLY,
.desc.file_name = NULL,
.desc.upload_id = NULL,
.desc.message = NULL
};
memset(&msg.desc, 0, sizeof(aiot_mqtt_upload_desc_t));
if (AIOT_MQTTRECV_PUB != packet->type) {
return;
}
/* Sub Topic Set userdata*/
if (userdata == NULL) {
return;
}
up_handle = (mqtt_upload_handle_t *)userdata;
sysdep = up_handle->sysdep;
payload = (char *)packet->data.pub.payload;
payload_len = packet->data.pub.payload_len;
/* Parse ID & Code & message */
if ((res = core_json_value((char *)payload, payload_len, "id", strlen("id"),
&value, &value_len)) != STATE_SUCCESS) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "recv handle parse err id\r\n");
}
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "code", &(code_string))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "json parse error errCode\r\n");
goto exit;
}
core_str2uint(code_string, strlen(code_string), &msg.desc.code);
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "message", &(msg.desc.message))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "json parse error errMsg\r\n");
goto exit;
}
/* Data */
if ((res = core_json_value((char *)payload, payload_len, "data", strlen("data"),
&value, &value_len)) < 0 ) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "json parse error data\r\n");
goto exit;
}
{
/* Parse Json Object */
char *data = (char *)value;
uint32_t data_len = value_len;
if ((STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "fileName", &(msg.desc.file_name)))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "json parse error fileName\r\n");
goto exit;
}
if (msg.desc.code == UPLOAD_FILE_OK) {
if ((STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "uploadId", &(msg.desc.upload_id)))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "json parse error uploadId\r\n");
goto exit;
}
} else {
msg.desc.upload_id = NULL;
}
if ((STATE_SUCCESS == _mqtt_upload_parse_json(sysdep, data, data_len, "offset", &(offset_string)))) {
core_str2uint(offset_string, strlen(offset_string), &msg.desc.file_offset);
} else {
msg.desc.file_offset = 0;
}
if ((STATE_SUCCESS == _mqtt_upload_parse_json(sysdep, data, data_len, "fileSize", &(filesize_string)))) {
core_str2uint(filesize_string, strlen(filesize_string), &msg.desc.file_size);
} else {
msg.desc.file_size = 0;
}
}
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
core_list_for_each_entry(up_task, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (msg.desc.file_name != NULL && up_task->file_name != NULL &&
memcmp(msg.desc.file_name, up_task->file_name, strlen(up_task->file_name)) == 0) {
if (msg.desc.upload_id == NULL) {
/* Upload 为空异常 */
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_INIT_FAILED, "[ERROR] Receive uploadID is NULL.\r\n");
} else {
if (up_task->upload_id == NULL) {
/* 第一次收到云端应答 */
if ((up_task->upload_id =
sysdep->core_sysdep_malloc(strlen(msg.desc.upload_id) + 1, MQTT_UPLOAD_MODULE_NAME)) == NULL) {
core_log(sysdep, STATE_MQTT_UPLOAD_MALLOC_FAILED, "Malloc upload_id error.\r\n");
} else {
memset(up_task->upload_id, 0, strlen(msg.desc.upload_id) + 1);
memcpy(up_task->upload_id, msg.desc.upload_id, strlen(msg.desc.upload_id));
msg.desc.block_size = 0;
}
} else {
/* 重复收到云端应答 */
memset(up_task->upload_id, 0, strlen(msg.desc.upload_id) + 1);
memcpy(up_task->upload_id, msg.desc.upload_id, strlen(msg.desc.upload_id));
msg.desc.block_size = 0;
}
}
up_task->is_rsp = 1;
up_task->rsp_code = msg.desc.code;
_mqtt_upload_desc_new(up_handle->sysdep, &msg, &up_task->packet);
_mqtt_upload_recv_response_process(up_handle, &msg, up_task);
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
core_log1(sysdep, STATE_MQTT_UPLOAD_RECV_UPLOADID_ERROR, "Recv file name:%s\r\n", msg.desc.file_name);
exit:
if (code_string != NULL) {
sysdep->core_sysdep_free(code_string);
}
if (offset_string != NULL) {
sysdep->core_sysdep_free(offset_string);
}
if (filesize_string != NULL) {
sysdep->core_sysdep_free(filesize_string);
}
_mqtt_upload_desc_free(sysdep, &msg);
}
static void _mqtt_upload_receive_upload_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata) {
mqtt_upload_handle_t *up_handle = NULL;
char *value = NULL;
uint32_t value_len = 0;
int32_t res = STATE_SUCCESS;
char *offset_string = NULL, *bsize_string = NULL, *code_string = NULL, *complete_string = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
upload_file_task_handle_t *up_task = NULL;
uint32_t payload_len = 0;
char *payload = NULL;
aiot_mqtt_upload_recv_t msg = {
.type = AIOT_MQTT_UPLOADRECV_UPLOAD_REPLY,
.desc.file_name = NULL,
.desc.upload_id = NULL,
.desc.message = NULL
};
memset(&msg.desc, 0, sizeof(aiot_mqtt_upload_desc_t));
if (AIOT_MQTTRECV_PUB != packet->type) {
return;
}
if (userdata == NULL) {
return;
}
up_handle = (mqtt_upload_handle_t *)userdata;
sysdep = up_handle->sysdep;
payload = (char *)packet->data.pub.payload;
payload_len = packet->data.pub.payload_len;
if ((res = core_json_value((char *)payload, payload_len, "id", strlen("id"),
&value, &value_len)) < 0) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "recv handle parse err id\r\n");
}
/* Result Code && message */
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "code", &(code_string))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error errCode\r\n");
goto exit;
}
core_str2uint(code_string, strlen(code_string), &msg.desc.code);
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "message", &(msg.desc.message))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error errMsg\r\n");
goto exit;
}
/* Parse data object */
if ((res = core_json_value((char *)payload, payload_len, "data", strlen("data"),
&value, &value_len)) < 0 ) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error data\r\n");
goto exit;
}
{
char *data = (char *)value;
uint32_t data_len = value_len;
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "uploadId", &(msg.desc.upload_id))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error uploadId\r\n");
goto exit;
}
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "offset", &(offset_string))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error offset\r\n");
goto exit;
}
core_str2uint(offset_string, strlen(offset_string), &msg.desc.file_offset);
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "bSize", &(bsize_string))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED, "json parse error bSize\r\n");
goto exit;
}
core_str2uint(bsize_string, strlen(bsize_string), &msg.desc.block_size);
/* 只有最后一包应答消息包括complete */
if (STATE_SUCCESS == _mqtt_upload_parse_json(sysdep, data, data_len, "complete", &(complete_string))) {
msg.desc.complete = (memcmp(complete_string, "true", strlen(complete_string)) == 0 ? 1 : 0);
} else {
msg.desc.complete = 0xFF;
}
}
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
core_list_for_each_entry(up_task, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (msg.desc.upload_id != NULL && up_task->upload_id != NULL &&
memcmp(msg.desc.upload_id, up_task->upload_id, strlen(msg.desc.upload_id)) == 0) {
if (up_task->status != STATE_MQTT_UPLOAD_IS_UPLOADING) {
/* 状态为非上传状态 */
break;
}
/* offset & block size 不同 忽略 */
if (msg.desc.file_offset != up_task->file_offset ||
msg.desc.block_size != up_task->block_size) {
/* 和上传的offset ，bszie不同,忽略，等待超时重发 */
core_log2(sysdep, STATE_MQTT_UPLOAD_RECV_FILE_INFO_ERROR, "Receive upload ACK error,file_offset:%d, block_szie:%d\r\n",
&msg.desc.file_offset, &msg.desc.block_size);
} else {
/* Modified File offset */
uint32_t name_size = strlen(up_task->file_name) + 1;
msg.desc.file_name = sysdep->core_sysdep_malloc(name_size, MQTT_UPLOAD_MODULE_NAME);
memset(msg.desc.file_name, 0, name_size);
memcpy(msg.desc.file_name, up_task->file_name, strlen(up_task->file_name));
up_task->is_rsp = 1;
up_task->rsp_code = msg.desc.code;
_mqtt_upload_recv_response_process(up_handle, &msg, up_task);
}
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
exit:
if (offset_string != NULL) {
sysdep->core_sysdep_free(offset_string);
}
if (bsize_string != NULL) {
sysdep->core_sysdep_free(bsize_string);
}
if (code_string != NULL) {
sysdep->core_sysdep_free(code_string);
}
if (complete_string != NULL) {
sysdep->core_sysdep_free(complete_string);
}
_mqtt_upload_desc_free(sysdep, &msg);
return;
}
static void _mqtt_upload_receive_cancel_response_handler(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata) {
mqtt_upload_handle_t *up_handle = NULL;
char *code_string = NULL, *value = NULL;
uint32_t value_len = 0;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
upload_file_task_handle_t *up_task = NULL;
uint32_t payload_len = 0;
char *payload = NULL;
aiot_mqtt_upload_recv_t msg = {
.type = AIOT_MQTT_UPLOADRECV_CANCEL_REPLY,
};
memset(&msg.desc, 0, sizeof(aiot_mqtt_upload_desc_t));
if (AIOT_MQTTRECV_PUB != packet->type) {
return;
}
if (userdata == NULL) {
return;
}
up_handle = (mqtt_upload_handle_t *)userdata;
sysdep = up_handle->sysdep;
payload = (char *)packet->data.pub.payload;
payload_len = packet->data.pub.payload_len;
if ((res = core_json_value((char *)payload, payload_len, "id", strlen("id"),
&value, &value_len)) < 0) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED, "recv handle parse err id\r\n");
}
/* Result Code && Message. */
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "code", &(code_string))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED, "json parse error errCode\r\n");
goto exit;
}
core_str2uint(code_string, strlen(code_string), &msg.desc.code);
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, payload, payload_len, "message", &(msg.desc.message))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED, "json parse error errMsg\r\n");
goto exit;
}
/* Parse data object */
if ((res = core_json_value((char *)payload, payload_len, "data", strlen("data"),
&value, &value_len)) < 0 ) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED, "json parse error data\r\n");
goto exit;
}
{
char *data = (char *)value;
uint32_t data_len = value_len;
if (STATE_SUCCESS != _mqtt_upload_parse_json(sysdep, data, data_len, "uploadId", &(msg.desc.upload_id))) {
core_log(sysdep, STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED, "json parse error uploadId\r\n");
goto exit;
}
}
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
core_list_for_each_entry(up_task, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (msg.desc.upload_id != NULL && up_task->upload_id != NULL &&
memcmp(msg.desc.upload_id, up_task->upload_id, strlen(up_task->upload_id)) == 0) {
if (up_task->status == STATE_MQTT_UPLOAD_NONE) {
break;
}
up_task->is_rsp = 1;
up_task->rsp_code = msg.desc.code;
_mqtt_upload_recv_response_process(up_handle, &msg, up_task);
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
exit:
if (code_string != NULL) {
sysdep->core_sysdep_free(code_string);
}
_mqtt_upload_desc_free(sysdep, &msg);
}
static int32_t _mqtt_upload_subscribe(void *mqtt_handle, mqtt_upload_handle_t *up_handle)
{
uint8_t i = 0;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
if(up_handle == NULL || mqtt_handle ==NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
sysdep = up_handle->sysdep;
for (i = 0; i < MQTT_UPLOAD_DEFAULT_SUBTOPIC_NUM; i++) {
char *topic_src[] = {core_mqtt_get_product_key(mqtt_handle), core_mqtt_get_device_name(mqtt_handle)};
char *topic = g_upload_sub_topic_map[i].topic_fmt;
res = core_sprintf(sysdep, &topic, g_upload_sub_topic_map[i].topic_fmt, topic_src, sizeof(topic_src) / sizeof(char *),
MQTT_UPLOAD_MODULE_NAME);
if (res != STATE_SUCCESS) {
break;
}
res = aiot_mqtt_sub(mqtt_handle, topic, g_upload_sub_topic_map[i].func, 0, (void *)up_handle);
sysdep->core_sysdep_free(topic);
if (res < 0) {
break;
}
}
return res;
}
static int32_t _mqtt_upload_unsubscribe(mqtt_upload_handle_t *up_handle)
{
uint8_t i = 0;
int32_t res = STATE_SUCCESS;
aiot_sysdep_portfile_t *sysdep = NULL;
if(up_handle == NULL || up_handle->mqtt_handle ==NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
sysdep = up_handle->sysdep;
for (i = 0; i < MQTT_UPLOAD_DEFAULT_SUBTOPIC_NUM; i++) {
char *topic_src[] = {core_mqtt_get_product_key(up_handle->mqtt_handle), core_mqtt_get_device_name(up_handle->mqtt_handle)};
char *topic = g_upload_sub_topic_map[i].topic_fmt;
res = core_sprintf(sysdep, &topic, g_upload_sub_topic_map[i].topic_fmt, topic_src, sizeof(topic_src) / sizeof(char *),
MQTT_UPLOAD_MODULE_NAME);
if (res != STATE_SUCCESS) {
break;
}
res = aiot_mqtt_unsub(up_handle->mqtt_handle, topic);
sysdep->core_sysdep_free(topic);
if (res < 0) {
break;
}
}
return res;
}
static int32_t _mqtt_upload_resend_pub(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task) {
int32_t res = STATE_SUCCESS;
if (up_handle == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
// /* 未知长度上传时使用aiot_mqtt_upload_send_data接口,不处理重发逻辑 */
if (up_task->send_last_time == 0 || up_task->file_size == -1 ||
up_task->status == STATE_MQTT_UPLOAD_REQUEST_INIT) {
return res;
}
core_log(up_handle->sysdep, STATE_MQTT_UPLOAD_FAILED_TIMEOUT, "Resend pub\r\n");
up_task->failed_count++;
if (up_task->failed_count >= up_handle->retry_max_value) {
up_task->status = STATE_MQTT_UPLOAD_FAILED_TIMEOUT;
up_task->failed_count = 0;
return STATE_MQTT_UPLOAD_FAILED_TIMEOUT;
}
if (up_task->status == STATE_MQTT_UPLOAD_IS_UPLOADING && up_task->block_size != 0) {
res = _mqtt_upload_send_block_file(up_handle, up_task, up_task->data, up_task->block_size, up_task->file_offset, 0);
} else if (up_task->status == STATE_MQTT_UPLOAD_REQUEST_CANCEL) {
res = _mqtt_upload_send_request_cancel(up_handle, up_task);
}
return res;
}
static int32_t _mqtt_upload_filelist_insert(mqtt_upload_handle_t *up_handle, upload_file_task_handle_t *up_task)
{
upload_file_task_handle_t *node = NULL;
core_list_for_each_entry(node, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
/* 文件名存在 */
if (memcmp(node->file_name, up_task->file_name, strlen(node->file_name)) == 0) {
return STATE_SUCCESS;
}
}
node = up_task;
CORE_INIT_LIST_HEAD(&node->linked_node);
core_list_add_tail(&node->linked_node, &up_handle->file_list);
return STATE_SUCCESS;
}
static void _mqtt_upload_filelist_destroy(mqtt_upload_handle_t *up_handle)
{
upload_file_task_handle_t *node = NULL, *next = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = up_handle->sysdep;
core_list_for_each_entry_safe(node, next, &up_handle->file_list,
linked_node, upload_file_task_handle_t) {
while (!node->is_destory)
{
sysdep->core_sysdep_sleep(1);
}
core_list_del(&node->linked_node);
_mqtt_upload_up_task_free(sysdep, node);
}
}
static void _mqtt_upload_up_task_free(aiot_sysdep_portfile_t *sysdep, upload_file_task_handle_t *up_task) {
if (sysdep == NULL || up_task == NULL) {
return;
}
if (up_task->file_name != NULL) {
sysdep->core_sysdep_free(up_task->file_name);
}
if (up_task->upload_id != NULL) {
sysdep->core_sysdep_free(up_task->upload_id);
}
if (up_task->mode != NULL) {
sysdep->core_sysdep_free(up_task->mode);
}
if (up_task->crc64 != NULL) {
sysdep->core_sysdep_free(up_task->crc64);
}
if (up_task->uuid != NULL) {
sysdep->core_sysdep_free(up_task->uuid);
}
if (up_task->data != NULL) {
sysdep->core_sysdep_free(up_task->data);
}
_mqtt_upload_desc_free(sysdep, &up_task->packet);
if (up_task != NULL) {
sysdep->core_sysdep_free(up_task);
}
}
void *aiot_mqtt_upload_init(void)
{
mqtt_upload_handle_t *up_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
up_handle = sysdep->core_sysdep_malloc(sizeof(mqtt_upload_handle_t), MQTT_UPLOAD_MODULE_NAME);
if (up_handle == NULL) {
return NULL;
}
memset(up_handle, 0, sizeof(mqtt_upload_handle_t));
/* Init upload param. */
up_handle->sysdep = sysdep;
up_handle->rsp_timeout = MQTT_UPLOAD_DEFAULT_RSP_TIMEOUT;
up_handle->retry_max_value = MQTT_UPLOAD_DEFAULT_RETRY_MAX_COUNT;
up_handle->default_block_size = MQTT_UPLOAD_DEFAULT_BLOCK_SIZE;
/* Init upload mutex. */
up_handle->data_mutex = sysdep->core_sysdep_mutex_init();
up_handle->send_mutex = sysdep->core_sysdep_mutex_init();
up_handle->open_mutex = sysdep->core_sysdep_mutex_init();
up_handle->uptask_mutex = sysdep->core_sysdep_mutex_init();
CORE_INIT_LIST_HEAD(&up_handle->file_list);
core_log(up_handle->sysdep, STATE_MQTT_UPLOAD_HANDLE_INIT, "aiot_mqtt_upload_init init\r\n");
return (mqtt_upload_handle_t *)up_handle;
}
int32_t aiot_mqtt_upload_deinit(void **handle)
{
int32_t res = STATE_SUCCESS;
mqtt_upload_handle_t *up_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
if (NULL == handle || NULL == *handle) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
up_handle = * (mqtt_upload_handle_t **)handle;
sysdep = up_handle->sysdep;
core_log(sysdep, STATE_MQTT_UPLOAD_HANDLE_DEINIT, "aiot_mqtt_upload_deinit\r\n");
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
_mqtt_upload_filelist_destroy(up_handle);
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
if (NULL != up_handle->mqtt_handle) {
_mqtt_upload_unsubscribe((mqtt_upload_handle_t *)up_handle);
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _mqtt_upload_core_mqtt_process_handler;
process_data.context = handle;
core_mqtt_setopt(up_handle->mqtt_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER, &process_data);
}
/* Deinit upload mutex. */
sysdep->core_sysdep_mutex_deinit(&up_handle->data_mutex);
sysdep->core_sysdep_mutex_deinit(&up_handle->send_mutex);
sysdep->core_sysdep_mutex_deinit(&up_handle->open_mutex);
sysdep->core_sysdep_mutex_deinit(&up_handle->uptask_mutex);
sysdep->core_sysdep_free(up_handle);
*handle = NULL;
return res;
}
void _upload_get_crc64_hexstr(void *digest, char *crc64_str) {
uint64_t crc64 = 0;
uint64_t tmp = 1;
uint8_t crc64_temp[8] = {0};
if (digest != NULL) {
crc64 = *(uint64_t *)digest;
/* 转成16进制字符串,忽略大小端 */
tmp = 1;
for(uint8_t i = 0; i < 8; i++)
{
crc64_temp[7 - i] = ((crc64 / tmp) % 256) & 0xFF;
tmp *= 256;
}
core_hex2str(crc64_temp, 8, crc64_str, 1);
}
}
int32_t aiot_mqtt_upload_setopt(void *handle, aiot_mqtt_upload_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == data) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_MQTT_UPLOADOPT_MAX) {
return STATE_USER_INPUT_UNKNOWN_OPTION;
}
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
sysdep->core_sysdep_mutex_lock(up_handle->data_mutex);
switch (option) {
case AIOT_MQTT_UPLOADOPT_RETRY_COUNT: {
up_handle->retry_max_value = *(uint32_t *)data;
}
break;
case AIOT_MQTT_UPLOADOPT_RSP_TIMEOUT_MS: {
if (*(uint32_t *)data != 0) {
up_handle->rsp_timeout = *(uint32_t *)data;
}
}
break;
case AIOT_MQTT_UPLOADOPT_MQTT_HANDLE: {
up_handle->mqtt_handle = data;
res = _mqtt_upload_subscribe(data, up_handle);
if (res >= STATE_SUCCESS) {
res = _mqtt_upload_mqtt_operate_process_handler(up_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
}
break;
case AIOT_MQTT_UPLOADOPT_DEFAULLT_BLOCK_SIZE: {
if (_mqtt_upload_block_size_is_valid(*(uint32_t *)data, 0)) {
up_handle->default_block_size = *(uint32_t *)data;
} else {
res = STATE_MQTT_UPLOAD_BLOCK_SIZE_ERROR;
}
}
break;
case AIOT_MQTT_UPLOADOPT_FILE_OPTION : {
aiot_mqtt_upload_file_opt_t file_opt = *(aiot_mqtt_upload_file_opt_t *)data;
upload_file_task_handle_t *up_task = NULL;
up_handle->sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
core_list_for_each_entry(up_task, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (memcmp(file_opt.file_name, up_task->file_name, strlen(up_task->file_name)) == 0) {
up_handle->sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
return res;
}
}
/* 文件名不存在，发起新的请求 */
up_task = up_handle->sysdep->core_sysdep_malloc(sizeof(upload_file_task_handle_t), MQTT_UPLOAD_MODULE_NAME);
memset(up_task, 0, sizeof(upload_file_task_handle_t));
char uuid[MQTT_UPLOAD_DEFAULT_UUID_SIZE] = {0};
memset(uuid, 0, sizeof(uuid));
_mqtt_upload_get_uuid(up_handle->sysdep, uuid);
up_task->is_rsp = 0;
char crc64_str[MQTT_UPLOAD_DEFAULT_CRC64_LEN] = {0};
memset(crc64_str, 0, MQTT_UPLOAD_DEFAULT_CRC64_LEN);
_upload_get_crc64_hexstr(file_opt.digest, crc64_str);
_mqtt_upload_file_task_init(up_handle->sysdep, up_task, file_opt.file_name,
file_opt.file_size, file_opt.mode, crc64_str, uuid, file_opt.read_data_handler,
file_opt.userdata);
_mqtt_upload_filelist_insert(up_handle, up_task);
up_handle->sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
sysdep->core_sysdep_mutex_unlock(up_handle->data_mutex);
return res;
}
int32_t aiot_mqtt_upload_open_stream(void *handle, char *file_name, aiot_mqtt_upload_recv_t *packet) {
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
int32_t res = STATE_SUCCESS;
uint64_t now = 0;
uint8_t file_flag = 0;
if (NULL == up_handle) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
if (up_handle->sysdep == NULL) {
return STATE_MQTT_UPLOAD_MQTT_SYSDEP_IS_NULL;
}
if (file_name == NULL) {
return STATE_MQTT_UPLOAD_PARAMS_IS_NULL;
}
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
file_flag = 0;
sysdep->core_sysdep_mutex_lock(up_handle->open_mutex);
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
upload_file_task_handle_t *up_task = NULL;
core_list_for_each_entry(up_task, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (memcmp(file_name, up_task->file_name, strlen(up_task->file_name)) == 0) {
/* 请求文件信息已经存在，重新请求 */
up_task->is_rsp = 0;
if ((res = _mqtt_upload_send_request_init(up_handle, up_task, up_task->file_name,
up_task->file_size, up_task->mode, up_task->crc64, up_task->uuid)) == STATE_SUCCESS) {
up_task->failed_count = 0;
up_task->is_destory = 0;
}
file_flag = 1;
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
if (file_flag != 1) {
sysdep->core_sysdep_mutex_unlock(up_handle->open_mutex);
return STATE_MQTT_UPLOAD_UPTASK_IS_NULL;
}
if (res != STATE_SUCCESS) {
up_task->is_destory = 1;
sysdep->core_sysdep_mutex_unlock(up_handle->open_mutex);
return res;
}
now = sysdep->core_sysdep_time();
while (up_task->is_rsp == 0) {
if((sysdep->core_sysdep_time() - now) > up_handle->rsp_timeout) {
core_log(sysdep, STATE_MQTT_UPLOAD_FAILED_TIMEOUT, "Wait init response timeout.\r\n");
break;
}
sysdep->core_sysdep_sleep(MQTT_UPLOAD_SYNC_API_SLEEP_MS);
}
if (up_task->is_rsp == 0) {
res = STATE_MQTT_UPLOAD_FAILED_TIMEOUT;
goto exit;
}
if (up_task->rsp_code != UPLOAD_FILE_OK) {
res = STATE_MQTT_UPLOAD_FAILED;
goto exit;
}
if (packet != NULL) {
_mqtt_upload_desc_copy(sysdep, &up_task->packet, packet);
}
exit:
up_task->is_destory = 1;
sysdep->core_sysdep_mutex_unlock(up_handle->open_mutex);
return res;
}
int32_t aiot_mqtt_upload_cancel_stream(void *handle, char *file_name) {
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
int32_t res = STATE_MQTT_UPLOAD_NO_UPLOAD_TASK;
if (NULL == up_handle || up_handle->sysdep == NULL) {
return STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
}
if (file_name == NULL) {
return STATE_MQTT_UPLOAD_FILENAME_IS_NULL;
}
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
upload_file_task_handle_t *up_task = NULL, *next = NULL;
core_list_for_each_entry_safe(up_task, next, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (memcmp(file_name, up_task->file_name, strlen(up_task->file_name)) == 0) {
if ( up_task->status == STATE_MQTT_UPLOAD_NONE ||
up_task->status == STATE_MQTT_UPLOAD_CANCEL_SUCCESS) {
/* 未收到初始化消息,删除upload stask资源 */
core_list_del(&up_task->linked_node);
_mqtt_upload_up_task_free(sysdep, up_task);
res = STATE_MQTT_UPLOAD_CANCEL_SUCCESS;
break;
} else if (up_task->status == STATE_MQTT_UPLOAD_FINISHED) {
res = STATE_MQTT_UPLOAD_CANCEL_FAILED;
break;
}
/* 发送取消文件上传的请求 */
if ((res = _mqtt_upload_send_request_cancel(handle, up_task)) == STATE_SUCCESS) {
up_task->status = STATE_MQTT_UPLOAD_REQUEST_CANCEL;
}
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
return res;
}
int32_t aiot_mqtt_upload_send_data(void *handle, char *file_name,
uint8_t *data, uint32_t datalen, uint8_t is_complete) {
int32_t res = STATE_SUCCESS;
uint8_t file_flag = 0;
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
sysdep->core_sysdep_mutex_lock(up_handle->send_mutex);
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
static upload_file_task_handle_t *up_task = NULL, *next = NULL;
core_list_for_each_entry_safe(up_task, next, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
if (file_name != NULL && up_task->file_name != NULL &&
memcmp(file_name, up_task->file_name, strlen(up_task->file_name)) == 0) {
up_task->block_size = datalen;
file_flag = 1;
up_task->is_destory = 0;
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
/* 没有查询到对应的upload id */
if (file_flag != 1) {
sysdep->core_sysdep_mutex_unlock(up_handle->send_mutex);
return STATE_MQTT_UPLOAD_FAILED;
}
if (up_task != NULL && strlen(up_task->upload_id) == 0) {
up_task->is_destory = 1;
sysdep->core_sysdep_mutex_unlock(up_handle->send_mutex);
return STATE_MQTT_UPLOAD_FAILED;
}
up_task->is_rsp = 0;
up_task->rsp_code = 0;
res = _mqtt_upload_send_block_file(up_handle, up_task, data, datalen, up_task->file_offset, is_complete);
// 等待应答包
uint64_t now = sysdep->core_sysdep_time();
while (res == STATE_SUCCESS && up_task->is_rsp == 0) {
if((sysdep->core_sysdep_time() - now) > up_handle->rsp_timeout) {
/* 应答超时 */
break;
}
sysdep->core_sysdep_sleep(MQTT_UPLOAD_SYNC_API_SLEEP_MS);
}
if (up_task->is_rsp == 0) {
res = STATE_MQTT_UPLOAD_FAILED_TIMEOUT;
goto exit;
}
if (up_task->rsp_code != UPLOAD_FILE_OK) {
res = STATE_MQTT_UPLOAD_FAILED;
goto exit;
}
exit:
up_task->is_destory = 1;
sysdep->core_sysdep_mutex_unlock(up_handle->send_mutex);
return res;
}
aiot_mqtt_upload_result_t aiot_mqtt_upload_process(void *handle) {
mqtt_upload_handle_t *up_handle = (mqtt_upload_handle_t *)handle;
uint16_t file_name_len = 0, upload_id_len = 0;
uint64_t now = 0;
static aiot_mqtt_upload_result_t result = {
.status = STATE_MQTT_UPLOAD_NONE,
.err_code = 0
};
result.status = STATE_MQTT_UPLOAD_NONE;
result.err_code = 0;
memset(result.uploadid, 0, MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE);
memset(result.file_name, 0, MQTT_UPLOAD_DEFAULT_FILENAME_LEN);
if (up_handle == NULL) {
result.status = STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL;
return result;
}
aiot_sysdep_portfile_t *sysdep = up_handle->sysdep;
sysdep->core_sysdep_mutex_lock(up_handle->uptask_mutex);
upload_file_task_handle_t *up_task = NULL, *next = NULL;
core_list_for_each_entry_safe(up_task, next, &up_handle->file_list, linked_node, upload_file_task_handle_t) {
result.status = up_task->status;
file_name_len = strlen(up_task->file_name) > MQTT_UPLOAD_DEFAULT_FILENAME_LEN ?
MQTT_UPLOAD_DEFAULT_FILENAME_LEN : strlen(up_task->file_name);
upload_id_len = strlen(up_task->upload_id) > MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE ?
MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE : strlen(up_task->upload_id);
memset(result.file_name, 0, MQTT_UPLOAD_DEFAULT_FILENAME_LEN);
memset(result.uploadid, 0, MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE);
memcpy(result.file_name, up_task->file_name, file_name_len);
memcpy(result.uploadid, up_task->upload_id, upload_id_len);
switch (up_task->status)
{
case STATE_MQTT_UPLOAD_NONE:
/* 未开始上传任务 Nothing Todo */
break;
case STATE_MQTT_UPLOAD_REQUEST_INIT:
/* 请求上传UploadID */
now = sysdep->core_sysdep_time();
if((now - up_task->send_last_time) > up_handle->rsp_timeout) {
_mqtt_upload_resend_pub(up_handle, up_task);
}
break;
case STATE_MQTT_UPLOAD_IS_UPLOADING:
/* 上传中 */
now = sysdep->core_sysdep_time();
if((now - up_task->send_last_time) > up_handle->rsp_timeout) {
_mqtt_upload_resend_pub(up_handle, up_task);
}
break;
case STATE_MQTT_UPLOAD_REQUEST_CANCEL:
/* 请求取消 */
now = sysdep->core_sysdep_time();
if((now - up_task->send_last_time) > up_handle->rsp_timeout) {
_mqtt_upload_resend_pub(up_handle, up_task);
}
break;
case STATE_MQTT_UPLOAD_FINISHED: /* 上传完成 */
case STATE_MQTT_UPLOAD_CANCEL_SUCCESS: /* 取消文件上传成功 */
up_task->status = STATE_MQTT_UPLOAD_NONE;
result.err_code = up_task->rsp_code;
/* 结束上传，销毁对应的链表内存 */
core_log(sysdep, STATE_MQTT_UPLOAD_BASE, "Finish upload,Deleted upload task.\r\n");
while (!up_task->is_destory)
{
sysdep->core_sysdep_sleep(1);
}
core_list_del(&up_task->linked_node);
_mqtt_upload_up_task_free(sysdep, up_task);
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
return result;
case STATE_MQTT_UPLOAD_CANCEL_FAILED: /* 取消文件上传失败 */
case STATE_MQTT_UPLOAD_FAILED: /* 上传失败 */
case STATE_MQTT_UPLOAD_FAILED_TIMEOUT: /* 发送超时 */
case STATE_MQTT_UPLOAD_FAILED_WHOLE_CHECK: /* CRC64校验失败 */
/* 回到空闲模式 */
up_task->status = STATE_MQTT_UPLOAD_NONE;
result.err_code = up_task->rsp_code;
while (!up_task->is_destory)
{
sysdep->core_sysdep_sleep(1);
}
core_list_del(&up_task->linked_node);
_mqtt_upload_up_task_free(sysdep, up_task);
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
return result;
default:
break;
}
}
sysdep->core_sysdep_mutex_unlock(up_handle->uptask_mutex);
return result;
}
| YifuLiu/AliOS-Things | components/linksdk/components/mqtt-upload/aiot_mqtt_upload_api.c | C | apache-2.0 | 60,304 |
/**
* @file aiot_mqtt_upload_api.h
* @brief MQTT UPLOAD模块头文件, 提供通过mqtt进行文件上传的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __AIOT_MQTT_UPLOAD_API_H__
#define __AIOT_MQTT_UPLOAD_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @brief -0x2100~-0x21FF表达SDK在mqtt_upload模块内的状态码
*/
#define STATE_MQTT_UPLOAD_BASE (-0x2100)
/**
* @brief MQTT UPLOAD Handle 为空
*/
#define STATE_MQTT_UPLOAD_MQTT_HANDLE_IS_NULL (-0x2101)
/**
* @brief MQTT UPLOAD 请求上传文件时，文件名是空的
*
*/
#define STATE_MQTT_UPLOAD_FILENAME_IS_NULL (-0x2102)
/**
* @brief MQTT UPLOAD PUB到服务端的时候参数为空
*
*/
#define STATE_MQTT_UPLOAD_PARAMS_IS_NULL (-0x2103)
/**
* @brief MQTT UPLOAD上传文件数据为空
*
*/
#define STATE_MQTT_UPLOAD_FILE_DATA_IS_NULL (-0x2104)
/**
* @brief MQTT portfile是空的
*/
#define STATE_MQTT_UPLOAD_MQTT_SYSDEP_IS_NULL (-0x2105)
/**
* @brief MQTT UPLOAD 解析服务端初始化应答的Json数据失败
*/
#define STATE_MQTT_UPLOAD_PARSE_INIT_FAILED (-0x2106)
/**
* @brief MQTT UPLOAD 解析服务端文件数据上传应答的Json数据失败
*/
#define STATE_MQTT_UPLOAD_PARSE_UPLOAD_REPLY_FAILED (-0x2107)
/**
* @brief MQTT UPLOAD 解析服务端取消应答的Json数据失败
*/
#define STATE_MQTT_UPLOAD_PARSE_CANCEL_FAILED (-0x2108)
/**
* @brief MQTT UPLOAD 解析服务端应答的Json数据失败
*/
#define STATE_MQTT_UPLOAD_PARSE_JSON_FAILED (-0x2109)
/**
* @brief MQTT UPLOAD 接收到的服务端应答文件信息不对
*/
#define STATE_MQTT_UPLOAD_RECV_FILE_INFO_ERROR (-0x210A)
/**
* @brief MQTT UPLOAD uploadId不匹配或者设备端为初始化请求
*/
#define STATE_MQTT_UPLOAD_RECV_UPLOADID_ERROR (-0x210B)
/**
* @brief MQTT UPLOAD malloc失败
*/
#define STATE_MQTT_UPLOAD_MALLOC_FAILED (-0x210C)
/**
* @brief MQTT UPLOAD 初始化文件upload的句柄时失败
*/
#define STATE_MQTT_UPLOAD_UPTASK_IS_NULL (-0x210D)
/**
* @brief MQTT UPLOAD 收到服务端应答的文件上传的偏移量和分包大小错误，与上次上传的不相同
*/
#define STATE_MQTT_UPLOAD_UPLOAD_REPLY_ERROR (-0x210E)
/**
* @brief MQTT UPLOAD 反初始化
*/
#define STATE_MQTT_UPLOAD_HANDLE_DEINIT (-0x210F)
/**
* @brief 重新启动文件上传失败
*/
#define STATE_MQTT_UPLOAD_FILE_RESTART_FAILED (-0x2110)
/**
* @brief MQTT UPLOAD 配置分包上传的大小错误，不在256~128K范围内，继续保持默认的2K
*
*/
#define STATE_MQTT_UPLOAD_BLOCK_SIZE_ERROR (-0x2111)
/**
* @brief MQTT UPLOAD 请求文件上传，回调函数为空
*
*/
#define STATE_MQTT_UPLOAD_READ_DATA_HANDLER_IS_NULL (-0x2112)
/**
* @brief MQTT UPLOAD 初始化
*/
#define STATE_MQTT_UPLOAD_HANDLE_INIT (-0x2113)
/**
* @brief MQTT UPLOAD 处理服务端应答的回调时失败
*/
#define STATE_MQTT_UPLOAD_PROCESS_REPLY_ERROR (-0x2114)
/**
* @brief 无任何状态，未开始进行文件上传的处理
*
*/
#define STATE_MQTT_UPLOAD_NONE (-0x2115)
/**
* @brief 请求服务端进行文件上传，等待服务端返回结果
*
*/
#define STATE_MQTT_UPLOAD_REQUEST_INIT (-0x2116)
/**
* @brief 正在执行文件上传任务
*
*/
#define STATE_MQTT_UPLOAD_IS_UPLOADING (-0x2117)
/**
* @brief 通知服务端取消文件上传。
*
*/
#define STATE_MQTT_UPLOAD_REQUEST_CANCEL (-0x2118)
/**
* @brief 文件上传，取消上传任务成功，取消成功后会销毁对应的upload task释放内存资源
*
*/
#define STATE_MQTT_UPLOAD_CANCEL_SUCCESS (-0x2119)
/**
* @brief 文件上传，取消上传任务失败
*
*/
#define STATE_MQTT_UPLOAD_CANCEL_FAILED (-0x2120)
/**
* @brief 文件上传失败
*
*/
#define STATE_MQTT_UPLOAD_FAILED (-0x2121)
/**
* @brief 文件上传超时失败
*
*/
#define STATE_MQTT_UPLOAD_FAILED_TIMEOUT (-0x2122)
/**
* @brief 文件完整性校验失败
*
*/
#define STATE_MQTT_UPLOAD_FAILED_WHOLE_CHECK (-0x2124)
/**
* @brief 已经完成文件上传的任务，完成文件上传后会销毁对应的upload task释放内存资源
*
*/
#define STATE_MQTT_UPLOAD_FINISHED (-0x2125)
/**
* @brief 没有文件上传任务，无法执行取消操作
*
*/
#define STATE_MQTT_UPLOAD_NO_UPLOAD_TASK (-0x2126)
/**
* @brief 同名的文件的处理策略 overwrite: 覆盖模式，服务端删除之前的同名文件，原有文件无法找回
*/
#define AIOT_MQTT_UPLOAD_FILE_MODE_OVERWRITE "overwrite"
/**
* @brief 同名的文件的处理策略 append:文件追加模式
* 有同名文件未完成上传：在服务端文件未完成上传的情况下，云端返回当前已上传文件的信息，以便设备端继续上传后续的文件内
* 容，未完成的文件云端保留24H，超过24小时后删除未完成的文件，下次请求时重新建立
* 有同名已完成上传：返回错误码 UPLOAD_FILE_FAILED_SAME_FILE ，请求上传失败
* 无同名文件：服务端新建文件信息
*/
#define AIOT_MQTT_UPLOAD_FILE_MODE_APPEND "append"
/**
* @brief 同名的文件的处理策略 reject: 拒绝模式，服务端返回文件已经存在不能再次上传的错误码 UPLOAD_FILE_FAILED_SAME_FILE
*/
#define AIOT_MQTT_UPLOAD_FILE_MODE_FAIL "reject"
/**
* @brief MQTT上传文件名的最大长度
*/
#define MQTT_UPLOAD_DEFAULT_FILENAME_LEN (128)
/**
* @brief CRC64数据校验的长度
*/
#define MQTT_UPLOAD_DEFAULT_CRC64_LEN (32)
/**
* @brief UploadID的数据长度
*/
#define MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE (64)
/**
* @brief 请求文件上传和文件传输过程中的服务端返回的文件信息
*
*/
typedef enum {
/**
* @brief 文件上传正常
*
*/
UPLOAD_FILE_OK = 200,
/**
* @brief 请求上传的payload格式非法，无法解析其中的json格式数据
*
*/
UPLOAD_FILE_FAILED_PAYLOAD_ERROR = 400,
/**
* @brief 文件上传被限流
*
*/
UPLOAD_FILE_FAILED_QPS_LIMIT = 429,
/**
* @brief 文件上传请求参数错误
*
*/
UPLOAD_FILE_FAILED_PARAMS = 460,
/**
* @brief 服务端其他异常
*
*/
UPLOAD_FILE_FAILED_SERVER_OTHER = 500,
/**
* @brief 申请使用mqtt协议上传文件时，文件大小超过阈值16M
*
*/
UPLOAD_FILE_FAILED_MAX_FILESIZE = 78117,
/**
* @brief 设备上传文件分片时，分片大小超过阈值128KB
*
*/
UPLOAD_FILE_FALED_BLOCK_SIZE_MORE = 78118,
/**
* @brief 设备上传文件分片时，当前分片的offset与已上传至的服务端文件大小不一致
*
*/
UPLOAD_FILE_FAILED_OFFSET_UNEQUAL = 78119,
/**
* @brief 设备上传文件分片时，当前分片的大小小于最小阈值，除最后一片文件外，传输过程中分片大小不得小于256Byte
*
*/
UPLOAD_FILE_FAILED_BLOCK_SIZE_LESS = 78120,
/**
* @brief 设备上传文件分片时，当前分片的CRC校验失败，SDK内会自动对当前分片进行重传
*
*/
UPLOAD_FILE_FAILED_BLOCK_CRC = 78121,
/**
* @brief 上传文件的任务不存在，用户需要发起新的上传请求调用 aiot_mqtt_upload_open_stream
*
*/
UPLOAD_FILE_FAILED_NOT_FILE_TASK = 78122,
/**
* @brief 同名文件已经存在，在追加模式 AIOT_MQTT_UPLOAD_FILE_MODE_APPEND 和拒绝模式 AIOT_MQTT_UPLOAD_FILE_MODE_FAIL 下会返回该错误码
*
*/
UPLOAD_FILE_FAILED_SAME_FILE = 78123,
/**
* @brief 文件上传任务已经完成，通知用户对应的文件上传已经完成，销毁对应的upload task释放内存资源
*
*/
UPLOAD_FILE_HAVE_FINISHED = 78124,
/**
* @brief 文件完整性校验失败，在调用 aiot_mqtt_upload_open_stream 时，如果传入 degist参数服务端会对文件完整性进行校验，传入NULL时云端不校验
*
*/
UPLOAD_FILE_FAILED_WHOLE_CHECK = 78125,
/**
* @brief 重传或网络断开造成文件写入重复，忽略
*
*/
UPLOAD_FILE_FILE_BLOCK_DUPLICATION = 78126,
/**
* @brief 文件上传过程中，消息限流
*
*/
UPLOAD_FILE_MESSAGE_LIMIT = 78127
} aiot_mqtt_upload_result_code_t;
/**
* @brief MQTT UPLOAD模块收到从服务端应答的报文类型
*/
typedef enum {
/**
* @brief 收到的服务端应答请求初始化时的报文信息，通过回调函数反馈给用户
*
*/
AIOT_MQTT_UPLOADRECV_INIT_REPLY,
/**
* @brief 收到的服务端应答上传分片文件时的应答报文消息，通过回调反馈给用户，同时也会调用回调获取下一段分片文件
*
*/
AIOT_MQTT_UPLOADRECV_UPLOAD_REPLY,
/**
* @brief 收到的服务端应答取消上传的报文应答
*
*/
AIOT_MQTT_UPLOADRECV_CANCEL_REPLY
} aiot_mqtt_upload_recv_type_t;
/**
* @brief 接收到的服务端应答消息的报文信息
*
*/
typedef struct {
/**
* @brief 服务端应答的文件名信息，用户调用 aiot_mqtt_upload_open_stream 传入的文件名，可用于回调函数中读取文件信息
*
*/
char *file_name;
/**
* @brief 对应上传文件的总长度，用户调用 aiot_mqtt_upload_open_stream 传入的文件大小
*/
uint32_t file_size;
/**
* @brief 服务端应答文件上传请求唯一识别信息，在文件上传的声明周期内uploadId唯一，有效时间24H
*
*/
char *upload_id;
/**
* @brief 已经上传文件的偏移量，偏移量的是相对于文件开始的起始点算起，可以用于回调函数中读取新分片文件的偏移量
*/
uint32_t file_offset;
/**
* @brief 本次进行分片上传的分片长度
*/
uint32_t block_size;
/**
* @brief 服务端应答的错误编码，对应本次上传的状态
*/
aiot_mqtt_upload_result_code_t code;
/**
* @brief 服务端应答，错误码对应的错误信息
*/
char *message;
/**
* @brief 服务端应答文件上传完成后才有的应答，complete true: 文件上传成功，false: 文件上传失败
*/
uint8_t complete;
} aiot_mqtt_upload_desc_t;
/**
* @brief MQTT UPLOAD模块收到服务端应答的报文信息, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 收到服务端应答的报文类型
*
*/
aiot_mqtt_upload_recv_type_t type;
/**
* @brief 收到服务端应答的报文描述信息
*
*/
aiot_mqtt_upload_desc_t desc;
} aiot_mqtt_upload_recv_t;
/**
* @brief @ref aiot_mqtt_upload_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_mqtt_upload_setopt 中, data参数的数据类型
*
*/
typedef enum {
/**
* @brief 关联MQTT Handle会话，UPLOAD过程中使用MQTT的通道能力, 用以向服务端请求上传、发送分片文件、请求关闭通道
*
*/
AIOT_MQTT_UPLOADOPT_MQTT_HANDLE,
/**
* @brief MQTT UPLOAD会话发送消息时，超时重发的最长时间间隔, 数据类型为(uint32_t *)
*/
AIOT_MQTT_UPLOADOPT_RSP_TIMEOUT_MS,
/**
* @brief 配置MQTT文件上传单包发送超时时候的重试次数, 数据类型为(uint32_t *)
*/
AIOT_MQTT_UPLOADOPT_RETRY_COUNT,
/**
* @brief 配置文件上传的分片长度，默认是2048byte, 数据类型为(uint32_t *)
*/
AIOT_MQTT_UPLOADOPT_DEFAULLT_BLOCK_SIZE,
/**
* @brief 配置需要上传的文件，数据类型为aiot_mqtt_upload_file_opt_t
*/
AIOT_MQTT_UPLOADOPT_FILE_OPTION,
/**
* @brief 设置MQTT的最大值，设置失败
*/
AIOT_MQTT_UPLOADOPT_MAX
} aiot_mqtt_upload_option_t;
/**
* @brief aiot_mqtt_upload_process 循环处理，返回对应文件的上传状态给到用户
*
*/
typedef struct
{
/**
* @brief 通过MQTT通过上传的情况
*
*/
int32_t status;
/**
* @brief 云端应答的错误码,参考@ref aiot_mqtt_upload_result_code_t
*
*/
int32_t err_code;
/**
* @brief 结果对应的文件名，文件上传成功后，返回为空 NULL
*
*/
char file_name[MQTT_UPLOAD_DEFAULT_FILENAME_LEN];
/**
* @brief 返回文件名对应的uploadid
*
*/
char uploadid[MQTT_UPLOAD_DEFAULT_UPLOAD_SIZE];
} aiot_mqtt_upload_result_t;
/**
* @brief 回调函数读取用户的本地文件或内存数据不能在回调函数中执行
* @ref aiot_mqtt_upload_open_stream 和 @ref aiot_mqtt_upload_cancel_stream
* 多个文件同时请求上传时，可以使用不同的回调函数，也可以使用同一个回调函数用户根据file_name区分对应的文件或内存区
*
* @param[in] packet 服务端的应答报文,包含应答的状态和错误信息，更多信息参考 @ref aiot_mqtt_upload_recv_t
* @param[in] data 指向用于接收用户数据的缓冲块的指针
* @param[in] size 数据缓冲区大小, 此大小在发送过程中会变化
* @param[in] userdata 指向用户上下文的指针
*
* @return int32_t
* @retval 用户实际拷贝到buf中的数据长度
*/
typedef int32_t (*aiot_mqtt_upload_read_handler_t)(const aiot_mqtt_upload_recv_t *packet, uint8_t *data, uint32_t size, void *userdata);
/**
* @brief @ref aiot_mqtt_upload_setopt 对应参数AIOT_MQTT_UPLOADOPT_FILE_OPTION的结构体
*
* @details 首先配置对应的文件信息，然后调用aiot_mqtt_upload_open_stream接口开始文件上传
*
*/
typedef struct
{
char *file_name;
uint32_t file_size;
char *mode;
void *digest;
aiot_mqtt_upload_read_handler_t read_data_handler;
void *userdata;
}aiot_mqtt_upload_file_opt_t;
/**
* @brief 创建MQTT UPLOAD会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL, 返回mqtt_upload_handle_t实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_mqtt_upload_init(void);
/**
* @brief 配置MQTT UPLOAD会话
*
* @param[in] handle MQTT UPLOAD会话句柄
* @param[in] option 配置选项, 更多信息请参考 @ref aiot_mqtt_upload_option_t
* @param[in] data 配置选项数据, 更多信息请参考 @ref aiot_mqtt_upload_option_t
*
* @return int32_t
* @retval STATE_SUCCESS 参数配置成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参handle或data为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参optioin的枚举值>=AIOT_DMOPT_MAX
* @retval others 参考 @ref aiot_state_api.h
*
*/
int32_t aiot_mqtt_upload_setopt(void *handle, aiot_mqtt_upload_option_t option, void *data);
/**
* @brief 结束MQTT UPLOAD会话, 销毁实例并回收资源
*
* @param[in] handle 指向MQTT UPLOAD会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_mqtt_upload_deinit(void **handle);
/**
* @brief 向MQTT UPLOAD 服务请求发送文件
*
* @param[in] handle MQTT UPLOAD会话句柄
* @param[in] file_name 需要在服务端创建的文件名
* @param[in] file_size 需要上传的文件大小
* @param[in] mode 同名的文件的处理策略, 更多信息请参考 @ref AIOT_MQTT_UPLOAD_FILE_MODE_OVERWRITE
* @ref AIOT_MQTT_UPLOAD_FILE_MODE_APPEND @ref AIOT_MQTT_UPLOAD_FILE_MODE_FAIL
* @param[in] digest 文件完整的CRC64，不需要完整性校验则为NULL
* @param[in] read_data_handler 读取用户文件数据的回调函数, 更多信息请参考 @ref aiot_mqtt_upload_read_handler_t
* @param[in] userdata 用户上下文
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_MQTT_UPLOAD_BASE 中对应的错误码说明
*
*/
int32_t aiot_mqtt_upload_open_stream(void *handle, char *file_name, aiot_mqtt_upload_recv_t *packet);
/**
* @brief 向mqtt_upload服务器请求关闭MQTT通道数据上传命令
*
* @param[in] handle MQTT UPLOAD会话句柄
* @param[in] file_name 需要取消继续上传的文件名
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_MQTT_UPLOAD_BASE 中对应的错误码说明
*
*/
int32_t aiot_mqtt_upload_cancel_stream(void *handle, char *file_name);
/**
* @brief MQTT Upload 处理函数,处理超时和重发逻辑，返回对应文件的执行的状态
*
* @param[in] handle MQTT UPLOAD 会话句柄
*
* @return aiot_mqtt_upload_result_t 返回消息包括两个<i>status</i>, <i>file_name</i>; 更多信息请参考 @ref aiot_mqtt_upload_result_t
* @retval STATE_MQTT_UPLOAD_NONE 无任何状态，未开始进行文件上传的处理
* @retval STATE_MQTT_UPLOAD_REQUEST_INIT 请求服务端进行文件上传，等待服务端返回结果
* @retval STATE_MQTT_UPLOAD_IS_UPLOADING 正在执行文件上传任务
* @retval STATE_MQTT_UPLOAD_REQUEST_CANCEL 通知服务端取消文件上传
* @retval STATE_MQTT_UPLOAD_CANCEL_SUCCESS 文件上传，取消上传任务成功，取消成功后会销毁对应的upload task释放内存资源
* @retval STATE_MQTT_UPLOAD_CANCEL_FAILED 文件上传，取消上传任务失败
* @retval STATE_MQTT_UPLOAD_FAILED 文件上传失败
* @retval STATE_MQTT_UPLOAD_FAILED_TIMEOUT 文件上传超时失败
* @retval STATE_MQTT_UPLOAD_FAILED_WHOLE_CHECK 文件完整性校验失败
* @retval STATE_MQTT_UPLOAD_FINISHED 已经完成文件上传的任务，完成文件上传后会销毁对应的upload task释放内存资源
*/
aiot_mqtt_upload_result_t aiot_mqtt_upload_process(void *handle);
/**
* @brief MQTT Upload 数据发送接口，如果没有配置aiot_mqtt_upload_read_handler_t时，使用该接口发送数据
*
* @param[in] handle MQTT UPLOAD会话句柄
* @param[in] file_name 需要上传的文件名
* @param[in] data 需要上传的数据缓冲区
* @param[in] datalen 需要上传数据的长度
* @param[in] is_complete 数据是否上传完成,上传最后一包文件时需要设置为1,否则云端不会存储上传文件
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_MQTT_UPLOAD_BASE 中对应的错误码说明
*
*/
int32_t aiot_mqtt_upload_send_data(void *handle, char *file_name, uint8_t *data, uint32_t datalen, uint8_t is_complete);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_MQTT_UPLOAD_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/mqtt-upload/aiot_mqtt_upload_api.h | C | apache-2.0 | 19,592 |
/**
* @file mqtt_upload_private.h
* @brief MQTT UPLOAD模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __MQTT_UPLOAD_PRIVATE_H__
#define __MQTT_UPLOAD_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
#include "core_string.h"
#include "core_log.h"
#include "core_diag.h"
#include "core_global.h"
#include "core_mqtt.h"
#include "aiot_sysdep_api.h"
#include "aiot_state_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_mqtt_upload_api.h"
/**
* @brief 文件上传流服务对应的上下文数据
*/
typedef struct {
char *file_name; /* 上传的文件名 */
char *upload_id; /* 文件上传的id */
char *mode; /* 云端文件的写入模式 */
char *crc64; /* (可选)对文件完整性进行CRC64校验,为空云端则不校验 */
char *uuid; /* 请求初始化时的UUID*/
uint8_t is_rsp;
uint32_t file_size; /* 上传文件的大小，SDK内不做任何限制 */
uint32_t file_offset; /* 文件上传的偏移量 */
uint8_t *data; /* 当前上传的分片文件 */
uint32_t block_size; /* 当前上传分片的大小 */
uint32_t failed_count; /* 上传失败计数 */
uint64_t send_last_time; /* 最近一次发送的时间点 */
int32_t status; /* 文件上传的状态 */
int32_t rsp_code; /* 云端应答的错误码 */
aiot_mqtt_upload_read_handler_t read_data_handler; /* 读取用户需要上传的数据回调，同时通知用户云端返回的信息 */
void *userdata; /* 用户回调接口使用的数据 */
aiot_mqtt_upload_recv_t packet;
uint8_t is_destory;
struct core_list_head linked_node;
} upload_file_task_handle_t;
/**
* @brief 定义MQTT UPLOAD模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针
*/
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
struct core_list_head file_list; /* 文件上传的任务链表 */
uint32_t rsp_timeout; /* 从发送数据开始，等待云端返回超时的时间 */
uint32_t retry_max_value; /* 单调上行消息发送失败时，尝试的次数 */
uint32_t default_block_size; /* 文件上传，单包的默认长度 */
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是MQTT_UPLOAD在内部使用, 用户无感知 ----*/
void *mqtt_handle; /* MQTT 会话句柄 */
void *data_mutex; /* 保护本地的数据结构 */
void *uptask_mutex; /* 保证不会并发打开stream */
void *send_mutex;
void *open_mutex;
} mqtt_upload_handle_t;
#define MQTT_UPLOAD_MODULE_NAME "Upload" /* 用于内存统计的模块名字符串 */
/* MQTT文件上传的topic */
#define MQTT_UPLOAD_UPLOAD_INIT "/sys/%s/%s/thing/file/upload/mqtt/init" /* 请求上传 */
#define MQTT_UPLOAD_UPLOAD_FILE "/sys/%s/%s/thing/file/upload/mqtt/send" /* 分片上传 */
#define MQTT_UPLOAD_UPLOAD_CANCEL "/sys/%s/%s/thing/file/upload/mqtt/cancel" /* 设备取消上传 */
#define MQTT_UPLOAD_UPLOAD_INIT_REPLY "/sys/%s/%s/thing/file/upload/mqtt/init_reply" /* 请求应答 */
#define MQTT_UPLOAD_UPLOAD_FILE_REPLY "/sys/%s/%s/thing/file/upload/mqtt/send_reply" /* 上传应答 */
#define MQTT_UPLOAD_UPLOAD_CANCEL_REPLY "/sys/%s/%s/thing/file/upload/mqtt/cancel_reply" /* 取消应答 */
/* MQTT UPLOAD请求的JSON格式 */
#define MQTT_UPLOAD_DEFAULT_BASE_FMT "{\"id\":\"%s\",\"params\":%s}"
#define MQTT_UPLOAD_OPEN_STREAM_PARAM_FMT "{\"fileName\":\"%s\",\"fileSize\":%s,\"conflictStrategy\":\"%s\",\"initUid\":\"%s\"}"
#define MQTT_UPLOAD_OPEN_STREAM_PARAM_FMT_MD5 "{\"fileName\":\"%s\",\"fileSize\":%s,\"conflictStrategy\":\"%s\",\"ficMode\":\"%s\",\"ficValue\":\"%s\",\"initUid\":\"%s\"}"
#define MQTT_UPLOAD_SEND_DATA_PARAM_FMT "{\"uploadId\":\"%s\",\"offset\":%s,\"bSize\":%s,\"isComplete\":%s}"
#define MQTT_UPLOAD_CLOSE_STREAM_PARAM_FMT "{\"uploadId\":\"%s\"}"
/* 文件分片上报的格式 | Heard H | Heard L | HeaderJson | DATA | CRC16 L | CRC16 H| */
#define MQTT_UPLOAD_SEND_DATA_RAM_FMT "%.2x%s%s%.2x"
/* 这一段列出用户未用 aiot_MQTT UPLOAD_setopt() 配置时, 各个对外选项的默认值, 必须以 MQTT_UPLOAD_DEFAULT_ 作为前缀 */
#define MQTT_UPLOAD_DEFAULT_SEND_MAX_SIZE (128 * 1024) /* MQTT文件最大上传128KB */
#define MQTT_UPLOAD_DEFAULT_SEND_MIN_SIZE (256) /* MQTT文件除最后一包外，其他大小不能小于256B */
#define MQTT_UPLOAD_DEFAULT_BLOCK_SIZE (2 * 1024) /* MQTT文件上传，默认一包的最大长达 */
#define MQTT_UPLOAD_DEFAULT_RSP_TIMEOUT (10 * 1000) /* MQTT上传等待超时时间默认 10s */
#define MQTT_UPLOAD_DEFAULT_RETRY_MAX_COUNT (5) /* 默认每次消息重发次数 5次 */
#define MQTT_UPLOAD_DEFAULT_MODE_MAX_SIZE (32) /* MQTT文件上传，云端文件覆盖或者追加的模式 */
#define MQTT_UPLOAD_DEFAULT_SUBTOPIC_NUM (3) /* MQTT文件上传用到的subtopic的数量 */
#define MQTT_UPLOAD_DEFAULT_UUID_SIZE (32) /* 初始化请求时生成的UUID */
#define MQTT_UPLOAD_SYNC_API_SLEEP_MS (20) /* 等待云端应答的最小时间*/
#if defined(__cplusplus)
}
#endif
#endif /* __MQTT_UPLOAD_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/mqtt-upload/mqtt_upload_private.h | C | apache-2.0 | 6,254 |
#include <stdint.h>
#include "upload_crc64.h"
static const uint64_t crc64_table[256] = {
0x0000000000000000, 0xb32e4cbe03a75f6f, 0xf4843657a840a05b, 0x47aa7ae9abe7ff34,
0x7bd0c384ff8f5e33, 0xc8fe8f3afc28015c, 0x8f54f5d357cffe68, 0x3c7ab96d5468a107,
0xf7a18709ff1ebc66, 0x448fcbb7fcb9e309, 0x0325b15e575e1c3d, 0xb00bfde054f94352,
0x8c71448d0091e255, 0x3f5f08330336bd3a, 0x78f572daa8d1420e, 0xcbdb3e64ab761d61,
0x7d9ba13851336649, 0xceb5ed8652943926, 0x891f976ff973c612, 0x3a31dbd1fad4997d,
0x064b62bcaebc387a, 0xb5652e02ad1b6715, 0xf2cf54eb06fc9821, 0x41e11855055bc74e,
0x8a3a2631ae2dda2f, 0x39146a8fad8a8540, 0x7ebe1066066d7a74, 0xcd905cd805ca251b,
0xf1eae5b551a2841c, 0x42c4a90b5205db73, 0x056ed3e2f9e22447, 0xb6409f5cfa457b28,
0xfb374270a266cc92, 0x48190ecea1c193fd, 0x0fb374270a266cc9, 0xbc9d3899098133a6,
0x80e781f45de992a1, 0x33c9cd4a5e4ecdce, 0x7463b7a3f5a932fa, 0xc74dfb1df60e6d95,
0x0c96c5795d7870f4, 0xbfb889c75edf2f9b, 0xf812f32ef538d0af, 0x4b3cbf90f69f8fc0,
0x774606fda2f72ec7, 0xc4684a43a15071a8, 0x83c230aa0ab78e9c, 0x30ec7c140910d1f3,
0x86ace348f355aadb, 0x3582aff6f0f2f5b4, 0x7228d51f5b150a80, 0xc10699a158b255ef,
0xfd7c20cc0cdaf4e8, 0x4e526c720f7dab87, 0x09f8169ba49a54b3, 0xbad65a25a73d0bdc,
0x710d64410c4b16bd, 0xc22328ff0fec49d2, 0x85895216a40bb6e6, 0x36a71ea8a7ace989,
0x0adda7c5f3c4488e, 0xb9f3eb7bf06317e1, 0xfe5991925b84e8d5, 0x4d77dd2c5823b7ba,
0x64b62bcaebc387a1, 0xd7986774e864d8ce, 0x90321d9d438327fa, 0x231c512340247895,
0x1f66e84e144cd992, 0xac48a4f017eb86fd, 0xebe2de19bc0c79c9, 0x58cc92a7bfab26a6,
0x9317acc314dd3bc7, 0x2039e07d177a64a8, 0x67939a94bc9d9b9c, 0xd4bdd62abf3ac4f3,
0xe8c76f47eb5265f4, 0x5be923f9e8f53a9b, 0x1c4359104312c5af, 0xaf6d15ae40b59ac0,
0x192d8af2baf0e1e8, 0xaa03c64cb957be87, 0xeda9bca512b041b3, 0x5e87f01b11171edc,
0x62fd4976457fbfdb, 0xd1d305c846d8e0b4, 0x96797f21ed3f1f80, 0x2557339fee9840ef,
0xee8c0dfb45ee5d8e, 0x5da24145464902e1, 0x1a083bacedaefdd5, 0xa9267712ee09a2ba,
0x955cce7fba6103bd, 0x267282c1b9c65cd2, 0x61d8f8281221a3e6, 0xd2f6b4961186fc89,
0x9f8169ba49a54b33, 0x2caf25044a02145c, 0x6b055fede1e5eb68, 0xd82b1353e242b407,
0xe451aa3eb62a1500, 0x577fe680b58d4a6f, 0x10d59c691e6ab55b, 0xa3fbd0d71dcdea34,
0x6820eeb3b6bbf755, 0xdb0ea20db51ca83a, 0x9ca4d8e41efb570e, 0x2f8a945a1d5c0861,
0x13f02d374934a966, 0xa0de61894a93f609, 0xe7741b60e174093d, 0x545a57dee2d35652,
0xe21ac88218962d7a, 0x5134843c1b317215, 0x169efed5b0d68d21, 0xa5b0b26bb371d24e,
0x99ca0b06e7197349, 0x2ae447b8e4be2c26, 0x6d4e3d514f59d312, 0xde6071ef4cfe8c7d,
0x15bb4f8be788911c, 0xa6950335e42fce73, 0xe13f79dc4fc83147, 0x521135624c6f6e28,
0x6e6b8c0f1807cf2f, 0xdd45c0b11ba09040, 0x9aefba58b0476f74, 0x29c1f6e6b3e0301b,
0xc96c5795d7870f42, 0x7a421b2bd420502d, 0x3de861c27fc7af19, 0x8ec62d7c7c60f076,
0xb2bc941128085171, 0x0192d8af2baf0e1e, 0x4638a2468048f12a, 0xf516eef883efae45,
0x3ecdd09c2899b324, 0x8de39c222b3eec4b, 0xca49e6cb80d9137f, 0x7967aa75837e4c10,
0x451d1318d716ed17, 0xf6335fa6d4b1b278, 0xb199254f7f564d4c, 0x02b769f17cf11223,
0xb4f7f6ad86b4690b, 0x07d9ba1385133664, 0x4073c0fa2ef4c950, 0xf35d8c442d53963f,
0xcf273529793b3738, 0x7c0979977a9c6857, 0x3ba3037ed17b9763, 0x888d4fc0d2dcc80c,
0x435671a479aad56d, 0xf0783d1a7a0d8a02, 0xb7d247f3d1ea7536, 0x04fc0b4dd24d2a59,
0x3886b22086258b5e, 0x8ba8fe9e8582d431, 0xcc0284772e652b05, 0x7f2cc8c92dc2746a,
0x325b15e575e1c3d0, 0x8175595b76469cbf, 0xc6df23b2dda1638b, 0x75f16f0cde063ce4,
0x498bd6618a6e9de3, 0xfaa59adf89c9c28c, 0xbd0fe036222e3db8, 0x0e21ac88218962d7,
0xc5fa92ec8aff7fb6, 0x76d4de52895820d9, 0x317ea4bb22bfdfed, 0x8250e80521188082,
0xbe2a516875702185, 0x0d041dd676d77eea, 0x4aae673fdd3081de, 0xf9802b81de97deb1,
0x4fc0b4dd24d2a599, 0xfceef8632775faf6, 0xbb44828a8c9205c2, 0x086ace348f355aad,
0x34107759db5dfbaa, 0x873e3be7d8faa4c5, 0xc094410e731d5bf1, 0x73ba0db070ba049e,
0xb86133d4dbcc19ff, 0x0b4f7f6ad86b4690, 0x4ce50583738cb9a4, 0xffcb493d702be6cb,
0xc3b1f050244347cc, 0x709fbcee27e418a3, 0x3735c6078c03e797, 0x841b8ab98fa4b8f8,
0xadda7c5f3c4488e3, 0x1ef430e13fe3d78c, 0x595e4a08940428b8, 0xea7006b697a377d7,
0xd60abfdbc3cbd6d0, 0x6524f365c06c89bf, 0x228e898c6b8b768b, 0x91a0c532682c29e4,
0x5a7bfb56c35a3485, 0xe955b7e8c0fd6bea, 0xaeffcd016b1a94de, 0x1dd181bf68bdcbb1,
0x21ab38d23cd56ab6, 0x9285746c3f7235d9, 0xd52f0e859495caed, 0x6601423b97329582,
0xd041dd676d77eeaa, 0x636f91d96ed0b1c5, 0x24c5eb30c5374ef1, 0x97eba78ec690119e,
0xab911ee392f8b099, 0x18bf525d915feff6, 0x5f1528b43ab810c2, 0xec3b640a391f4fad,
0x27e05a6e926952cc, 0x94ce16d091ce0da3, 0xd3646c393a29f297, 0x604a2087398eadf8,
0x5c3099ea6de60cff, 0xef1ed5546e415390, 0xa8b4afbdc5a6aca4, 0x1b9ae303c601f3cb,
0x56ed3e2f9e224471, 0xe5c372919d851b1e, 0xa26908783662e42a, 0x114744c635c5bb45,
0x2d3dfdab61ad1a42, 0x9e13b115620a452d, 0xd9b9cbfcc9edba19, 0x6a978742ca4ae576,
0xa14cb926613cf817, 0x1262f598629ba778, 0x55c88f71c97c584c, 0xe6e6c3cfcadb0723,
0xda9c7aa29eb3a624, 0x69b2361c9d14f94b, 0x2e184cf536f3067f, 0x9d36004b35545910,
0x2b769f17cf112238, 0x9858d3a9ccb67d57, 0xdff2a94067518263, 0x6cdce5fe64f6dd0c,
0x50a65c93309e7c0b, 0xe388102d33392364, 0xa4226ac498dedc50, 0x170c267a9b79833f,
0xdcd7181e300f9e5e, 0x6ff954a033a8c131, 0x28532e49984f3e05, 0x9b7d62f79be8616a,
0xa707db9acf80c06d, 0x14299724cc279f02, 0x5383edcd67c06036, 0xe0ada17364673f59
};
// OK ，初始化CRC设置为0
crc64_t upload_crc64_update(crc64_t crc, const unsigned char *s, uint64_t l) {
crc = ~crc;
while (l != 0) {
crc = crc64_table[*s++ ^ (crc & 0xFF)] ^ (crc >> 8);
--l;
}
return ~crc;
} | YifuLiu/AliOS-Things | components/linksdk/components/mqtt-upload/upload_crc64.c | C | apache-2.0 | 5,524 |
#ifndef _CRC64_H_
#define _CRC64_H_
#include <stdint.h>
#include <stddef.h>
typedef uint64_t crc64_t;
crc64_t upload_crc64_update(crc64_t crc, const unsigned char *s, uint64_t l);
#endif
| YifuLiu/AliOS-Things | components/linksdk/components/mqtt-upload/upload_crc64.h | C | apache-2.0 | 191 |
/**
* @file aiot_ntp_api.c
* @brief ntp模块的API接口实现, 提供获取utc时间的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
/* TODO: 对本模块的头文件, 仅需包含ntp_private.h, 不需包含aiot_ntp_api.h */
#include "ntp_private.h"
/* TODO: 列出对core模块需要包含的头文件 */
#include "core_string.h"
#include "core_log.h"
#include "core_global.h"
#include "core_mqtt.h"
static void _core_ntp_exec_inc(ntp_handle_t *ntp_handle)
{
ntp_handle->sysdep->core_sysdep_mutex_lock(ntp_handle->data_mutex);
ntp_handle->exec_count++;
ntp_handle->sysdep->core_sysdep_mutex_unlock(ntp_handle->data_mutex);
}
static void _core_ntp_exec_dec(ntp_handle_t *ntp_handle)
{
ntp_handle->sysdep->core_sysdep_mutex_lock(ntp_handle->data_mutex);
ntp_handle->exec_count--;
ntp_handle->sysdep->core_sysdep_mutex_unlock(ntp_handle->data_mutex);
}
static void _ntp_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
ntp_handle_t *ntp_handle = (ntp_handle_t *)userdata;
switch (packet->type) {
case AIOT_MQTTRECV_PUB: {
char *dst_key = "deviceSendTime", *srt_key = "serverRecvTime", *sst_key = "serverSendTime";
char *dst_value = NULL, *srt_value = NULL, *sst_value = NULL;
uint32_t dst_value_len = 0, srt_value_len = 0, sst_value_len = 0;
uint64_t dst = 0, srt = 0, sst = 0, utc = 0;
if (core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len, dst_key, (uint32_t)strlen(dst_key),
&dst_value, &dst_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len, srt_key, (uint32_t)strlen(srt_key),
&srt_value, &srt_value_len) == STATE_SUCCESS &&
core_json_value((char *)packet->data.pub.payload, packet->data.pub.payload_len, sst_key, (uint32_t)strlen(sst_key),
&sst_value, &sst_value_len) == STATE_SUCCESS) {
if (core_str2uint64(dst_value, (uint8_t)dst_value_len, &dst) == STATE_SUCCESS &&
core_str2uint64(srt_value, (uint8_t)srt_value_len, &srt) == STATE_SUCCESS &&
core_str2uint64(sst_value, (uint8_t)sst_value_len, &sst) == STATE_SUCCESS) {
core_date_t date;
utc = (srt + sst + ntp_handle->sysdep->core_sysdep_time() - dst) / 2;
core_log_set_timestamp(ntp_handle->sysdep, utc);
memset(&date, 0, sizeof(core_date_t));
core_utc2date(utc, ntp_handle->time_zone, &date);
if (ntp_handle->recv_handler != NULL) {
aiot_ntp_recv_t recv;
memset(&recv, 0, sizeof(aiot_ntp_recv_t));
recv.type = AIOT_NTPRECV_LOCAL_TIME;
recv.data.local_time.timestamp = utc;
recv.data.local_time.year = date.year;
recv.data.local_time.mon = date.mon;
recv.data.local_time.day = date.day;
recv.data.local_time.hour = date.hour;
recv.data.local_time.min = date.min;
recv.data.local_time.sec = date.sec;
recv.data.local_time.msec = date.msec;
ntp_handle->recv_handler(ntp_handle, &recv, ntp_handle->userdata);
}
} else {
if (ntp_handle->event_handler != NULL) {
aiot_ntp_event_t event;
memset(&event, 0, sizeof(aiot_ntp_event_t));
event.type = AIOT_NTPEVT_INVALID_TIME_FORMAT;
ntp_handle->event_handler(ntp_handle, &event, ntp_handle->userdata);
}
}
} else {
if (ntp_handle->event_handler != NULL) {
aiot_ntp_event_t event;
memset(&event, 0, sizeof(aiot_ntp_event_t));
event.type = AIOT_NTPEVT_INVALID_RESPONSE;
ntp_handle->event_handler(ntp_handle, &event, ntp_handle->userdata);
}
}
}
default: {
}
break;
}
}
static int32_t _ntp_operate_topic_map(ntp_handle_t *ntp_handle, aiot_mqtt_option_t option)
{
int32_t res = STATE_SUCCESS;
aiot_mqtt_topic_map_t map;
char *topic = NULL;
char *topic_src[] = { core_mqtt_get_product_key(ntp_handle->mqtt_handle), core_mqtt_get_device_name(ntp_handle->mqtt_handle) };
char *topic_fmt = NTP_RESPONSE_TOPIC_FMT;
memset(&map, 0, sizeof(aiot_mqtt_topic_map_t));
res = core_sprintf(ntp_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src) / sizeof(char *),
NTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
map.topic = topic;
map.handler = _ntp_recv_handler;
map.userdata = (void *)ntp_handle;
res = aiot_mqtt_setopt(ntp_handle->mqtt_handle, option, &map);
ntp_handle->sysdep->core_sysdep_free(topic);
return res;
}
static void _ntp_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
ntp_handle_t *ntp_handle = (ntp_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
ntp_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _ntp_core_mqtt_operate_process_handler(ntp_handle_t *ntp_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _ntp_core_mqtt_process_handler;
process_data.context = ntp_handle;
return core_mqtt_setopt(ntp_handle->mqtt_handle, option, &process_data);
}
void *aiot_ntp_init(void)
{
ntp_handle_t *ntp_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
ntp_handle = sysdep->core_sysdep_malloc(sizeof(ntp_handle_t), NTP_MODULE_NAME);
if (ntp_handle == NULL) {
return NULL;
}
memset(ntp_handle, 0, sizeof(ntp_handle_t));
ntp_handle->sysdep = sysdep;
ntp_handle->deinit_timeout_ms = NTP_DEFAULT_DEINIT_TIMEOUT_MS;
ntp_handle->data_mutex = sysdep->core_sysdep_mutex_init();
ntp_handle->exec_enabled = 1;
return ntp_handle;
}
int32_t aiot_ntp_setopt(void *handle, aiot_ntp_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
ntp_handle_t *ntp_handle = (ntp_handle_t *)handle;
if (handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_NTPOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (ntp_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_ntp_exec_inc(ntp_handle);
ntp_handle->sysdep->core_sysdep_mutex_lock(ntp_handle->data_mutex);
switch (option) {
case AIOT_NTPOPT_MQTT_HANDLE: {
ntp_handle->mqtt_handle = data;
ntp_handle->sysdep->core_sysdep_mutex_unlock(ntp_handle->data_mutex);
res = _ntp_operate_topic_map(ntp_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP);
if (res >= STATE_SUCCESS) {
res = _ntp_core_mqtt_operate_process_handler(ntp_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
ntp_handle->sysdep->core_sysdep_mutex_lock(ntp_handle->data_mutex);
}
break;
case AIOT_NTPOPT_TIME_ZONE: {
ntp_handle->time_zone = *(int8_t *)data;
}
break;
case AIOT_NTPOPT_RECV_HANDLER: {
ntp_handle->recv_handler = (aiot_ntp_recv_handler_t)data;
}
break;
case AIOT_NTPOPT_EVENT_HANDLER: {
ntp_handle->event_handler = (aiot_ntp_event_handler_t)data;
}
break;
case AIOT_NTPOPT_USERDATA: {
ntp_handle->userdata = data;
}
break;
case AIOT_NTPOPT_DEINIT_TIMEOUT_MS: {
ntp_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
ntp_handle->sysdep->core_sysdep_mutex_unlock(ntp_handle->data_mutex);
_core_ntp_exec_dec(ntp_handle);
return res;
}
int32_t aiot_ntp_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
ntp_handle_t *ntp_handle = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
ntp_handle = *(ntp_handle_t **)handle;
if (ntp_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
ntp_handle->exec_enabled = 0;
_ntp_core_mqtt_operate_process_handler(ntp_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
_ntp_operate_topic_map(ntp_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP);
deinit_timestart = ntp_handle->sysdep->core_sysdep_time();
do {
if (ntp_handle->exec_count == 0) {
break;
}
ntp_handle->sysdep->core_sysdep_sleep(NTP_DEINIT_INTERVAL_MS);
} while ((ntp_handle->sysdep->core_sysdep_time() - deinit_timestart) < ntp_handle->deinit_timeout_ms);
if (ntp_handle->exec_count != 0) {
return STATE_MQTT_DEINIT_TIMEOUT;
}
*handle = NULL;
ntp_handle->sysdep->core_sysdep_mutex_deinit(&ntp_handle->data_mutex);
ntp_handle->sysdep->core_sysdep_free(ntp_handle);
return STATE_SUCCESS;
}
int32_t aiot_ntp_send_request(void *handle)
{
int32_t res = STATE_SUCCESS;
char *topic = NULL, *payload = NULL;
ntp_handle_t *ntp_handle = (ntp_handle_t *)handle;
if (handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (ntp_handle->mqtt_handle == NULL) {
return STATE_NTP_MISSING_MQTT_HANDLE;
}
if (ntp_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_ntp_exec_inc(ntp_handle);
{
char *topic_src[] = { core_mqtt_get_product_key(ntp_handle->mqtt_handle), core_mqtt_get_device_name(ntp_handle->mqtt_handle) };
char *topic_fmt = NTP_REQUEST_TOPIC_FMT;
char time_str[21] = {0};
char *payload_src[] = { time_str };
char *payload_fmt = NTP_REQUEST_PAYLOAD_FMT;
res = core_sprintf(ntp_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src) / sizeof(char *),
NTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
_core_ntp_exec_dec(ntp_handle);
return res;
}
core_uint642str(ntp_handle->sysdep->core_sysdep_time(), time_str, NULL);
res = core_sprintf(ntp_handle->sysdep, &payload, payload_fmt, payload_src, sizeof(payload_src) / sizeof(char *),
NTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
ntp_handle->sysdep->core_sysdep_free(topic);
_core_ntp_exec_dec(ntp_handle);
return res;
}
}
res = aiot_mqtt_pub(ntp_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), 0);
ntp_handle->sysdep->core_sysdep_free(topic);
ntp_handle->sysdep->core_sysdep_free(payload);
if (res < STATE_SUCCESS) {
_core_ntp_exec_dec(ntp_handle);
return res;
}
_core_ntp_exec_dec(ntp_handle);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/ntp/aiot_ntp_api.c | C | apache-2.0 | 11,699 |
/**
* @file aiot_ntp_api.h
* @brief ntp模块头文件, 提供获取utc时间的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
* NTP模块用于从阿里云物联网平台上获取UTC时间, API的使用流程如下:
*
* 1. 首先参考 @ref aiot_mqtt_api.h 的说明, 保证成功建立与物联网平台的`MQTT`连接
*
* 2. 调用 @ref aiot_ntp_init 初始化ntp会话, 获取会话句柄
*
* 3. 调用 @ref aiot_ntp_setopt 配置NTP会话的参数, 常用配置项见 @ref aiot_ntp_setopt 的说明
*
* 4. 调用 @ref aiot_ntp_send_request 发送NTP请求
*
* 5. 收到的UTC时间经SDK处理后会调用由 @ref aiot_ntp_setopt 配置的 @ref AIOT_NTPOPT_RECV_HANDLER 回调函数, 通知用户当前的时间
*
*/
#ifndef __AIOT_NTP_API_H__
#define __AIOT_NTP_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x1100~-0x11FF表达SDK在ntp模块内的状态码
*/
#define STATE_NTP_BASE (-0x1100)
/**
* @brief MQTT会话句柄未设置, 请通过 @ref aiot_ntp_setopt 设置MQTT会话句柄
*/
#define STATE_NTP_MISSING_MQTT_HANDLE (-0x1101)
/**
* @brief ntp模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
AIOT_NTPRECV_LOCAL_TIME
} aiot_ntp_recv_type_t;
/**
* @brief ntp模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_ntp_recv_type_t
*/
aiot_ntp_recv_type_t type;
union {
/**
* @brief utc事件戳以及时区换算后的日期, 以 @ref AIOT_NTPOPT_TIME_ZONE 设置的时区为准
*/
struct {
uint64_t timestamp;
uint32_t year;
uint32_t mon;
uint32_t day;
uint32_t hour;
uint32_t min;
uint32_t sec;
uint32_t msec;
} local_time;
} data;
} aiot_ntp_recv_t;
/**
* @brief ntp模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle ntp会话句柄
* @param[in] packet ntp消息结构体, 存放收到的ntp报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_ntp_recv_handler_t)(void *handle,
const aiot_ntp_recv_t *packet, void *userdata);
/**
* @brief ntp内部事件类型
*/
typedef enum {
/**
* @brief 收到的ntp应答中字段不合法
*/
AIOT_NTPEVT_INVALID_RESPONSE,
/**
* @brief 收到的ntp应答中时间字段格式错误
*/
AIOT_NTPEVT_INVALID_TIME_FORMAT,
} aiot_ntp_event_type_t;
/**
* @brief NTP内部事件
*/
typedef struct {
/**
* @brief NTP内部事件类型. 更多信息请参考@ref aiot_ntp_event_type_t
*
*/
aiot_ntp_event_type_t type;
} aiot_ntp_event_t;
/**
* @brief ntp事件回调函数
*
* @details
*
* 当NTP内部事件被触发时, 调用此函数
*
*/
typedef void (*aiot_ntp_event_handler_t)(void *handle, const aiot_ntp_event_t *event, void *userdata);
/**
* @brief @ref aiot_ntp_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_ntp_setopt 中, data参数的数据类型
*
* 1. data的数据类型是char *时, 以配置@ref AIOT_NTPOPT_MQTT_HANDLE 为例:
*
* void *mqtt_handle = aiot_mqtt_init();
* aiot_ntp_setopt(ntp_handle, AIOT_NTPOPT_MQTT_HANDLE, mqtt_handle);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_NTPOPT_TIME_ZONE 为例:
*
* int8_t time_zone = 8;
* aiot_mqtt_setopt(ntp_handle, AIOT_NTPOPT_TIME_ZONE, (void *)&time_zone);
*/
typedef enum {
/**
* @brief ntp会话 需要的MQTT句柄, 需要先建立MQTT连接, 再设置MQTT句柄
*
* @details
*
* 数据类型: (void *)
*/
AIOT_NTPOPT_MQTT_HANDLE,
/**
* @brief ntp会话 获取到utc时间后会根据此时区值转换成本地时间, 再通过 @ref aiot_ntp_recv_handler_t 通知
*
* @details
*
* 取值示例: 东8区, 取值为8; 西3区, 取值为-3
*
* 数据类型: (int8_t *)
*/
AIOT_NTPOPT_TIME_ZONE,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户
*
* @details
*
* 数据类型: ( @ref aiot_ntp_recv_handler_t )
*/
AIOT_NTPOPT_RECV_HANDLER,
/**
* @brief ntp内部发生的事件会从此回调函数进行通知
*
* @details
*
* 数据类型: ( @ref aiot_ntp_event_handler_t )
*/
AIOT_NTPOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details 这个上下文指针会在 AIOT_NTPOPT_RECV_HANDLER 和 AIOT_NTPOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_NTPOPT_USERDATA,
/**
* @brief 销毁ntp实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_ntp_deinit 销毁NTP实例时, 若继续调用其他aiot_ntp_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_ntp_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_NTPOPT_DEINIT_TIMEOUT_MS,
AIOT_NTPOPT_MAX
} aiot_ntp_option_t;
/**
* @brief 创建ntp会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL ntp实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_ntp_init(void);
/**
* @brief 配置ntp会话
*
* @details
*
* 常见的配置项如下
*
* + `AIOT_NTPOPT_MQTT_HANDLE`: 已建立连接的MQTT会话句柄
*
* + `AIOT_NTPOPT_TIME_ZONE`: 时区设置, SDK会将收到的UTC时间按配置的时区进行转换
*
* + `AIOT_NTPOPT_RECV_HANDLER`: 时间数据接收回调函数, SDK将UTC时间转换完成后, 通过此回调函数输出
*
* @param[in] handle ntp会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_ntp_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_ntp_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_ntp_setopt(void *handle, aiot_ntp_option_t option, void *data);
/**
* @brief 结束ntp会话, 销毁实例并回收资源
*
* @param[in] handle 指向ntp会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_ntp_deinit(void **handle);
/**
* @brief 向ntp服务器发送ntp消息请求
*
* @details
*
* 发送NTP请求, 然后SDK会调用通过 @ref aiot_ntp_setopt 配置的 @ref AIOT_NTPOPT_RECV_HANDLER 回调函数, 通知用户当前的时间
*
* @param handle ntp会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*/
int32_t aiot_ntp_send_request(void *handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_NTP_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/ntp/aiot_ntp_api.h | C | apache-2.0 | 7,274 |
/**
* @file ntp_private.h
* @brief ntp模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __NTP_PRIVATE_H__
#define __NTP_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
/* TODO: 这一段列出需要包含SDK其它模块头文件, 与上一段落以1个空行隔开 */
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_ntp_api.h" /* 内部头文件是用户可见头文件的超集 */
/* TODO: 定义ntp模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
void *mqtt_handle;
int8_t time_zone;
uint32_t deinit_timeout_ms;
aiot_ntp_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
aiot_ntp_event_handler_t event_handler;
void *userdata; /* 组件调用以上2个 ntp_handler 时的入参之一 */
/*---- 以上都是用户在API可配 ----*/
void *data_mutex;
uint8_t exec_enabled;
uint32_t exec_count;
} ntp_handle_t;
#define NTP_MODULE_NAME "ntp" /* 用于内存统计的模块名字符串 */
#define NTP_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define NTP_DEFAULT_TIME_ZONE (0)
#define NTP_REQUEST_TOPIC_FMT "/ext/ntp/%s/%s/request"
#define NTP_REQUEST_PAYLOAD_FMT "{\"deviceSendTime\":\"%s\"}"
#define NTP_RESPONSE_TOPIC_FMT "/ext/ntp/%s/%s/response"
#define NTP_DEINIT_INTERVAL_MS (100)
#if defined(__cplusplus)
}
#endif
#endif /* __NTP_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/ntp/ntp_private.h | C | apache-2.0 | 1,894 |
/**
* @file aiot_ota_api.c
* @brief OTA模块接口实现文件, 其中包含了OTA的所有用户API
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#include "aiot_ota_api.h"
#include "core_mqtt.h"
#include "core_string.h"
#include "core_sha256.h"
#include "ota_md5.h"
#include "ota_private.h"
#include "core_log.h"
#include "core_global.h"
static int32_t _ota_subscribe(void *mqtt_handle, void *ota_handle);
static int32_t _ota_publish_base(void *handle, char *topic_prefix, char *product_key, char *device_name, char *suffix,
char *params);
static void _ota_mqtt_process(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata);
static int32_t _ota_parse_json(aiot_sysdep_portfile_t *sysdep, void *in, uint32_t in_len, char *key_word, char **out);
static void _http_recv_handler(void *handle, const aiot_http_recv_t *recv_data, void *userdata);
static int32_t _download_parse_url(const char *url, char *host, uint32_t max_host_len, char *path,
uint32_t max_path_len);
static int32_t _download_digest_update(download_handle_t *download_handle, uint8_t *buffer, uint32_t buffer_len);
static int32_t _download_digest_verify(download_handle_t *download_handle);
static void *_download_deep_copy_base(aiot_sysdep_portfile_t *sysdep, char *in);
static void *_download_deep_copy_task_desc(aiot_sysdep_portfile_t *sysdep, void *data);
static int32_t _download_deep_free_task_desc(aiot_sysdep_portfile_t *sysdep, void *data);
static aiot_mqtt_topic_map_t g_ota_topic_map[OTA_TOPIC_NUM];
static void _ota_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
ota_handle_t *ota_handle = (ota_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
ota_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _ota_core_mqtt_operate_process_handler(ota_handle_t *ota_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _ota_core_mqtt_process_handler;
process_data.context = ota_handle;
return core_mqtt_setopt(ota_handle->mqtt_handle, option, &process_data);
}
void *aiot_ota_init(void)
{
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
ota_handle = sysdep->core_sysdep_malloc(sizeof(ota_handle_t), OTA_MODULE_NAME);
if (ota_handle == NULL) {
return NULL;
}
memset(ota_handle, 0, sizeof(ota_handle_t));
ota_handle->data_mutex = sysdep->core_sysdep_mutex_init();
ota_handle->sysdep = sysdep;
core_global_init(sysdep);
return ota_handle;
}
int32_t aiot_ota_deinit(void **handle)
{
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
int count = 0;
int32_t res;
if (NULL == handle || NULL == *handle) {
return STATE_OTA_DEINIT_HANDLE_IS_NULL;
}
ota_handle = * (ota_handle_t **)handle;
_ota_core_mqtt_operate_process_handler(ota_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
for (count = 0; count < OTA_TOPIC_NUM; count++) {
aiot_mqtt_topic_map_t topic_map = g_ota_topic_map[count];
res = aiot_mqtt_setopt(ota_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, (void *)&topic_map);
if (STATE_SUCCESS != res) {
continue;
}
}
sysdep = ota_handle->sysdep;
core_global_deinit(sysdep);
sysdep->core_sysdep_mutex_deinit(&(ota_handle->data_mutex));
sysdep->core_sysdep_free(ota_handle);
*handle = NULL;
return STATE_SUCCESS;
}
int32_t aiot_ota_setopt(void *handle, aiot_ota_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
ota_handle_t *ota_handle = (ota_handle_t *)handle;
aiot_sysdep_portfile_t *sysdep = NULL;
if (NULL == ota_handle) {
return STATE_OTA_SETOPT_HANDLE_IS_NULL;
}
if (NULL == data) {
return STATE_OTA_SETOPT_DATA_IS_NULL;
}
sysdep = ota_handle->sysdep;
sysdep->core_sysdep_mutex_lock(ota_handle->data_mutex);
switch (option) {
case AIOT_OTAOPT_RECV_HANDLER: {
ota_handle->recv_handler = (aiot_ota_recv_handler_t)data;
}
break;
case AIOT_OTAOPT_USERDATA: {
ota_handle->userdata = data;
}
break;
case AIOT_OTAOPT_MQTT_HANDLE: {
ota_handle->mqtt_handle = data;
res = _ota_subscribe(data, ota_handle);
if (res >= STATE_SUCCESS) {
res = _ota_core_mqtt_operate_process_handler(ota_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
}
break;
case AIOT_OTAOPT_MODULE: {
ota_handle->module = data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
sysdep->core_sysdep_mutex_unlock(ota_handle->data_mutex);
return res;
}
void *aiot_download_init(void)
{
download_handle_t *download_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
void *http_handle = NULL;
uint32_t default_body_max_len = OTA_DEFAULT_DOWNLOAD_BUFLEN;
uint32_t default_timeout_ms = OTA_DEFAULT_DOWNLOAD_TIMEOUT_MS;
sysdep = aiot_sysdep_get_portfile();
if (NULL == sysdep) {
return NULL;
}
download_handle = sysdep->core_sysdep_malloc(sizeof(download_handle_t), DOWNLOAD_MODULE_NAME);
if (NULL == download_handle) {
return NULL;
}
memset(download_handle, 0, sizeof(download_handle_t));
download_handle->sysdep = sysdep;
download_handle->data_mutex = sysdep->core_sysdep_mutex_init();
download_handle->recv_mutex = sysdep->core_sysdep_mutex_init();
http_handle = core_http_init();
if (NULL == http_handle) {
sysdep->core_sysdep_free(download_handle);
return NULL;
}
if ((STATE_SUCCESS != core_http_setopt(http_handle, CORE_HTTPOPT_RECV_HANDLER, _http_recv_handler)) ||
(STATE_SUCCESS != core_http_setopt(http_handle, CORE_HTTPOPT_USERDATA, (void *)download_handle)) ||
(STATE_SUCCESS != core_http_setopt(http_handle, CORE_HTTPOPT_BODY_BUFFER_MAX_LEN, (void *)&default_body_max_len)) ||
(STATE_SUCCESS != core_http_setopt(http_handle, CORE_HTTPOPT_RECV_TIMEOUT_MS, (void *)&default_timeout_ms))) {
sysdep->core_sysdep_free(download_handle);
sysdep->core_sysdep_free(http_handle);
return NULL;
}
download_handle->http_handle = http_handle;
return download_handle;
}
int32_t aiot_download_deinit(void **handle)
{
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == *handle) {
return STATE_DOWNLOAD_DEINIT_HANDLE_IS_NULL;
}
download_handle_t *download_handle = *(download_handle_t **)(handle);
aiot_sysdep_portfile_t *sysdep = download_handle->sysdep;
core_http_deinit(&(download_handle->http_handle));
if (NULL != download_handle->task_desc) {
if (AIOT_OTA_DIGEST_SHA256 == download_handle->task_desc->digest_method) {
if (NULL != download_handle->digest_ctx) {
core_sha256_free(download_handle->digest_ctx);
sysdep->core_sysdep_free(download_handle->digest_ctx);
}
} else if (AIOT_OTA_DIGEST_MD5 == download_handle->task_desc->digest_method) {
if (NULL != download_handle->digest_ctx) {
utils_md5_free(download_handle->digest_ctx);
sysdep->core_sysdep_free(download_handle->digest_ctx);
}
}
_download_deep_free_task_desc(sysdep, download_handle->task_desc);
sysdep->core_sysdep_free(download_handle->task_desc);
}
sysdep->core_sysdep_mutex_deinit(&(download_handle->data_mutex));
sysdep->core_sysdep_mutex_deinit(&(download_handle->recv_mutex));
sysdep->core_sysdep_free(download_handle);
*handle = NULL;
return res;
}
int32_t aiot_download_setopt(void *handle, aiot_download_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
download_handle_t *download_handle = (download_handle_t *)handle;
if (download_handle == NULL) {
return STATE_DOWNLOAD_SETOPT_HANDLE_IS_NULL;
}
if (NULL == data) {
return STATE_DOWNLOAD_SETOPT_DATA_IS_NULL;
}
aiot_sysdep_portfile_t *sysdep = download_handle->sysdep;
sysdep->core_sysdep_mutex_lock(download_handle->data_mutex);
switch (option) {
case AIOT_DLOPT_NETWORK_CRED: {
res = core_http_setopt(download_handle->http_handle, CORE_HTTPOPT_NETWORK_CRED, data);
}
break;
case AIOT_DLOPT_NETWORK_PORT: {
res = core_http_setopt(download_handle->http_handle, CORE_HTTPOPT_PORT, data);
}
break;
case AIOT_DLOPT_RECV_TIMEOUT_MS: {
uint32_t *timeout_ms = (uint32_t *)data;
void *http_handle = download_handle->http_handle;
res = core_http_setopt(http_handle, CORE_HTTPOPT_RECV_TIMEOUT_MS, timeout_ms);
}
break;
case AIOT_DLOPT_USERDATA: {
download_handle->userdata = data;
}
break;
case AIOT_DLOPT_TASK_DESC: {
void *new_task_desc = _download_deep_copy_task_desc(sysdep, data);
if (NULL == new_task_desc) {
res = STATE_DOWNLOAD_SETOPT_COPIED_DATA_IS_NULL;
break;
}
download_handle->task_desc = (aiot_download_task_desc_t *)new_task_desc;
if (AIOT_OTA_DIGEST_SHA256 == download_handle->task_desc->digest_method) {
core_sha256_context_t *ctx = sysdep->core_sysdep_malloc(sizeof(core_sha256_context_t), OTA_MODULE_NAME);
if (NULL == ctx) {
res = STATE_DOWNLOAD_SETOPT_MALLOC_SHA256_CTX_FAILED;
break;
}
core_sha256_init(ctx);
core_sha256_starts(ctx);
download_handle->digest_ctx = (void *) ctx;
} else if (AIOT_OTA_DIGEST_MD5 == download_handle->task_desc->digest_method) {
utils_md5_context_t *ctx = sysdep->core_sysdep_malloc(sizeof(utils_md5_context_t), OTA_MODULE_NAME);
if (NULL == ctx) {
res = STATE_DOWNLOAD_SETOPT_MALLOC_MD5_CTX_FAILED;
break;
}
utils_md5_init(ctx);
utils_md5_starts(ctx);
download_handle->digest_ctx = (void *) ctx;
}
download_handle->download_status = DOWNLOAD_STATUS_START;
}
break;
case AIOT_DLOPT_RANGE_START: {
download_handle->range_start = *(uint32_t *)data;
download_handle->range_size_fetched = 0;
}
break;
case AIOT_DLOPT_RANGE_END: {
download_handle->range_end = *(uint32_t *)data;
download_handle->range_size_fetched = 0;
}
break;
case AIOT_DLOPT_RECV_HANDLER: {
download_handle->recv_handler = (aiot_download_recv_handler_t)data;
}
break;
case AIOT_DLOPT_BODY_BUFFER_MAX_LEN: {
res = core_http_setopt(download_handle->http_handle, CORE_HTTPOPT_BODY_BUFFER_MAX_LEN, data);
}
break;
default: {
res = STATE_USER_INPUT_OUT_RANGE;
}
break;
}
sysdep->core_sysdep_mutex_unlock(download_handle->data_mutex);
return res;
}
int32_t aiot_ota_report_version(void *handle, char *version)
{
int32_t res = STATE_SUCCESS;
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep;
char *payload_string;
char *product_key;
char *device_name;
ota_handle = (ota_handle_t *)handle;
if (NULL == ota_handle) {
return STATE_OTA_REPORT_HANDLE_IS_NULL;
}
if (NULL == version) {
return STATE_OTA_REPORT_VERSION_IS_NULL;
}
core_mqtt_handle_t *mqtt_handle = ota_handle->mqtt_handle;
if (NULL == mqtt_handle) {
return STATE_OTA_REPORT_MQTT_HANDLE_IS_NULL;
}
product_key = mqtt_handle->product_key;
device_name = mqtt_handle->device_name;
sysdep = ota_handle->sysdep;
if (ota_handle->module) {
char *src[] = {"{\"version\":\"", version, "\",\"module\":\"", ota_handle->module, "\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s%s%s", src, topic_len, OTA_MODULE_NAME);
} else {
char *src[] = {"{\"version\":\"", version, "\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s", src, topic_len, OTA_MODULE_NAME);
}
res = _ota_publish_base(mqtt_handle, OTA_VERSION_TOPIC_PREFIX, product_key, device_name, NULL, payload_string);
sysdep->core_sysdep_free(payload_string);
return res;
}
int32_t aiot_ota_report_version_ext(void *handle, char *product_key, char *device_name, char *version)
{
int32_t res = STATE_SUCCESS;
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep;
char *payload_string;
ota_handle = (ota_handle_t *)handle;
if (NULL == ota_handle) {
return STATE_OTA_REPORT_EXT_HANELD_IS_NULL;
}
if (NULL == version) {
return STATE_OTA_REPORT_EXT_VERSION_NULL;
}
if (NULL == product_key) {
return STATE_OTA_REPORT_EXT_PRODUCT_KEY_IS_NULL;
}
if (NULL == device_name) {
return STATE_OTA_REPORT_EXT_DEVICE_NAME_IS_NULL;
}
core_mqtt_handle_t *mqtt_handle = ota_handle->mqtt_handle;
if (NULL == mqtt_handle) {
return STATE_OTA_REPORT_EXT_MQTT_HANDLE_IS_NULL;
}
sysdep = ota_handle->sysdep;
{
char *src[] = {"{\"version\":\"", version, "\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s", src, topic_len, OTA_MODULE_NAME);
}
res = _ota_publish_base(mqtt_handle, OTA_VERSION_TOPIC_PREFIX, product_key, device_name, NULL, payload_string);
sysdep->core_sysdep_free(payload_string);
return res;
}
int32_t aiot_ota_query_firmware(void *handle)
{
int32_t res = STATE_SUCCESS;
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
char *payload_string;
if (NULL == handle) {
return STATE_OTA_QUERY_FIRMWARE_HANDLE_IS_NULL;
}
ota_handle = (ota_handle_t *)handle;
sysdep = ota_handle->sysdep;
if (ota_handle->module) {
char *src[] = {"{\"module\":\"", ota_handle->module, "\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s", src, topic_len, OTA_MODULE_NAME);
} else {
char *src[] = {"{}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s", src, topic_len, OTA_MODULE_NAME);
}
res = _ota_publish_base(ota_handle->mqtt_handle, OTA_GET_TOPIC_PREFIX,
((core_mqtt_handle_t *)(ota_handle->mqtt_handle))->product_key,
((core_mqtt_handle_t *)(ota_handle->mqtt_handle))->device_name, OTA_GET_TOPIC_SUFFIX, payload_string);
sysdep->core_sysdep_free(payload_string);
return res;
}
int32_t aiot_download_report_progress(void *handle, int32_t percent)
{
int32_t res = STATE_SUCCESS;
download_handle_t *download_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
char out_buffer[4] = {0};
uint8_t out_len;
char *payload_string;
if (NULL == handle) {
return STATE_DOWNLOAD_REPORT_HANDLE_IS_NULL;
}
download_handle = (download_handle_t *)handle;
sysdep = download_handle->sysdep;
if (NULL == download_handle->task_desc) {
return STATE_DOWNLOAD_REPORT_TASK_DESC_IS_NULL;
}
core_int2str(percent, out_buffer, &out_len);
if (download_handle->task_desc->module) {
char *src[] = {"{\"step\":\"", out_buffer, "\",\"desc\":\"\",\"module\":\"", download_handle->task_desc->module, "\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s%s%s", src, topic_len, OTA_MODULE_NAME);
} else {
char *src[] = {"{\"step\":\"", out_buffer, "\",\"desc\":\"\"}"};
uint8_t topic_len = sizeof(src) / sizeof(char *);
core_sprintf(sysdep, &payload_string, "%s%s%s", src, topic_len, OTA_MODULE_NAME);
}
res = _ota_publish_base(download_handle->task_desc->mqtt_handle, OTA_PROGRESS_TOPIC_PREFIX,
download_handle->task_desc->product_key,
download_handle->task_desc->device_name, NULL, payload_string);
sysdep->core_sysdep_free(payload_string);
return res;
}
int32_t aiot_download_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
download_handle_t *download_handle = (download_handle_t *)handle;
aiot_sysdep_portfile_t *sysdep = NULL;
void *http_handle = NULL;
if (NULL == download_handle) {
return STATE_DOWNLOAD_RECV_HANDLE_IS_NULL;
}
http_handle = download_handle->http_handle;
sysdep = download_handle->sysdep;
sysdep->core_sysdep_mutex_lock(download_handle->recv_mutex);
switch (download_handle->download_status) {
case DOWNLOAD_STATUS_RENEWAL: {
/* 下载中断, 发起断点续传 */
res = aiot_download_send_request(download_handle);
if (res == STATE_SUCCESS) {
res = STATE_DOWNLOAD_RENEWAL_REQUEST_SENT;
}
}
break;
case DOWNLOAD_STATUS_FETCH: {
/* 去网络收取报文, 并将各种状态值反馈给用户 */
res = core_http_recv(http_handle);
/* 全部固件下载完成 */
if (download_handle->size_fetched == download_handle->task_desc->size_total) {
res = STATE_DOWNLOAD_FINISHED;
break;
}
/* 用户用多个range下载, 可能有重合, 导致最终累计的下载长度超出了固件的实际长度 */
if (download_handle->size_fetched > download_handle->task_desc->size_total) {
res = STATE_DOWNLOAD_FETCH_TOO_MANY;
break;
}
/* 没有下载完整个固件, 但是下载完成了用户指定的range */
if (download_handle->range_size_fetched == download_handle->content_len) {
res = STATE_DOWNLOAD_RANGE_FINISHED;
break;
}
if (res <= 0) {
/* 在没有下载完成, 同时又碰到core_http_recv的返回值<=0的情况, 需要做断点续传 */
uint8_t res_string_len = 0;
char res_string[OTA_MAX_DIGIT_NUM_OF_UINT32] = {0};
core_int2str(res, res_string, &res_string_len);
core_log1(download_handle->sysdep, STATE_DOWNLOAD_RECV_ERROR, "recv got %s, renewal\r\n",
&res_string);
download_handle->download_status = DOWNLOAD_STATUS_RENEWAL;
} else {
/* 在下载未完成(或者未开始), 同时core_http_recv的返回值>0的情况, 需要判断是否出现了http返回值403错误, 以及判断包头格式是否异常 */
if (OTA_RESPONSE_OK != download_handle->http_rsp_status_code
&& OTA_RESPONSE_PARTIAL != download_handle->http_rsp_status_code) {
/* HTTP回复报文的code应该是200或者206, 否则这个下载链接不可用 */
res = STATE_DOWNLOAD_HTTPRSP_CODE_ERROR;
} else if (0 == download_handle->content_len) {
/* HTTP回复报文的header里面应该有Content-Length, 否则这个下载链接为trunked编码, 不可用 */
res = STATE_DOWNLOAD_HTTPRSP_HEADER_ERROR;
}
/* 如果没有上述code错误或者content_length字段错误, 则返回正数值, 表示下载到的字节数 */
}
}
break;
default:
break;
}
sysdep->core_sysdep_mutex_unlock(download_handle->recv_mutex);
return res;
}
/* 对aiot_download_task_desc_t结构体里面的指针所指向的内容进行深度释放 */
int32_t _download_deep_free_task_desc(aiot_sysdep_portfile_t *sysdep, void *data)
{
int32_t res = STATE_SUCCESS;
aiot_download_task_desc_t *task_desc = (aiot_download_task_desc_t *)data;
if (NULL == task_desc) {
return res;
}
if (NULL != task_desc->product_key) {
sysdep->core_sysdep_free(task_desc->product_key);
}
if (NULL != task_desc->device_name) {
sysdep->core_sysdep_free(task_desc->device_name);
}
if (NULL != task_desc->url) {
sysdep->core_sysdep_free(task_desc->url);
}
if (NULL != task_desc->expect_digest) {
sysdep->core_sysdep_free(task_desc->expect_digest);
}
if (NULL != task_desc->version) {
sysdep->core_sysdep_free(task_desc->version);
}
if (NULL != task_desc->module) {
sysdep->core_sysdep_free(task_desc->module);
}
if (NULL != task_desc->extra_data) {
sysdep->core_sysdep_free(task_desc->extra_data);
}
return res;
}
/* 从下行报文的topic中, 解析出product_key, device_name, ota的类型 */
int32_t _ota_prase_topic(aiot_sysdep_portfile_t *sysdep, char *topic, uint8_t topic_len,
ota_type_t *type, char **product_key, char **device_name)
{
char *_product_key, *_device_name, *tmp;
char *_product_key_local, *_device_name_local;
uint8_t _product_key_len, _device_name_len;
const char *SLASH = "/";
uint8_t slash_len = strlen(SLASH);
if (memcmp(topic, OTA_FOTA_TOPIC_PREFIX, strlen(OTA_FOTA_TOPIC_PREFIX)) == 0) {
/* 判断是fota的/ota/device/upgrade的topic, 并且从中解出来product_key, device_name */
_product_key = topic + strlen(OTA_FOTA_TOPIC_PREFIX) + slash_len;
tmp = strstr((const char *)(_product_key), SLASH);
_product_key_len = tmp - _product_key;
_device_name = tmp + slash_len;
_device_name_len = topic_len - (_device_name - topic);
*type = OTA_TYPE_FOTA;
} else if ((topic_len > strlen(OTA_GET_REPLY_TOPIC_SUFFIX))
&& (0 == memcmp(topic + topic_len - strlen(OTA_GET_REPLY_TOPIC_SUFFIX),
OTA_GET_REPLY_TOPIC_SUFFIX, strlen(OTA_GET_REPLY_TOPIC_SUFFIX)))) {
/* 判断是fota的firmware/get的topic, 并且从中解出来product_key, device_name */
_product_key = topic + strlen(OTA_GET_TOPIC_PREFIX) + slash_len;
tmp = strstr((const char *)(_product_key), SLASH);
_product_key_len = tmp - _product_key;
_device_name = tmp + slash_len;
_device_name_len = strstr((const char *)topic, OTA_GET_REPLY_TOPIC_SUFFIX) - _device_name - slash_len;
*type = OTA_TYPE_FOTA;
} else {
/* 判断是cota的topic, 同时还区分是config/push还是config/get, 从中解出来product_key, device_name */
char *postfix = NULL;
_product_key = topic + strlen(OTA_COTA_TOPIC_PREFIX);
tmp = strstr((const char *)(_product_key), SLASH);
_product_key_len = tmp - _product_key;
_device_name = tmp + slash_len;
tmp = strstr((const char *)(_device_name), SLASH);
_device_name_len = tmp - _device_name;
postfix = _device_name + _device_name_len;
if (0 != memcmp(postfix, OTA_COTA_PUSH_TOPIC_POSTFIX, strlen(OTA_COTA_PUSH_TOPIC_POSTFIX))) {
*type = OTA_TYPE_CONFIG_GET;
} else {
*type = OTA_TYPE_CONFIG_PUSH;
};
}
if ((NULL == (_product_key_local = sysdep->core_sysdep_malloc(_product_key_len + 1, OTA_MODULE_NAME)))
|| (NULL == (_device_name_local = sysdep->core_sysdep_malloc(_device_name_len + 1, OTA_MODULE_NAME)))) {
if (NULL != _product_key_local) {
sysdep->core_sysdep_free(_product_key_local);
};
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(_product_key_local, 0, _product_key_len + 1);
memcpy(_product_key_local, _product_key, _product_key_len);
*product_key = _product_key_local;
memset(_device_name_local, 0, _device_name_len + 1);
memcpy(_device_name_local, _device_name, _device_name_len);
*device_name = _device_name_local;
return STATE_SUCCESS;
}
/* OTA topic的mqtt回调函数. 主要作用是解析OTA下行的MQTT报文, 从中解析出url/digest等有关的信息 */
void _ota_mqtt_process(void *handle, const aiot_mqtt_recv_t *const packet, void *userdata)
{
int32_t res = STATE_SUCCESS;
ota_handle_t *ota_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
char *size_string = NULL, *digest_method_string = NULL;
char *product_key = NULL, *device_name = NULL;
char *data = NULL, *key = NULL;
uint32_t data_len = 0, size = 0;
ota_type_t type;
aiot_download_task_desc_t task_desc = {0};
if (AIOT_MQTTRECV_PUB != packet->type) {
return;
}
ota_handle = (ota_handle_t *)userdata;
if (NULL == userdata) {
return;
}
sysdep = ota_handle->sysdep;
res = _ota_prase_topic(sysdep, packet->data.pub.topic, packet->data.pub.topic_len,
&type, &product_key, &device_name);
if (res != STATE_SUCCESS) {
goto exit;
}
task_desc.product_key = product_key;
task_desc.device_name = device_name;
task_desc.mqtt_handle = ota_handle->mqtt_handle;
/* 如果是config/push这种topic, 下载有关的信息存放在json报文的params字段里面
* 如果是其他类型的topic, 则下载有关的信息放在json报文的data字段里面
*/
key = "data";
if (OTA_TYPE_CONFIG_PUSH == type) {
key = "params";
}
res = core_json_value((const char *)(packet->data.pub.payload), packet->data.pub.payload_len,
key, strlen(key), &data, &data_len);
if (res != STATE_SUCCESS) {
goto exit;
}
if (OTA_TYPE_FOTA == type) {
/* 对于FOTA来说, 下载文件大小的关键字是size, 版本有关的关键字是version */
if ((STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "size", &size_string))
|| (STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "version", &(task_desc.version)))) {
goto exit;
}
} else {
/* 对于COTA来说, 下载文件大小的关键字是configSize, 版本有关的关键字是configId */
if ((STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "configSize", &size_string))
|| (STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "configId", &(task_desc.version)))) {
goto exit;
}
}
core_str2uint(size_string, strlen(size_string), &size);
task_desc.size_total = size;
if ((STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "url", &(task_desc.url)))
|| (STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "sign", &(task_desc.expect_digest)))
|| (STATE_SUCCESS != _ota_parse_json(sysdep, data, data_len, "signMethod", &(digest_method_string)))) {
goto exit;
}
if (strcmp(digest_method_string, "SHA256") == 0 || strcmp(digest_method_string, "Sha256") == 0) {
task_desc.digest_method = AIOT_OTA_DIGEST_SHA256;
} else if (strcmp(digest_method_string, "Md5") == 0) {
task_desc.digest_method = AIOT_OTA_DIGEST_MD5;
} else {
res = STATE_OTA_UNKNOWN_DIGEST_METHOD;
goto exit;
}
if ((task_desc.digest_method == AIOT_OTA_DIGEST_MD5 && strlen(task_desc.expect_digest) != OTA_MD5_LEN) ||
(task_desc.digest_method == AIOT_OTA_DIGEST_SHA256 && strlen(task_desc.expect_digest) != OTA_SHA256_LEN)) {
goto exit;
}
/* module字段, 并非必选(用户可能没有在云端设置过, 因此如果没有解析出来, 也不能算解析失败 */
_ota_parse_json(sysdep, data, data_len, "module", &(task_desc.module));
_ota_parse_json(sysdep, data, data_len, "extData", &(task_desc.extra_data));
aiot_ota_recv_t msg = {
/* 对于用户, 需要屏蔽config/push和config/get的区别, 都归并为AIOT_OTARECV_COTA */
.type = (OTA_TYPE_FOTA == type) ? AIOT_OTARECV_FOTA : AIOT_OTARECV_COTA,
.task_desc = &task_desc
};
if (ota_handle->recv_handler) {
ota_handle->recv_handler(ota_handle, &msg, ota_handle->userdata);
}
exit:
if (NULL != size_string) {
sysdep->core_sysdep_free(size_string);
}
if (NULL != digest_method_string) {
sysdep->core_sysdep_free(digest_method_string);
}
_download_deep_free_task_desc(sysdep, (void *)(&task_desc));
}
/* 解析URL, 从中解出来host, path */
static int32_t _download_parse_url(const char *url, char *host, uint32_t max_host_len, char *path,
uint32_t max_path_len)
{
char *host_ptr = (char *) strstr(url, "://");
uint32_t host_len = 0;
uint32_t path_len;
char *path_ptr;
char *fragment_ptr;
if (host_ptr == NULL) {
return STATE_OTA_PARSE_URL_HOST_IS_NULL;
}
host_ptr += 3;
path_ptr = strchr(host_ptr, '/');
if (NULL == path_ptr) {
return STATE_OTA_PARSE_URL_PATH_IS_NULL;
}
if (host_len == 0) {
host_len = path_ptr - host_ptr;
}
if (host_len >= max_host_len) {
return STATE_OTA_HOST_STRING_OVERFLOW;
}
memcpy(host, host_ptr, host_len);
host[host_len] = '\0';
fragment_ptr = strchr(host_ptr, '#');
if (fragment_ptr != NULL) {
path_len = fragment_ptr - path_ptr;
} else {
path_len = strlen(path_ptr);
}
if (path_len >= max_path_len) {
return STATE_OTA_PATH_STRING_OVERFLOW;
}
memcpy(path, path_ptr, path_len);
path[path_len] = '\0';
return STATE_SUCCESS;
}
/* 往固件服务器发送下载所需的GET请求 */
int32_t aiot_download_send_request(void *handle)
{
int32_t res = STATE_SUCCESS;
char host[OTA_HTTPCLIENT_MAX_URL_LEN] = { 0 };
char path[OTA_HTTPCLIENT_MAX_URL_LEN] = { 0 };
char *header_string = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
download_handle_t *download_handle = (download_handle_t *)handle;
if (NULL == download_handle) {
return STATE_DOWNLOAD_REQUEST_HANDLE_IS_NULL;
}
if (NULL == download_handle->task_desc) {
return STATE_DOWNLOAD_REQUEST_TASK_DESC_IS_NULL;
}
if (NULL == download_handle->task_desc->url) {
return STATE_DOWNLOAD_REQUEST_URL_IS_NULL;
}
sysdep = download_handle->sysdep;
{
uint32_t range_start = download_handle->range_start;
uint32_t range_end = download_handle->range_end;
uint8_t range_start_string_len = 0;
uint8_t range_end_string_len = 0;
char range_start_string[OTA_MAX_DIGIT_NUM_OF_UINT32] = {0};
char range_end_string[OTA_MAX_DIGIT_NUM_OF_UINT32] = {0};
/* 对于按照range下载的情况, 如果中间出现了断点续传的情况, 则需要从range_start后面的续传位置开始 */
uint32_t renewal_start = range_start + download_handle->range_size_fetched;
core_int2str(renewal_start, range_start_string, &range_start_string_len);
/* 对于按照range下载的情况, 即range_end不为0的情况, 需要将其翻译成字符串 */
if (0 != range_end) {
core_int2str(range_end, range_end_string, &range_end_string_len);
}
{
char *prefix = "Accept: text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8\r\nRange: bytes=";
char *src[] = { prefix, range_start_string, "-", range_end_string};
uint32_t len = sizeof(src) / sizeof(char *);
res = core_sprintf(sysdep, &header_string, "%s%s%s%s\r\n", src, len, OTA_MODULE_NAME);
if (res != STATE_SUCCESS) {
if (header_string) {
sysdep->core_sysdep_free(header_string);
}
return res;
}
}
}
res = _download_parse_url(download_handle->task_desc->url, host, OTA_HTTPCLIENT_MAX_URL_LEN, path,
OTA_HTTPCLIENT_MAX_URL_LEN);
if (res != STATE_SUCCESS) {
if (header_string) {
sysdep->core_sysdep_free(header_string);
}
return res;
}
res = core_http_setopt(download_handle->http_handle, CORE_HTTPOPT_HOST, host);
if (res != STATE_SUCCESS) {
if (header_string) {
sysdep->core_sysdep_free(header_string);
}
return res;
}
res = core_http_connect(download_handle->http_handle);
if (res != STATE_SUCCESS) {
if (header_string) {
sysdep->core_sysdep_free(header_string);
}
return res;
}
core_http_request_t request = {
.method = "GET",
.path = path,
.header = header_string,
.content = NULL,
.content_len = 0
};
res = core_http_send(download_handle->http_handle, &request);
if (header_string) {
sysdep->core_sysdep_free(header_string);
}
/* core_http_send 返回的是发送的body的长度; 错误返回负数 */
if (res < STATE_SUCCESS) {
download_handle->download_status = DOWNLOAD_STATUS_START;
res = STATE_DOWNLOAD_SEND_REQUEST_FAILED;
} else {
download_handle->download_status = DOWNLOAD_STATUS_FETCH;
aiot_download_report_progress(download_handle, download_handle->percent);
res = STATE_SUCCESS;
}
return res;
}
/* 根据下载到的固件的内容, 计算其digest值 */
static int32_t _download_digest_update(download_handle_t *download_handle, uint8_t *buffer, uint32_t buffer_len)
{
int32_t res = STATE_SUCCESS;
if (AIOT_OTA_DIGEST_SHA256 == download_handle->task_desc->digest_method) {
core_sha256_update(download_handle->digest_ctx, buffer, buffer_len);
} else if (AIOT_OTA_DIGEST_MD5 == download_handle->task_desc->digest_method) {
res = utils_md5_update(download_handle->digest_ctx, buffer, buffer_len);
}
return res;
}
/* 对计算出来的digest值, 与云端下发的digest值进行比较 */
static int32_t _download_digest_verify(download_handle_t *download_handle)
{
uint8_t output[32] = {0};
uint8_t expected_digest[32] = {0};
if (AIOT_OTA_DIGEST_SHA256 == download_handle->task_desc->digest_method) {
core_str2hex(download_handle->task_desc->expect_digest, OTA_SHA256_LEN, expected_digest);
core_sha256_finish(download_handle->digest_ctx, output);
if (memcmp(output, expected_digest, 32) == 0) {
return STATE_SUCCESS;
}
} else if (AIOT_OTA_DIGEST_MD5 == download_handle->task_desc->digest_method) {
core_str2hex(download_handle->task_desc->expect_digest, OTA_MD5_LEN, expected_digest);
utils_md5_finish(download_handle->digest_ctx, output);
if (memcmp(output, expected_digest, 16) == 0) {
return STATE_SUCCESS;
}
}
return STATE_OTA_DIGEST_MISMATCH;
}
/* 对于收到的http报文进行处理的回调函数, 内部处理完后再调用用户的回调函数 */
void _http_recv_handler(void *handle, const aiot_http_recv_t *packet, void *userdata)
{
download_handle_t *download_handle = (download_handle_t *)userdata;
if (NULL == download_handle || NULL == packet) {
return;
}
switch (packet->type) {
case AIOT_HTTPRECV_STATUS_CODE : {
download_handle->http_rsp_status_code = packet->data.status_code.code;
}
break;
case AIOT_HTTPRECV_HEADER: {
if ((strlen(packet->data.header.key) == strlen("Content-Length")) &&
(memcmp(packet->data.header.key, "Content-Length", strlen(packet->data.header.key)) == 0)) {
uint32_t size = 0;
/* 在用户指定的range并非全部固件的情况下, content_len < size_total, 所以不能简单替换 */
core_str2uint(packet->data.header.value, (uint8_t)strlen(packet->data.header.value), &size);
download_handle->content_len = size;
/* 该字段表示在这个range内总共下载了多少字节, 初始化为0 */
download_handle->range_size_fetched = 0;
}
}
break;
case AIOT_HTTPRECV_BODY: {
int32_t percent = 0;
if (OTA_RESPONSE_OK != download_handle->http_rsp_status_code
/* HTTP回复报文的code应该是200或者206, 否则这个下载链接不可用 */
&& OTA_RESPONSE_PARTIAL != download_handle->http_rsp_status_code) {
percent = AIOT_OTAERR_FETCH_FAILED;
core_log(download_handle->sysdep, STATE_DOWNLOAD_HTTPRSP_CODE_ERROR, "wrong http respond code\r\n");
} else if (0 == download_handle->content_len) {
/* HTTP回复报文的header里面应该有Content-Length, 否则这个下载链接为trunked编码, 不可用 */
percent = AIOT_OTAERR_FETCH_FAILED;
core_log(download_handle->sysdep, STATE_DOWNLOAD_HTTPRSP_HEADER_ERROR, "wrong http respond header\r\n");
} else {
/* 正常的固件的报文 */
/* 在按照多个range分片下载的情况下, 判断用户下载到的固件的累计大小是否超过了整体的值 */
if (download_handle->size_fetched > download_handle->task_desc->size_total) {
core_log(download_handle->sysdep, STATE_DOWNLOAD_FETCH_TOO_MANY, "downloaded exceeds expected\r\n");
break;
}
/* 该字段表示累计下载了多少字节, 不区分range */
download_handle->size_fetched += packet->data.body.len;
/* 该字段表示在这个range内总共下载了多少字节 */
download_handle->range_size_fetched += packet->data.body.len;
/* 当size_fetched*100超过uint32_t能表达的范围时, 比如239395702, 会导致percent计算错误, 因此需要一个更大的临时变量 */
uint64_t tmp_size_fetched = 0;
tmp_size_fetched = download_handle->size_fetched;
percent = (100 * tmp_size_fetched) / download_handle->task_desc->size_total;
/* 计算digest, 如果下载完成, 还要看看是否与云端计算出来的一致 */
_download_digest_update(download_handle, packet->data.body.buffer, packet->data.body.len);
if (download_handle->size_fetched == download_handle->task_desc->size_total) {
int32_t ret = _download_digest_verify(download_handle);
if (ret != STATE_SUCCESS) {
percent = AIOT_OTAERR_CHECKSUM_MISMATCH;
core_log(download_handle->sysdep, ret, "digest mismatch\r\n");
aiot_download_report_progress(download_handle, AIOT_OTAERR_CHECKSUM_MISMATCH);
} else {
core_log(download_handle->sysdep, STATE_OTA_DIGEST_MATCH, "digest matched\r\n");
}
}
download_handle->percent = percent;
/* 调用用户的回调函数, 将报文传给用户 */
if (NULL != download_handle->recv_handler) {
aiot_download_recv_t recv_data = {
.type = AIOT_DLRECV_HTTPBODY,
.data = {
.buffer = packet->data.body.buffer,
.len = packet->data.body.len,
.percent = percent
}
};
download_handle->recv_handler(download_handle, &recv_data, download_handle->userdata);
}
}
}
break;
default:
break;
}
}
/* 提供深度拷贝的底层函数 */
static void *_download_deep_copy_base(aiot_sysdep_portfile_t *sysdep, char *in)
{
uint8_t len = 0;
void *tmp = NULL;
if (NULL == in) {
return NULL;
}
len = strlen(in) + 1;
tmp = (aiot_download_task_desc_t *)sysdep->core_sysdep_malloc(len,
DOWNLOAD_MODULE_NAME);
if (NULL == tmp) {
return NULL;
}
memset(tmp, 0, len);
memcpy(tmp, in, strlen(in));
return tmp;
}
/* 对aiot_download_task_desc_t结构体实现深度拷贝 */
static void *_download_deep_copy_task_desc(aiot_sysdep_portfile_t *sysdep, void *data)
{
aiot_download_task_desc_t *src_task_desc = (aiot_download_task_desc_t *)data;
aiot_download_task_desc_t *dst_task_desc = NULL;
dst_task_desc = (aiot_download_task_desc_t *)sysdep->core_sysdep_malloc(sizeof(aiot_download_task_desc_t),
DOWNLOAD_MODULE_NAME);
if (NULL == dst_task_desc) {
return NULL;
}
memset(dst_task_desc, 0, sizeof(aiot_download_task_desc_t));
dst_task_desc->size_total = src_task_desc->size_total;
dst_task_desc->digest_method = src_task_desc->digest_method;
dst_task_desc->mqtt_handle = src_task_desc->mqtt_handle;
/* 对于module字段, 只有判断云端有下发过module的报文, 才能认为出参是要有module字段的 */
if (NULL != src_task_desc->module) {
if (NULL == (dst_task_desc->module = _download_deep_copy_base(sysdep, src_task_desc->module))) {
return NULL;
}
}
if ((NULL == (dst_task_desc->product_key = _download_deep_copy_base(sysdep, src_task_desc->product_key)))
|| (NULL == (dst_task_desc->device_name = _download_deep_copy_base(sysdep, src_task_desc->device_name)))
|| (NULL == (dst_task_desc->url = _download_deep_copy_base(sysdep, src_task_desc->url)))
|| (NULL == (dst_task_desc->version = _download_deep_copy_base(sysdep, src_task_desc->version)))
|| (NULL == (dst_task_desc->expect_digest = _download_deep_copy_base(sysdep, src_task_desc->expect_digest)))) {
_download_deep_free_task_desc(sysdep, dst_task_desc);
sysdep->core_sysdep_free(dst_task_desc);
return NULL;
}
return dst_task_desc;
}
/* 提供上报版本号与上报进度的底层函数 */
static int32_t _ota_publish_base(void *handle, char *topic_prefix, char *product_key,
char *device_name, char *suffix, char *params)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
char *topic_string = NULL;
char *payload_string = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
if (NULL == product_key || NULL == device_name || NULL == mqtt_handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
sysdep = mqtt_handle->sysdep;
/* 拼装topic */
if (NULL == suffix) {
char *src[] = { topic_prefix, product_key, device_name };
uint8_t topic_len = sizeof(src) / sizeof(char *);
res = core_sprintf(sysdep, &topic_string, "%s/%s/%s", src, topic_len, OTA_MODULE_NAME);
if (res != STATE_SUCCESS) {
goto exit;
}
} else {
char *src[] = { topic_prefix, product_key, device_name, suffix };
uint8_t topic_len = sizeof(src) / sizeof(char *);
res = core_sprintf(sysdep, &topic_string, "%s/%s/%s/%s", src, topic_len, OTA_MODULE_NAME);
if (res != STATE_SUCCESS) {
goto exit;
}
}
/* 拼装payload, 几种报文都是基于alink协议, 所以需要alink id */
{
int32_t alink_id;
uint8_t alink_id_string_len;
char alink_id_string[OTA_MAX_DIGIT_NUM_OF_UINT32] = {0};
res = core_global_alink_id_next(sysdep, &alink_id);
if (res != STATE_SUCCESS) {
goto exit;
}
core_int2str(alink_id, alink_id_string, &alink_id_string_len);
{
char *src[] = {
"{\"id\":", alink_id_string, ", \"params\":", params, "}"
};
uint8_t topic_len = sizeof(src) / sizeof(char *);
res = core_sprintf(sysdep, &payload_string, "%s%s%s%s%s", src, topic_len, OTA_MODULE_NAME);
if (res != STATE_SUCCESS) {
goto exit;
}
}
}
res = aiot_mqtt_pub(mqtt_handle, topic_string, (uint8_t *)payload_string, strlen(payload_string), 0);
exit:
if (NULL != topic_string) {
sysdep->core_sysdep_free(topic_string);
}
if (NULL != payload_string) {
sysdep->core_sysdep_free(payload_string);
}
if (res != STATE_SUCCESS) {
core_log(sysdep, STATE_OTA_REPORT_FAILED, topic_prefix);
}
return res;
}
/* 将ota的回调函数挂载到mqtt模块里面 */
static int32_t _ota_subscribe(void *mqtt_handle, void *ota_handle)
{
int32_t res = STATE_SUCCESS;
char *topic[OTA_TOPIC_NUM] = { OTA_FOTA_TOPIC, OTA_COTA_PUSH_TOPIC, OTA_COTA_GET_REPLY_TOPIC, OTA_OTA_GET_REPLY_TOPIC };
uint8_t count = 0;
memset(&g_ota_topic_map, 0, sizeof(g_ota_topic_map));
for (count = 0; count < OTA_TOPIC_NUM; count++) {
char *topic_string = topic[count];
aiot_mqtt_topic_map_t topic_map = {topic_string, _ota_mqtt_process, (void *)ota_handle};
g_ota_topic_map[count] = topic_map;
res = aiot_mqtt_setopt(mqtt_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP, (void *)&topic_map);
if (STATE_SUCCESS != res) {
break;
}
}
return res;
}
/* 解析json报文, 并且将解析出来的内容, 填充到malloc出来的一片内存中 */
static int32_t _ota_parse_json(aiot_sysdep_portfile_t *sysdep, void *input, uint32_t input_len, char *key_word,
char **out)
{
int32_t res = STATE_SUCCESS;
char *value = NULL, *buffer = NULL;
uint32_t value_len = 0, buffer_len = 0;
res = core_json_value((const char *)input, input_len, key_word, strlen(key_word), &value, &value_len);
if (res != STATE_SUCCESS) {
return STATE_OTA_PARSE_JSON_ERROR;
}
buffer_len = value_len + 1;
buffer = sysdep->core_sysdep_malloc(buffer_len, OTA_MODULE_NAME);
if (NULL == buffer) {
return STATE_OTA_PARSE_JSON_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len);
memcpy(buffer, value, value_len);
*out = buffer;
return res;
}
| YifuLiu/AliOS-Things | components/linksdk/components/ota/aiot_ota_api.c | C | apache-2.0 | 46,752 |
/**
* @file aiot_ota_api.h
* @brief OTA模块头文件, 提供设备获取固件升级和远程配置的能力
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
* @details
*
* OTA模块可用于配合阿里云平台的固件升级服务, 在[推送固件到设备](https://help.aliyun.com/document_detail/58328.html)页面有介绍OTA的控制操作流程
*
* + 参考[设备端OTA升级](https://help.aliyun.com/document_detail/58328.html)页面, 了解设备端配合OTA升级时的网络交互流程
*
* + 设备要使用OTA服务, 必须先以@ref aiot_ota_report_version 向云端上报当前的固件版本号, 否则无法接收到固件信息推送
* + 设备下载固件时, 设备自行用@ref aiot_download_send_request 从云端获取, SDK不会自动下载固件
* + 设备下载中或者下载完成后, 设备需自行将内存buffer中的固件内容写到Flash上, SDK不含有固件烧录的逻辑
* + 设备升级完成后, 需以@ref aiot_ota_report_version 接口, 向云端上报升级后的新固件版本号, 否则云端不会认为升级完成
* + 设备从@ref aiot_ota_recv_handler_t 收到升级任务时, 如果忽略了该任务, 可以通过调用@ref aiot_ota_query_firmware 再次收到该任务
*
* + 用户在控制台推送固件的下载地址等信息给设备时, 是通过MQTT通道, 所以设备OTA升级的前提是成功建立并保持MQTT长连接通道在线
*
*/
#ifndef __AIOT_OTA_API_H__
#define __AIOT_OTA_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief 云端下行的OTA消息的类型, 分为固件升级和远程配置两种
*
* @details
* 传入@ref aiot_ota_recv_handler_t 的MQTT报文类型
*
*/
typedef enum {
/**
* @brief 收到的OTA消息为固件升级消息
*
*/
AIOT_OTARECV_FOTA,
/**
* @brief 收到的OTA消息为远程配置消息
*
*/
AIOT_OTARECV_COTA
} aiot_ota_recv_type_t;
/**
* @brief OTA过程中使用的digest方法类型, 分为MD5和SHA256两种
*
*/
typedef enum {
/**
* @brief 收到的OTA固件的digest方法为MD5
*
*/
AIOT_OTA_DIGEST_MD5,
/**
* @brief 收到的OTA固件的digest方法为SHA256
*
*/
AIOT_OTA_DIGEST_SHA256,
AIOT_OTA_DIGEST_MAX
} aiot_ota_digest_type_t;
/**
* @brief 云端下推的固件升级任务的描述信息, 包括url, 大小, 签名等
*
*/
typedef struct {
/**
* @brief 待升级设备的product_key
*
*/
char *product_key;
/**
* @brief 待升级设备的device_name
*
*/
char *device_name;
/*
* @brief 下载固件所需的链接
*
*/
char *url;
/*
* @brief 固件的大小, 单位为Byte
*
*/
uint32_t size_total;
/*
* @brief 云端对的固件进行数字签名的方式, 具体见@ref aiot_ota_digest_type_t
*
*/
uint8_t digest_method;
/*
* @brief 云端对固件计算数字签名得出来的结果
*
*/
char *expect_digest;
/**
* @brief 固件的版本信息. 如果为固件信息, 则这个version字段为固件的版本号. 如果为远程配置消息, 则为配置的configId
*
*/
char *version;
/**
* @brief 当前固件所都对应的模块
*
*/
char *module;
/**
* @brief *固件升级过程中需用往云端上报消息时需要用到的mqtt句柄
*/
void *mqtt_handle;
/**
* @brief 当前下载信息中的扩展内容
*
*/
char *extra_data;
} aiot_download_task_desc_t;
/**
* @brief 云端下行的OTA消息, 包括其消息类型(固件升级/远程配置)和升级任务的具体描述
*
*/
typedef struct {
/**
* @brief 云端下行的OTA消息类型, 更多信息请参考@ref aiot_ota_recv_type_t
*/
aiot_ota_recv_type_t type;
/**
* @brief 云端下推的固件升级任务的描述信息, 包括url, 大小, 签名等, 更多信息参考@ref aiot_download_task_desc_t
*/
aiot_download_task_desc_t *task_desc;
} aiot_ota_recv_t;
/**
* @brief 设备收到OTA的mqtt下行报文时的接收回调函数.用户在这个回调函数中可以看到待升级固件的版本号, 决定升级策略(是否升级, 何时升级等)
* @param[in] handle OTA实例句柄
* @param[in] msg 云端下行的OTA消息
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_ota_recv_handler_t)(void *handle, const aiot_ota_recv_t *const msg, void *userdata);
/**
* @brief 下载固件过程中收到的分片的报文的类型
*
*/
typedef enum {
/**
* @brief 基于HTTP传输的固件分片报文
*
*/
AIOT_DLRECV_HTTPBODY
} aiot_download_recv_type_t;
/**
* @brief 下载固件过程中收到的分片的报文的描述, 包括类型, 以及所存储的buffer地址, buffer的长度, 以及当前的下载进度
*
*/
typedef struct {
/**
* @brief 下载固件过程中收到的分片的报文的类型, 具体见@ref aiot_download_recv_type_t
*
*/
aiot_download_recv_type_t type;
struct {
/**
* @brief 下载固件过程中, SDK分配出来的存储云端下行的固件内容的buffer地址.在回调函数结束后SDK就会主动释放.用户需要自行将报文拷贝保存.
*
*/
uint8_t *buffer;
/**
* @brief 下载固件过程中, SDK分配出来的存储云端下行的固件内容的buffer的大小, 用户可以通过@ref AIOT_DLOPT_BODY_BUFFER_MAX_LEN 来调整
*
*/
uint32_t len;
/**
* @brief 当前的下载进度的百分比
*
*/
int32_t percent;
} data;
} aiot_download_recv_t;
/**
* @brief 升级开始后, 设备收到分成一段段的固件内容时的收包回调函数.当前默认是通过https报文下推分段后的固件内容.
* @param[in] handle download实例句柄
* @param[in] packet 云端下行的分段后的固件的报文
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_download_recv_handler_t)(void *handle, const aiot_download_recv_t *packet,
void *userdata);
/**
* @brief 与云端约定的OTA过程中的错误码, 云端据此知道升级过程中出错在哪个环节
*
*/
typedef enum {
/**
* @brief 与云端约定的设备升级出错的错误描述
*/
AIOT_OTAERR_UPGRADE_FAILED = -1,
/**
* @brief 与云端约定的设备下载出错的错误码描述
*/
AIOT_OTAERR_FETCH_FAILED = -2,
/**
* @brief 与云端约定的固件校验数字签名时出错的错误码描述
*/
AIOT_OTAERR_CHECKSUM_MISMATCH = -3,
/**
* @brief 与云端约定的烧写固件出错的错误码描述
*/
AIOT_OTAERR_BURN_FAILED = -4
} aiot_ota_protocol_errcode_t;
/**
* @brief 调用 @ref aiot_ota_setopt 接口时, option参数的可用值
*
*/
typedef enum {
/**
* @brief 设置处理OTA消息的用户回调函数
*
* @details
*
* 在该回调中, 用户可能收到两种消息: 固件升级消息或者远程配置消息.
*
* 无论哪种消息, 都包含了url, version, digest method, sign等内容.
*
* 用户需要在该回调中决定升级策略, 包括是否升级和何时升级等. 如果需要升级, 则需要调用aiot_download_init初始化一个download实例句柄.
* 具体见demos目录下的fota_xxx_xxx.c的用例
*
* 数据类型: (void *)
*/
AIOT_OTAOPT_RECV_HANDLER,
/**
* @brief 设置MQTT的handle
*
* @details
*
* OTA过程中使用MQTT的通道能力, 用以向云端上报版本号, 进度, 以及错误码
*
* 数据类型: (void *)
*/
AIOT_OTAOPT_MQTT_HANDLE,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 该上下文会在@ref AIOT_OTAOPT_RECV_HANDLER 中传回给用户
*
* 数据类型: (void *)
*/
AIOT_OTAOPT_USERDATA,
/**
* @brief 如果当前ota是针对某个外接模块(mcu等), 需要通过该字段设置模块名
*
* @details
*
* OTA可能会针对某个外接的模块进行, 在上报版本号的时候, 需要知道模块的名称.
* 模块的名称通过该字段来设置.
*
* 数据类型: (void *)
*/
AIOT_OTAOPT_MODULE,
AIOT_OTAOPT_MAX
} aiot_ota_option_t;
/**
* @brief 调用 @ref aiot_download_setopt 接口时, option参数的可用值
*
*/
typedef enum {
/**
* @brief 设备通过HTTP与固件服务器建联时, 网络使用的安全凭据
*
* @details
*
* 该配置项用于为底层网络配置@ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 1. 若该选项不配置, 那么HTTP将以tcp方式直接建联
*
* 2. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_NONE , HTTP将以tcp方式直接建联
*
* 3. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , HTTP将以tls方式建联
*
* 4. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_PSK , HTTP将以tls psk方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_DLOPT_NETWORK_CRED,
/**
* @brief 设备通过HTTP访问固件下载服务器的端口号
*
* @details
*
* 如果使用的是tcp或者tls证书方式, 端口号设置为443
*
* 数据类型: (uint16_t *)
*/
AIOT_DLOPT_NETWORK_PORT,
/**
* @brief 通过HTTP接收固件内容时, 在协议栈花费的最长时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_DLOPT_RECV_TIMEOUT_MS,
/**
* @brief HTTP 数据接收回调函数
*
* @details
*
* 数据类型: (aiot_download_recv_handler_t)
*/
AIOT_DLOPT_RECV_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 当接收到HTTP数据时, 该上下文会从 @ref aiot_download_recv_handler_t 的 userdata 参数给出
*
* 数据类型: (void *)
*/
AIOT_DLOPT_USERDATA,
/**
* @brief 设置download实例句柄所包含下载任务的具体内容
*
* @details
*
* 用户在收到OTA的mqtt消息后, 如果决定升级, 则需要通过该选项, 在download实例句柄中开辟内存,
* 将OTA消息中携带的url, version, digest method, sign等信息复制过来, 有了这些信息后才能开始下载任务
*
* 数据类型: (aiot_download_task_desc_t *)
*
**/
AIOT_DLOPT_TASK_DESC,
/**
* @brief 设置按照range下载的起始地址
*
* @details
*
* HTTP 范围请求(range requests)特性中, 表示从第该byte开始下载
* 如果指定从头开始下载, 则start的值为0
*
* 数据类型: (uint32_t *)
*
**/
AIOT_DLOPT_RANGE_START,
/**
* @brief 设置按照range下载的结束地址
*
* @details
* HTTP 范围请求(range requests)特性中, 表示下载到该byte后结束.
* 如果指定从头开始下载到10个byte后结束,
* 则需要指定start = 0, end = 9, 这样总共10个byte
*
* 数据类型: (uint32_t *)
*
**/
AIOT_DLOPT_RANGE_END,
/**
* @brief 当设备从固件下载服务器接收返回的http报文时, 每次从 @ref aiot_download_recv_handler_t 回调函数中给出的body最大长度
*
* @details
* 如果收到的数据没能达到这个长度, 则以aiot_download_recv_handler_t回调函数给出的长度是设备实际接收到的长度
*
* 数据类型: (uint32_t *) 默认值: (2 *1024) Bytes
*/
AIOT_DLOPT_BODY_BUFFER_MAX_LEN,
AIOT_DLOPT_MAX
} aiot_download_option_t;
/**
* @brief 设备端主动向云端查询升级任务
*
* @details
* 设备上线后, 云端如果部署了OTA任务, SDK会通过@ref aiot_ota_recv_handler_t 将该任务透给用户.
* 出于当前业务繁忙等原因, 这个OTA任务可能被暂时忽略, 那么用户可以在业务空闲的时候通过调用本api来让云端再次下推这个OTA任务.
* 同样地, SDK会从@ref aiot_ota_recv_handler_t 将该OTA任务透给用户
*
* @return int32_t
* @retval STATE_SUCCESS 发送请求成功
* @retval STATE_OTA_QUERY_FIRMWARE_HANDLE_IS_NULL 作为入参的handle句柄没有经过初始化, 需要调用@ref aiot_ota_init 来进行初始化
*
*/
int32_t aiot_ota_query_firmware(void *handle);
/**
* @brief 创建一个OTA实例
*
* @return void*
* @retval 非NULL ota实例句柄
* @retval NULL 初始化失败, 或者是因为没有设置portfile, 或者是内存分配失败导致
*
*/
void *aiot_ota_init();
/**
* @brief 销毁ota实例句柄
*
* @param[in] handle 指向ota实例句柄的指针
*
* @return int32_t
* @retval STATE_OTA_DEINIT_HANDLE_IS_NULL handle或者handle所指向的地址为空
* @retval STATE_SUCCESS 执行成功
*
*/
int32_t aiot_ota_deinit(void **handle);
/**
* @brief 上报普通设备(非网关中的子设备)的版本号
*
* @details
*
* 如果云端不知道某台设备当前的固件版本号, 就不会为其提供OTA服务, 而如果不知道设备的新版本号, 也不会认为它升级成功
*
* 所以OTA要正常工作, 一般会要求设备在每次开机之后, 就调用这个接口, 将当前运行的固件版本号字符串上报给云端
*
* 参数的handle通过@ref aiot_ota_init 得到, 比如, 上报当前版本号为"1.0.0"的代码写作
*
* ```c
* handle = aiot_ota_init();
* ...
* aiot_ota_report_version(handle, "1.0.0");
* ```
*
* @param[in] handle 指向ota实例句柄的指针
* @param[in] version 待上报的版本号
*
* @return int32_t
* @retval STATE_OTA_REPORT_HANDLE_IS_NULL ota句柄为空
* @retval STATE_OTA_REPORT_VERSION_IS_NULL 用户输入的版本号为空
* @retval STATE_OTA_REPORT_MQTT_HANDLE_IS_NULL ota_handle句柄中的mqtt句柄为空
* @retval STATE_OTA_REPORT_FAILED 中止执行上报
* @retval STATE_SUCCESS 执行成功
*
*/
int32_t aiot_ota_report_version(void *handle, char *version);
/**
* @brief 用于网关中的子设备上报版本号
*
* @param[in] handle ota实例句柄
* @param[in] product_key 设备的product_key
* @param[in] device_name 设备的名称
* @param[in] version 版本号
*
* @return int32_t
* @retval STATE_SUCCESS 上报成功
* @retval STATE_OTA_REPORT_EXT_HANELD_IS_NULL ota句柄为空
* @retval STATE_OTA_REPORT_EXT_VERSION_NULL 用户输入的版本号为空
* @retval STATE_OTA_REPORT_EXT_PRODUCT_KEY_IS_NULL 子设备的product_key输入为空
* @retval STATE_OTA_REPORT_EXT_DEVICE_NAME_IS_NULL 子设备的device_name输入为空
* @retval STATE_OTA_REPORT_EXT_MQTT_HANDLE_IS_NULL ota句柄中的mqtt_handle为空
* @retval STATE_OTA_REPORT_FAILED 中止执行上报
*
*/
int32_t aiot_ota_report_version_ext(void *handle, char *product_key, char *device_name, char *version);
/**
* @brief 设置ota句柄的参数
*
* @details
*
* 对OTA会话进行配置, 常见的配置选项包括
*
* + `AIOT_OTAOPT_MQTT_HANDLE`: 把 @ref aiot_mqtt_init 返回的MQTT会话句柄跟OTA会话关联起来
* + `AIOT_OTAOPT_RECV_HANDLER`: 设置OTA消息的数据处理回调, 这个用户回调在有OTA消息的时候, 会被 @ref aiot_mqtt_recv 调用到
*
* @param[in] handle ota句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_ota_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_ota_option_t
*
* @return int32_t
* @retval STATE_OTA_SETOPT_HANDLE_IS_NULL ota句柄为空
* @retval STATE_OTA_SETOPT_DATA_IS_NULL 参数data字段为空
* @retval STATE_USER_INPUT_UNKNOWN_OPTION option不支持
* @retval STATE_SUCCESS 参数设置成功
*
*/
int32_t aiot_ota_setopt(void *handle, aiot_ota_option_t option, void *data);
/**
* @brief 初始化download实例并设置默认参数
*
* @return void*
* @retval 非NULL download实例句柄
* @retval NULL 初始化失败, 或者是没有设置portfile, 或者是内存不足无法分配download或者http实例
*
*/
void *aiot_download_init();
/**
* @brief 释放download实例句柄的资源
*
* @param[in] handle 指向download实例句柄的指针
*
* @return int32_t
* @retval STATE_DOWNLOAD_DEINIT_HANDLE_IS_NULL handle或者handle指向的内容为空
* @retval STATE_SUCCESS 执行成功
*
*/
int32_t aiot_download_deinit(void **handle);
/**
* @brief 通过download实例句柄下载一段buffer
*
* @details
*
* 用户解析完OTA消息, 知道了固件的下载地址之后, 就可以用这个接口以HTTP下载固件内容
*
* 被下载到的内容, 会通过回调函数传递给用户, 用户调用 @ref aiot_download_setopt 把自己的数据处理回调函数设置给SDK
*
* @param[in] handle 指向download实例句柄的指针
*
* @return int32_t
* @retval >STATE_SUCCESS 表示下载到的字节数
* @retval STATE_DOWNLOAD_HTTPRSP_CODE_ERROR 下载所使用的url链接不可访问, 返回的code并非200或者206
* @retval STATE_DOWNLOAD_FINISHED 整个固件包下载完成
* @retval STATE_DOWNLOAD_RANGE_FINISHED 分段下载的时候, 单个分段下载完成
* @retval STATE_DOWNLOAD_HTTPRSP_HEADER_ERROR 访问下载链接后http的回复报文中并没有Content-Length字段
* @retval STATE_DOWNLOAD_RECV_HANDLE_IS_NULL download句柄为空
* @retval STATE_DOWNLOAD_RENEWAL_REQUEST_SENT 进行断点续传往固件服务器重新发送了下载请求
* @retval 其他出错信息 请参考@ref aiot_state_api.h
*
*/
int32_t aiot_download_recv(void *handle); /* 返回条件: 网络出错 | 校验出错 | 读到EOF | buf填满 */
/**
* @brief 设置download句柄参数
*
* @details
*
* 配置固件下载会话的选项, 常见需要设置的选项包括
*
* + `AIOT_DLOPT_RECV_HANDLER`: 用户告诉SDK, 当SDK收到固件内容的时候, 调用哪个用户函数来传出固件内容缓冲区
* + `AIOT_DLOPT_NETWORK_CRED`: 可以配置是走HTTP还是走HTTPS下载固件内容
* + `AIOT_DLOPT_BODY_BUFFER_MAX_LEN`: 这是个缓冲区的长度, SDK下载中, 每当填满这个长度就调用一次用户回调, 所以这里设置的越大, 下载越快, 内存开销也越大
*
* @param[in] handle download句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_download_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_download_option_t
*
* @return int32_t
* @retval STATE_SUCCESS 参数设置成功
* @retval STATE_DOWNLOAD_SETOPT_HANDLE_IS_NULL download句柄为空
* @retval STATE_DOWNLOAD_SETOPT_DATA_IS_NULL data字段为空
* @retval STATE_DOWNLOAD_SETOPT_COPIED_DATA_IS_NULL 拷贝task_desc失败
* @retval STATE_DOWNLOAD_SETOPT_MALLOC_SHA256_CTX_FAILED 为shs256算法的context分配内存失败
* @retval STATE_DOWNLOAD_SETOPT_MALLOC_MD5_CTX_FAILED 为MD5算法的context分配内存失败
* @retval 其他出错信息 请参考@ref aiot_state_api.h
*
*/
int32_t aiot_download_setopt(void *handle, aiot_download_option_t option, void *data);
/**
* @brief 上报下载完成度的百分比或者错误码
*
* @details
*
* 在设备开始下载固件的过程之后, 都可以用这个接口向云端上报进展情况, 包括下载进度或出错信息
*
* + 如果下载是正常的, 可以整数形式上报, 当前已下载的内容占固件整体大小的百分比, percent参数, SDK会自动计算好, 在回调中传给用户
* + 如果下载异常或者下载之后固件的烧录异常了, 也可以用这个接口把异常告诉云端, 设备和云端的协议错误码约定见 @ref aiot_ota_protocol_errcode_t
* + 通过 @ref aiot_download_report_progress 上报的内容都会影响控制台的显示, 比如显示OTA升级进度, 显示OTA升级失败等
*
* @param[in] handle download句柄
* @param[in] percent 当前所下载内容完成度的百分比或者错误码
*
* @return int32_t
* @retval STATE_SUCCESS 参数设置成功
* @retval STATE_DOWNLOAD_REPORT_HANDLE_IS_NULL 上报时handle为空
* @retval STATE_DOWNLOAD_REPORT_TASK_DESC_IS_NULL 上报时task_desc为空, 无法找到相应的product_key, device_name
* @retval 其他出错信息 请参考@ref aiot_state_api.h
*
*/
int32_t aiot_download_report_progress(void *handle, int32_t percent);
/**
* @brief 向云端发送GET固件报文请求
*
* @details
*
* 设备通过OTA消息回调函数知道了固件下载地址后, 就可以调用这个接口, 下载一段固件
*
* + 这段长度可由`AIOT_DLOPT_RANGE_START`和`AIOT_DLOPT_RANGE_END`选项设置
* + 如果不做设置, 则默认SDK会整段去请求固件内容, 但每到填满1次用户buffer就会通知用户1次, buffer长度用`AIOT_DLOPT_BODY_BUFFER_MAX_LEN`选项配置
*
* @param[in] handle download句柄, 包含了固件的url等信息
*
* @return int32_t
* @retval STATE_SUCCESS 请求发送成功
* @retval STATE_DOWNLOAD_REQUEST_HANDLE_IS_NULL 发送GET请求的时候handle为空
* @retval STATE_DOWNLOAD_REQUEST_URL_IS_NULL 发送GET请求的时候task_desc不为空, 但是其中的url为空
* @retval STATE_DOWNLOAD_SEND_REQUEST_FAILED 发送GET请求的时候http底层发包逻辑报错
* @retval STATE_DOWNLOAD_REQUEST_TASK_DESC_IS_NULL 发送GET请求的时候task_desc字段为空
* @retval 其他出错信息 请参考@ref aiot_state_api.h
*/
int32_t aiot_download_send_request(void *handle);
/**
* @brief -0x0900~-0x09FF表达SDK在OTA模块内的状态码, 也包含下载时使用的`STATE_DOWNLOAD_XXX`
*
*/
#define STATE_OTA_BASE (-0x0900)
/**
* @brief OTA固件下载已完成, 校验和验证成功
*
*/
#define STATE_OTA_DIGEST_MATCH (-0x0901)
/**
* @brief OTA下载进度消息或固件版本号消息上报到服务器时遇到失败
*
*/
#define STATE_OTA_REPORT_FAILED (-0x0902)
/**
* @brief OTA模块收取固件内容数据时出现错误
*
*/
#define STATE_DOWNLOAD_RECV_ERROR (-0x0903)
/**
* @brief OTA模块下载固件时出现校验和签名验证错误
*
* @details
*
* 固件的md5或者sha256计算结果跟云端通知的期望值不匹配所致的错误
*
*/
#define STATE_OTA_DIGEST_MISMATCH (-0x0904)
/**
* @brief OTA模块解析服务器下推的MQTT下行JSON报文时出错
*
* @details
*
* 从云端下行的JSON报文中, 无法找到目标的key, 从而无法找到相应的value
*
*/
#define STATE_OTA_PARSE_JSON_ERROR (-0x0905)
/**
* @brief OTA模块发送HTTP报文, 请求下载固件时遇到失败
*
* @details
*
* OTA模块往存储固件的服务器发送GET请求失败
*
*/
#define STATE_DOWNLOAD_SEND_REQUEST_FAILED (-0x0906)
/**
* @brief OTA模块下载固件内容已到达之前设置的range末尾, 不会继续下载
*
* @details
*
* 按照range下载的时候已经下载到了range_end字段指定的地方. 如果用户此时还是继续尝试去下载, SDK返回返回错误码提示用户
*
*/
#define STATE_DOWNLOAD_RANGE_FINISHED (-0x0907)
/**
* @brief OTA模块为解析JSON报文而申请内存时, 未获取到所需内存而解析失败
*
*/
#define STATE_OTA_PARSE_JSON_MALLOC_FAILED (-0x0908)
/**
* @brief 销毁OTA会话实例时, 发现会话句柄为空, 中止销毁动作
*
*/
#define STATE_OTA_DEINIT_HANDLE_IS_NULL (-0x0909)
/**
* @brief 配置OTA会话实例时, 发现会话句柄为空, 中止配置动作
*
*/
#define STATE_OTA_SETOPT_HANDLE_IS_NULL (-0x090A)
/**
* @brief 配置OTA会话实例时, 发现配置数据为空, 中止配置动作
*
*/
#define STATE_OTA_SETOPT_DATA_IS_NULL (-0x090B)
/**
* @brief 销毁下载会话实例时, 发现会话句柄为空, 中止销毁动作
*
*/
#define STATE_DOWNLOAD_DEINIT_HANDLE_IS_NULL (-0x090C)
/**
* @brief 配置下载会话实例时, 发现会话句柄为空, 中止配置动作
*
*/
#define STATE_DOWNLOAD_SETOPT_HANDLE_IS_NULL (-0x090D)
/**
* @brief 配置下载会话实例时, 发现配置数据为空, 中止配置动作
*
*/
#define STATE_DOWNLOAD_SETOPT_DATA_IS_NULL (-0x090E)
/**
* @brief 配置下载会话实例时, 从OTA会话同步配置发生内部错误, 中止配置动作
*
*/
#define STATE_DOWNLOAD_SETOPT_COPIED_DATA_IS_NULL (-0x090F)
/**
* @brief 直连设备上报版本号时, OTA句柄为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_HANDLE_IS_NULL (-0x0910)
/**
* @brief 直连设备上报版本号时, 版本号字符串为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_VERSION_IS_NULL (-0x0911)
/**
* @brief 直连设备上报版本号时, MQTT句柄为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_MQTT_HANDLE_IS_NULL (-0x0912)
/**
* @brief 网关为子设备上报版本号时, OTA句柄为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_EXT_HANELD_IS_NULL (-0x0913)
/**
* @brief 网关为子设备上报版本号时, 版本号字符串为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_EXT_VERSION_NULL (-0x0914)
/**
* @brief 网关为子设备上报版本号时, 子设备productKey为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_EXT_PRODUCT_KEY_IS_NULL (-0x0915)
/**
* @brief 网关为子设备上报版本号时, 子设备deviceName为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_EXT_DEVICE_NAME_IS_NULL (-0x0916)
/**
* @brief 网关为子设备上报版本号时, MQTT会话句柄为空, 中止执行上报
*
*/
#define STATE_OTA_REPORT_EXT_MQTT_HANDLE_IS_NULL (-0x0917)
/**
* @brief 上报下载进度或OTA错误码时, 下载会话句柄为空, 中止执行上报
*
*/
#define STATE_DOWNLOAD_REPORT_HANDLE_IS_NULL (-0x0918)
/**
* @brief 上报下载进度或OTA错误码时, 任务描述数据结构为空, 中止执行上报
*
*/
#define STATE_DOWNLOAD_REPORT_TASK_DESC_IS_NULL (-0x0919)
/**
* @brief 调用aiot_download_recv接收固件内容时, 处理接收数据的用户回调为空值, 中止执行
*
*/
#define STATE_DOWNLOAD_RECV_HANDLE_IS_NULL (-0x091A)
/**
* @brief 调用aiot_download_send_request发送固件下载请求时, 下载会话的句柄为空, 中止执行
*
*/
#define STATE_DOWNLOAD_REQUEST_HANDLE_IS_NULL (-0x091B)
/**
* @brief 调用aiot_download_send_request发送固件下载请求时, 任务描述为空, 中止执行
*
*/
#define STATE_DOWNLOAD_REQUEST_TASK_DESC_IS_NULL (-0x091C)
/**
* @brief 调用aiot_download_send_request发送固件下载请求时, 任务描述中的固件URL为空, 中止执行
*
*/
#define STATE_DOWNLOAD_REQUEST_URL_IS_NULL (-0x091D)
/**
* @brief 解析通知OTA的MQTT下行报文时, 其中的digest方法并非md5或sha256, SDK不支持
*
*/
#define STATE_OTA_UNKNOWN_DIGEST_METHOD (-0x091E)
/**
* @brief 整个固件(而不是单独一次的下载片段)收取已完成, 收取的累计字节数与固件预期字节数一致
*
*/
#define STATE_DOWNLOAD_FINISHED (-0x091F)
/**
* @brief 设备向固件服务器发出GET请求时, 服务器返回的HTTP报文中Status Code错误, 既非200, 也非206
*
*/
#define STATE_DOWNLOAD_HTTPRSP_CODE_ERROR (-0x0920)
/**
* @brief 设备向固件服务器发出GET请求时, 服务器返回的HTTP报文header里, 没有说明Content-Length
*
*/
#define STATE_DOWNLOAD_HTTPRSP_HEADER_ERROR (-0x0921)
/**
* @brief OTA固件下载失败后, 正在进行断点续传, SDK向服务端重新发起了下载请求
*
*/
#define STATE_DOWNLOAD_RENEWAL_REQUEST_SENT (-0x0922)
/**
* @brief OTA模块为计算固件的SHA256校验和申请内存时遇到失败
*
*/
#define STATE_DOWNLOAD_SETOPT_MALLOC_SHA256_CTX_FAILED (-0x0923)
/**
* @brief OTA模块为计算固件的MD5校验和内存时遇到失败
*
*/
#define STATE_DOWNLOAD_SETOPT_MALLOC_MD5_CTX_FAILED (-0x0924)
/**
* @brief OTA模块从任务描述数据结构中解析固件下载URL时, 遇到HOST字段为空, 解析失败
*
*/
#define STATE_OTA_PARSE_URL_HOST_IS_NULL (-0x0925)
/**
* @brief OTA模块从任务描述数据结构中解析固件下载URL时, 遇到PATH字段为空, 解析失败
*
*/
#define STATE_OTA_PARSE_URL_PATH_IS_NULL (-0x0926)
/**
* @brief OTA模块分多段下载固件时, 多段累计的总和大小超过了固件预期的值
*
* @details 可能的一个原因是用户将固件划分了多个range来下载, 但是由于不同的range之间存在重叠等原因, 导致最终的下载总量超出了固件的总大小
*
*/
#define STATE_DOWNLOAD_FETCH_TOO_MANY (-0x0927)
/**
* @brief 向云端查询OTA的升级任务时, OTA句柄为空
*
* @details 需要先调用aiot_ota_init函数来初始化一个OTA句柄, 再把这个句柄传给aiot_ota_query_firmware. 如果这个句柄没有被初始化, 或者
* 初始化不成功, 就会报出这个错误
*
*/
#define STATE_OTA_QUERY_FIRMWARE_HANDLE_IS_NULL (-0x0928)
/**
* @brief OTA下行报文中url字段中的host字段超出长度限制
*
* @details 在OTA的下行报文中, 包含了存储固件的url. url中包含host字段, 如果host字段超出限制(当前限1024个字节), 就会报出这个错误
*
*/
#define STATE_OTA_HOST_STRING_OVERFLOW (-0x0929)
/**
* @brief OTA下行报文中url字段中的path字段超出长度限制
*
* @details 在OTA的下行报文中, 包含了存储固件的url. url中包含path字段, 如果path字段超出限制(当前限1024个字节), 就会报出这个错误
*
*/
#define STATE_OTA_PATH_STRING_OVERFLOW (-0x092A)
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef __AIOT_OTA_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/ota/aiot_ota_api.h | C | apache-2.0 | 30,967 |
#include "ota_md5.h"
/*
* 32-bit integer manipulation macros (little endian)
*/
#ifndef GET_UINT32_LE
#define GET_UINT32_LE(n,b,i) \
{ \
(n) = ( (uint32_t) (b)[(i) ] ) \
| ( (uint32_t) (b)[(i) + 1] << 8 ) \
| ( (uint32_t) (b)[(i) + 2] << 16 ) \
| ( (uint32_t) (b)[(i) + 3] << 24 ); \
}
#endif
#ifndef PUT_UINT32_LE
#define PUT_UINT32_LE(n,b,i) \
{ \
(b)[(i) ] = (unsigned char) ( ( (n) ) & 0xFF ); \
(b)[(i) + 1] = (unsigned char) ( ( (n) >> 8 ) & 0xFF ); \
(b)[(i) + 2] = (unsigned char) ( ( (n) >> 16 ) & 0xFF ); \
(b)[(i) + 3] = (unsigned char) ( ( (n) >> 24 ) & 0xFF ); \
}
#endif
static void utils_md5_zeroize(void *v, uint32_t n)
{
volatile unsigned char *p = v;
while (n--) {
*p++ = 0;
}
}
void utils_md5_init(utils_md5_context_t *ctx)
{
memset(ctx, 0, sizeof(utils_md5_context_t));
}
void utils_md5_free(utils_md5_context_t *ctx)
{
if (ctx == NULL) {
return;
}
utils_md5_zeroize(ctx, sizeof(utils_md5_context_t));
}
/*
* MD5 context setup
*/
int32_t utils_md5_starts(utils_md5_context_t *ctx)
{
ctx->total[0] = 0;
ctx->total[1] = 0;
ctx->state[0] = 0x67452301;
ctx->state[1] = 0xEFCDAB89;
ctx->state[2] = 0x98BADCFE;
ctx->state[3] = 0x10325476;
return (0);
}
int32_t utils_internal_md5_process(utils_md5_context_t *ctx,
const unsigned char data[64])
{
uint32_t X[16], A, B, C, D;
GET_UINT32_LE(X[ 0], data, 0);
GET_UINT32_LE(X[ 1], data, 4);
GET_UINT32_LE(X[ 2], data, 8);
GET_UINT32_LE(X[ 3], data, 12);
GET_UINT32_LE(X[ 4], data, 16);
GET_UINT32_LE(X[ 5], data, 20);
GET_UINT32_LE(X[ 6], data, 24);
GET_UINT32_LE(X[ 7], data, 28);
GET_UINT32_LE(X[ 8], data, 32);
GET_UINT32_LE(X[ 9], data, 36);
GET_UINT32_LE(X[10], data, 40);
GET_UINT32_LE(X[11], data, 44);
GET_UINT32_LE(X[12], data, 48);
GET_UINT32_LE(X[13], data, 52);
GET_UINT32_LE(X[14], data, 56);
GET_UINT32_LE(X[15], data, 60);
#define S(x,n) ((x << n) | ((x & 0xFFFFFFFF) >> (32 - n)))
#define P(a,b,c,d,k,s,t) \
{ \
a += F(b,c,d) + X[k] + t; a = S(a,s) + b; \
}
A = ctx->state[0];
B = ctx->state[1];
C = ctx->state[2];
D = ctx->state[3];
#define F(x,y,z) (z ^ (x & (y ^ z)))
P(A, B, C, D, 0, 7, 0xD76AA478);
P(D, A, B, C, 1, 12, 0xE8C7B756);
P(C, D, A, B, 2, 17, 0x242070DB);
P(B, C, D, A, 3, 22, 0xC1BDCEEE);
P(A, B, C, D, 4, 7, 0xF57C0FAF);
P(D, A, B, C, 5, 12, 0x4787C62A);
P(C, D, A, B, 6, 17, 0xA8304613);
P(B, C, D, A, 7, 22, 0xFD469501);
P(A, B, C, D, 8, 7, 0x698098D8);
P(D, A, B, C, 9, 12, 0x8B44F7AF);
P(C, D, A, B, 10, 17, 0xFFFF5BB1);
P(B, C, D, A, 11, 22, 0x895CD7BE);
P(A, B, C, D, 12, 7, 0x6B901122);
P(D, A, B, C, 13, 12, 0xFD987193);
P(C, D, A, B, 14, 17, 0xA679438E);
P(B, C, D, A, 15, 22, 0x49B40821);
#undef F
#define F(x,y,z) (y ^ (z & (x ^ y)))
P(A, B, C, D, 1, 5, 0xF61E2562);
P(D, A, B, C, 6, 9, 0xC040B340);
P(C, D, A, B, 11, 14, 0x265E5A51);
P(B, C, D, A, 0, 20, 0xE9B6C7AA);
P(A, B, C, D, 5, 5, 0xD62F105D);
P(D, A, B, C, 10, 9, 0x02441453);
P(C, D, A, B, 15, 14, 0xD8A1E681);
P(B, C, D, A, 4, 20, 0xE7D3FBC8);
P(A, B, C, D, 9, 5, 0x21E1CDE6);
P(D, A, B, C, 14, 9, 0xC33707D6);
P(C, D, A, B, 3, 14, 0xF4D50D87);
P(B, C, D, A, 8, 20, 0x455A14ED);
P(A, B, C, D, 13, 5, 0xA9E3E905);
P(D, A, B, C, 2, 9, 0xFCEFA3F8);
P(C, D, A, B, 7, 14, 0x676F02D9);
P(B, C, D, A, 12, 20, 0x8D2A4C8A);
#undef F
#define F(x,y,z) (x ^ y ^ z)
P(A, B, C, D, 5, 4, 0xFFFA3942);
P(D, A, B, C, 8, 11, 0x8771F681);
P(C, D, A, B, 11, 16, 0x6D9D6122);
P(B, C, D, A, 14, 23, 0xFDE5380C);
P(A, B, C, D, 1, 4, 0xA4BEEA44);
P(D, A, B, C, 4, 11, 0x4BDECFA9);
P(C, D, A, B, 7, 16, 0xF6BB4B60);
P(B, C, D, A, 10, 23, 0xBEBFBC70);
P(A, B, C, D, 13, 4, 0x289B7EC6);
P(D, A, B, C, 0, 11, 0xEAA127FA);
P(C, D, A, B, 3, 16, 0xD4EF3085);
P(B, C, D, A, 6, 23, 0x04881D05);
P(A, B, C, D, 9, 4, 0xD9D4D039);
P(D, A, B, C, 12, 11, 0xE6DB99E5);
P(C, D, A, B, 15, 16, 0x1FA27CF8);
P(B, C, D, A, 2, 23, 0xC4AC5665);
#undef F
#define F(x,y,z) (y ^ (x | ~z))
P(A, B, C, D, 0, 6, 0xF4292244);
P(D, A, B, C, 7, 10, 0x432AFF97);
P(C, D, A, B, 14, 15, 0xAB9423A7);
P(B, C, D, A, 5, 21, 0xFC93A039);
P(A, B, C, D, 12, 6, 0x655B59C3);
P(D, A, B, C, 3, 10, 0x8F0CCC92);
P(C, D, A, B, 10, 15, 0xFFEFF47D);
P(B, C, D, A, 1, 21, 0x85845DD1);
P(A, B, C, D, 8, 6, 0x6FA87E4F);
P(D, A, B, C, 15, 10, 0xFE2CE6E0);
P(C, D, A, B, 6, 15, 0xA3014314);
P(B, C, D, A, 13, 21, 0x4E0811A1);
P(A, B, C, D, 4, 6, 0xF7537E82);
P(D, A, B, C, 11, 10, 0xBD3AF235);
P(C, D, A, B, 2, 15, 0x2AD7D2BB);
P(B, C, D, A, 9, 21, 0xEB86D391);
#undef F
ctx->state[0] += A;
ctx->state[1] += B;
ctx->state[2] += C;
ctx->state[3] += D;
return (0);
}
/*
* MD5 process buffer
*/
int32_t utils_md5_update(utils_md5_context_t *ctx,
const unsigned char *input,
uint32_t ilen)
{
int32_t ret;
uint32_t fill;
uint32_t left;
if (ilen == 0) {
return (0);
}
left = ctx->total[0] & 0x3F;
fill = 64 - left;
ctx->total[0] += (uint32_t) ilen;
ctx->total[0] &= 0xFFFFFFFF;
if (ctx->total[0] < (uint32_t) ilen) {
ctx->total[1]++;
}
if (left && ilen >= fill) {
memcpy((void *)(ctx->buffer + left), input, fill);
if ((ret = utils_internal_md5_process(ctx, ctx->buffer)) != 0) {
return (ret);
}
input += fill;
ilen -= fill;
left = 0;
}
while (ilen >= 64) {
if ((ret = utils_internal_md5_process(ctx, input)) != 0) {
return (ret);
}
input += 64;
ilen -= 64;
}
if (ilen > 0) {
memcpy((void *)(ctx->buffer + left), input, ilen);
}
return (0);
}
/*
* MD5 final digest
*/
int32_t utils_md5_finish(utils_md5_context_t *ctx,
unsigned char output[16])
{
int32_t ret;
uint32_t used;
uint32_t high, low;
/*
* Add padding: 0x80 then 0x00 until 8 bytes remain for the length
*/
used = ctx->total[0] & 0x3F;
ctx->buffer[used++] = 0x80;
if (used <= 56) {
/* Enough room for padding + length in current block */
memset(ctx->buffer + used, 0, 56 - used);
} else {
/* We'll need an extra block */
memset(ctx->buffer + used, 0, 64 - used);
if ((ret = utils_internal_md5_process(ctx, ctx->buffer)) != 0) {
return (ret);
}
memset(ctx->buffer, 0, 56);
}
/*
* Add message length
*/
high = (ctx->total[0] >> 29)
| (ctx->total[1] << 3);
low = (ctx->total[0] << 3);
PUT_UINT32_LE(low, ctx->buffer, 56);
PUT_UINT32_LE(high, ctx->buffer, 60);
if ((ret = utils_internal_md5_process(ctx, ctx->buffer)) != 0) {
return (ret);
}
/*
* Output final state
*/
PUT_UINT32_LE(ctx->state[0], output, 0);
PUT_UINT32_LE(ctx->state[1], output, 4);
PUT_UINT32_LE(ctx->state[2], output, 8);
PUT_UINT32_LE(ctx->state[3], output, 12);
return (0);
}
| YifuLiu/AliOS-Things | components/linksdk/components/ota/ota_md5.c | C | apache-2.0 | 7,833 |
#ifndef __OTA_MD5_H__
#define __OTA_MD5_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdint.h>
#include <stddef.h>
/**
* \brief MD5 context structure
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
typedef struct {
uint32_t total[2]; /*!< number of bytes processed */
uint32_t state[4]; /*!< intermediate digest state */
unsigned char buffer[64]; /*!< data block being processed */
} utils_md5_context_t;
/**
* \brief Initialize MD5 context
*
* \param ctx MD5 context to be initialized
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
void utils_md5_init(utils_md5_context_t *ctx);
/**
* \brief Clear MD5 context
*
* \param ctx MD5 context to be cleared
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
void utils_md5_free(utils_md5_context_t *ctx);
/**
* \brief MD5 context setup
*
* \param ctx context to be initialized
*
* \return 0 if successful
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
int32_t utils_md5_starts(utils_md5_context_t *ctx);
/**
* \brief MD5 process buffer
*
* \param ctx MD5 context
* \param input buffer holding the data
* \param ilen length of the input data
*
* \return 0 if successful
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
int32_t utils_md5_update(utils_md5_context_t *ctx,
const unsigned char *input,
uint32_t ilen);
/**
* \brief MD5 final digest
*
* \param ctx MD5 context
* \param output MD5 checksum result
*
* \return 0 if successful
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
int32_t utils_md5_finish(utils_md5_context_t *ctx,
unsigned char output[16]);
/**
* \brief MD5 process data block (internal use only)
*
* \param ctx MD5 context
* \param data buffer holding one block of data
*
* \return 0 if successful
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
int32_t utils_internal_md5_process(utils_md5_context_t *ctx,
const unsigned char data[64]);
/**
* \brief Output = MD5( input buffer )
*
* \param input buffer holding the data
* \param ilen length of the input data
* \param output MD5 checksum result
*
* \return 0 if successful
*
* \warning MD5 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
#if defined(__cplusplus)
}
#endif
#endif /* __OTA_MD5_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/ota/ota_md5.h | C | apache-2.0 | 3,801 |
#ifndef __OTA_PRIVATE_H__
#define __OTA_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_http.h"
#include "aiot_ota_api.h"
#define OTA_VERSION_TOPIC_PREFIX "/ota/device/inform"
#define OTA_PROGRESS_TOPIC_PREFIX "/ota/device/progress"
#define OTA_MODULE_NAME "OTA"
#define DOWNLOAD_MODULE_NAME "DOWNLOAD"
#define OTA_DEFAULT_DOWNLOAD_BUFLEN (2 * 1024)
#define OTA_DEFAULT_DOWNLOAD_TIMEOUT_MS (5 * 1000)
#define OTA_FOTA_TOPIC "/ota/device/upgrade/+/+"
#define OTA_FOTA_TOPIC_PREFIX "/ota/device/upgrade"
#define OTA_COTA_PUSH_TOPIC "/sys/+/+/thing/config/push"
#define OTA_COTA_PUSH_TOPIC_POSTFIX "/thing/config/push"
#define OTA_COTA_GET_REPLY_TOPIC "/sys/+/+/thing/config/get_reply"
#define OTA_COTA_GET_REPLY_TOPIC_POSTFIX "/thing/config/get_reply"
#define OTA_COTA_TOPIC_PREFIX "/sys/"
#define OTA_GET_TOPIC_PREFIX "/sys"
#define OTA_GET_TOPIC_SUFFIX "thing/ota/firmware/get"
#define OTA_GET_REPLY_TOPIC_SUFFIX "thing/ota/firmware/get_reply"
#define OTA_OTA_GET_REPLY_TOPIC "/sys/+/+/thing/ota/firmware/get_reply"
#define OTA_HTTPCLIENT_MAX_URL_LEN (256)
#define OTA_MAX_DIGIT_NUM_OF_UINT32 (20)
#define OTA_RESPONSE_PARTIAL (206)
#define OTA_RESPONSE_OK (200)
#define OTA_TOPIC_NUM (4)
#define OTA_MD5_LEN (32)
#define OTA_SHA256_LEN (64)
typedef enum {
DOWNLOAD_STATUS_START,
DOWNLOAD_STATUS_FETCH,
DOWNLOAD_STATUS_RENEWAL,
} download_status_t;
typedef enum {
OTA_TYPE_FOTA,
OTA_TYPE_CONFIG_PUSH,
OTA_TYPE_CONFIG_GET,
} ota_type_t;
/**
* @brief OTA过程中处理mqtt消息的句柄, 该句柄主要用于通过mqtt协议从云端收取固件升级消息, 包括固件的url等
*
*/
typedef struct {
void *userdata; /* 组件调用recv_handler的入参之一, 传入用户数据 */
aiot_ota_recv_handler_t recv_handler; /* OTA的mqtt消息到达设备端时, 通知用户的回调 */
aiot_sysdep_portfile_t *sysdep;
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是OTA内部使用, 用户无感知 ----*/
void *mqtt_handle;
void *module;
void *data_mutex;
} ota_handle_t;
/**
* @brief 处理下载任务的句柄, 该句柄主要用于通过http协议从指定的url下载固件
*
*/
typedef struct {
void
*userdata; /* 组件调用recv_handler 时的入参之一, 传入用户数据 */
aiot_download_recv_handler_t recv_handler; /* 设备收到分段的固件报文时的回调函数 */
aiot_download_task_desc_t *task_desc; /* 某次下载活动的目标描述信息, 如URL等 */
aiot_sysdep_portfile_t *sysdep;
uint32_t range_start;
uint32_t range_end;
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是downloader内部使用, 用户无感知 ----*/
uint8_t download_status;
void *http_handle;
uint32_t size_fetched;
uint32_t range_size_fetched;
uint32_t content_len;
int32_t percent;
int32_t http_rsp_status_code;
void *digest_ctx;
void *data_mutex;
void *recv_mutex;
} download_handle_t;
#if defined(__cplusplus)
}
#endif
#endif /* __OTA_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/ota/ota_private.h | C | apache-2.0 | 3,714 |
/**
* @file aiot_shadow_api.c
* @brief shadow模块的API接口实现, 提供更新, 删除, 获取设备影子的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "shadow_private.h"
#include "core_string.h"
#include "core_log.h"
#include "core_global.h"
#include "core_mqtt.h"
static int32_t _shadow_get_pk_dn(aiot_sysdep_portfile_t *sysdep, char *topic, uint16_t topic_len,
char **product_key, char **device_name)
{
uint16_t pk_offset = 12; /* length of "/shadow/get/" */
uint16_t idx = 0;
uint16_t pk_len = 0, dn_len = 0;
char *pk_pos = topic + pk_offset;
char *dn_pos = NULL;
char *tmp_pk = NULL, *tmp_dn = NULL;
for (idx = pk_offset; idx < topic_len - 1; idx++) {
if (topic[idx] == '/') {
dn_pos = topic + idx + 1;
pk_len = dn_pos - pk_pos - 1;
dn_len = topic_len - idx - 1;
}
}
if (pk_len == 0 || dn_len == 0) {
return STATE_SHADOW_INTERNAL_TOPIC_ERROR;
}
tmp_pk = sysdep->core_sysdep_malloc(pk_len + 1, SHADOW_MODULE_NAME);
if (tmp_pk == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(tmp_pk, 0, pk_len + 1);
memcpy(tmp_pk, pk_pos, pk_len);
tmp_dn = sysdep->core_sysdep_malloc(dn_len + 1, SHADOW_MODULE_NAME);
if (tmp_dn == NULL) {
sysdep->core_sysdep_free(tmp_pk);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(tmp_dn, 0, dn_len + 1);
memcpy(tmp_dn, dn_pos, dn_len);
*product_key = tmp_pk;
*device_name = tmp_dn;
return STATE_SUCCESS;
}
int32_t _shadow_int642str(int64_t input, char *output, uint8_t *output_len)
{
uint64_t temp = 0;
uint8_t len = 0;
if (input < 0) {
*output = '-';
temp = -input;
core_uint642str(temp, output + 1, &len);
if (output_len != NULL) {
*output_len = len + 1;
}
} else {
temp = input;
core_uint642str(temp, output, output_len);
}
return STATE_SUCCESS;
}
static void _shadow_recv_message_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
shadow_handle_t *shadow_handle = (shadow_handle_t *)userdata;
aiot_shadow_recv_t recv;
char *value = NULL;
uint32_t value_len = 0;
char *pk = NULL;
char *dn = NULL;
int32_t res = STATE_SUCCESS;
char *method = NULL;
uint32_t method_len = 0;
char *payload = NULL;
uint32_t payload_len = 0;
uint64_t timestamp = 0;
uint64_t version = 0;
char status[10] = { 0 };
char *version_str = NULL;
uint32_t version_strlen = 0;
if (NULL == shadow_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_shadow_recv_t));
do {
/* get pk & dn */
if ((res = _shadow_get_pk_dn(shadow_handle->sysdep, msg->data.pub.topic, msg->data.pub.topic_len, &pk, &dn)) < 0) {
break;
}
recv.product_key = pk;
recv.device_name = dn;
/* parse the message */
if ((res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_METHOD, strlen(SHADOW_JSON_KEY_METHOD), &method, &method_len) < 0) ||
(res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_TIMESTAMP, strlen(SHADOW_JSON_KEY_TIMESTAMP), &value, &value_len) < 0) ||
(res = core_str2uint64(value, value_len, ×tamp) < 0) ||
(res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_PAYLOAD, strlen(SHADOW_JSON_KEY_PAYLOAD), &payload, &payload_len) < 0)) {
break;
}
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_VERSION, strlen(SHADOW_JSON_KEY_VERSION), &version_str, &version_strlen) == STATE_SUCCESS) {
core_str2uint64(version_str, version_strlen, &version);
}
/* control message */
if (method_len == strlen("control") && !memcmp(method, "control", method_len)) {
/* get version */
if (version_str == NULL) {
break;
}
core_log(shadow_handle->sysdep, STATE_SHADOW_LOG_RECV, "SHADOW recv control message\r\n");
recv.type = AIOT_SHADOWRECV_CONTROL;
recv.data.control.payload = payload;
recv.data.control.payload_len = payload_len;
recv.data.control.version = version;
} /* reply message */
else if (method_len == strlen("reply") && !memcmp(method, "reply", method_len)) {
/* get_reply */
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_STATE, strlen(SHADOW_JSON_KEY_STATE), &value, &value_len) < 0) {
if ((res = core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len,
SHADOW_JSON_KEY_STATUS, strlen(SHADOW_JSON_KEY_STATUS), &value, &value_len) < 0) ||
(value_len >= sizeof(status))) {
break;
}
core_log(shadow_handle->sysdep, STATE_SHADOW_LOG_RECV, "SHADOW recv get_reply message\r\n");
memcpy(status, value, value_len);
recv.type = AIOT_SHADOWRECV_GENERIC_REPLY;
recv.data.generic_reply.payload = payload;
recv.data.generic_reply.payload_len = payload_len;
recv.data.generic_reply.status = status;
recv.data.generic_reply.timestamp = timestamp;
} /* get_reply */
else {
if (version_str == NULL) {
break;
}
core_log(shadow_handle->sysdep, STATE_SHADOW_LOG_RECV, "SHADOW recv generic_reply message\r\n");
recv.type = AIOT_SHADOWRECV_GET_REPLY;
recv.data.get_reply.payload = payload;
recv.data.get_reply.payload_len = payload_len;
recv.data.get_reply.version = version;
}
} else {
break;
}
shadow_handle->recv_handler(shadow_handle, &recv, shadow_handle->userdata);
shadow_handle->sysdep->core_sysdep_free(pk);
shadow_handle->sysdep->core_sysdep_free(dn);
return;
} while (0);
/* invalid message log */
core_log(shadow_handle->sysdep, SATAE_SHADOW_LOG_PARSE_RECV_MSG_FAILED, "SHADOW parse recv message failed\r\n");
if (pk != NULL) {
shadow_handle->sysdep->core_sysdep_free(pk);
}
if (dn != NULL) {
shadow_handle->sysdep->core_sysdep_free(dn);
}
}
static void _shadow_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
shadow_handle_t *shadow_handle = (shadow_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
shadow_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _shadow_core_mqtt_operate_process_handler(shadow_handle_t *shadow_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _shadow_core_mqtt_process_handler;
process_data.context = shadow_handle;
return core_mqtt_setopt(shadow_handle->mqtt_handle, option, &process_data);
}
void *aiot_shadow_init(void)
{
aiot_sysdep_portfile_t *sysdep = aiot_sysdep_get_portfile();
shadow_handle_t *shadow_handle = NULL;
if (NULL == sysdep) {
return NULL;
}
shadow_handle = sysdep->core_sysdep_malloc(sizeof(shadow_handle_t), SHADOW_MODULE_NAME);
if (NULL == shadow_handle) {
return NULL;
}
memset(shadow_handle, 0, sizeof(shadow_handle_t));
shadow_handle->sysdep = sysdep;
return shadow_handle;
}
int32_t aiot_shadow_setopt(void *handle, aiot_shadow_option_t option, void *data)
{
shadow_handle_t *shadow_handle;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == data) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_SHADOWOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
shadow_handle = (shadow_handle_t *)handle;
switch (option) {
case AIOT_SHADOWOPT_MQTT_HANDLE: {
aiot_mqtt_topic_map_t topic_mapping;
shadow_handle->mqtt_handle = data;
/* setup mqtt topic mapping */
topic_mapping.topic = SHADOW_GET_TOPIC;
topic_mapping.handler = _shadow_recv_message_handler;
topic_mapping.userdata = handle;
res = aiot_mqtt_setopt(data, AIOT_MQTTOPT_APPEND_TOPIC_MAP, &topic_mapping);
if (res >= STATE_SUCCESS) {
res = _shadow_core_mqtt_operate_process_handler(shadow_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
}
break;
case AIOT_SHADOWOPT_RECV_HANDLER: {
shadow_handle->recv_handler = (aiot_shadow_recv_handler_t)data;
}
break;
case AIOT_SHADOWOPT_USERDATA: {
shadow_handle->userdata = data;
}
break;
default:
break;
}
return res;
}
int32_t aiot_shadow_send(void *handle, aiot_shadow_msg_t *msg)
{
shadow_handle_t *shadow_handle = NULL;
char *topic = NULL;
char *payload = NULL;
int32_t res = STATE_SUCCESS;
if (NULL == handle || NULL == msg) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (msg->type >= AIOT_SHADOWMSG_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
shadow_handle = (shadow_handle_t *)handle;
if (NULL == shadow_handle->mqtt_handle) {
return STATE_SHADOW_MQTT_HANDLE_IS_NULL;
}
/* construct mqtt topic */
{
char *src[2];
char *pk = NULL, *dn = NULL;
pk = core_mqtt_get_product_key(shadow_handle->mqtt_handle);
dn = core_mqtt_get_device_name(shadow_handle->mqtt_handle);
if (NULL == msg->product_key && NULL == pk) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (NULL == msg->device_name && NULL == dn) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
src[0] = (msg->product_key != NULL) ? msg->product_key : pk;
src[1] = (msg->device_name != NULL) ? msg->device_name : dn;
res = core_sprintf(shadow_handle->sysdep, &topic, SHADOW_UPDATE_TOPIC_FMT, src, sizeof(src) / sizeof(char *),
SHADOW_MODULE_NAME);
if (NULL == topic) {
return res;
}
}
/* construct payload */
switch (msg->type) {
case AIOT_SHADOWMSG_UPDATE: {
char version_string[21] = { 0 };
char *src[3] = { NULL };
if (NULL == msg->data.update.reported) {
res = STATE_SHADOW_REPORTED_DATA_IS_NULL;
break;
}
_shadow_int642str(msg->data.update.version, version_string, NULL);
src[0] = "update";
src[1] = msg->data.update.reported;
src[2] = version_string;
res = core_sprintf(shadow_handle->sysdep, &payload, SHADOW_PAYLOAD_REQ_FMT,
src, sizeof(src) / sizeof(char *), SHADOW_MODULE_NAME);
if (res < STATE_SUCCESS) {
break;
}
}
break;
case AIOT_SHADOWMSG_CLEAN_DESIRED: {
char version_string[21] = { 0 };
char *src[1] = { NULL };
_shadow_int642str(msg->data.clean_desired.version, version_string, NULL);
src[0] = version_string;
res = core_sprintf(shadow_handle->sysdep, &payload, SHADOW_PAYLOAD_CLEAN_FMT,
src, sizeof(src) / sizeof(char *), SHADOW_MODULE_NAME);
if (res < STATE_SUCCESS) {
break;
}
}
break;
case AIOT_SHADOWMSG_GET: {
payload = SHADOW_PAYLOAD_GET;
}
break;
case AIOT_SHADOWMSG_DELETE_REPORTED: {
char version_string[21] = { 0 };
char *src[3] = { NULL };
if (NULL == msg->data.delete_reporte.reported) {
res = STATE_SHADOW_REPORTED_DATA_IS_NULL;
break;
}
_shadow_int642str(msg->data.delete_reporte.version, version_string, NULL);
src[0] = "delete";
src[1] = msg->data.update.reported;
src[2] = version_string;
res = core_sprintf(shadow_handle->sysdep, &payload, SHADOW_PAYLOAD_REQ_FMT,
src, sizeof(src) / sizeof(char *), SHADOW_MODULE_NAME);
if (res < STATE_SUCCESS) {
break;
}
}
break;
default: {
res = STATE_USER_INPUT_OUT_RANGE;
}
break;
}
if (NULL == payload) {
shadow_handle->sysdep->core_sysdep_free(topic);
return res;
}
res = aiot_mqtt_pub(shadow_handle->mqtt_handle, topic, (uint8_t *)payload, strlen(payload), 0);
shadow_handle->sysdep->core_sysdep_free(topic);
if (msg->type != AIOT_SHADOWMSG_GET) {
shadow_handle->sysdep->core_sysdep_free(payload);
}
return res;
}
int32_t aiot_shadow_deinit(void **p_handle)
{
shadow_handle_t *shadow_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
aiot_mqtt_topic_map_t topic_mapping;
if (NULL == p_handle || NULL == *p_handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
shadow_handle = *p_handle;
sysdep = shadow_handle->sysdep;
*p_handle = NULL;
_shadow_core_mqtt_operate_process_handler(shadow_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
/* remove mqtt topic mapping */
memset(&topic_mapping, 0, sizeof(aiot_mqtt_topic_map_t));
topic_mapping.topic = SHADOW_GET_TOPIC;
topic_mapping.handler = _shadow_recv_message_handler;
aiot_mqtt_setopt(shadow_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, &topic_mapping);
sysdep->core_sysdep_free(shadow_handle);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/shadow/aiot_shadow_api.c | C | apache-2.0 | 14,469 |
/**
* @file aiot_shadow_api.h
* @brief shadow模块头文件, 提供更新, 删除, 获取设备影子的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
* 请按照以下流程使用API
*
* 1. 在使用设备影子模块前, 用户应首先创建好一个MQTT实例
*
* 2. 调用`aiot_shadow_init`创建一个设备影子实例, 保存实例句柄
*
* 3. 调用`aiot_shadow_setopt`配置`AIOT_SHADOWOPT_MQTT_HANDLE`选项以设置MQTT句柄, 此选项为强制配置选项
*
* 4. 调用`aiot_shadow_setopt`配置`AIOT_SHADOWOPT_RECV_HANDLER`和`AIOT_SHADOWOPT_USERDATA`选项以注册数据接受回调函数和用户上下文数据指针
*
* 5. 在使用`aiot_shadow_send`发送消息前, 应先完成MQTT实例的建连
*
* 6. 调动`aiot_shadow_send`发送更新设备影子, 获取设备影子或删除设备等消息到云平台, 在注册的回调函数中处理各种类型的云端应答消息或主动下推消息
*
*/
#ifndef __AIOT_SHADOW_API_H__
#define __AIOT_SHADOW_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x1300~-0x13FF表达SDK在data-model模块内的状态码
*/
#define STATE_SHADOW_BASE (-0x1300)
/**
* @brief 用户未调用@ref aiot_shadow_setopt 配置MQTT句柄
*/
#define STATE_SHADOW_MQTT_HANDLE_IS_NULL (-0x1301)
/**
* @brief 用户上报@ref AIOT_SHADOWMSG_UPDATE 或 @ref AIOT_SHADOWMSG_DELETE_REPORTED 消息时, 消息结构体中的reported为NULL
*
*/
#define STATE_SHADOW_REPORTED_DATA_IS_NULL (-0x1302)
/**
* @brief 解析下行数据对应的topic时发生错误
*/
#define STATE_SHADOW_INTERNAL_TOPIC_ERROR (-0x1303)
/**
* @brief 接收到服务器下行消息时的日志状态码
*/
#define STATE_SHADOW_LOG_RECV (-0x1304)
/**
* @brief 解析服务器下行消息失败时的日志状态码
*/
#define SATAE_SHADOW_LOG_PARSE_RECV_MSG_FAILED (-0x1305)
/**
* @brief @ref aiot_shadow_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_shadow_setopt 中, data参数的数据类型
*
* 当data的数据类型是char *时, 以配置@ref AIOT_SHADOWOPT_PRODUCT_KEY 为例:
*
* char *product_key = "xxx";
* aiot_shadow_setopt(shadow_handle, AIOT_SHADOWOPT_PRODUCT_KEY, product_key);
*
*/
typedef enum {
/**
* @brief 模块依赖的MQTT句柄
*
* @details
*
* shadow模块依赖底层的MQTT模块, 用户必需配置正确的MQTT句柄, 否则无法正常工作, 数据类型为(void *)
*/
AIOT_SHADOWOPT_MQTT_HANDLE,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户, 数据类型为(aiot_shadow_recv_handler_t)
*/
AIOT_SHADOWOPT_RECV_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文, 数据类型为(void *)
*
* @details 这个上下文指针会在 AIOT_SHADOWOPT_RECV_HANDLER 设置的回调被调用时, 由SDK传给用户
*/
AIOT_SHADOWOPT_USERDATA,
/**
* @brief 配置选项数量最大值, 不可用作配置参数
*/
AIOT_SHADOWOPT_MAX,
} aiot_shadow_option_t;
/**
* @brief shadow模块发送消息类型
*
* @details
*
* 这个枚举类型包括了shadow模块支持发送的所有数据类型, 不同的消息类型将对于不同的消息结构体
*
*/
typedef enum {
/**
* @brief 更新设备影子中的reported值, 消息结构体参考@ref aiot_shadow_msg_update_t
*
*/
AIOT_SHADOWMSG_UPDATE,
/**
* @brief 清空设备影子的desired值, 消息结构体参考@ref aiot_shadow_msg_clean_desired_t
*
*/
AIOT_SHADOWMSG_CLEAN_DESIRED,
/**
* @brief 获取设备影子, 消息结构体参考@ref aiot_shadow_msg_get_t
*
*/
AIOT_SHADOWMSG_GET,
/**
* @brief 删除设备影子的部分或全部reported值, 消息结构体参考@ref aiot_shadow_msg_delete_reported_t
*
*/
AIOT_SHADOWMSG_DELETE_REPORTED,
/**
* @brief 消息数量最大值, 不可用作消息类型
*/
AIOT_SHADOWMSG_MAX,
} aiot_shadow_msg_type_t;
/**
* @brief 用于<b>更新设备影子中的reported数据</b>的消息结构体
*/
typedef struct {
/**
* @brief 设备影子reported object字符串, <b>必须为以结束符'\0'结尾的字符串</b>, 如"{\"LightSwitch\": 1}"
*/
char *reported;
/**
* @brief 设备影子的目标版本, <b>必须大于设备影子的当前版本</b>, 若设置为-1将清空设备影子数据, 并将设备影子版本更新为0
*/
int64_t version;
} aiot_shadow_msg_update_t;
/**
* @brief 用于<b>清除设备影子中的desired数据</b>的消息结构体
*/
typedef struct {
/**
* @brief 设备影子的目标版本, <b>必须大于设备影子的当前版本</b>
*/
int64_t version;
} aiot_shadow_msg_clean_desired_t;
/**
* @brief 用于<b>获取设备影子</b>的消息结构体,
*/
typedef struct {
/**
* @brief 保留字段
*/
uint32_t resevered;
} aiot_shadow_msg_get_t;
/**
* @brief 用于<b>删除设备影子中的reported数据</b>的消息结构体
*/
typedef struct {
/**
* @brief 用户将要删除的reported数据, <b>必须为以结束符'\0'结尾的字符串</b>. \n
* 若要删除全部reported数据, 则应填写"\"null\""字符串 \n
* 若要删除部分reported数据, 则将对应的值定义为null, 如只清除LightSwitch的值应填写"{\"LightSwitch\":\"null\"}"
*/
char *reported;
/**
* @brief 设备影子的目标版本, <b>必须大于设备影子的当前版本</b>
*/
int64_t version;
} aiot_shadow_msg_delete_reported_t;
/**
* @brief data-model模块发送消息的消息结构体
*/
typedef struct {
/**
* @brief 消息所属设备的product_key, 若为NULL则使用通过aiot_shadow_setopt配置的product_key \n
* 在网关子设备场景下, 可通过指定为子设备的product_key来发送子设备的消息到云端
*/
char *product_key;
/**
* @brief 消息所属设备的device_name, 若为NULL则使用通过aiot_shadow_setopt配置的device_name \n
* 在网关子设备场景下, 可通过指定为子设备的product_key来发送子设备的消息到云端
*/
char *device_name;
/**
* @brief 消息类型, 可参考@ref aiot_shadow_msg_type_t
*/
aiot_shadow_msg_type_t type;
/**
* @brief 消息数据联合体, 不同的消息类型将使用不同的消息结构体
*/
union {
aiot_shadow_msg_update_t update;
aiot_shadow_msg_clean_desired_t clean_desired;
aiot_shadow_msg_get_t get;
aiot_shadow_msg_delete_reported_t delete_reporte;
} data;
} aiot_shadow_msg_t;
/**
* @brief shadow模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
/**
* @brief 设备发送 @ref AIOT_SHADOWMSG_UPDATE, @ref AIOT_SHADOWMSG_CLEAN_DESIRED 或 @ref AIOT_SHADOWMSG_DELETE_REPORTED 这3这类型消息后, 云端返回的应答消息, \n
* 消息数据结构体参考 @ref aiot_shadow_recv_generic_reply_t
*/
AIOT_SHADOWRECV_GENERIC_REPLY,
/**
* @brief 设备在线时, 云端自动下发的影子内容, 消息数据结构体参考 @ref aiot_shadow_recv_control_t
*/
AIOT_SHADOWRECV_CONTROL,
/**
* @brief 主动获取设备影子内容云端返回的影子内容, 消息数据结构体参考 @ref aiot_shadow_recv_get_reply_t
*/
AIOT_SHADOWRECV_GET_REPLY,
} aiot_shadow_recv_type_t;
/**
* @brief 设备发送 @ref AIOT_SHADOWMSG_UPDATE, @ref AIOT_SHADOWMSG_CLEAN_DESIRED 或 @ref AIOT_SHADOWMSG_DELETE_REPORTED 类型消息后, 云端返回的应答消息
*/
typedef struct {
/**
* @brief 指向应答数据的指针
*/
char *payload;
/**
* @brief 应答数据长度
*/
uint32_t payload_len;
/**
* @brief 应答状态字符串, 云端处理成功则为<b>success</b>, 发送消息错误则为<b>error</b>, 错误信息和错误码放在在payload中
*/
char *status;
/**
* @brief 应答报文对应的时间戳
*/
uint64_t timestamp;
} aiot_shadow_recv_generic_reply_t;
/**
* @brief 如果设备在线, 用户应用调用云端API<a href="https://help.aliyun.com/document_detail/69954.html#doc-api-Iot-UpdateDeviceShadow">UpdateDeviceShadow</a>后云端下推的消息
*/
typedef struct {
/**
* @brief 指向设备影子数据的指针
*/
char *payload;
/**
* @brief 设备影子数据长度
*/
uint32_t payload_len;
/**
* @brief 设备影子版本
*/
uint64_t version;
} aiot_shadow_recv_control_t;
/**
* @brief 设备发送 @ref AIOT_SHADOWMSG_GET 类型消息后, 云端返回的设备影子数据
*/
typedef struct {
/**
* @brief 指向设备影子数据的指针
*/
char *payload;
/**
* @brief 设备影子数据长度
*/
uint32_t payload_len;
/**
* @brief 设备影子版本号
*/
uint64_t version;
} aiot_shadow_recv_get_reply_t;
/**
* @brief shadow模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 消息所属设备的product_key
*/
char *product_key;
/**
* @brief 消息所属设备的device_name
*/
char *device_name;
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_shadow_recv_type_t
*/
aiot_shadow_recv_type_t type;
/**
* @brief 消息数据联合体, 不同的消息类型将使用不同的消息结构体
*/
union {
aiot_shadow_recv_generic_reply_t generic_reply;
aiot_shadow_recv_control_t control;
aiot_shadow_recv_get_reply_t get_reply;
} data;
} aiot_shadow_recv_t;
/**
* @brief shadow模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle shadow会话句柄
* @param[in] recv shadow接受消息结构体, 存放收到的shadow报文内容
* @param[in] userdata 指向用户上下文数据的指针, 这个指针由用户通过调用@ref aiot_shadow_setopt 配置@ref AIOT_SHADOWOPT_USERDATA 选项设置
*
* @return void
*/
typedef void (* aiot_shadow_recv_handler_t)(void *handle,
const aiot_shadow_recv_t *recv, void *userdata);
/**
* @brief 创建shadow会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL shadow实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_shadow_init(void);
/**
* @brief 配置shadow会话
*
* @param[in] handle shadow会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_shadow_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_shadow_option_t
*
* @return int32_t
* @retval STATE_SUCCESS 参数配置成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参handle或data为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参optioin的枚举值>=AIOT_SHADOWOPT_MAX
* @retval others 参考@ref aiot_state_api.h
*
*/
int32_t aiot_shadow_setopt(void *handle, aiot_shadow_option_t option, void *data);
/**
* @brief 向服务器发送shadow消息请求
*
* @param[in] handle shadow会话句柄
* @param[in] msg 消息结构体, 可指定发送消息的设备<i>productKey</i>, <i>deviceName</i>; 消息类型, 消息数据等, 更多信息请参考@ref aiot_shadow_msg_t
*
* @return int32_t
* @retval STATE_SUCCESS 请求发送成功
* @retval STATE_USER_INPUT_NULL_POINTER 入参<i>handle</i>或<i>msg</i>为NULL
* @retval STATE_USER_INPUT_OUT_RANGE 入参<i>msg</i>的结构体成员<i>type</i> >= AIOT_SHADOWMSG_MAX
* @retval STATE_SYS_DEPEND_MALLOC_FAILED 内存分配失败
* @retval STATE_SHADOW_MQTT_HANDLE_IS_NULL 用户未调用@ref aiot_shadow_setopt 配置MQTT句柄
* @retval others 参考@ref aiot_state_api.h 或@ref STATE_SHADOW_BASE 中对应的错误码说明
*
*/
int32_t aiot_shadow_send(void *handle, aiot_shadow_msg_t *msg);
/**
* @brief 结束shadow会话, 销毁实例并回收资源
*
* @param[in] handle 指向shadow会话句柄的指针
*
* @return int32_t
* @retval STATE_SUCCESS 执行成功
* @retval <STATE_SUCCESS 执行失败
*
*/
int32_t aiot_shadow_deinit(void **handle);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_SHADOW_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/shadow/aiot_shadow_api.h | C | apache-2.0 | 12,674 |
/**
* @file shadow_private.h
* @brief shadow模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __SHADOW_PRIVATE_H__
#define __SHADOW_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_shadow_api.h"
/* shadow模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *mqtt_handle;
aiot_shadow_recv_handler_t recv_handler;
void *userdata;
} shadow_handle_t;
#define SHADOW_MODULE_NAME "shadow"
#define SHADOW_UPDATE_TOPIC_FMT "/shadow/update/%s/%s"
#define SHADOW_GET_TOPIC "/shadow/get/+/+"
#define SHADOW_PAYLOAD_REQ_FMT "{\"method\":\"%s\",\"state\":{\"reported\":%s},\"version\":%s}"
#define SHADOW_PAYLOAD_CLEAN_FMT "{\"method\":\"update\",\"state\":{\"desired\":\"null\"},\"version\":%s}"
#define SHADOW_PAYLOAD_GET "{\"method\":\"get\"}"
#define SHADOW_JSON_KEY_METHOD "method"
#define SHADOW_JSON_KEY_PAYLOAD "payload"
#define SHADOW_JSON_KEY_STATUS "status"
#define SHADOW_JSON_KEY_TIMESTAMP "timestamp"
#define SHADOW_JSON_KEY_STATE "state"
#define SHADOW_JSON_KEY_VERSION "version"
#if defined(__cplusplus)
}
#endif
#endif /* __SHADOW_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/shadow/shadow_private.h | C | apache-2.0 | 1,653 |
/**
* @file aiot_subdev_api.c
* @brief subdev模块的API接口实现, 提供.......的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#include "subdev_private.h"
/* TODO: 列出对core模块需要包含的头文件 */
#include "core_global.h"
#include "core_string.h"
#include "core_log.h"
#include "core_sha256.h"
#include "core_mqtt.h"
#include "cJSON.h"
static int32_t _subdev_update_alink_id(subdev_handle_t *subdev_handle)
{
int32_t res = STATE_SUCCESS, alink_id = 0;
memset(subdev_handle->alink_id, 0, SUBDEV_ALINK_ID_MAX_LEN);
core_global_alink_id_next(subdev_handle->sysdep, &alink_id);
res = core_int2str(alink_id, subdev_handle->alink_id, NULL);
if (res < STATE_SUCCESS) {
return res;
}
return STATE_SUCCESS;
}
static void _subdev_topo_generic_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata, aiot_subdev_recv_type_t type, uint8_t pk_pos)
{
subdev_handle_t *subdev_handle = (subdev_handle_t *)userdata;
if (subdev_handle->recv_handler == NULL) {
return;
}
switch (packet->type) {
case AIOT_MQTTRECV_PUB: {
char *id = NULL, *code = NULL, *data = NULL, *data_str = NULL, *message = NULL, *message_str = NULL;
uint32_t id_len = 0, code_len = 0, data_len = 0, message_len = 0, id_num = 0, code_num = 0;
aiot_subdev_recv_t recv;
if (core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "id", strlen("id"), &id, &id_len) < STATE_SUCCESS ||
core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "code", strlen("code"), &code, &code_len) < STATE_SUCCESS ||
core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "data", strlen("data"), &data, &data_len) < STATE_SUCCESS ||
core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "message", strlen("message"), &message, &message_len) < STATE_SUCCESS) {
aiot_subdev_event_t event;
memset(&event, 0, sizeof(aiot_subdev_event_t));
event.type = AIOT_SUBDEVEVT_INVALID_RESPONSE;
if (subdev_handle->event_handler != NULL) {
subdev_handle->event_handler(subdev_handle, &event, subdev_handle->userdata);
}
}
if (core_str2uint(id, id_len, &id_num) < STATE_SUCCESS) {
aiot_subdev_event_t event;
memset(&event, 0, sizeof(aiot_subdev_event_t));
event.type = AIOT_SUBDEVEVT_INVALID_ID;
if (subdev_handle->event_handler != NULL) {
subdev_handle->event_handler(subdev_handle, &event, subdev_handle->userdata);
}
}
if (core_str2uint(code, code_len, &code_num) < STATE_SUCCESS) {
aiot_subdev_event_t event;
memset(&event, 0, sizeof(aiot_subdev_event_t));
event.type = AIOT_SUBDEVEVT_INVALID_CODE;
if (subdev_handle->event_handler != NULL) {
subdev_handle->event_handler(subdev_handle, &event, subdev_handle->userdata);
}
}
data_str = subdev_handle->sysdep->core_sysdep_malloc(data_len + 1, SUBDEV_MODULE_NAME);
if (data_str == NULL) {
return;
}
memset(data_str, 0, data_len + 1);
memcpy(data_str, data, data_len);
message_str = subdev_handle->sysdep->core_sysdep_malloc(message_len + 1, SUBDEV_MODULE_NAME);
if (message_str == NULL) {
subdev_handle->sysdep->core_sysdep_free(data_str);
return;
}
memset(message_str, 0, message_len + 1);
memcpy(message_str, message, message_len);
memset(&recv, 0, sizeof(aiot_subdev_recv_t));
recv.type = type;
recv.data.generic_reply.msg_id = id_num;
recv.data.generic_reply.code = code_num;
recv.data.generic_reply.data = data_str;
recv.data.generic_reply.message = message_str;
strtok(packet->data.pub.topic, "/");
while((--pk_pos - 1) > 0) {
strtok(NULL, "/");
}
recv.data.generic_reply.product_key = strtok(NULL, "/");
recv.data.generic_reply.device_name = strtok(NULL, "/");
subdev_handle->recv_handler(subdev_handle, &recv, subdev_handle->userdata);
subdev_handle->sysdep->core_sysdep_free(data_str);
subdev_handle->sysdep->core_sysdep_free(message_str);
}
break;
default: {
break;
}
}
}
static void _subdev_topo_generic_notify_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata, aiot_subdev_recv_type_t type, uint8_t pk_pos)
{
subdev_handle_t *subdev_handle = (subdev_handle_t *)userdata;
if (subdev_handle->recv_handler == NULL) {
return;
}
switch (packet->type) {
case AIOT_MQTTRECV_PUB: {
char *id = NULL, *params = NULL, *params_str = NULL;
uint32_t id_len = 0, params_len = 0, id_num = 0;
aiot_subdev_recv_t recv;
if (core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "id", strlen("id"), &id, &id_len) < STATE_SUCCESS ||
core_json_value((const char *)packet->data.pub.payload, packet->data.pub.payload_len, "params", strlen("params"), ¶ms, ¶ms_len) < STATE_SUCCESS) {
aiot_subdev_event_t event;
memset(&event, 0, sizeof(aiot_subdev_event_t));
event.type = AIOT_SUBDEVEVT_INVALID_RESPONSE;
if (subdev_handle->event_handler != NULL) {
subdev_handle->event_handler(subdev_handle, &event, subdev_handle->userdata);
}
}
if (core_str2uint(id, id_len, &id_num) < STATE_SUCCESS) {
aiot_subdev_event_t event;
memset(&event, 0, sizeof(aiot_subdev_event_t));
event.type = AIOT_SUBDEVEVT_INVALID_ID;
if (subdev_handle->event_handler != NULL) {
subdev_handle->event_handler(subdev_handle, &event, subdev_handle->userdata);
}
}
params_str = subdev_handle->sysdep->core_sysdep_malloc(params_len + 1, SUBDEV_MODULE_NAME);
if (params_str == NULL) {
return;
}
memset(params_str, 0, params_len + 1);
memcpy(params_str, params, params_len);
memset(&recv, 0, sizeof(aiot_subdev_recv_t));
recv.type = type;
recv.data.generic_notify.msg_id = id_num;
recv.data.generic_notify.params = params_str;
strtok(packet->data.pub.topic, "/");
while((--pk_pos - 1) > 0) {
strtok(NULL, "/");
}
recv.data.generic_notify.product_key = strtok(NULL, "/");
recv.data.generic_notify.device_name = strtok(NULL, "/");
subdev_handle->recv_handler(subdev_handle, &recv, subdev_handle->userdata);
subdev_handle->sysdep->core_sysdep_free(params_str);
}
break;
default: {
break;
}
}
}
static void _subdev_topo_add_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_TOPO_ADD_REPLY, 2);
}
static void _subdev_topo_delete_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_TOPO_DELETE_REPLY, 2);
}
static void _subdev_topo_get_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_TOPO_GET_REPLY, 2);
}
static void _subdev_batch_login_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_BATCH_LOGIN_REPLY, 3);
}
static void _subdev_batch_logout_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_BATCH_LOGOUT_REPLY, 3);
}
static void _subdev_sub_register_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_SUB_REGISTER_REPLY, 2);
}
static void _subdev_product_register_reply_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_reply_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_PRODUCT_REGISTER_REPLY, 2);
}
static void _subdev_topo_change_recv_handler(void *handle, const aiot_mqtt_recv_t *packet, void *userdata)
{
_subdev_topo_generic_notify_recv_handler(handle, packet, userdata, AIOT_SUBDEVRECV_TOPO_CHANGE_NOTIFY, 2);
}
static subdev_topic_map_t g_subdev_topic_map[] = {
{SUBDEV_TOPIC_TOPO_ADD_REPLY, _subdev_topo_add_reply_recv_handler },
{SUBDEV_TOPIC_TOPO_DELETE_REPLY, _subdev_topo_delete_reply_recv_handler },
{SUBDEV_TOPIC_TOPO_GET_REPLY, _subdev_topo_get_reply_recv_handler },
{SUBDEV_TOPIC_BATCH_LOGIN_REPLY, _subdev_batch_login_reply_recv_handler },
{SUBDEV_TOPIC_BATCH_LOGOUT_REPLY, _subdev_batch_logout_reply_recv_handler },
{SUBDEV_TOPIC_SUB_REGISTER_REPLY, _subdev_sub_register_reply_recv_handler },
{SUBDEV_TOPIC_PRODUCT_REGISTER_REPLY, _subdev_product_register_reply_recv_handler },
{SUBDEV_TOPIC_TOPO_CHANGE_NOTIFY, _subdev_topo_change_recv_handler }
};
static int32_t _subdev_operate_topic_map(subdev_handle_t *subdev_handle, aiot_mqtt_option_t option)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
aiot_mqtt_topic_map_t map;
for (idx = 0;idx < sizeof(g_subdev_topic_map)/sizeof(subdev_topic_map_t);idx++) {
memset(&map, 0, sizeof(aiot_mqtt_topic_map_t));
map.topic = g_subdev_topic_map[idx].topic;
map.handler = g_subdev_topic_map[idx].handler;
map.userdata = (void *)subdev_handle;
res = aiot_mqtt_setopt(subdev_handle->mqtt_handle, option, &map);
if (res < STATE_SUCCESS) {
return res;
}
}
return res;
}
static int32_t _subdev_send_message(subdev_handle_t *subdev_handle, char *topic_fmt, cJSON *root)
{
int32_t res = STATE_SUCCESS;
char *topic = NULL, *payload = NULL;
char *topic_src[] = { core_mqtt_get_product_key(subdev_handle->mqtt_handle), core_mqtt_get_device_name(subdev_handle->mqtt_handle) };
res = core_sprintf(subdev_handle->sysdep, &topic, topic_fmt, topic_src, sizeof(topic_src)/sizeof(char *), SUBDEV_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
payload = cJSON_PrintUnformatted(root);
if (payload == NULL) {
subdev_handle->sysdep->core_sysdep_free(topic);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
res = aiot_mqtt_pub(subdev_handle->mqtt_handle, topic, (uint8_t *)payload, (uint32_t)strlen(payload), 0);
subdev_handle->sysdep->core_sysdep_free(topic);
subdev_handle->sysdep->core_sysdep_free(payload);
return res;
}
static int32_t _subdev_calculate_sign(subdev_handle_t *subdev_handle, aiot_subdev_dev_t *dev, char *timestamp, char sign_str[65])
{
int32_t res = STATE_SUCCESS;
uint8_t sign[32] = {0};
char *plain_text = NULL;
char *plain_text_src[] = { dev->product_key, dev->device_name, dev->device_name, dev->product_key, timestamp };
char *plain_text_fmt = "clientId%s.%sdeviceName%sproductKey%stimestamp%s";
res = core_sprintf(subdev_handle->sysdep, &plain_text, plain_text_fmt, plain_text_src, sizeof(plain_text_src)/sizeof(char *), SUBDEV_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
core_hmac_sha256((uint8_t *)plain_text, (uint32_t)strlen(plain_text), (uint8_t *)dev->device_secret, (uint32_t)strlen(dev->device_secret), sign);
core_hex2str(sign, 32, sign_str, 0);
subdev_handle->sysdep->core_sysdep_free(plain_text);
return STATE_SUCCESS;
}
static int32_t _subdev_calculate_product_register_sign(subdev_handle_t *subdev_handle, aiot_subdev_dev_t *dev, char *random, char sign_str[65])
{
int32_t res = STATE_SUCCESS;
uint8_t sign[32] = {0};
char *plain_text = NULL;
char *plain_text_src[] = { dev->device_name, dev->product_key, random };
char *plain_text_fmt = "deviceName%sproductKey%srandom%s";
res = core_sprintf(subdev_handle->sysdep, &plain_text, plain_text_fmt, plain_text_src, sizeof(plain_text_src)/sizeof(char *), SUBDEV_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
core_hmac_sha256((uint8_t *)plain_text, (uint32_t)strlen(plain_text), (uint8_t *)dev->product_secret, (uint32_t)strlen(dev->product_secret), sign);
core_hex2str(sign, 32, sign_str, 0);
subdev_handle->sysdep->core_sysdep_free(plain_text);
return STATE_SUCCESS;
}
static int32_t _subdev_topo_add_append_params(subdev_handle_t *subdev_handle, cJSON *params, aiot_subdev_dev_t *dev, char *timestamp)
{
int32_t res = STATE_SUCCESS;
cJSON *param = NULL;
char *client_id = NULL, sign_str[65] = {0};
param = cJSON_CreateObject();
if (param == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
client_id = subdev_handle->sysdep->core_sysdep_malloc(strlen(dev->product_key) + strlen(dev->device_name) + 2, SUBDEV_MODULE_NAME);
if (client_id == NULL) {
cJSON_Delete(param);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(client_id, 0, strlen(dev->product_key) + strlen(dev->device_name) + 2);
memcpy(client_id, dev->product_key, strlen(dev->product_key));
memcpy(client_id + strlen(client_id), ".", strlen("."));
memcpy(client_id + strlen(client_id), dev->device_name, strlen(dev->device_name));
cJSON_AddStringToObject(param, "productKey", dev->product_key);
cJSON_AddStringToObject(param, "deviceName", dev->device_name);
cJSON_AddStringToObject(param, "clientId", client_id);
cJSON_AddStringToObject(param, "timestamp", timestamp);
cJSON_AddStringToObject(param, "signmethod", "hmacSha256");
subdev_handle->sysdep->core_sysdep_free(client_id);
res = _subdev_calculate_sign(subdev_handle, dev, timestamp, sign_str);
if (res < STATE_SUCCESS) {
cJSON_Delete(param);
return res;
}
cJSON_AddStringToObject(param, "sign", sign_str);
cJSON_AddItemToArray(params, param);
return STATE_SUCCESS;
}
static int32_t _subdev_append_pk_dn_to_params(subdev_handle_t *subdev_handle, cJSON *params, aiot_subdev_dev_t *dev)
{
cJSON *param = NULL;
param = cJSON_CreateObject();
if (param == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(param, "productKey", dev->product_key);
cJSON_AddStringToObject(param, "deviceName", dev->device_name);
cJSON_AddItemToArray(params, param);
return STATE_SUCCESS;
}
static int32_t _subdev_topo_delete_append_params(subdev_handle_t *subdev_handle, cJSON *params, aiot_subdev_dev_t *dev)
{
return _subdev_append_pk_dn_to_params(subdev_handle, params, dev);
}
static int32_t _subdev_batch_login_append_device_list(subdev_handle_t *subdev_handle, cJSON *device_list, aiot_subdev_dev_t *dev, char *timestamp)
{
int32_t res = STATE_SUCCESS;
cJSON *param = NULL;
char *client_id = NULL, sign_str[65] = {0};
param = cJSON_CreateObject();
if (param == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
client_id = subdev_handle->sysdep->core_sysdep_malloc(strlen(dev->product_key) + strlen(dev->device_name) + 2, SUBDEV_MODULE_NAME);
if (client_id == NULL) {
cJSON_Delete(param);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(client_id, 0, strlen(dev->product_key) + strlen(dev->device_name) + 2);
memcpy(client_id, dev->product_key, strlen(dev->product_key));
memcpy(client_id + strlen(client_id), ".", strlen("."));
memcpy(client_id + strlen(client_id), dev->device_name, strlen(dev->device_name));
cJSON_AddStringToObject(param, "productKey", dev->product_key);
cJSON_AddStringToObject(param, "deviceName", dev->device_name);
cJSON_AddStringToObject(param, "clientId", client_id);
cJSON_AddStringToObject(param, "timestamp", timestamp);
cJSON_AddStringToObject(param, "cleanSession", "false");
subdev_handle->sysdep->core_sysdep_free(client_id);
res = _subdev_calculate_sign(subdev_handle, dev, timestamp, sign_str);
if (res < STATE_SUCCESS) {
cJSON_Delete(param);
return res;
}
cJSON_AddStringToObject(param, "sign", sign_str);
cJSON_AddItemToArray(device_list, param);
return STATE_SUCCESS;
}
static int32_t _subdev_batch_logout_append_params(subdev_handle_t *subdev_handle, cJSON *params, aiot_subdev_dev_t *dev)
{
return _subdev_append_pk_dn_to_params(subdev_handle, params, dev);
}
static int32_t _subdev_sub_register_append_params(subdev_handle_t *subdev_handle, cJSON *params, aiot_subdev_dev_t *dev)
{
return _subdev_append_pk_dn_to_params(subdev_handle, params, dev);
}
static int32_t _subdev_product_register_append_params(subdev_handle_t *subdev_handle, cJSON *proxieds, aiot_subdev_dev_t *dev)
{
int32_t res = STATE_SUCCESS;
cJSON *param = NULL;
uint8_t random[10] = {0};
char random_str[21] = {0}, sign_str[65] = {0};
param = cJSON_CreateObject();
if (param == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
subdev_handle->sysdep->core_sysdep_rand(random, 10);
core_hex2str(random, 10, random_str, 0);
cJSON_AddStringToObject(param, "productKey", dev->product_key);
cJSON_AddStringToObject(param, "deviceName", dev->device_name);
cJSON_AddStringToObject(param, "random", random_str);
cJSON_AddStringToObject(param, "signMethod", "hmacSha256");
res = _subdev_calculate_product_register_sign(subdev_handle, dev, random_str, sign_str);
if (res < STATE_SUCCESS) {
cJSON_Delete(param);
return res;
}
cJSON_AddStringToObject(param, "sign", sign_str);
cJSON_AddItemToArray(proxieds, param);
return STATE_SUCCESS;
}
void *aiot_subdev_init(void)
{
int32_t res = STATE_SUCCESS;
subdev_handle_t *subdev_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
res = core_global_init(sysdep);
if (res < STATE_SUCCESS) {
return NULL;
}
subdev_handle = sysdep->core_sysdep_malloc(sizeof(subdev_handle_t), SUBDEV_MODULE_NAME);
if (subdev_handle == NULL) {
return NULL;
}
memset(subdev_handle, 0, sizeof(subdev_handle_t));
subdev_handle->sysdep = sysdep;
subdev_handle->data_mutex = sysdep->core_sysdep_mutex_init();
return subdev_handle;
}
int32_t aiot_subdev_setopt(void *handle, aiot_subdev_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_SUBDEVOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
subdev_handle->sysdep->core_sysdep_mutex_lock(subdev_handle->data_mutex);
switch (option) {
case AIOT_SUBDEVOPT_MQTT_HANDLE: {
subdev_handle->mqtt_handle = data;
res = _subdev_operate_topic_map(subdev_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP);
}
break;
case AIOT_SUBDEVOPT_RECV_HANDLER: {
subdev_handle->recv_handler = (aiot_subdev_recv_handler_t)data;
}
break;
case AIOT_SUBDEVOPT_EVENT_HANDLER: {
subdev_handle->event_handler = (aiot_subdev_event_handler_t)data;
}
break;
case AIOT_SUBDEVOPT_USERDATA: {
subdev_handle->userdata = data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
subdev_handle->sysdep->core_sysdep_mutex_unlock(subdev_handle->data_mutex);
return res;
}
int32_t aiot_subdev_deinit(void **handle)
{
subdev_handle_t *subdev_handle = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
subdev_handle = *(subdev_handle_t **)handle;
*handle = NULL;
core_global_deinit(subdev_handle->sysdep);
subdev_handle->sysdep->core_sysdep_mutex_deinit(&subdev_handle->data_mutex);
subdev_handle->sysdep->core_sysdep_free(subdev_handle);
return STATE_SUCCESS;
}
int32_t aiot_subdev_send_topo_add(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
char timestamp[21] = {0};
cJSON *root = NULL, *params = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (dev[idx].device_secret == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_SECRET;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
/* timestamp */
core_uint642str(subdev_handle->sysdep->core_sysdep_time(), timestamp, NULL);
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateArray();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
for (idx = 0;idx < dev_num;idx++) {
_subdev_topo_add_append_params(subdev_handle, params, &dev[idx], timestamp);
}
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/sys/%s/%s/thing/topo/add", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_topo_delete(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
cJSON *root = NULL, *params = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateArray();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
for (idx = 0;idx < dev_num;idx++) {
_subdev_topo_delete_append_params(subdev_handle, params, &dev[idx]);
}
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/sys/%s/%s/thing/topo/delete", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_topo_get(void *handle)
{
int32_t res = STATE_SUCCESS;
cJSON *root = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
cJSON_AddStringToObject(root, "params", "{}");
res = _subdev_send_message(subdev_handle, "/sys/%s/%s/thing/topo/get", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_batch_login(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
char timestamp[21] = {0};
cJSON *root = NULL, *params = NULL, *device_list = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (dev[idx].device_secret == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_SECRET;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
/* timestamp */
core_uint642str(subdev_handle->sysdep->core_sysdep_time(), timestamp, NULL);
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateObject();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
device_list = cJSON_CreateArray();
if (device_list == NULL) {
cJSON_Delete(params);
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
cJSON_AddStringToObject(params, "signMethod", "hmacSha256");
for (idx = 0;idx < dev_num;idx++) {
_subdev_batch_login_append_device_list(subdev_handle, device_list, &dev[idx], timestamp);
}
cJSON_AddItemToObject(params, "deviceList", device_list);
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/ext/session/%s/%s/combine/batch_login", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_batch_logout(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
cJSON *root = NULL, *params = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateArray();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
for (idx = 0;idx < dev_num;idx++) {
_subdev_batch_logout_append_params(subdev_handle, params, &dev[idx]);
}
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/ext/session/%s/%s/combine/batch_logout", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_sub_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
cJSON *root = NULL, *params = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateArray();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
for (idx = 0;idx < dev_num;idx++) {
_subdev_sub_register_append_params(subdev_handle, params, &dev[idx]);
}
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/sys/%s/%s/thing/sub/register", root);
cJSON_Delete(root);
return res;
}
int32_t aiot_subdev_send_product_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num)
{
int32_t res = STATE_SUCCESS;
uint32_t idx = 0;
cJSON *root = NULL, *params = NULL, *proxieds = NULL;
subdev_handle_t *subdev_handle = (subdev_handle_t *)handle;
if (handle == NULL || dev == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (dev_num == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0;idx < dev_num;idx++) {
if (dev[idx].product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (dev[idx].device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (dev[idx].product_secret == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_SECRET;
}
}
/* alink id */
res = _subdev_update_alink_id(subdev_handle);
if (res < STATE_SUCCESS) {
return res;
}
root = cJSON_CreateObject();
if (root == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
params = cJSON_CreateObject();
if (params == NULL) {
cJSON_Delete(root);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
proxieds = cJSON_CreateArray();
if (proxieds == NULL) {
cJSON_Delete(root);
cJSON_Delete(params);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
cJSON_AddStringToObject(root, "id", subdev_handle->alink_id);
cJSON_AddStringToObject(root, "version", "1.0");
for (idx = 0;idx < dev_num;idx++) {
_subdev_product_register_append_params(subdev_handle, proxieds, &dev[idx]);
}
cJSON_AddItemToObject(params, "proxieds", proxieds);
cJSON_AddItemToObject(root, "params", params);
res = _subdev_send_message(subdev_handle, "/sys/%s/%s/thing/proxy/provisioning/product_register", root);
cJSON_Delete(root);
return res;
}
| YifuLiu/AliOS-Things | components/linksdk/components/subdev/aiot_subdev_api.c | C | apache-2.0 | 32,005 |
/**
* @file aiot_subdev_api.h
* @brief subdev模块头文件, 提供子设备管理的能力
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __AIOT_SUBDEV_API_H__
#define __AIOT_SUBDEV_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0C00~-0x0CFF表达SDK在subdev模块内的状态码
*/
#define STATE_SUBDEV_BASE (-0x0C00)
/**
* @brief subdev模块收到从网络上来的报文时, 通知用户的报文类型
*/
typedef enum {
AIOT_SUBDEVRECV_TOPO_ADD_REPLY,
AIOT_SUBDEVRECV_TOPO_DELETE_REPLY,
AIOT_SUBDEVRECV_TOPO_GET_REPLY,
AIOT_SUBDEVRECV_BATCH_LOGIN_REPLY,
AIOT_SUBDEVRECV_BATCH_LOGOUT_REPLY,
AIOT_SUBDEVRECV_SUB_REGISTER_REPLY,
AIOT_SUBDEVRECV_PRODUCT_REGISTER_REPLY,
AIOT_SUBDEVRECV_TOPO_CHANGE_NOTIFY
} aiot_subdev_recv_type_t;
typedef struct {
uint32_t msg_id;
uint32_t code;
char* data;
char* message;
char* product_key;
char* device_name;
} aiot_subdev_generic_reply_t;
typedef struct {
uint32_t msg_id;
char* params;
char* product_key;
char* device_name;
} aiot_subdev_generic_notify_t;
/**
* @brief subdev模块收到从网络上来的报文时, 通知用户的报文内容
*/
typedef struct {
/**
* @brief 报文内容所对应的报文类型, 更多信息请参考@ref aiot_subdev_recv_type_t
*/
aiot_subdev_recv_type_t type;
union {
/**
* @brief 从设备发起请求消息后，收到的云端的应答
*/
aiot_subdev_generic_reply_t generic_reply;
/**
* @brief 收到的云端的通知
*/
aiot_subdev_generic_notify_t generic_notify;
} data;
} aiot_subdev_recv_t;
/**
* @brief subdev模块收到从网络上来的报文时, 通知用户所调用的数据回调函数
*
* @param[in] handle subdev会话句柄
* @param[in] packet subdev消息结构体, 存放收到的subdev报文内容
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_subdev_recv_handler_t)(void *handle,
const aiot_subdev_recv_t *packet, void *user_data);
/* TODO: 列举 SUBDEV 可能发生的所有内部状态变更(可选), 如MQTT重连, OTA收到通知, CoAP的token过期, 与上一段之间有2个空行 */
/* TODO: 填上 doxygen 的注释说明 */
/* TODO: 由于面向用户, 模块名字符串长度 > 6个字符的时候, 改成缩写, 例如: DYNREG_HTTP_EVT -> DRHTTPEVT */
/**
* @brief subdev模块内部发生值得用户关注的状态变化时, 通知用户的事件类型
*/
typedef enum {
/**
* @brief 非法的应答报文
*/
AIOT_SUBDEVEVT_INVALID_RESPONSE,
/**
* @brief 应答报文的id字段非法
*/
AIOT_SUBDEVEVT_INVALID_ID,
/**
* @brief 应答报文的code字段非法
*/
AIOT_SUBDEVEVT_INVALID_CODE
} aiot_subdev_event_type_t;
/**
* @brief subdev模块内部发生值得用户关注的状态变化时, 通知用户的事件内容
*/
typedef struct {
/**
* @brief 事件内容所对应的事件类型, 更多信息请参考@ref aiot_subdev_event_type_t
*/
aiot_subdev_event_type_t type;
} aiot_subdev_event_t;
/**
* @brief subdev模块内部发生值得用户关注的状态变化时, 通知用户所调用的事件回调函数
*
* @param[in] handle, subdev会话句柄
* @param[in] event, subdev模块中发生的事件的内容
* @param[in] userdata, 用户上下文
*
* @return void
*/
typedef void (*aiot_subdev_event_handler_t)(void *handle,
const aiot_subdev_event_t *event, void *userdata);
/**
* @brief
*
*/
typedef struct {
char *product_key;
char *device_name;
char *device_secret;
char *product_secret;
} aiot_subdev_dev_t;
/**
* @brief @ref aiot_subdev_setopt 接口的option参数可选值.
*
* @details 下文每个选项中的数据类型, 指的是@ref aiot_subdev_setopt 中, data参数的数据类型
*
* 1. data的数据类型是char *时, 以配置@ref AIOT_SUBDEVOPT_MQTT_HANDLE 为例:
*
* void *mqtt_handle = aiot_mqtt_init();
* aiot_subdev_setopt(subdev_handle, AIOT_SUBDEVOPT_MQTT_HANDLE, mqtt_handle);
*/
typedef enum {
/**
* @brief subdev会话 需要的MQTT句柄, 需要先建立MQTT连接，再设置MQTT句柄
*
* @details
*
* 数据类型: (void *)
*/
AIOT_SUBDEVOPT_MQTT_HANDLE,
/**
* @brief 设置回调, 它在SDK收到网络报文的时候被调用, 告知用户, 数据类型为(aiot_subdev_recv_handler_t)
*
* @details
*
* 数据类型: (aiot_subdev_recv_handler_t)
*/
AIOT_SUBDEVOPT_RECV_HANDLER,
/**
* @brief 设置回调, 它在SDK发生内部状态变更时被调用, 告知用户, 数据类型为(aiot_subdev_event_handler_t)
*
* @details
*
* 数据类型: (aiot_subdev_event_handler_t)
*/
AIOT_SUBDEVOPT_EVENT_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文, 数据类型为(void *)
*
* @details 这个上下文指针会在 AIOT_SUBDEVOPT_RECV_HANDLER 和 AIOT_SUBDEVOPT_EVENT_HANDLER 设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_SUBDEVOPT_USERDATA,
AIOT_SUBDEVOPT_MAX
} aiot_subdev_option_t;
/**
* @brief 创建subdev会话实例, 并以默认值配置会话参数
*
* @return void *
* @retval 非NULL subdev实例的句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_subdev_init(void);
/**
* @brief 配置subdev会话
*
* @param[in] handle subdev会话句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_subdev_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_subdev_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数配置失败
* @retval >=STATE_SUCCESS 参数配置成功
*
*/
int32_t aiot_subdev_setopt(void *handle, aiot_subdev_option_t option, void *data);
/**
* @brief 结束subdev会话, 销毁实例并回收资源
*
* @param[in] handle 指向subdev会话句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_subdev_deinit(void **handle);
/**
* @brief 向物联网平台发送添加子设备与网关topo关系的请求
*
* @param handle subdev会话句柄
* @param dev 需要添加topo关系的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name 和 device secret
*/
int32_t aiot_subdev_send_topo_add(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
/**
* @brief 向物联网平台发送删除子设备与网关topo关系的请求
*
* @param handle subdev会话句柄
* @param dev 需要删除topo关系的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name
*/
int32_t aiot_subdev_send_topo_delete(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
/**
* @brief 向物联网平台发送查询子设备与网关topo关系的请求
*
* @param handle subdev会话句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name
*/
int32_t aiot_subdev_send_topo_get(void *handle);
/**
* @brief 向物联网平台发送子设备上线请求
*
* @param handle subdev会话句柄
* @param dev 需要上线的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name, device secret
*/
int32_t aiot_subdev_send_batch_login(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
/**
* @brief 向物联网平台发送子设备下线请求
*
* @param handle subdev会话句柄
* @param dev 需要下线的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name
*/
int32_t aiot_subdev_send_batch_logout(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
/**
* @brief 向物联网平台发送子设备动态注册请求
*
* @param handle subdev会话句柄
* @param dev 需要动态注册的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name
*/
int32_t aiot_subdev_send_sub_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
/**
* @brief 向物联网平台发送子设备动态注册请求(可从其他网关抢绑子设备)
*
* @param handle subdev会话句柄
* @param dev 需要动态注册的子设备数组
* @param dev_num 子设备数组中的子设备数量
*
* @return int32_t
* @retval <STATE_SUCCESS 请求发送失败
* @retval >=STATE_SUCCESS 请求发送成功
*
* @note
*
* @ref aiot_subdev_dev_t 中需要填写product key, device name, product secret
*/
int32_t aiot_subdev_send_product_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);
#if defined(__cplusplus)
}
#endif
#endif /* __AIOT_SUBDEV_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/subdev/aiot_subdev_api.h | C | apache-2.0 | 9,988 |
/**
* @file subdev_private.h
* @brief subdev模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __SUBDEV_PRIVATE_H__
#define __SUBDEV_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
/* TODO: 这一段列出需要包含SDK其它模块头文件, 与上一段落以1个空行隔开 */
#include "core_list.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_subdev_api.h" /* 内部头文件是用户可见头文件的超集 */
#include "aiot_mqtt_api.h"
#define SUBDEV_ALINK_ID_MAX_LEN (11)
/* TODO: 定义subdev模块内部的会话句柄结构体, SDK用户不可见, 只能得到void *handle类型的指针 */
typedef struct {
aiot_sysdep_portfile_t *sysdep; /* 底层依赖回调合集的引用指针 */
void *mqtt_handle;
aiot_subdev_event_handler_t event_handler; /* 组件内部运行状态变更时, 通知用户的回调 */
aiot_subdev_recv_handler_t recv_handler; /* 组件从协议栈读到内容时, 通知用户的回调 */
void *userdata; /* 组件调用以上2个 subdev_handler 时的入参之一 */
/*---- 以上都是用户在API可配 ----*/
/*---- 以下都是SUBDEV在内部使用, 用户无感知 ----*/
void *data_mutex; /* 保护本地的数据结构 */
char alink_id[SUBDEV_ALINK_ID_MAX_LEN];
} subdev_handle_t;
#define SUBDEV_MODULE_NAME "subdev" /* 用于内存统计的模块名字符串 */
#define SUBDEV_TOPIC_TOPO_ADD_REPLY "/sys/+/+/thing/topo/add_reply"
#define SUBDEV_TOPIC_TOPO_DELETE_REPLY "/sys/+/+/thing/topo/delete_reply"
#define SUBDEV_TOPIC_TOPO_GET_REPLY "/sys/+/+/thing/topo/get_reply"
#define SUBDEV_TOPIC_BATCH_LOGIN_REPLY "/ext/session/+/+/combine/batch_login_reply"
#define SUBDEV_TOPIC_BATCH_LOGOUT_REPLY "/ext/session/+/+/combine/batch_logout_reply"
#define SUBDEV_TOPIC_SUB_REGISTER_REPLY "/sys/+/+/thing/sub/register_reply"
#define SUBDEV_TOPIC_PRODUCT_REGISTER_REPLY "/sys/+/+/thing/proxy/provisioning/product_register_reply"
#define SUBDEV_TOPIC_TOPO_CHANGE_NOTIFY "/sys/+/+/thing/topo/change"
typedef struct {
char *topic;
aiot_mqtt_recv_handler_t handler;
} subdev_topic_map_t;
#if defined(__cplusplus)
}
#endif
#endif /* __SUBDEV_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/subdev/subdev_private.h | C | apache-2.0 | 2,563 |
/**
* @file aiot_task_api.c
* @brief TASK模块接口实现文件, 其中包含了TASK的所有用户API
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#include "core_mqtt.h"
#include "core_string.h"
#include "core_log.h"
#include "core_global.h"
#include "task_private.h"
#include "aiot_task_api.h"
static void _task_recv_notify_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _task_recv_get_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static void _task_recv_update_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata);
static const task_status_map_t g_task_stauts_mapping[] = {
{"QUEUED", AIOT_TASK_STATUS_QUEUED},
{"SENT", AIOT_TASK_STATUS_SENT},
{"IN_PROGRESS", AIOT_TASK_STATUS_IN_PROGRESS},
{"SUCCEEDED", AIOT_TASK_STATUS_SUCCEEDED},
{"FAILED", AIOT_TASK_STATUS_FAILED},
{"REJECTED", AIOT_TASK_STATUS_REJECTED},
{"CANCELLED", AIOT_TASK_STATUS_CANCELLED},
{"REMOVED", AIOT_TASK_STATUS_REMOVED},
{"TIMED_OUT", AIOT_TASK_STATUS_TIMED_OUT}
};
static const task_recv_topic_map_t g_task_recv_topic_mapping[] = {
{
"/sys/+/+/thing/job/notify",
_task_recv_notify_handler,
},
{
"/sys/+/+/thing/job/get_reply",
_task_recv_get_reply_handler,
},
{
"/sys/+/+/thing/job/update_reply",
_task_recv_update_reply_handler,
}
};
static char *_task_convert_status_to_str(aiot_task_status_t status)
{
uint32_t i = 0;
for (i = 0; i < sizeof(g_task_stauts_mapping) / sizeof(task_status_map_t); i++) {
if (g_task_stauts_mapping[i].status == status) {
return g_task_stauts_mapping[i].str;
}
}
return NULL;
}
static aiot_task_status_t _task_cover_status_to_enum(char *str)
{
uint32_t i = 0;
if (NULL == str) {
return AIOT_TASK_STATUS_FAILED;
}
for (i = 0; i < sizeof(g_task_stauts_mapping) / sizeof(task_status_map_t); i++) {
if (strcmp(g_task_stauts_mapping[i].str, str) == 0) {
return g_task_stauts_mapping[i].status;
}
}
return AIOT_TASK_STATUS_FAILED;
}
static int32_t _task_parse_json(aiot_sysdep_portfile_t *sysdep, const void *input, uint32_t input_len, char *key_word,
char **out)
{
int32_t res = STATE_SUCCESS;
char *value = NULL, *buffer = NULL;
uint32_t value_len = 0, buffer_len = 0;
res = core_json_value((const char *)input, input_len, key_word, strlen(key_word), &value, &value_len);
if (res != STATE_SUCCESS) {
return STATE_TASK_PARSE_JSON_ERROR;
}
buffer_len = value_len + 1;
buffer = sysdep->core_sysdep_malloc(buffer_len, TASK_MODULE_NAME);
if (NULL == buffer) {
return STATE_TASK_PARSE_JSON_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len);
memcpy(buffer, value, value_len);
*out = buffer;
return res;
}
static int32_t _task_parse_task_detail(task_handle_t *task_handle, const char *payload, uint32_t payload_len,
task_desc_t *task)
{
int32_t res = STATE_SUCCESS;
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, payload, payload_len, "taskId", &(task->task_id))) {
return STATE_TASK_PARSE_JSON_MALLOC_FAILED;
}
char *status = NULL;
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, payload, payload_len, "status", &status)) {
return STATE_TASK_PARSE_JSON_MALLOC_FAILED;
}
task->status = _task_cover_status_to_enum(status);
task_handle->sysdep->core_sysdep_free(status);
_task_parse_json(task_handle->sysdep, payload, payload_len, "jobDocument", &(task->job_document));
char *job_file_key = "jobFile";
char *job_file_value = NULL;
uint32_t job_file_len = 0;
if ((res = core_json_value(payload, payload_len, job_file_key, (uint32_t)strlen(job_file_key),
&job_file_value, &job_file_len)) != STATE_SUCCESS) {
return STATE_SUCCESS;
}
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, job_file_value, job_file_len, "signMethod",
&(task->sign_method))) {
return res;
}
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, job_file_value, job_file_len, "sign", &(task->sign))) {
return res;
}
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, job_file_value, job_file_len, "fileUrl",
&(task->document_file_url))) {
return res;
}
return res;
}
static void _task_free_task_list(task_handle_t *task_handle, task_get_list_reply_t *list)
{
int32_t i = 0;
if (NULL == list->tasks) {
return;
}
for (i = 0; i < list->number; i++) {
if (list->tasks[i].task_id) {
task_handle->sysdep->core_sysdep_free(list->tasks[i].task_id);
}
}
task_handle->sysdep->core_sysdep_free(list->tasks);
}
static void _task_free_task_detail(task_handle_t *task_handle, task_desc_t *task)
{
aiot_sysdep_portfile_t *sysdep = aiot_sysdep_get_portfile();
if (NULL == task) {
return;
}
if (task->task_id) {
sysdep->core_sysdep_free(task->task_id);
}
if (task->job_document) {
sysdep->core_sysdep_free(task->job_document);
}
if (task->sign_method) {
sysdep->core_sysdep_free(task->sign_method);
}
if (task->sign) {
sysdep->core_sysdep_free(task->sign);
}
if (task->document_file_url) {
sysdep->core_sysdep_free(task->document_file_url);
}
}
static void _task_free_update_reply(task_update_reply_t *reply)
{
aiot_sysdep_portfile_t *sysdep = aiot_sysdep_get_portfile();
if (NULL == reply) {
return;
}
if (reply->task_id) {
sysdep->core_sysdep_free(reply->task_id);
}
}
static int32_t _task_send_notify_reply(task_handle_t *task_handle, char *msg_id, uint32_t code)
{
char *topic = NULL, *payload = NULL;
char code_string[11] = { 0 };
char *src[2] = { NULL };
int32_t res = STATE_SUCCESS;
core_uint2str(code, code_string, NULL);
src[0] = msg_id;
src[1] = code_string;
res = core_sprintf(task_handle->sysdep, &payload, TASK_NOTIFY_REPLY_FMT, src, sizeof(src) / sizeof(char *),
TASK_MODULE_NAME);
if (res < 0) {
return res;
}
char *topic_src[] = { core_mqtt_get_product_key(task_handle->mqtt_handle), core_mqtt_get_device_name(task_handle->mqtt_handle) };
res = core_sprintf(task_handle->sysdep, &topic, TASK_NOTIFY_REPLY_TOPIC_FMT, topic_src,
sizeof(topic_src) / sizeof(char *),
TASK_MODULE_NAME);
if (res < STATE_SUCCESS) {
task_handle->sysdep->core_sysdep_free(payload);
return res;
}
res = aiot_mqtt_pub(task_handle->mqtt_handle, (char *)topic, (uint8_t *)payload, strlen(payload), 0);
task_handle->sysdep->core_sysdep_free(topic);
task_handle->sysdep->core_sysdep_free(payload);
return res;
}
static int32_t _task_parse_notify(task_handle_t *task_handle, const char *payload, uint32_t payload_len,
task_desc_t *task)
{
int32_t res = STATE_SUCCESS;
char *params_key = "params";
char *params_value = NULL;
uint32_t params_len = 0;
if ((res = core_json_value(payload, payload_len, params_key, (uint32_t)strlen(params_key),
¶ms_value, ¶ms_len)) != STATE_SUCCESS) {
return res;
}
char *task_key = "task";
char *task_value = NULL;
uint32_t task_len = 0;
if ((res = core_json_value(params_value, params_len, task_key, (uint32_t)strlen(task_key),
&task_value, &task_len)) != STATE_SUCCESS) {
return res;
}
res = _task_parse_task_detail(task_handle, task_value, task_len, task);
return res;
}
static void _task_recv_notify_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
task_handle_t *task_handle = (task_handle_t *)userdata;
aiot_task_recv_t recv;
int32_t res = STATE_SUCCESS;
char *id = NULL;
if (NULL == task_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_task_recv_t));
recv.type = AIOT_TASKRECV_NOTIFY;
core_log(task_handle->sysdep, STATE_TASK_RECV_NOTIFY, "task recv notify\r\n");
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, (char *)msg->data.pub.payload, msg->data.pub.payload_len,
"id", &id)) {
return;
}
_task_send_notify_reply(task_handle, id, 200);
if (NULL != id) {
task_handle->sysdep->core_sysdep_free(id);
}
if ((res = _task_parse_notify(task_handle, (char *)msg->data.pub.payload, msg->data.pub.payload_len,
&(recv.data.notify))) == STATE_SUCCESS) {
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
} else {
core_log(task_handle->sysdep, STATE_TASK_PARSE_NOTIFY_FAILED, "task parse notify failed\r\n");
}
_task_free_task_detail(task_handle, &(recv.data.notify));
}
static int32_t _task_parse_get_list_reply_array(char *str, int32_t str_len, task_list_json *array)
{
int32_t num = 0, len = 0;
int32_t i = 0, new = 0;
if ((NULL == str) || (str_len <= 2)) {
return 0;
}
str++;
if (*str == ']') { /* empty array */
return 0;
}
while ((i < str_len) && (num < TASK_GET_LIST_REPLY_ARRAY_MAX)) {
if (*str == '{') {
len = 1;
new = 1;
array[num].pos = str;
} else if (*str == '}') {
len++;
if (new == 1) {
array[num].len = len;
num++;
new = 0;
}
} else {
len++;
}
str++;
i++;
}
return num;
}
static uint32_t _task_parse_get_list_reply(task_handle_t *task_handle, void *input, uint32_t input_len,
task_get_list_reply_t *reply)
{
int32_t res = STATE_SUCCESS;
task_list_json json_array[TASK_GET_LIST_REPLY_ARRAY_MAX];
int32_t num = _task_parse_get_list_reply_array(input, input_len, json_array);
reply->number = num;
if (0 == num) {
return res;
}
task_summary_t *array = task_handle->sysdep->core_sysdep_malloc(sizeof(task_summary_t) * num, TASK_MODULE_NAME);
if (NULL == array) {
return STATE_TASK_PARSE_JSON_MALLOC_FAILED;
}
memset(array, 0, sizeof(task_summary_t)*num);
reply->tasks = array;
for (int32_t i = 0; i < num; i++) {
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, json_array[i].pos, json_array[i].len, "taskId",
&(array[i].task_id))) {
return res;
}
char *status = NULL;
if (STATE_SUCCESS != _task_parse_json(task_handle->sysdep, json_array[i].pos, json_array[i].len, "status", &status)) {
return res;
}
array[i].status = _task_cover_status_to_enum(status);
task_handle->sysdep->core_sysdep_free(status);
}
return res;
}
static void _task_recv_get_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
task_handle_t *task_handle = (task_handle_t *)userdata;
aiot_task_recv_t recv;
int32_t res = STATE_SUCCESS;
if (NULL == task_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_task_recv_t));
char *code_key = "code";
char *code_value = NULL;
uint32_t code_len = 0;
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len, code_key, (uint32_t)strlen(code_key),
&code_value, &code_len) != STATE_SUCCESS) {
return;
}
if (core_str2uint(code_value, (uint8_t)code_len, &(recv.data.get_detail_reply.code)) != STATE_SUCCESS) {
return;
}
char *data_key = "data";
char *data_value = NULL;
uint32_t data_len = 0;
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len, data_key, (uint32_t)strlen(data_key),
&data_value, &data_len) != STATE_SUCCESS) {
return;
}
char *tasks_key = "tasks";
char *tasks_value = NULL;
uint32_t tasks_len = 0;
if (core_json_value(data_value, data_len, tasks_key, (uint32_t)strlen(tasks_key),
&tasks_value, &tasks_len) == STATE_SUCCESS) {
recv.type = AIOT_TASKRECV_GET_LIST_REPLY;
task_get_list_reply_t *reply = &(recv.data.get_list_reply);
if ((res = _task_parse_get_list_reply(task_handle, tasks_value, tasks_len, reply)) == STATE_SUCCESS) {
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
}
_task_free_task_list(task_handle, &(recv.data.get_list_reply));
return;
}
char *task_key = "task";
char *task_value = NULL;
uint32_t task_len = 0;
if (core_json_value(data_value, data_len, task_key, (uint32_t)strlen(task_key),
&task_value, &task_len) == STATE_SUCCESS) {
recv.type = AIOT_TASKRECV_GET_DETAIL_REPLY;
task_desc_t *task = &(recv.data.get_detail_reply.task);
if ((res = _task_parse_task_detail(task_handle, task_value, task_len, task)) == STATE_SUCCESS) {
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
}
_task_free_task_detail(task_handle, task);
return;
}
char *task_id_key = "taskId";
char *task_id_value = NULL;
uint32_t task_id_len = 0;
if (core_json_value(data_value, data_len, task_id_key, (uint32_t)strlen(task_id_key),
&task_id_value, &task_id_len) == STATE_SUCCESS) {
if (memcmp(task_id_value, TASK_GET_LIST_REPLY_TASK_ID, strlen(TASK_GET_LIST_REPLY_TASK_ID)) == 0) {
recv.type = AIOT_TASKRECV_GET_LIST_REPLY;
task_get_list_reply_t *reply = &(recv.data.get_list_reply);
reply->number = 0;
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
} else {
recv.type = AIOT_TASKRECV_GET_DETAIL_REPLY;
task_desc_t *task = &(recv.data.get_detail_reply.task);
char *id = task_handle->sysdep->core_sysdep_malloc(task_id_len + 1, TASK_MODULE_NAME);
memset(id, 0, task_id_len + 1);
memcpy(id, task_id_value, task_id_len);
task->task_id = id;
task->status = AIOT_TASK_STATUS_NOT_FOUND;
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
_task_free_task_detail(task_handle, task);
}
}
}
static void _task_recv_update_reply_handler(void *handle, const aiot_mqtt_recv_t *msg, void *userdata)
{
task_handle_t *task_handle = (task_handle_t *)userdata;
aiot_task_recv_t recv;
if (NULL == task_handle->recv_handler) {
return;
}
memset(&recv, 0, sizeof(aiot_task_recv_t));
recv.type = AIOT_TASKRECV_UPDATE_REPLY;
char *code_key = "code";
char *code_value = NULL;
uint32_t code_len = 0;
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len, code_key, (uint32_t)strlen(code_key),
&code_value, &code_len) != STATE_SUCCESS) {
return;
}
if (core_str2uint(code_value, (uint8_t)code_len, &(recv.data.get_detail_reply.code)) != STATE_SUCCESS) {
return;
}
char *data_key = "data";
char *data_value = NULL;
uint32_t data_len = 0;
if (core_json_value((char *)msg->data.pub.payload, msg->data.pub.payload_len, data_key, (uint32_t)strlen(data_key),
&data_value, &data_len) != STATE_SUCCESS) {
return;
}
_task_parse_json(task_handle->sysdep, data_value, data_len, "taskId", &(recv.data.update_reply.task_id));
task_handle->recv_handler(task_handle, &recv, task_handle->userdata);
_task_free_update_reply(&(recv.data.update_reply));
}
static int32_t _task_setup_topic_mapping(void *mqtt_handle, void *task_handle)
{
uint32_t i = 0;
int32_t res = STATE_SUCCESS;
aiot_mqtt_topic_map_t topic_mapping;
for (i = 0; i < sizeof(g_task_recv_topic_mapping) / sizeof(task_recv_topic_map_t); i++) {
topic_mapping.topic = g_task_recv_topic_mapping[i].topic;
topic_mapping.handler = g_task_recv_topic_mapping[i].func;
topic_mapping.userdata = task_handle;
res = aiot_mqtt_setopt(mqtt_handle, AIOT_MQTTOPT_APPEND_TOPIC_MAP, &topic_mapping);
if (STATE_SUCCESS != res) {
break;
}
}
return res;
}
static void _task_core_mqtt_process_handler(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event)
{
task_handle_t *task_handle = (task_handle_t *)context;
if (core_event != NULL) {
switch (core_event->type) {
case CORE_MQTTEVT_DEINIT: {
task_handle->mqtt_handle = NULL;
return;
}
break;
default: {
}
break;
}
}
}
static int32_t _task_core_mqtt_operate_process_handler(task_handle_t *task_handle, core_mqtt_option_t option)
{
core_mqtt_process_data_t process_data;
memset(&process_data, 0, sizeof(core_mqtt_process_data_t));
process_data.handler = _task_core_mqtt_process_handler;
process_data.context = task_handle;
return core_mqtt_setopt(task_handle->mqtt_handle, option, &process_data);
}
static int32_t _task_send_query_task(task_handle_t *task_handle, char *task_id)
{
char *topic = NULL, *payload = NULL;
int32_t id = 0;
char id_string[11] = { 0 };
char *src[2] = { NULL };
int32_t res = STATE_SUCCESS;
if (NULL == task_id) {
return STATE_TASK_QUERY_TASK_ID_IS_NULL;
}
core_global_alink_id_next(task_handle->sysdep, &id);
core_int2str(id, id_string, NULL);
src[0] = id_string;
src[1] = task_id;
res = core_sprintf(task_handle->sysdep, &payload, TASK_REQUEST_QUERY_TASK_FMT, src, sizeof(src) / sizeof(char *),
TASK_MODULE_NAME);
if (res < 0) {
return res;
}
char *topic_src[] = { core_mqtt_get_product_key(task_handle->mqtt_handle), core_mqtt_get_device_name(task_handle->mqtt_handle) };
res = core_sprintf(task_handle->sysdep, &topic, TASK_QUERY_TASK_TOPIC_FMT, topic_src,
sizeof(topic_src) / sizeof(char *),
TASK_MODULE_NAME);
if (res < STATE_SUCCESS) {
task_handle->sysdep->core_sysdep_free(payload);
return res;
}
res = aiot_mqtt_pub(task_handle->mqtt_handle, (char *)topic, (uint8_t *)payload, strlen(payload), 0);
task_handle->sysdep->core_sysdep_free(payload);
task_handle->sysdep->core_sysdep_free(topic);
return res;
}
int32_t aiot_task_get_task_list(void *handle)
{
task_handle_t *task_handle = (task_handle_t *)handle;
if (NULL == handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
return _task_send_query_task(task_handle, "$list");
}
int32_t aiot_task_get_task_detail(void *handle, char *task_id)
{
int32_t res = STATE_SUCCESS;
task_handle_t *task_handle = (task_handle_t *)handle;
if (NULL == handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (NULL == task_id) {
res = _task_send_query_task(task_handle, "$next");
} else {
res = _task_send_query_task(task_handle, task_id);
}
return res;
}
int32_t aiot_task_update(void *handle, task_desc_t *task)
{
int32_t res = STATE_SUCCESS;
char *topic = NULL, *payload = NULL, *status = NULL;
int32_t id = 0;
char id_string[11] = { 0 };
char progress_string[11] = { 0 };
char *src[5] = { NULL };
task_handle_t *task_handle = (task_handle_t *)handle;
if ((NULL == handle) || (NULL == task)) {
return STATE_USER_INPUT_NULL_POINTER;
}
if ((NULL != task->status_details) && (strcmp(task->status_details, "") == 0)) {
return STATE_TASK_UPDATE_STATUS_DETAILS_INVALID;
}
status = _task_convert_status_to_str(task->status);
if (NULL == status) {
return STATE_TASK_UPDATE_STATUS_INVALID;
}
core_global_alink_id_next(task_handle->sysdep, &id);
core_int2str(id, id_string, NULL);
char *topic_src[] = { core_mqtt_get_product_key(task_handle->mqtt_handle), core_mqtt_get_device_name(task_handle->mqtt_handle) };
res = core_sprintf(task_handle->sysdep, &topic, TASK_UPDATE_TASK_TOPIC_FMT, topic_src,
sizeof(topic_src) / sizeof(char *),
TASK_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
core_uint2str(task->progress, progress_string, NULL);
src[0] = id_string;
src[1] = task->task_id;
src[2] = _task_convert_status_to_str(task->status);
src[3] = progress_string;
if (NULL == task->status_details) {
res = core_sprintf(task_handle->sysdep, &payload, TASK_REQUEST_UPDATE_TASK_NO_DETAIL_FMT, src, 4,
TASK_MODULE_NAME);
} else {
src[4] = task->status_details;
res = core_sprintf(task_handle->sysdep, &payload, TASK_REQUEST_UPDATE_TASK_FMT, src, sizeof(src) / sizeof(char *),
TASK_MODULE_NAME);
}
if (res < STATE_SUCCESS) {
task_handle->sysdep->core_sysdep_free(topic);
return res;
}
res = aiot_mqtt_pub(task_handle->mqtt_handle, (char *)topic, (uint8_t *)payload, strlen(payload), 0);
task_handle->sysdep->core_sysdep_free(topic);
task_handle->sysdep->core_sysdep_free(payload);
return res;
}
int32_t aiot_task_setopt(void *handle, aiot_task_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
task_handle_t *task_handle = (task_handle_t *)handle;
aiot_sysdep_portfile_t *sysdep = NULL;
if (NULL == task_handle) {
return STATE_TASK_SETOPT_HANDLE_IS_NULL;
}
if (NULL == data) {
return STATE_TASK_SETOPT_DATA_IS_NULL;
}
sysdep = task_handle->sysdep;
sysdep->core_sysdep_mutex_lock(task_handle->data_mutex);
switch (option) {
case AIOT_TASKOPT_RECV_HANDLER: {
task_handle->recv_handler = (aiot_task_recv_handler_t)data;
}
break;
case AIOT_TASKOPT_USERDATA: {
task_handle->userdata = data;
}
break;
case AIOT_TASKOPT_MQTT_HANDLE: {
task_handle->mqtt_handle = data;
res = _task_setup_topic_mapping(data, task_handle);
if (res >= STATE_SUCCESS) {
res = _task_core_mqtt_operate_process_handler(task_handle, CORE_MQTTOPT_APPEND_PROCESS_HANDLER);
}
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
sysdep->core_sysdep_mutex_unlock(task_handle->data_mutex);
return res;
}
void *aiot_task_init(void)
{
task_handle_t *task_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
task_handle = sysdep->core_sysdep_malloc(sizeof(task_handle_t), TASK_MODULE_NAME);
if (task_handle == NULL) {
return NULL;
}
memset(task_handle, 0, sizeof(task_handle_t));
task_handle->sysdep = sysdep;
core_global_init(sysdep);
return task_handle;
}
int32_t aiot_task_deinit(void **p_handle)
{
task_handle_t *task_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
uint8_t i = 0;
if (NULL == p_handle || NULL == *p_handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
task_handle = *p_handle;
sysdep = task_handle->sysdep;
*p_handle = NULL;
_task_core_mqtt_operate_process_handler(task_handle, CORE_MQTTOPT_REMOVE_PROCESS_HANDLER);
/* remove mqtt topic mapping */
for (i = 0; i < sizeof(g_task_recv_topic_mapping) / sizeof(task_recv_topic_map_t); i++) {
aiot_mqtt_topic_map_t topic_mapping;
memset(&topic_mapping, 0, sizeof(aiot_mqtt_topic_map_t));
topic_mapping.topic = g_task_recv_topic_mapping[i].topic;
topic_mapping.handler = g_task_recv_topic_mapping[i].func;
aiot_mqtt_setopt(task_handle->mqtt_handle, AIOT_MQTTOPT_REMOVE_TOPIC_MAP, &topic_mapping);
}
sysdep->core_sysdep_free(task_handle);
core_global_deinit(sysdep);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/components/task/aiot_task_api.c | C | apache-2.0 | 24,566 |
/**
* @file aiot_task_api.h
* @brief task模块头文件, 提供任务管理的能力
* @date 2020-11-25
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
* @details
*
*
*/
#ifndef __AIOT_TASK_API_H__
#define __AIOT_TASK_API_H__
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief -0x0B00~-0x0BFF表达SDK在task模块内的状态码
*
*/
#define STATE_TASK_BASE (-0x0B00)
/**
* @brief 销毁task会话实例时, 发现会话句柄为空, 中止销毁动作
*
*/
#define STATE_TASK_DEINIT_HANDLE_IS_NULL (-0x0B01)
/**
* @brief 配置task会话实例时, 发现会话句柄为空, 中止配置动作
*
*/
#define STATE_TASK_SETOPT_HANDLE_IS_NULL (-0x0B02)
/**
* @brief 接收到服务器notify下行消息时的日志状态码
*/
#define STATE_TASK_RECV_NOTIFY (-0x0B03)
/**
* @brief 解析服务器下推的MQTT下行JSON报文时出错
*/
#define STATE_TASK_PARSE_NOTIFY_FAILED (-0x0B04)
/**
* @brief 为解析JSON报文而申请内存时, 未获取到所需内存而解析失败
*/
#define STATE_TASK_PARSE_JSON_MALLOC_FAILED (-0x0B05)
/**
* @brief 接收到服务器notify下行消息时的日志状态码
*/
#define STATE_TASK_PARSE_JSON_ERROR (-0x0B06)
/**
* @brief 接收到查询task id是空
*/
#define STATE_TASK_QUERY_TASK_ID_IS_NULL (-0x0B07)
/**
* @brief 接收到服务器get list reply下行消息时的日志状态码
*/
#define STATE_TASK_RECV_GET_LIST_REPLY (-0x0B08)
/**
* @brief 配置task会话实例时, 发现会话句柄为空, 中止配置动作
*
*/
#define STATE_TASK_SETOPT_DATA_IS_NULL (-0x0B09)
/**
* @brief 配置task 描述时状态设置不对
*
*/
#define STATE_TASK_UPDATE_STATUS_INVALID (-0x0B0A)
/**
* @brief aiot_task_setopt 接口的option参数可选值.
*/
/**
* @brief update task的时候task status_details只能为NULL或者json字符串对象
*
*/
#define STATE_TASK_UPDATE_STATUS_DETAILS_INVALID (-0x0B0B)
typedef enum {
/**
* @brief 设置MQTT的handle
*
* @details
*
* OTA过程中使用MQTT的通道能力, 用以向云端上报版本号, 进度, 以及错误码
*
* 数据类型: (void *)
*/
AIOT_TASKOPT_MQTT_HANDLE,
/**
* @brief 设置处理task消息的用户回调函数
*
* @details
*
* 从云端下发或者返回的数据的处理函数
*
* 数据类型: (void *)
*/
AIOT_TASKOPT_RECV_HANDLER,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 这个上下文指针会在 AIOT_TASKOPT_RECV_HANDLER设置的回调被调用时, 由SDK传给用户
*
* 数据类型: (void *)
*/
AIOT_TASKOPT_USERDATA,
AIOT_TASKOPT_MAX
} aiot_task_option_t;
/**
* @brief 任务的状态.
*/
typedef enum {
AIOT_TASK_STATUS_QUEUED, /* 服务端设置的状态: 任务处于队列中, 还没有推送 */
AIOT_TASK_STATUS_SENT, /* 服务端设置的状态: 任务已推送 */
AIOT_TASK_STATUS_IN_PROGRESS, /* 设备端设置的状态: 任务进行中. 设备端开始执行一个任务后, 将 */
AIOT_TASK_STATUS_SUCCEEDED, /* 设备端设置的状态: 任务完成 */
AIOT_TASK_STATUS_FAILED, /* 设备端设置的状态: 任务执行失败 */
AIOT_TASK_STATUS_REJECTED, /* 设备端设置的状态: 设备端拒绝执行任务 */
AIOT_TASK_STATUS_CANCELLED, /* 服务端设置的状态: 任务被服务端取消 */
AIOT_TASK_STATUS_REMOVED, /* 服务端设置的状态: 任务从服务端删除 */
AIOT_TASK_STATUS_TIMED_OUT, /* 服务端设置的状态: 任务执行超时 */
AIOT_TASK_STATUS_NOT_FOUND /* 服务端设置的状态: 没有找到此任务相关信息 */
} aiot_task_status_t;
/**
* @brief 下行有关的数据结构
*/
typedef enum {
AIOT_TASKRECV_NOTIFY, /* 对应/sys/{productKey}/{deviceName}/thing/job/notify 这个下行topic, 云端主动下推, 带任务详情 */
AIOT_TASKRECV_GET_DETAIL_REPLY, /* 对应/sys/{productKey}/{deviceName}/thing/job/get_reply 这个下行topic, 可以是单个任务的详情, 也可以是任务列表的简单描述 */
AIOT_TASKRECV_GET_LIST_REPLY, /* 对应/sys/{productKey}/{deviceName}/thing/job/get_reply 这个下行topic, 可以是单个任务的详情, 也可以是任务列表的简单描述 */
AIOT_TASKRECV_UPDATE_REPLY /* 对应/sys/{productKey}/{deviceName}/thing/job/update_reply 这个下行topic, 里面包含某个任务的update的结果, 即是否成功 */
} aiot_task_recv_type_t;
/**
* @brief 任务描述的数据结构
*/
typedef struct {
char *task_id; /* 任务ID */
aiot_task_status_t status; /* 任务的状态 */
char *job_document; /* 任务执行规则 */
char *sign_method; /* 文件签名的方法 */
char *sign; /* 文件的签名 */
char *document_file_url; /* 任务文件下载的url */
char *status_details; /* 客户自定义状态，透传到云端, 注意格式为json对象，例如 "{\"key\": \"value\"", strlen("\"key\": \"value\"}"*/
uint8_t progress; /* 任务处理的进度，数字从0-100 */
void *handle; /* 任务处理的句柄 */
} task_desc_t;
/**
* @brief 从云端拉取list时每个任务的简要描述
*/
typedef struct {
char *task_id; /* 任务ID */
aiot_task_status_t status; /* 任务的状态 */
} task_summary_t;
/**
* @brief 从云端拉取list返回的数据
*/
typedef struct {
uint32_t number; /* 从云端拉取的任务list的大小 */
task_summary_t *tasks; /* 拉取的任务数组指针 */
} task_get_list_reply_t;
/**
* @brief 从云端拉取任务详细信息时返回的数据
*/
typedef struct {
uint32_t code; /* 云端返回的code */
task_desc_t task; /* 任务描述的详细信息 */
} task_get_detail_reply_t;
/**
* @brief 更新任务状态到云端后，云端返回的数据
*/
typedef struct {
uint32_t code; /* 云端返回的code */
char *task_id; /* 更新任务后返回的任务id */
aiot_task_status_t status; /* 更新任务后返回的状态 */
} task_update_reply_t;
/**
* @brief 云端主动下发或更新任务云端返回的数据
*/
typedef struct {
aiot_task_recv_type_t type; /* 返回的数据类型 */
union {
task_desc_t notify; /* 云端主动推送任务的数据 */
task_get_list_reply_t get_list_reply; /* 请求任务list返回的数据 */
task_get_detail_reply_t get_detail_reply; /* 请求任务详细状态返回的数据 */
task_update_reply_t update_reply; /* 更新任务状态返回的数据 */
} data;
} aiot_task_recv_t;
/**
* @brief 设备收到task的mqtt下行报文时的接收回调函数
*
* @param[in] handle task实例句柄
* @param[in] recv 云端下行的消息
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (* aiot_task_recv_handler_t)(void *handle, const aiot_task_recv_t *recv, void *userdata);
/**
* @brief 创建一个task实例
*
* @return void*
* @retval 非NULL task实例句柄
* @retval NULL 初始化失败, 或者是因为没有设置portfile, 或者是内存分配失败导致
*
*/
void *aiot_task_init(void);
/**
* @brief 销毁task实例句柄
*
* @param[in] handle 指向task实例句柄的指针
*
* @return int32_t
* @retval STATE_USER_INPUT_NULL_POINTER handle或者handle所指向的地址为空
* @retval STATE_SUCCESS 执行成功
*
*/
int32_t aiot_task_deinit(void **handle);
/**
* @brief 设置task句柄的参数
*
* @details
*
* 对task会话进行配置, 常见的配置选项包括
*
* @param[in] handle task句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_task_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_task_option_t
*
* @return int32_t
* @retval STATE_TASK_SETOPT_HANDLE_IS_NULL task句柄为空
* @retval STATE_TASK_SETOPT_DATA_IS_NULL 参数data字段为空
* @retval STATE_USER_INPUT_UNKNOWN_OPTION option不支持
* @retval STATE_SUCCESS 参数设置成功
*
*/
int32_t aiot_task_setopt(void *handle, aiot_task_option_t option, void *data);
/**
* @brief 从云端获取task列表
*
* @details
*
* 从云端获取task列表
*
* @param[in] handle task句柄
*
* @return int32_t
* @retval STATE_TASK_SETOPT_DATA_IS_NULL 参数的handle字段为空
* @retval STATE_SUCCESS 发送成功
*/
int32_t aiot_task_get_task_list(void *handle);
/* 发送报文到/sys/{productKey}/{deviceName}/thing/job/get. 若函数入参user_task_id不为空, 则上行报文的payload为 "taskId": user_task_id, 返回该任务的详情; */
/* 若user_task_id为空, 则上行报文的payload为 "taskId": "$next", 云端返回未处于终态的任务队列中时间排在最前面一个任务, 该任务状态为QUEUED、SENT、IN_PROGRESS三者之一 */
/**
* @brief 从云端获取task详细内容
*
* @details
*
* 从云端获取task详细内容
*
* @param[in] handle task句柄
* @param[in] user_task_id task的id或者$next
*
* @return int32_t
* @retval STATE_TASK_SETOPT_DATA_IS_NULL或user_task_id 参数的handle字段为空
* @retval STATE_SUCCESS 发送成功
*
*/
int32_t aiot_task_get_task_detail(void *handle, char *user_task_id);
/**
* @brief 更新任务状态到云端
*
* @details
*
* 更新任务状态到云端
*
* @param[in] handle task句柄
* @param[in] task task信息
*
* @return int32_t
* @retval STATE_TASK_SETOPT_DATA_IS_NULL或task 参数的handle字段为空
* @retval STATE_SUCCESS 更新成功
*
*/
int32_t aiot_task_update(void *handle, task_desc_t *task);
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef __AIOT_TASK_API_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/task/aiot_task_api.h | C | apache-2.0 | 10,514 |
/**
* @file task_private.h
* @brief task模块内部的宏定义和数据结构声明, 不面向其它模块, 更不面向用户
*
* @copyright Copyright (C) 2015-2020 Alibaba Group Holding Limited
*
*/
#ifndef __TASK_PRIVATE_H__
#define __TASK_PRIVATE_H__
#if defined(__cplusplus)
extern "C" {
#endif
/* 用这种方式包含标准C库的头文件 */
#include "core_stdinc.h"
/* TODO: 这一段列出需要包含SDK其它模块头文件, 与上一段落以1个空行隔开 */
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_task_api.h"
#define TASK_MODULE_NAME "TASK"
#define TASK_NOTIFY_TOPIC "/sys/+/+/thing/job/notify_reply"
#define TASK_QUERY_RESPONSE_TOPIC "/sys/+/+/thing/job/get_reply"
#define TASK_QUERY_TASK_TOPIC_FMT "/sys/%s/%s/thing/job/get"
#define TASK_UPDATE_TASK_TOPIC_FMT "/sys/%s/%s/thing/job/update"
#define TASK_NOTIFY_REPLY_TOPIC_FMT "/sys/%s/%s/thing/job/notify_reply"
/* ALINK请求的JSON格式 */
#define TASK_REQUEST_QUERY_TASK_FMT "{\"id\":\"%s\",\"version\":\"1.0.0\",\"params\":{\"taskId\":\"%s\"}}"
#define TASK_REQUEST_UPDATE_TASK_FMT "{\"id\":\"%s\",\"version\":\"1.0.0\",\"params\":{\"taskId\":\"%s\",\"status\":\"%s\",\"progress\":%s,\"statusDetails\":%s}}"
#define TASK_REQUEST_UPDATE_TASK_NO_DETAIL_FMT "{\"id\":\"%s\",\"version\":\"1.0.0\",\"params\":{\"taskId\":\"%s\",\"status\":\"%s\",\"progress\":%s}}"
#define TASK_NOTIFY_REPLY_FMT "{\"id\":\"%s\",\"code\":%s,\"data\":{}}"
#define TASK_GET_LIST_REPLY_ARRAY_MAX 10
#define TASK_GET_LIST_REPLY_TASK_ID "$list"
typedef struct {
aiot_sysdep_portfile_t *sysdep;
aiot_task_recv_handler_t recv_handler;
void *mqtt_handle;
void *userdata;
task_desc_t
*default_task_desc; /* handle中用于存储任务描述的数据结构. handle里面只存放一个任务. 如果用户要存放多个,可以自己在外部定义一个列表 */
void *data_mutex;
} task_handle_t;
/* 包含下行topic和对应处理函数的结构体定义 */
typedef struct {
char *topic;
aiot_mqtt_recv_handler_t func;
} task_recv_topic_map_t;
typedef struct {
char *str;
aiot_task_status_t status;
} task_status_map_t;
typedef struct {
char *pos;
int len;
} task_list_json;
#if defined(__cplusplus)
}
#endif
#endif /* __TASK_PRIVATE_H__ */
| YifuLiu/AliOS-Things | components/linksdk/components/task/task_private.h | C | apache-2.0 | 2,541 |
#include "core_http.h"
static void _core_aiot_http_exec_inc(core_http_handle_t *http_handle)
{
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
http_handle->exec_count++;
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
}
static void _core_aiot_http_exec_dec(core_http_handle_t *http_handle)
{
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
http_handle->exec_count--;
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
}
static void _core_http_auth_recv_handler(void *handle, const aiot_http_recv_t *packet, void *userdata)
{
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
core_http_response_t *response = (core_http_response_t *)userdata;
switch (packet->type) {
case AIOT_HTTPRECV_STATUS_CODE: {
response->code = packet->data.status_code.code;
}
break;
case AIOT_HTTPRECV_HEADER: {
if ((strlen(packet->data.header.key) == strlen("Content-Length")) &&
(memcmp(packet->data.header.key, "Content-Length", strlen(packet->data.header.key)) == 0)) {
core_str2uint(packet->data.header.value, (uint8_t)strlen(packet->data.header.value), &response->content_total_len);
}
}
break;
case AIOT_HTTPRECV_BODY: {
uint8_t *content = http_handle->sysdep->core_sysdep_malloc(response->content_len + packet->data.body.len + 1,
CORE_HTTP_MODULE_NAME);
if (content == NULL) {
return;
}
memset(content, 0, response->content_len + packet->data.body.len + 1);
if (response->content != NULL) {
memcpy(content, response->content, response->content_len);
http_handle->sysdep->core_sysdep_free(response->content);
}
memcpy(content + response->content_len, packet->data.body.buffer, packet->data.body.len);
response->content = content;
response->content_len = response->content_len + packet->data.body.len;
}
break;
default: {
}
break;
}
}
static void _core_http_recv_handler(void *handle, const aiot_http_recv_t *packet, void *userdata)
{
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
core_http_response_t *response = (core_http_response_t *)userdata;
if (http_handle->recv_handler == NULL) {
return;
}
switch (packet->type) {
case AIOT_HTTPRECV_STATUS_CODE: {
http_handle->recv_handler(http_handle, packet, http_handle->userdata);
}
break;
case AIOT_HTTPRECV_HEADER: {
if ((strlen(packet->data.header.key) == strlen("Content-Length")) &&
(memcmp(packet->data.header.key, "Content-Length", strlen(packet->data.header.key)) == 0)) {
core_str2uint(packet->data.header.value, (uint8_t)strlen(packet->data.header.value), &response->content_total_len);
}
http_handle->recv_handler(http_handle, packet, http_handle->userdata);
}
break;
case AIOT_HTTPRECV_BODY: {
uint8_t *content = http_handle->sysdep->core_sysdep_malloc(response->content_len + packet->data.body.len + 1,
CORE_HTTP_MODULE_NAME);
if (content == NULL) {
return;
}
memset(content, 0, response->content_len + packet->data.body.len + 1);
if (response->content != NULL) {
memcpy(content, response->content, response->content_len);
http_handle->sysdep->core_sysdep_free(response->content);
}
memcpy(content + response->content_len, packet->data.body.buffer, packet->data.body.len);
response->content = content;
response->content_len = response->content_len + packet->data.body.len;
}
break;
default: {
}
break;
}
}
static void _core_aiot_http_token_expired_event(core_http_handle_t *http_handle, core_http_response_t *response)
{
int32_t res = STATE_SUCCESS;
char *code_str = NULL;
uint32_t code_strlen = 0, code = 0;
res = core_json_value((const char *)response->content, response->content_len, "code", strlen("code"), &code_str,
&code_strlen);
if (res < STATE_SUCCESS) {
return;
}
res = core_str2uint(code_str, code_strlen, &code);
if (res < STATE_SUCCESS) {
return;
}
if (code == AIOT_HTTP_RSPCODE_TOKEN_EXPIRED ||
code == AIOT_HTTP_RSPCODE_TOKEN_CHECK_ERROR) {
if (http_handle->event_handler != NULL) {
aiot_http_event_t event;
event.type = AIOT_HTTPEVT_TOKEN_INVALID;
http_handle->event_handler(http_handle, &event, http_handle->userdata);
}
}
}
static int32_t _core_http_send_auth(core_http_handle_t *http_handle)
{
int32_t res = STATE_SUCCESS;
char *content = NULL, *path = NULL;
char *path_fmt = "/auth?_v=%s&%s";
char *path_src[] = { CORE_AUTH_SDK_VERSION, http_handle->extend_devinfo };
core_http_request_t request;
res = core_auth_http_body(http_handle->sysdep, &content, http_handle->product_key, http_handle->device_name,
http_handle->device_secret, CORE_HTTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
res = core_sprintf(http_handle->sysdep, &path, path_fmt, path_src, sizeof(path_src) / sizeof(char *),
CORE_HTTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_free(content);
return res;
}
memset(&request, 0, sizeof(core_http_request_t));
request.method = "POST";
request.path = path;
request.header = (http_handle->long_connection == 0) ? ("Content-Type: application/json\r\nConnection: close\r\n") :
("Content-Type: application/json\r\n");
request.content = (uint8_t *)content;
request.content_len = (uint32_t)strlen(content);
res = core_http_send(http_handle, &request);
http_handle->sysdep->core_sysdep_free(path);
http_handle->sysdep->core_sysdep_free(content);
return res;
}
static int32_t _core_http_recv_auth(core_http_handle_t *http_handle, core_http_response_t *response)
{
int32_t res = STATE_SUCCESS;
char *token = NULL;
uint32_t token_len = 0;
uint64_t timenow_ms = http_handle->sysdep->core_sysdep_time();
while (1) {
if (timenow_ms >= http_handle->sysdep->core_sysdep_time()) {
timenow_ms = http_handle->sysdep->core_sysdep_time();
}
if (http_handle->sysdep->core_sysdep_time() - timenow_ms >= http_handle->auth_timeout_ms) {
break;
}
res = core_http_recv(http_handle);
if (res < STATE_SUCCESS) {
break;
}
}
if (res < STATE_SUCCESS) {
if (res != STATE_HTTP_READ_BODY_FINISHED) {
return res;
} else {
res = STATE_SUCCESS;
}
} else {
return STATE_HTTP_AUTH_NOT_FINISHED;
}
if (response->code != 200) {
return STATE_HTTP_AUTH_CODE_FAILED;
}
if (response->content == NULL || response->content_len != response->content_total_len) {
return STATE_HTTP_AUTH_NOT_EXPECTED;
}
core_log2(http_handle->sysdep, STATE_HTTP_LOG_AUTH, "%.*s\r\n", &response->content_len, response->content);
res = core_json_value((const char *)response->content, response->content_len, "token", strlen("token"), &token,
&token_len);
if (res < STATE_SUCCESS) {
return STATE_HTTP_AUTH_TOKEN_FAILED;
}
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
if (http_handle->token != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->token);
http_handle->token = NULL;
}
http_handle->token = http_handle->sysdep->core_sysdep_malloc(token_len + 1, CORE_HTTP_MODULE_NAME);
if (http_handle->token == NULL) {
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(http_handle->token, 0, token_len + 1);
memcpy(http_handle->token, token, token_len);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
return STATE_SUCCESS;
}
void *aiot_http_init(void)
{
core_http_handle_t *http_handle = NULL;
http_handle = core_http_init();
if (http_handle == NULL) {
return NULL;
}
http_handle->auth_timeout_ms = CORE_HTTP_DEFAULT_AUTH_TIMEOUT_MS;
http_handle->long_connection = 1;
http_handle->exec_enabled = 1;
return http_handle;
}
int32_t aiot_http_setopt(void *handle, aiot_http_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_HTTPOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (http_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_aiot_http_exec_inc(http_handle);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
switch (option) {
case AIOT_HTTPOPT_HOST:
case AIOT_HTTPOPT_PORT:
case AIOT_HTTPOPT_NETWORK_CRED:
case AIOT_HTTPOPT_CONNECT_TIMEOUT_MS:
case AIOT_HTTPOPT_SEND_TIMEOUT_MS:
case AIOT_HTTPOPT_RECV_TIMEOUT_MS:
case AIOT_HTTPOPT_DEINIT_TIMEOUT_MS:
case AIOT_HTTPOPT_HEADER_BUFFER_LEN:
case AIOT_HTTPOPT_BODY_BUFFER_LEN:
case AIOT_HTTPOPT_EVENT_HANDLER: {
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
res = core_http_setopt(handle, (core_http_option_t)option, data);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
}
break;
case AIOT_HTTPOPT_USERDATA: {
http_handle->userdata = data;
}
break;
case AIOT_HTTPOPT_RECV_HANDLER: {
http_handle->recv_handler = (aiot_http_recv_handler_t)data;
}
break;
case AIOT_HTTPOPT_PRODUCT_KEY: {
res = core_strdup(http_handle->sysdep, &http_handle->product_key, (char *)data, CORE_HTTP_MODULE_NAME);
}
break;
case AIOT_HTTPOPT_DEVICE_NAME: {
res = core_strdup(http_handle->sysdep, &http_handle->device_name, (char *)data, CORE_HTTP_MODULE_NAME);
}
break;
case AIOT_HTTPOPT_DEVICE_SECRET: {
res = core_strdup(http_handle->sysdep, &http_handle->device_secret, (char *)data, CORE_HTTP_MODULE_NAME);
}
break;
case AIOT_HTTPOPT_EXTEND_DEVINFO: {
res = core_strdup(http_handle->sysdep, &http_handle->extend_devinfo, (char *)data, CORE_HTTP_MODULE_NAME);
}
break;
case AIOT_HTTPOPT_AUTH_TIMEOUT_MS: {
http_handle->auth_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_HTTPOPT_LONG_CONNECTION: {
http_handle->long_connection = *(uint8_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
_core_aiot_http_exec_dec(http_handle);
return res;
}
int32_t aiot_http_auth(void *handle)
{
int32_t res = STATE_SUCCESS;
core_http_response_t response;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (http_handle->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (http_handle->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (http_handle->device_secret == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_SECRET;
}
if (http_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_aiot_http_exec_inc(http_handle);
memset(&response, 0, sizeof(core_http_response_t));
if ((res = core_http_setopt(http_handle, CORE_HTTPOPT_RECV_HANDLER,
(void *)_core_http_auth_recv_handler)) < STATE_SUCCESS ||
(res = core_http_setopt(http_handle, CORE_HTTPOPT_USERDATA, (void *)&response)) < STATE_SUCCESS) {
return res;
}
if (http_handle->network_handle == NULL ||
(http_handle->network_handle != NULL && http_handle->long_connection == 0)) {
if ((res = core_http_connect(http_handle)) < STATE_SUCCESS) {
_core_aiot_http_exec_dec(http_handle);
return res;
}
}
/* send auth request */
res = _core_http_send_auth(http_handle);
if (res < STATE_SUCCESS) {
_core_aiot_http_exec_dec(http_handle);
return res;
}
/* recv auth response */
res = _core_http_recv_auth(http_handle, &response);
if (response.content != NULL) {
http_handle->sysdep->core_sysdep_free(response.content);
}
_core_aiot_http_exec_dec(http_handle);
return res;
}
int32_t aiot_http_send(void *handle, char *topic, uint8_t *payload, uint32_t payload_len)
{
int32_t res = STATE_SUCCESS;
char *path = NULL, *header = NULL;
char *header_src[] = { NULL, NULL };
core_http_request_t request;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL || topic == NULL || payload == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (payload_len == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (http_handle->token == NULL) {
return STATE_HTTP_NEED_AUTH;
}
if (http_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_aiot_http_exec_inc(http_handle);
if (http_handle->network_handle == NULL ||
(http_handle->network_handle != NULL && http_handle->long_connection == 0)) {
if ((res = core_http_connect(http_handle)) < STATE_SUCCESS) {
_core_aiot_http_exec_dec(http_handle);
return res;
}
}
/* path */
res = core_sprintf(http_handle->sysdep, &path, "/topic%s", (char **)&topic, 1, CORE_HTTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
_core_aiot_http_exec_dec(http_handle);
return res;
}
/* header */
header_src[0] = http_handle->token;
if (http_handle->long_connection == 0) {
header_src[1] = "Connection: close\r\n";
}
res = core_sprintf(http_handle->sysdep, &header, "Content-Type: application/octet-stream\r\nPassword: %s\r\n%s",
header_src, sizeof(header_src) / sizeof(char *), CORE_HTTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_free(path);
_core_aiot_http_exec_dec(http_handle);
return res;
}
memset(&request, 0, sizeof(core_http_request_t));
request.method = "POST";
request.path = path;
request.header = header;
request.content = (uint8_t *)payload;
request.content_len = payload_len;
res = core_http_send(http_handle, &request);
http_handle->sysdep->core_sysdep_free(path);
http_handle->sysdep->core_sysdep_free(header);
_core_aiot_http_exec_dec(http_handle);
return res;
}
int32_t aiot_http_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint64_t timenow_ms = 0;
core_http_response_t response;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (http_handle->network_handle == NULL) {
return STATE_SYS_DEPEND_NWK_CLOSED;
}
if (http_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_aiot_http_exec_inc(http_handle);
memset(&response, 0, sizeof(core_http_response_t));
if ((res = core_http_setopt(http_handle, CORE_HTTPOPT_RECV_HANDLER, (void *)_core_http_recv_handler)) < STATE_SUCCESS ||
(res = core_http_setopt(http_handle, CORE_HTTPOPT_USERDATA, (void *)&response)) < STATE_SUCCESS) {
return res;
}
timenow_ms = http_handle->sysdep->core_sysdep_time();
while (1) {
if (timenow_ms >= http_handle->sysdep->core_sysdep_time()) {
timenow_ms = http_handle->sysdep->core_sysdep_time();
}
if (http_handle->sysdep->core_sysdep_time() - timenow_ms >= http_handle->recv_timeout_ms) {
break;
}
res = core_http_recv(http_handle);
if (res < STATE_SUCCESS) {
break;
}
}
if (res < STATE_SUCCESS) {
if (res != STATE_HTTP_READ_BODY_FINISHED) {
_core_aiot_http_exec_dec(http_handle);
if (response.content != NULL) {
http_handle->sysdep->core_sysdep_free(response.content);
}
return res;
} else {
res = STATE_SUCCESS;
}
} else {
return STATE_HTTP_RECV_NOT_FINISHED;
}
_core_aiot_http_token_expired_event(http_handle, &response);
if (http_handle->recv_handler != NULL) {
aiot_http_recv_t packet;
packet.type = AIOT_HTTPRECV_BODY;
packet.data.body.buffer = response.content;
packet.data.body.len = response.content_len;
http_handle->recv_handler(http_handle, &packet, http_handle->userdata);
}
if (response.content != NULL) {
http_handle->sysdep->core_sysdep_free(response.content);
}
_core_aiot_http_exec_dec(http_handle);
return res;
}
int32_t aiot_http_deinit(void **p_handle)
{
uint64_t deinit_timestart = 0;
core_http_handle_t *http_handle = NULL;
if (p_handle == NULL || *p_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
http_handle = *(core_http_handle_t **)p_handle;
if (http_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
http_handle->exec_enabled = 0;
deinit_timestart = http_handle->sysdep->core_sysdep_time();
do {
if (http_handle->exec_count == 0) {
break;
}
http_handle->sysdep->core_sysdep_sleep(CORE_HTTP_DEINIT_INTERVAL_MS);
} while ((http_handle->sysdep->core_sysdep_time() - deinit_timestart) < http_handle->deinit_timeout_ms);
if (http_handle->exec_count != 0) {
return STATE_HTTP_DEINIT_TIMEOUT;
}
if (http_handle->product_key != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->product_key);
}
if (http_handle->device_name != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->device_name);
}
if (http_handle->device_secret != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->device_secret);
}
if (http_handle->extend_devinfo != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->extend_devinfo);
}
if (http_handle->token != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->token);
}
core_http_deinit(p_handle);
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_http_api.c | C | apache-2.0 | 19,388 |
/**
* @file aiot_http_api.h
* @brief HTTP模块头文件, 提供用HTTP协议向阿里云物联网平台上报数据的能力
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#ifndef _AIOT_HTTP_API_H_
#define _AIOT_HTTP_API_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
/**
* @brief 服务器返回的业务错误码
*
* @details
*
* 从云平台对上报消息回应的报文JSON中解析
*/
typedef enum {
/**
* @brief 0, 服务端成功接收到上报的消息
*/
AIOT_HTTP_RSPCODE_SUCCESS = 0,
/**
* @brief 10000, 服务端返回未知错误
*/
AIOT_HTTP_RSPCODE_COMMON_ERROR = 10000,
/**
* @brief 10001, 请求参数错误
*/
AIOT_HTTP_RSPCODE_PARAM_ERROR = 10001,
/**
* @brief 20001, token过期, 请调用 @ref aiot_http_auth 进行鉴权, 获取新token
*/
AIOT_HTTP_RSPCODE_TOKEN_EXPIRED = 20001,
/**
* @brief 20002, 请求的header中无token可表明设备端合法, 请调用 @ref aiot_http_auth 进行鉴权, 获取新token
*/
AIOT_HTTP_RSPCODE_TOKEN_NULL = 20002,
/**
* @brief 20003, token错误, 请调用 @ref aiot_http_auth 进行鉴权, 获取新token
*/
AIOT_HTTP_RSPCODE_TOKEN_CHECK_ERROR = 20003,
/**
* @brief 30001, 消息上报失败
*/
AIOT_HTTP_RSPCODE_PUBLISH_MESSAGE_ERROR = 30001,
/**
* @brief 40000, 设备端上报过于频繁, 触发服务端限流
*/
AIOT_HTTP_RSPCODE_REQUEST_TOO_MANY = 40000,
} aiot_http_response_code_t;
/**
* @brief @ref aiot_http_setopt 函数的 option 参数, 对于下文每一个选项中的数据类型, 指的是 @ref aiot_mqtt_setopt 中的data参数的数据类型
*
*/
typedef enum {
/**
* @brief HTTP 服务器的域名地址或者ip地址
*
* @details
*
* 阿里云物联网平台域名地址列表: (tcp使用80端口, tls使用443端口)
*
* | 域名地址 | 区域 | 端口号 |
* |---------------------------------------|---------|--------|
* | iot-as-http.cn-shanghai.aliyuncs.com | 上海 | 443 |
*
* 数据类型: (char *)
*/
AIOT_HTTPOPT_HOST,
/**
* @brief HTTP 服务器的端口号
*
* @details
*
* 连接阿里云物联网平台时:
*
* 1.如果使用的是tcp, 端口号设置为80
*
* 2. 如果使用的是tls, 端口号设置为443
*
* 数据类型: (uint16_t *)
*/
AIOT_HTTPOPT_PORT,
/**
* @brief HTTP建联时, 网络使用的安全凭据
*
* @details
*
* 该配置项用于为底层网络配置 @ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 1. 若该选项不配置, 那么MQTT将以tcp方式直接建联
*
* 2. 若 @ref aiot_sysdep_network_cred_t 中option配置为 @ref AIOT_SYSDEP_NETWORK_CRED_NONE , HTTP将以tcp方式直接建联
*
* 3. 若 @ref aiot_sysdep_network_cred_t 中option配置为 @ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , HTTP将以tls方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_HTTPOPT_NETWORK_CRED,
/**
* @brief HTTP建联时, 建立网络连接的超时时间
*
* @details
*
* 指建立socket连接的超时时间
*
* 数据类型: (uint32_t *) 默认值: (5 *1000) ms
*
*/
AIOT_HTTPOPT_CONNECT_TIMEOUT_MS,
/**
* @brief HTTP发送数据时, 在协议栈花费的最长时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_HTTPOPT_SEND_TIMEOUT_MS,
/**
* @brief HTTP接收数据时, 在协议栈花费的最长时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_HTTPOPT_RECV_TIMEOUT_MS,
/**
* @brief 销毁HTTP实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用 @ref aiot_http_deinit 销毁HTTP实例时, 若继续调用其他 aiot_http_xxx API, API会返回STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他 aiot_http_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_HTTPOPT_DEINIT_TIMEOUT_MS,
/**
* @brief 当接收服务器返回的http报文时, 单行http header的最大长度
*
* @details
*
* 当单行http header设置过短时, @ref aiot_http_recv 会返回 @ref STATE_HTTP_HEADER_BUFFER_TOO_SHORT 状态码
*
* 数据类型: (uint32_t *) 默认值: 128
*/
AIOT_HTTPOPT_HEADER_BUFFER_LEN,
/**
* @brief 当接收服务器返回的http报文时, 每次从 @ref aiot_http_recv_handler_t 回调函数中给出的body最大长度
*
* @details
*
* 数据类型: (uint32_t *) 默认值: 128
*/
AIOT_HTTPOPT_BODY_BUFFER_LEN,
/**
* @brief HTTP 内部事件回调函数
*
* @details
*
* 数据类型: (aiot_http_event_handler_t)
*/
AIOT_HTTPOPT_EVENT_HANDLER,
/* 以上选项配置的数据与 CORE_HTTPOPT_XXX 共用 */
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 1. 当接收到HTTP数据时, 该上下文会从 @ref aiot_http_recv_handler_t 的 userdata 参数给出
*
* 2. 当HTTP内部有事件发生时, 该上下文会从 @ref aiot_http_event_handler_t 的 userdata 参数给出
*
* 数据类型: (void *)
*/
AIOT_HTTPOPT_USERDATA,
/**
* @brief HTTP 数据接收回调函数
*
* @details
*
* 数据类型: (aiot_http_recv_handler_t)
*/
AIOT_HTTPOPT_RECV_HANDLER,
/**
* @brief 设备的product key, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_HTTPOPT_PRODUCT_KEY,
/**
* @brief 设备的device name, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_HTTPOPT_DEVICE_NAME,
/**
* @brief 设备的device secret, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_HTTPOPT_DEVICE_SECRET,
/**
* @brief 上报设备的扩展信息, 比如模组商ID和模组ID
*
* @details
*
* 1. 模组商ID: 格式为pid=xxx
*
* 2. 模组ID: 格式为mid=xxx
*
* 如果需要同时上报多个信息, 那么它们之间用&连接, 例如: pid=xxx&mid=xxx
*
* 数据类型: (char *)
*/
AIOT_HTTPOPT_EXTEND_DEVINFO,
/**
* @brief 使用 @ref aiot_http_auth 进行认证并获取token的超时时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_HTTPOPT_AUTH_TIMEOUT_MS,
/**
* @brief 是否使用http长连接
*
* @details
*
* 若该配置的值为0, 则每次使用 @ref aiot_http_auth 和 @ref aiot_http_send 时, SDK会重新与 HTTP 服务器建立简介
*
* 数据类型: (uint8_t *) 默认值: (5 * 1000) ms
*/
AIOT_HTTPOPT_LONG_CONNECTION,
AIOT_HTTPOPT_MAX
} aiot_http_option_t;
/**
* @brief SDK收到HTTP报文, 传递给用户数据回调函数时, 对报文类型的描述
*/
typedef enum {
/**
* @brief 获取到HTTP Status Code
*/
AIOT_HTTPRECV_STATUS_CODE,
/**
* @brief 获取到HTTP Header, 每次返回Header中的一组键值对
*/
AIOT_HTTPRECV_HEADER,
/**
* @brief 获取到HTTP Body, 返回完整的Body内容
*/
AIOT_HTTPRECV_BODY
} aiot_http_recv_type_t;
/**
* @brief SDK收到HTTP报文, 传递给用户数据回调函数时, 对报文内容的描述
*/
typedef struct {
/**
* @brief HTTP 消息类型, 更多信息请参考 @ref aiot_http_recv_type_t
*/
aiot_http_recv_type_t type;
union {
/**
* @brief HTTP 消息类型为 @ref AIOT_HTTPRECV_STATUS_CODE 时的数据
*/
struct {
/**
* @brief HTTP Status Code
*/
uint32_t code;
} status_code;
/**
* @brief HTTP 消息类型为 @ref AIOT_HTTPRECV_HEADER 时的数据
*/
struct {
/**
* @brief 单行 HTTP Header 的 key
*/
char *key;
/**
* @brief 单行 HTTP Header 的 value
*/
char *value;
} header;
/**
* @brief HTTP 消息类型为 @ref AIOT_HTTPRECV_BODY 时的数据
*/
struct {
/**
* @brief HTTP Body 的内容
*/
uint8_t *buffer;
/**
* @brief HTTP Body 的长度
*/
uint32_t len;
} body;
} data;
} aiot_http_recv_t;
/**
* @brief HTTP 消息接收回调函数原型, 可以通过 @ref aiot_http_setopt 接口的 @ref AIOT_HTTPOPT_RECV_HANDLER 参数指定
*
* @details
*
* 当SDK收到 HTTP 服务器的应答数据时, 通过此回调函数输出
*
* @param[out] handle HTTP 句柄
* @param[out] packet 从 HTTP 服务器接收到的数据
* @param[out] userdata 用户通过 @ref AIOT_HTTPOPT_USERDATA 交由SDK暂存的上下文
*
* @return void
*/
typedef void (*aiot_http_recv_handler_t)(void *handle, const aiot_http_recv_t *packet, void *userdata);
/**
* @brief SDK内部发生状态变化, 通过用户事件回调函数通知用户时, 对事件类型的描述
*/
typedef enum {
/**
* @brief token无效事件, 此时用户应该调用 @ref aiot_http_auth 获取新的token
*/
AIOT_HTTPEVT_TOKEN_INVALID
} aiot_http_event_type_t;
/**
* @brief SDK内部发生状态变化, 通过用户事件回调函数通知用户时, 对事件内容的描述
*/
typedef struct {
aiot_http_event_type_t type;
} aiot_http_event_t;
/**
* @brief HTTP 事件回调函数原型, 可以通过 @ref aiot_http_setopt 接口的 @ref AIOT_HTTPOPT_EVENT_HANDLER 参数指定
*
* @param[out] handle HTTP句柄
* @param[out] event 事件结构体
* @param[out] user_data 指向用户上下文数据的指针, 由 @ref aiot_http_setopt 的 @ref AIOT_HTTPOPT_USERDATA 选项设置
*/
typedef void (* aiot_http_event_handler_t)(void *handle, const aiot_http_event_t *event, void *userdata);
/**
* @brief 创建一个HTTP上云实例
*
* @return void*
*
* @retval 非NULL, HTTP 实例句柄
* @retval NULL,初始化 HTTP 实例失败
*/
void *aiot_http_init(void);
/**
* @brief 设置HTTP实例参数
*
* @param[in] handle HTTP句柄
* @param[in] option 配置选项, 更多信息请参考 @ref aiot_http_option_t
* @param[in] data 配置数据, 更多信息请参考 @ref aiot_http_option_t
*
* @return int32_t
*
* @retval STATE_SUCCESS, 成功
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_OUT_RANGE, 用户输入参数无效
* @retval STATE_SYS_DEPEND_MALLOC_FAILED, 内存分配失败
*/
int32_t aiot_http_setopt(void *handle, aiot_http_option_t option, void *data);
/**
* @brief 向服务器发送认证请求, 获取token
*
* @param[in] handle HTTP句柄
*
* @return int32_t
*
* @retval STATE_SUCCESS, 认证成功
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_MISSING_PRODUCT_KEY, 未设置必要选项ProductKey
* @retval STATE_USER_INPUT_MISSING_DEVICE_NAME, 未设置必要选项DeviceName
* @retval STATE_USER_INPUT_MISSING_DEVICE_SECRET, 未设置必要选项DeviceSecret
* @retval STATE_HTTP_TOKEN_LEN_ERROR, token长度错误
* @retval STATE_HTTP_GET_TOKEN_FAILED, 获取token失败
*/
int32_t aiot_http_auth(void *handle);
/**
* @brief 上报数据到物联网平台
*
* @param[in] handle HTTP句柄
* @param[in] topic 上报的目标topic, 在物联网平台控制的产品详情页面有设备的完整topic列表
* @param[in] payload 指向上报数据的指针
* @param[in] payload_len 上报数据的长度
*
* @return int32_t
*
* @retval STATE_SUCCESS, 上报成功
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_OUT_RANGE, 用户输入参数无效
* @retval STATE_HTTP_NOT_AUTH, 设备未认证
*/
int32_t aiot_http_send(void *handle, char *topic, uint8_t *payload, uint32_t payload_len);
/**
* 服务器响应数据格式为
* {
* "code": 0, // 业务状态码
* "message": "success", // 业务信息
* "info": {
* "messageId": 892687627916247040,
* }
* }
*/
/**
* @brief 接受HTTP应答数据, 数据会从用户设置的 @ref aiot_http_event_handler_t 回调函数输出
*
* @param[in] handle HTTP句柄
*
* @return int32_t
*
* @retval >= 0, 接受到的HTTP body数据长度
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_NULL_POINTER, 用户输入参数为NULL
* @retval STATE_USER_INPUT_OUT_RANGE, buffer_len为0
* @retval STATE_HTTP_RSP_MSG_ERROR, 服务器应答消息错误
* @retval STATE_SYS_DEPEND_NWK_CLOSED, 网络连接已关闭
* @retval STATE_SYS_DEPEND_NWK_READ_OVERTIME, 网络接收超时
* @retval STATE_HTTP_RECV_LINE_TOO_LONG, HTTP单行数据过长, 内部无法解析
* @retval STATE_HTTP_PARSE_STATUS_LINE_FAILED, 无法解析状态码
* @retval STATE_HTTP_GET_CONTENT_LEN_FAILED, 获取Content-Length失败
*/
int32_t aiot_http_recv(void *handle);
/**
* @brief 销毁参数p_handle所指定的HTTP实例
*
* @param[in] p_handle 指向HTTP句柄的指针
*
* @return int32_t
*
* @retval STATE_SUCCESS 成功
* @retval STATE_USER_INPUT_NULL_POINTER 参数p_handle为NULL或者p_handle指向的句柄为NULL
*/
int32_t aiot_http_deinit(void **p_handle);
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef _AIOT_HTTP_API_H_ */
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_http_api.h | C | apache-2.0 | 14,157 |
/**
* @file aiot_mqtt_api.c
* @brief MQTT模块实现, 其中包含了连接到物联网平台和收发数据的API接口
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#include "core_mqtt.h"
static int32_t _core_mqtt_sysdep_return(int32_t sysdep_code, int32_t core_code)
{
if (sysdep_code >= (STATE_PORT_BASE - 0x00FF) && sysdep_code < (STATE_PORT_BASE)) {
return sysdep_code;
} else {
return core_code;
}
}
static int32_t _core_mqtt_5_feature_is_enabled(core_mqtt_handle_t *mqtt_handle)
{
return (AIOT_MQTT_VERSION_5_0 == mqtt_handle->protocol_version);
}
static void _core_mqtt_event_notify_process_handler(core_mqtt_handle_t *mqtt_handle, aiot_mqtt_event_t *event,
core_mqtt_event_t *core_event)
{
core_mqtt_process_data_node_t *node = NULL;
core_list_for_each_entry(node, &mqtt_handle->process_data_list,
linked_node, core_mqtt_process_data_node_t) {
node->process_data.handler(node->process_data.context, event, core_event);
}
}
static void _core_mqtt_event_notify(core_mqtt_handle_t *mqtt_handle, aiot_mqtt_event_type_t type)
{
aiot_mqtt_event_t event;
memset(&event, 0, sizeof(aiot_mqtt_event_t));
event.type = type;
if (mqtt_handle->event_handler) {
mqtt_handle->event_handler((void *)mqtt_handle, &event, mqtt_handle->userdata);
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->process_handler_mutex);
_core_mqtt_event_notify_process_handler(mqtt_handle, &event, NULL);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->process_handler_mutex);
}
static void _core_mqtt_connect_event_notify(core_mqtt_handle_t *mqtt_handle)
{
mqtt_handle->disconnected = 0;
if (mqtt_handle->has_connected == 0) {
mqtt_handle->has_connected = 1;
_core_mqtt_event_notify(mqtt_handle, AIOT_MQTTEVT_CONNECT);
} else {
_core_mqtt_event_notify(mqtt_handle, AIOT_MQTTEVT_RECONNECT);
}
}
static void _core_mqtt_disconnect_event_notify(core_mqtt_handle_t *mqtt_handle,
aiot_mqtt_disconnect_event_type_t disconnect)
{
if (mqtt_handle->has_connected == 1 && mqtt_handle->disconnected == 0) {
aiot_mqtt_event_t event;
mqtt_handle->disconnected = 1;
memset(&event, 0, sizeof(aiot_mqtt_event_t));
event.type = AIOT_MQTTEVT_DISCONNECT;
event.data.disconnect = disconnect;
if (mqtt_handle->event_handler) {
mqtt_handle->event_handler((void *)mqtt_handle, &event, mqtt_handle->userdata);
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->process_handler_mutex);
_core_mqtt_event_notify_process_handler(mqtt_handle, &event, NULL);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->process_handler_mutex);
}
}
static void _core_mqtt_exec_inc(core_mqtt_handle_t *mqtt_handle)
{
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
mqtt_handle->exec_count++;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
}
static void _core_mqtt_exec_dec(core_mqtt_handle_t *mqtt_handle)
{
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
mqtt_handle->exec_count--;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
}
static void _core_mqtt_sign_clean(core_mqtt_handle_t *mqtt_handle)
{
if (mqtt_handle->username) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->username);
mqtt_handle->username = NULL;
}
if (mqtt_handle->password) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->password);
mqtt_handle->password = NULL;
}
if (mqtt_handle->clientid) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->clientid);
mqtt_handle->clientid = NULL;
}
}
static int32_t _core_mqtt_handlerlist_insert(core_mqtt_handle_t *mqtt_handle, core_mqtt_sub_node_t *sub_node,
aiot_mqtt_recv_handler_t handler, void *userdata)
{
core_mqtt_sub_handler_node_t *node = NULL;
core_list_for_each_entry(node, &sub_node->handle_list, linked_node, core_mqtt_sub_handler_node_t) {
if (node->handler == handler) {
/* exist handler, replace userdata */
node->userdata = userdata;
return STATE_SUCCESS;
}
}
if (&node->linked_node == &sub_node->handle_list) {
/* new handler */
node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_sub_handler_node_t), CORE_MQTT_MODULE_NAME);
if (node == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node, 0, sizeof(core_mqtt_sub_handler_node_t));
CORE_INIT_LIST_HEAD(&node->linked_node);
node->handler = handler;
node->userdata = userdata;
core_list_add_tail(&node->linked_node, &sub_node->handle_list);
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_sublist_insert(core_mqtt_handle_t *mqtt_handle, core_mqtt_buff_t *topic,
aiot_mqtt_recv_handler_t handler, void *userdata)
{
int32_t res = STATE_SUCCESS;
core_mqtt_sub_node_t *node = NULL;
core_list_for_each_entry(node, &mqtt_handle->sub_list, linked_node, core_mqtt_sub_node_t) {
if ((strlen(node->topic) == topic->len) && memcmp(node->topic, topic->buffer, topic->len) == 0) {
/* exist topic */
if (handler != NULL) {
return _core_mqtt_handlerlist_insert(mqtt_handle, node, handler, userdata);
} else {
return STATE_SUCCESS;
}
}
}
if (&node->linked_node == &mqtt_handle->sub_list) {
/* new topic */
node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_sub_node_t), CORE_MQTT_MODULE_NAME);
if (node == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node, 0, sizeof(core_mqtt_sub_node_t));
CORE_INIT_LIST_HEAD(&node->linked_node);
CORE_INIT_LIST_HEAD(&node->handle_list);
node->topic = mqtt_handle->sysdep->core_sysdep_malloc(topic->len + 1, CORE_MQTT_MODULE_NAME);
if (node->topic == NULL) {
mqtt_handle->sysdep->core_sysdep_free(node);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node->topic, 0, topic->len + 1);
memcpy(node->topic, topic->buffer, topic->len);
if (handler != NULL) {
res = _core_mqtt_handlerlist_insert(mqtt_handle, node, handler, userdata);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(node->topic);
mqtt_handle->sysdep->core_sysdep_free(node);
return res;
}
}
core_list_add_tail(&node->linked_node, &mqtt_handle->sub_list);
}
return res;
}
static int32_t _core_mqtt_topic_alias_list_insert(core_mqtt_handle_t *mqtt_handle, core_mqtt_buff_t *topic,
uint16_t topic_alias, struct core_list_head *list)
{
int32_t res = STATE_SUCCESS;
core_mqtt_topic_alias_node_t *node = NULL;
core_list_for_each_entry(node, list, linked_node, core_mqtt_topic_alias_node_t) {
if ((strlen(node->topic) == topic->len) && memcmp(node->topic, topic->buffer, topic->len) == 0) {
/* exist topic */
return STATE_SUCCESS;
}
}
if (&node->linked_node == list) {
/* new topic */
node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_topic_alias_node_t), CORE_MQTT_MODULE_NAME);
if (node == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node, 0, sizeof(core_mqtt_topic_alias_node_t));
CORE_INIT_LIST_HEAD(&node->linked_node);
node->topic = mqtt_handle->sysdep->core_sysdep_malloc(topic->len + 1, CORE_MQTT_MODULE_NAME);
if (node->topic == NULL) {
mqtt_handle->sysdep->core_sysdep_free(node);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node->topic, 0, topic->len + 1);
memcpy(node->topic, topic->buffer, topic->len);
node->topic_alias = topic_alias;
core_list_add_tail(&node->linked_node, list);
}
return res;
}
static void _core_mqtt_topic_alias_list_remove_all(core_mqtt_handle_t *mqtt_handle)
{
core_mqtt_topic_alias_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->rx_topic_alias_list, linked_node,
core_mqtt_topic_alias_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node->topic);
mqtt_handle->sysdep->core_sysdep_free(node);
}
core_list_for_each_entry_safe(node, next, &mqtt_handle->tx_topic_alias_list, linked_node,
core_mqtt_topic_alias_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node->topic);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static void _core_mqtt_sublist_handlerlist_destroy(core_mqtt_handle_t *mqtt_handle, struct core_list_head *list)
{
core_mqtt_sub_handler_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, list, linked_node, core_mqtt_sub_handler_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static void _core_mqtt_sublist_remove(core_mqtt_handle_t *mqtt_handle, core_mqtt_buff_t *topic)
{
core_mqtt_sub_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->sub_list, linked_node, core_mqtt_sub_node_t) {
if ((strlen(node->topic) == topic->len) && memcmp(node->topic, topic->buffer, topic->len) == 0) {
core_list_del(&node->linked_node);
_core_mqtt_sublist_handlerlist_destroy(mqtt_handle, &node->handle_list);
mqtt_handle->sysdep->core_sysdep_free(node->topic);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
}
static void _core_mqtt_sublist_remove_handler(core_mqtt_handle_t *mqtt_handle, core_mqtt_buff_t *topic,
aiot_mqtt_recv_handler_t handler)
{
core_mqtt_sub_node_t *node = NULL;
core_mqtt_sub_handler_node_t *handler_node = NULL, *handler_next = NULL;
core_list_for_each_entry(node, &mqtt_handle->sub_list, linked_node, core_mqtt_sub_node_t) {
if ((strlen(node->topic) == topic->len) && memcmp(node->topic, topic->buffer, topic->len) == 0) {
core_list_for_each_entry_safe(handler_node, handler_next, &node->handle_list,
linked_node, core_mqtt_sub_handler_node_t) {
if (handler_node->handler == handler) {
core_list_del(&handler_node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(handler_node);
}
}
}
}
}
static void _core_mqtt_sublist_destroy(core_mqtt_handle_t *mqtt_handle)
{
core_mqtt_sub_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->sub_list, linked_node, core_mqtt_sub_node_t) {
core_list_del(&node->linked_node);
_core_mqtt_sublist_handlerlist_destroy(mqtt_handle, &node->handle_list);
mqtt_handle->sysdep->core_sysdep_free(node->topic);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static int32_t _core_mqtt_topic_is_valid(char *topic, uint32_t len)
{
uint32_t idx = 0;
/* topic should start with '/' */
if (topic[0] != '/') {
return STATE_MQTT_TOPIC_INVALID;
}
for (idx = 0; idx < len; idx++) {
if (topic[idx] == '+') {
/* topic should contain '/+/' in the middle or '/+' in the end */
if ((topic[idx - 1] != '/') ||
((idx + 1 < len) && (topic[idx + 1] != '/'))) {
return STATE_MQTT_TOPIC_INVALID;
}
}
if (topic[idx] == '#') {
/* topic should contain '/#' in the end */
if ((topic[idx - 1] != '/') ||
(idx + 1 < len)) {
return STATE_MQTT_TOPIC_INVALID;
}
}
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_append_topic_map(core_mqtt_handle_t *mqtt_handle, aiot_mqtt_topic_map_t *map)
{
int32_t res = STATE_SUCCESS;
core_mqtt_buff_t topic_buff;
if (map->topic == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (strlen(map->topic) >= CORE_MQTT_TOPIC_MAXLEN) {
return STATE_MQTT_TOPIC_TOO_LONG;
}
if ((res = _core_mqtt_topic_is_valid((char *)map->topic, strlen((char *)map->topic))) < STATE_SUCCESS) {
return res;
}
memset(&topic_buff, 0, sizeof(topic_buff));
topic_buff.buffer = (uint8_t *)map->topic;
topic_buff.len = strlen(map->topic);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->sub_mutex);
res = _core_mqtt_sublist_insert(mqtt_handle, &topic_buff, map->handler, map->userdata);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->sub_mutex);
return res;
}
static int32_t _core_mqtt_remove_topic_map(core_mqtt_handle_t *mqtt_handle, aiot_mqtt_topic_map_t *map)
{
int32_t res = STATE_SUCCESS;
core_mqtt_buff_t topic_buff;
if (map->topic == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (strlen(map->topic) >= CORE_MQTT_TOPIC_MAXLEN) {
return STATE_MQTT_TOPIC_TOO_LONG;
}
if ((res = _core_mqtt_topic_is_valid((char *)map->topic, strlen((char *)map->topic))) < STATE_SUCCESS) {
return res;
}
memset(&topic_buff, 0, sizeof(topic_buff));
topic_buff.buffer = (uint8_t *)map->topic;
topic_buff.len = strlen(map->topic);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->sub_mutex);
_core_mqtt_sublist_remove_handler(mqtt_handle, &topic_buff, map->handler);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->sub_mutex);
return STATE_SUCCESS;
}
static void _core_mqtt_set_utf8_encoded_str(uint8_t *input, uint16_t input_len, uint8_t *output)
{
uint32_t idx = 0, input_idx = 0;
/* String Length MSB */
output[idx++] = (uint8_t)((input_len >> 8) & 0x00FF);
/* String Length LSB */
output[idx++] = (uint8_t)((input_len) & 0x00FF);
/* UTF-8 Encoded Character Data */
for (input_idx = 0; input_idx < input_len; input_idx++) {
output[idx++] = input[input_idx];
}
}
static void _core_mqtt_remain_len_encode(uint32_t input, uint8_t *output, uint32_t *output_idx)
{
uint8_t encoded_byte = 0, idx = 0;
do {
encoded_byte = input % 128;
input /= 128;
if (input > 0) {
encoded_byte |= 128;
}
output[idx++] = encoded_byte;
} while (input > 0);
*output_idx += idx;
}
static int32_t _core_mqtt_general_property_is_valid(general_property_t *general_property)
{
uint32_t idx = 0;
if (NULL == general_property) {
return STATE_SUCCESS;
}
/* User Property */
user_property_t **user_prop_list = general_property->user_property;
do {
user_property_t *user_prop = user_prop_list[idx++];
if (NULL != user_prop) {
if (user_prop->key.len > CORE_MQTT_USER_PROPERTY_KEY_MAX_LEN
|| user_prop->value.len > CORE_MQTT_USER_PROPERTY_VALUE_MAX_LEN
) {
return STATE_MQTT_INVALID_USER_PERPERTY_LEN;
}
if ((user_prop->key.len > 0 && NULL == user_prop->key.value)
|| (user_prop->value.len > 0 && NULL == user_prop->value.value)) {
return STATE_MQTT_INVALID_USER_PERPERTY_DATA;
}
}
} while (idx < USER_PROPERTY_MAX);
/* Subscription Identifier */
if (general_property->subscription_identifier > 0xFFFFFFF) {
return STATE_MQTT_INVALID_SUBSCRIPTION_IDENTIFIER;
}
return STATE_SUCCESS;
}
uint32_t _core_get_general_property_len(general_property_t *general_prop);
void _core_write_general_prop(uint8_t *pos, uint32_t *index, general_property_t *general_property,
uint8_t *property_len_array, uint8_t property_len_offset)
{
uint32_t idx = *index;
uint16_t topic_alias_max = general_property->topic_alias_max;
uint16_t topic_alias = general_property->topic_alias;
uint16_t client_receive_max = general_property->client_receive_max;
len_value_t *reason_string = general_property->reason_string;
user_property_t **prop_list = general_property->user_property;
/* Total Length of All Properties */
if (NULL != property_len_array) {
memcpy(&(pos[idx]), property_len_array, property_len_offset);
idx += property_len_offset;
}
/*User Properties */
if (NULL != prop_list) {
int iter = 0;
for (iter = 0; iter < USER_PROPERTY_MAX; iter++) {
user_property_t *prop = prop_list[iter];
if (NULL != prop) {
pos[idx++] = CORE_MQTTPROP_USER_PROPERTY;
pos[idx++] = prop->key.len << 8;
pos[idx++] = prop->key.len & 0xff;
memcpy(&(pos[idx]), prop->key.value, prop->key.len);
idx += prop->key.len;
pos[idx++] = prop->value.len << 8;
pos[idx++] = prop->value.len & 0xff;
memcpy(&(pos[idx]), prop->value.value, prop->value.len);
idx += prop->value.len;
}
}
}
/*User Topic Alias max */
if (topic_alias_max > 0) {
pos[idx++] = CORE_MQTTPROP_TOPIC_ALIAS_MAX;
pos[idx++] = topic_alias_max >> 8;
pos[idx++] = topic_alias_max & 0xFF;
}
/* Topic Alias */
if (topic_alias > 0) {
pos[idx++] = CORE_MQTTPROP_TOPIC_ALIAS;
pos[idx++] = topic_alias >> 8;
pos[idx++] = topic_alias & 0xFF;
}
/*Client Receive Max */
if (client_receive_max > 0) {
pos[idx++] = CORE_MQTTPROP_RECEIVE_MAXIMUM;
pos[idx++] = client_receive_max >> 8;
pos[idx++] = client_receive_max & 0xFF;
}
/* Response Topic */
if (0 != general_property->response_topic.len) {
pos[idx++] = CORE_MQTTPROP_RESPONSE_TOPIC;
uint16_t topic_len = general_property->response_topic.len;
pos[idx++] = topic_len >> 8;
pos[idx++] = topic_len & 0xFF;
memcpy(&(pos[idx]), general_property->response_topic.value, topic_len);
idx += topic_len;
}
/* Correlation Data */
if (0 != general_property->correlation_data.len) {
pos[idx++] = CORE_MQTTPROP_CORRELATION_DATA;
uint16_t data_len = general_property->correlation_data.len;
pos[idx++] = data_len >> 8;
pos[idx++] = data_len & 0xFF;
memcpy(&(pos[idx]), general_property->correlation_data.value, data_len);
idx += data_len;
}
/* Subscription Identifier */
if (general_property->subscription_identifier > 0) {
uint32_t subscription_identifer_offset = 0;
uint8_t subscription_identifier[4] = {0};
_core_mqtt_remain_len_encode(general_property->subscription_identifier, &subscription_identifier[0],
&subscription_identifer_offset);
pos[idx++] = CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER;
memcpy(&pos[idx], subscription_identifier, subscription_identifer_offset);
idx += subscription_identifer_offset;
}
/* Reason String */
if (NULL != reason_string) {
pos[idx++] = CORE_MQTTPROP_REASON_STRING;
pos[idx++] = (reason_string->len) >> 8 ;
pos[idx++] = reason_string->len & 0xFF;
memcpy(&pos[idx], reason_string->value, reason_string->len);
idx += reason_string->len ;
}
*index = idx;
}
static int32_t _read_variable_byte_interger(uint8_t *input, uint32_t *remainlen, uint8_t *offset);
static int32_t _core_mqtt_conn_pkt(core_mqtt_handle_t *mqtt_handle, uint8_t **pkt, uint32_t *pkt_len,
conn_property_t *conn_prop)
{
uint32_t idx = 0, conn_paylaod_len = 0, conn_remainlen = 0, conn_pkt_len = 0, property_len = 0, property_total_len = 0;
uint8_t *pos = NULL;
const uint8_t conn_fixed_header = CORE_MQTT_CONN_PKT_TYPE;
const uint8_t conn_protocol_name[] = {0x00, 0x04, 0x4D, 0x51, 0x54, 0x54};
uint8_t conn_protocol_level = 0x04;
const uint8_t conn_connect_flag = 0xC0 | (mqtt_handle->clean_session << 1);
uint32_t property_len_offset = 0;
uint8_t property_len_array[4] = {0};
general_property_t general_property = {0};
/* Property Len */
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
conn_protocol_level = 0x5;
if (NULL != conn_prop) {
general_property.topic_alias_max = conn_prop->topic_alias_max;
memcpy(&(general_property.user_property[0]), &(conn_prop->user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
}
if (NULL == mqtt_handle->pre_connect_property) {
/* Normal Connection Case */
int res = _core_mqtt_general_property_is_valid(&general_property);
if (res < STATE_SUCCESS) {
return res;
}
property_len = _core_get_general_property_len(&general_property);
_core_mqtt_remain_len_encode(property_len, property_len_array, &property_len_offset);
} else {
/* Reconnetion Case: Use Connection Properties Stored Previously */
uint8_t tmp_offset = 0;
_read_variable_byte_interger(mqtt_handle->pre_connect_property, &property_len, &tmp_offset);
property_len_offset = tmp_offset;
}
property_total_len = property_len_offset + property_len;
}
/* Payload Length */
conn_paylaod_len = (uint32_t)(strlen(mqtt_handle->clientid) + strlen(mqtt_handle->username)
+ strlen(mqtt_handle->password) + 3 * CORE_MQTT_UTF8_STR_EXTRA_LEN);
/* Remain-Length Value */
conn_remainlen = CORE_MQTT_CONN_REMAINLEN_FIXED_LEN + conn_paylaod_len + property_total_len;
/* Total Packet Length */
conn_pkt_len = CORE_MQTT_CONN_FIXED_HEADER_TOTAL_LEN + conn_paylaod_len + property_total_len;
pos = mqtt_handle->sysdep->core_sysdep_malloc(conn_pkt_len, CORE_MQTT_MODULE_NAME);
if (pos == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(pos, 0, conn_pkt_len);
/* Fixed Header */
pos[idx++] = conn_fixed_header;
/* Remain Length */
_core_mqtt_remain_len_encode(conn_remainlen, pos + idx, &idx);
/* Protocol Name */
memcpy(pos + idx, conn_protocol_name, CORE_MQTT_CONN_PROTOCOL_NAME_LEN);
idx += CORE_MQTT_CONN_PROTOCOL_NAME_LEN;
/* Protocol Level */
pos[idx++] = conn_protocol_level;
/* Connect Flag */
pos[idx++] = conn_connect_flag;
/* Keep Alive MSB */
pos[idx++] = (uint8_t)((mqtt_handle->keep_alive_s >> 8) & 0x00FF);
/* Keep Alive LSB */
pos[idx++] = (uint8_t)((mqtt_handle->keep_alive_s) & 0x00FF);
/* property */
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
if (NULL != mqtt_handle->pre_connect_property) {
/* Normal Connection Case: Use Connection Properties Stored Previously */
memcpy(&(pos[idx]), mqtt_handle->pre_connect_property, property_total_len);
idx += property_total_len;
} else {
/* Not Reconnection Case */
uint8_t *start = &(pos[idx]);
_core_write_general_prop(pos, &idx, &general_property, property_len_array, property_len_offset);
mqtt_handle->pre_connect_property = mqtt_handle->sysdep->core_sysdep_malloc(property_total_len, CORE_MQTT_MODULE_NAME);
if (NULL == mqtt_handle->pre_connect_property) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(mqtt_handle->pre_connect_property, 0, property_total_len);
memcpy(mqtt_handle->pre_connect_property, start, property_total_len);
}
}
/* Payload: clientid, username, password */
_core_mqtt_set_utf8_encoded_str((uint8_t *)mqtt_handle->clientid, strlen(mqtt_handle->clientid), pos + idx);
idx += CORE_MQTT_UTF8_STR_EXTRA_LEN + strlen(mqtt_handle->clientid);
_core_mqtt_set_utf8_encoded_str((uint8_t *)mqtt_handle->username, strlen(mqtt_handle->username), pos + idx);
idx += CORE_MQTT_UTF8_STR_EXTRA_LEN + strlen(mqtt_handle->username);
_core_mqtt_set_utf8_encoded_str((uint8_t *)mqtt_handle->password, strlen(mqtt_handle->password), pos + idx);
idx += CORE_MQTT_UTF8_STR_EXTRA_LEN + strlen(mqtt_handle->password);
*pkt = pos;
*pkt_len = idx;
return STATE_SUCCESS;
}
static int32_t _read_variable_byte_interger(uint8_t *input, uint32_t *remainlen, uint8_t *offset)
{
uint8_t ch = 0;
uint32_t multiplier = 1;
uint32_t mqtt_remainlen = 0;
uint8_t pos = 0;
do {
ch = input[pos++];
mqtt_remainlen += (ch & 127) * multiplier;
if (multiplier > 128 * 128 * 128) {
return STATE_MQTT_MALFORMED_REMAINING_LEN;
}
multiplier *= 128;
} while ((ch & 128) != 0 && pos < 4);
*remainlen = mqtt_remainlen;
*offset = pos;
return STATE_SUCCESS;
}
static int32_t _core_mqtt_parse_property_element(core_mqtt_handle_t *mqtt_handle, uint8_t *property, uint32_t *idx,
type_len_value_t *tlv,
user_property_t *user_prop, uint32_t *variable_byte_integer)
{
uint32_t read_len = 0;
uint8_t type = property[0];
int32_t res;
switch (type) {
/* Bits (Single Byte) */
case CORE_MQTTPROP_PAYLOAD_FORMAT_INDICATOR:
case CORE_MQTTPROP_REQUEST_PROBLEM_INFORMATION:
case CORE_MQTTPROP_REQUEST_RESPONSE_INFORMATION:
case CORE_MQTTPROP_MAX_QOS:
case CORE_MQTTPROP_RETAIN_AVAILABLE:
case CORE_MQTTPROP_WILDCARD_SUBSCRIPTION_AVAILABLE:
case CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER_AVAILABLE:
case CORE_MQTTPROP_SHARED_SUBSCRIPTION_AVAILABLE: {
read_len++;
tlv->type = type;
tlv->len = 1;
read_len += 1;
tlv->value = property + CORE_MQTT_V5_PROPERTY_ID_LEN ;
}
break;
/* Two Byte Integer */
case CORE_MQTTPROP_SERVER_KEEP_ALIVE:
case CORE_MQTTPROP_TOPIC_ALIAS:
case CORE_MQTTPROP_RECEIVE_MAXIMUM:
case CORE_MQTTPROP_TOPIC_ALIAS_MAX: {
read_len++;
tlv->type = type;
tlv->len = 2;
read_len += 2;
tlv->value = property + CORE_MQTT_V5_PROPERTY_ID_LEN;
}
break;
/* Four Byte Integer */
case CORE_MQTTPROP_PUBLICATION_EXPIRY_INTERVAL:
case CORE_MQTTPROP_SESSION_EXPIRY_INTERVAL:
case CORE_MQTTPROP_WILL_DELAY_INTERVAL:
case CORE_MQTTPROP_MAX_PACK_SIZE: {
read_len++;
tlv->type = type;
tlv->len = 4;
read_len += 4;
tlv->value = property + CORE_MQTT_V5_PROPERTY_ID_LEN;
}
break;
/* Variable Byte Integer */
case CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER: {
read_len++;
uint8_t *remain_len_start = property + read_len;
uint32_t remain_len = 0;
uint8_t offset = 0;
res = _read_variable_byte_interger(remain_len_start, &remain_len, &offset);
if (res < STATE_SUCCESS) {
return res;
}
read_len += offset;
tlv->type = type;
tlv->len = offset;
*variable_byte_integer = remain_len;
}
break;
/* Binary Data; UTF-8 String */
case CORE_MQTTPROP_CONTENT_TYPE:
case CORE_MQTTPROP_RESPONSE_TOPIC:
case CORE_MQTTPROP_ASSIGNED_CLIENT_IDENTIFIER:
case CORE_MQTTPROP_AUTHENTICATION_METHOD:
case CORE_MQTTPROP_RESPONSE_INFORMATION:
case CORE_MQTTPROP_SERVER_REFERENCE:
case CORE_MQTTPROP_REASON_STRING:
case CORE_MQTTPROP_CORRELATION_DATA:
case CORE_MQTTPROP_AUTHENTICATION_DATA: {
read_len++;
tlv->type = type;
tlv->len = ((*(property + 1)) << 8) + (*(property + 2));
read_len += 2;
tlv->value = property + 3;
read_len += tlv->len;
}
break;
/* UTF-8 String Pairs. especially for User Properties */
case CORE_MQTTPROP_USER_PROPERTY: {
read_len++;
uint8_t *key_start = property + read_len;
user_prop->key.len = ((*(key_start)) << 8) + (*(key_start + 1));
user_prop->key.value = key_start + 2;
read_len += 2 + user_prop->key.len;
uint8_t *value_start = property + read_len;
user_prop->value.len = ((*(value_start)) << 8) + (*(value_start + 1));
user_prop->value.value = value_start + 2;
read_len += 2 + user_prop->value.len;
tlv->type = type;
tlv->len = 2 + user_prop->key.len + 2 + user_prop->value.len;
}
break;
default: {
tlv->type = CORE_MQTTPROP_UNRESOLVED;
core_log(mqtt_handle->sysdep, STATE_MQTT_UNKNOWN_PROPERTY_OPTION, "unresolved property option\n");
}
break;
}
*idx = *idx + read_len;
return STATE_SUCCESS;
}
static int32_t _core_mqtt_parse_general_properties(core_mqtt_handle_t *mqtt_handle, uint8_t *property,
general_property_t *general_prop, uint32_t *parsed_property_len, uint8_t *parsed_offset, uint32_t remain_len)
{
uint32_t idx = 0, total_prop_len = 0;
int32_t res;
user_property_t **user_prop = general_prop->user_property;
uint32_t property_len = 0;
uint8_t property_len_offset = 0;
type_len_value_t tlv = {0};
user_property_t cur_user_prop;
uint8_t user_property_count = 0;
uint32_t variable_byte_integer = 0;
res = _read_variable_byte_interger(&(property[0]), &property_len, &property_len_offset);
if (res < STATE_SUCCESS) {
return res;
}
/* quit if the total len of all properties exceeds the remain_len of mqtt packet */
if (property_len > remain_len - property_len_offset) {
return STATE_MQTT_INVALID_PROPERTY_LEN;
}
if (NULL != parsed_property_len) {
*parsed_property_len = property_len;
}
if (NULL != parsed_offset) {
*parsed_offset = property_len_offset;
}
total_prop_len = property_len + property_len_offset;
if (property_len == 0) {
return STATE_SUCCESS;
}
idx += property_len_offset;
general_prop->max_qos = 2; /* by default is 2 */
general_prop->wildcard_subscription_available = 1; /* enabled by default */
general_prop->subscription_identifier_available = 1; /* enabled by default */
general_prop->shared_subscription_available = 1; /* enabled by default */
while (total_prop_len > idx) {
memset(&tlv, 0, sizeof(tlv));
memset(&cur_user_prop, 0, sizeof(cur_user_prop));
res = _core_mqtt_parse_property_element(mqtt_handle, property + idx, &idx, &tlv, &cur_user_prop,
&variable_byte_integer);
if (res < STATE_SUCCESS) {
return res;
}
/* quit if the length of a certain property exceeds the remain_len of the whole packet */
if (idx > remain_len) {
return STATE_MQTT_INVALID_PROPERTY_LEN;
}
switch (tlv.type) {
case CORE_MQTTPROP_TOPIC_ALIAS: {
uint16_t topic_alias = 0;
topic_alias = (uint16_t)(*(tlv.value) << 8) ;
topic_alias += (uint16_t)(*(tlv.value + 1));
general_prop->topic_alias = topic_alias;
}
break;
case CORE_MQTTPROP_TOPIC_ALIAS_MAX: {
uint16_t topic_alias_max = 0;
topic_alias_max = (uint16_t)(*(tlv.value) << 8) ;
topic_alias_max += (uint16_t)(*(tlv.value + 1));
general_prop->topic_alias_max = topic_alias_max;
}
break;
case CORE_MQTTPROP_MAX_QOS: {
uint8_t max_qos = 0;
max_qos = (uint8_t)(*(tlv.value));
general_prop->max_qos = max_qos;
}
break;
case CORE_MQTTPROP_ASSIGNED_CLIENT_IDENTIFIER: {
void *cid = mqtt_handle->sysdep->core_sysdep_malloc(tlv.len + 1, CORE_MQTT_MODULE_NAME);
if (NULL == cid) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(cid, 0, tlv.len + 1);
memcpy(cid, tlv.value, tlv.len);
general_prop->assigned_clientid = cid;
}
break;
case CORE_MQTTPROP_WILDCARD_SUBSCRIPTION_AVAILABLE: {
general_prop->wildcard_subscription_available = (uint8_t)(*(tlv.value));
}
break;
case CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER_AVAILABLE: {
general_prop->subscription_identifier_available = (uint8_t)(*(tlv.value));
}
break;
case CORE_MQTTPROP_SHARED_SUBSCRIPTION_AVAILABLE: {
general_prop->shared_subscription_available = (uint8_t)(*(tlv.value));
}
break;
case CORE_MQTTPROP_PUBLICATION_EXPIRY_INTERVAL: {
uint32_t message_expire = 0;
message_expire += *(tlv.value) << 24;
message_expire += *(tlv.value + 1) << 16;
message_expire += *(tlv.value + 2) << 8;
message_expire += *(tlv.value + 3) << 0;
general_prop->message_expire_interval = message_expire;
}
break;
case CORE_MQTTPROP_MAX_PACK_SIZE: {
uint32_t max_pack_size = 0;
max_pack_size += *(tlv.value) << 24;
max_pack_size += *(tlv.value + 1) << 16;
max_pack_size += *(tlv.value + 2) << 8;
max_pack_size += *(tlv.value + 3) << 0;
general_prop->max_packet_size = max_pack_size;
}
break;
case CORE_MQTTPROP_RECEIVE_MAXIMUM: {
uint16_t server_receive_max = 0;
server_receive_max = (uint16_t)(*(tlv.value) << 8) ;
server_receive_max += (uint16_t)(*(tlv.value + 1));
general_prop->server_receive_max = server_receive_max;
}
break;
case CORE_MQTTPROP_USER_PROPERTY: {
if (user_property_count < USER_PROPERTY_MAX && cur_user_prop.key.len != 0) {
user_prop[user_property_count] = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(user_property_t),
CORE_MQTT_MODULE_NAME);
if (NULL == user_prop[user_property_count]) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memcpy(user_prop[user_property_count], &cur_user_prop, sizeof(user_property_t));
user_property_count++;
}
}
break;
case CORE_MQTTPROP_UNRESOLVED: {
return STATE_MQTT_UNKNOWN_PROPERTY_OPTION;
}
default:
break;
}
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_parse_conack_properties(core_mqtt_handle_t *mqtt_handle, uint8_t *property,
connack_property_t *conack_prop, uint32_t remain_len)
{
general_property_t general_prop = {0};
int32_t res = _core_mqtt_parse_general_properties(mqtt_handle, property, &general_prop, NULL, NULL, remain_len);
if (res != STATE_SUCCESS) {
return res;
}
conack_prop->max_qos = general_prop.max_qos;
conack_prop->topic_alias_max = general_prop.topic_alias_max;
memcpy(&(conack_prop->user_property[0]), &(general_prop.user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
conack_prop->assigned_clientid = general_prop.assigned_clientid;
conack_prop->max_packet_size = general_prop.max_packet_size;
conack_prop->server_receive_max = general_prop.server_receive_max;
conack_prop->wildcard_subscription_available = general_prop.wildcard_subscription_available;
conack_prop->subscription_identifier_available = general_prop.subscription_identifier_available;
conack_prop->shared_subscription_available = general_prop.shared_subscription_available;
mqtt_handle->tx_topic_alias_max =
conack_prop->topic_alias_max;
return STATE_SUCCESS;
}
static void _core_reclaim_user_properties_mem(core_mqtt_handle_t *mqtt_handle, user_property_t **user_property_list)
{
int iter = 0;
for (iter = 0; iter < USER_PROPERTY_MAX; iter++) {
user_property_t *user_prop = user_property_list[iter];
if (NULL != user_prop) {
mqtt_handle->sysdep->core_sysdep_free(user_prop);
user_property_list[iter] = NULL;
}
}
}
static int32_t _core_mqtt_connack_handle(core_mqtt_handle_t *mqtt_handle, uint8_t *connack, uint32_t remain_len)
{
int32_t res = STATE_SUCCESS;
int32_t ret = STATE_SUCCESS;
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
connack_property_t connack_prop = {0};
aiot_mqtt_recv_t packet = {0};
if (connack[0] != 0x00) {
return STATE_MQTT_CONNACK_FMT_ERROR;
}
/* First Byte is Conack Flag */
if (connack[1] == CORE_MQTT_CONNACK_RCODE_ACCEPTED) {
res = STATE_SUCCESS;
} else if (connack[1] == CORE_MQTT_V5_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT invalid protocol version, disconeect\r\n");
res = STATE_MQTT_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION;
} else if (connack[1] == CORE_MQTT_V5_CONNACK_RCODE_SERVER_UNAVAILABLE) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT server unavailable, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE;
} else if (connack[1] == CORE_MQTT_V5_CONNACK_RCODE_BAD_USERNAME_PASSWORD) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT bad username or password, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_BAD_USERNAME_PASSWORD;
} else if (connack[1] == CORE_MQTT_V5_CONNACK_RCODE_NOT_AUTHORIZED) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT authorize fail, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_NOT_AUTHORIZED;
} else {
res = STATE_MQTT_CONNACK_RCODE_UNKNOWN;
}
/* Second Byte is Reason Code */
packet.data.con_ack.reason_code = connack[1];
/* Properties Starts from 3rd Byte */
ret = _core_mqtt_parse_conack_properties(mqtt_handle, &connack[2], &connack_prop, remain_len);
if (ret < STATE_SUCCESS) {
return ret;
}
packet.data.con_ack.prop = connack_prop;
packet.type = AIOT_MQTTRECV_CON_ACK;
if (mqtt_handle->recv_handler) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
if (NULL != connack_prop.assigned_clientid) {
mqtt_handle->sysdep->core_sysdep_free(connack_prop.assigned_clientid);
}
/* Reclaims Mem of User Properties */
_core_reclaim_user_properties_mem(mqtt_handle, connack_prop.user_property);
} else {
if (connack[1] == CORE_MQTT_CONNACK_RCODE_ACCEPTED) {
res = STATE_SUCCESS;
} else if (connack[1] == CORE_MQTT_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT invalid protocol version, disconeect\r\n");
res = STATE_MQTT_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION;
} else if (connack[1] == CORE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT server unavailable, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE;
} else if (connack[1] == CORE_MQTT_CONNACK_RCODE_BAD_USERNAME_PASSWORD) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT bad username or password, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_BAD_USERNAME_PASSWORD;
} else if (connack[1] == CORE_MQTT_CONNACK_RCODE_NOT_AUTHORIZED) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT authorize fail, disconnect\r\n");
res = STATE_MQTT_CONNACK_RCODE_NOT_AUTHORIZED;
} else {
res = STATE_MQTT_CONNACK_RCODE_UNKNOWN;
}
}
return res;
}
static int32_t _core_mqtt_read(core_mqtt_handle_t *mqtt_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms)
{
int32_t res = STATE_SUCCESS;
if (mqtt_handle->network_handle != NULL) {
res = mqtt_handle->sysdep->core_sysdep_network_recv(mqtt_handle->network_handle, buffer, len, timeout_ms, NULL);
if (res < STATE_SUCCESS) {
res = _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_RECV_ERR);
} else if (res != len) {
res = STATE_SYS_DEPEND_NWK_READ_LESSDATA;
}
} else {
res = STATE_SYS_DEPEND_NWK_CLOSED;
}
return res;
}
static int32_t _core_mqtt_write(core_mqtt_handle_t *mqtt_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms)
{
int32_t res = STATE_SUCCESS;
if (mqtt_handle->network_handle != NULL) {
res = mqtt_handle->sysdep->core_sysdep_network_send(mqtt_handle->network_handle, buffer, len, timeout_ms, NULL);
if (res < STATE_SUCCESS) {
res = _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_SEND_ERR);
} else if (res != len) {
res = STATE_SYS_DEPEND_NWK_WRITE_LESSDATA;
}
} else {
res = STATE_SYS_DEPEND_NWK_CLOSED;
}
return res;
}
static void _core_mqtt_connect_diag(core_mqtt_handle_t *mqtt_handle, uint8_t flag)
{
uint8_t buf[4] = {0};
uint32_t idx = 0;
buf[idx++] = (CORE_MQTT_DIAG_TLV_MQTT_CONNECTION >> 8) & 0x00FF;
buf[idx++] = (CORE_MQTT_DIAG_TLV_MQTT_CONNECTION) & 0x00FF;
buf[idx++] = 0x01;
buf[idx++] = flag;
core_diag(mqtt_handle->sysdep, STATE_MQTT_BASE, buf, sizeof(buf));
}
static void _core_mqtt_heartbeat_diag(core_mqtt_handle_t *mqtt_handle, uint8_t flag)
{
uint8_t buf[4] = {0};
uint32_t idx = 0;
buf[idx++] = (CORE_MQTT_DIAG_TLV_MQTT_HEARTBEAT >> 8) & 0x00FF;
buf[idx++] = (CORE_MQTT_DIAG_TLV_MQTT_HEARTBEAT) & 0x00FF;
buf[idx++] = 0x01;
buf[idx++] = flag;
core_diag(mqtt_handle->sysdep, STATE_MQTT_BASE, buf, sizeof(buf));
}
static int32_t _core_mqtt_read_remainlen(core_mqtt_handle_t *mqtt_handle, uint32_t *remainlen);
static int32_t _core_mqtt_connect(core_mqtt_handle_t *mqtt_handle, conn_property_t *conn_prop)
{
int32_t res = 0;
core_sysdep_socket_type_t socket_type = CORE_SYSDEP_SOCKET_TCP_CLIENT;
char backup_ip[16] = {0};
uint8_t *conn_pkt = NULL;
uint8_t connack_fixed_header = 0;
uint8_t *connack_ptr = NULL;
uint32_t conn_pkt_len = 0;
char *secure_mode = (mqtt_handle->cred == NULL) ? ("3") : ("2");
uint8_t use_assigned_clientid = mqtt_handle->use_assigned_clientid;
uint32_t remain_len = 0;
if (mqtt_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
if (mqtt_handle->security_mode != NULL) {
secure_mode = mqtt_handle->security_mode;
}
if (mqtt_handle->cred && \
mqtt_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE && \
mqtt_handle->security_mode == NULL) {
secure_mode = "3";
}
if (mqtt_handle->username == NULL || mqtt_handle->password == NULL ||
mqtt_handle->clientid == NULL) {
/* no valid username, password or clientid, check pk/dn/ds */
if (mqtt_handle->product_key == NULL) {
return STATE_USER_INPUT_MISSING_PRODUCT_KEY;
}
if (mqtt_handle->device_name == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_NAME;
}
if (mqtt_handle->device_secret == NULL) {
return STATE_USER_INPUT_MISSING_DEVICE_SECRET;
}
_core_mqtt_sign_clean(mqtt_handle);
if ((res = core_auth_mqtt_username(mqtt_handle->sysdep, &mqtt_handle->username, mqtt_handle->product_key,
mqtt_handle->device_name, CORE_MQTT_MODULE_NAME)) < STATE_SUCCESS ||
(res = core_auth_mqtt_password(mqtt_handle->sysdep, &mqtt_handle->password, mqtt_handle->product_key,
mqtt_handle->device_name, mqtt_handle->device_secret, use_assigned_clientid, CORE_MQTT_MODULE_NAME)) < STATE_SUCCESS ||
(res = core_auth_mqtt_clientid(mqtt_handle->sysdep, &mqtt_handle->clientid, mqtt_handle->product_key,
mqtt_handle->device_name, secure_mode, mqtt_handle->extend_clientid, use_assigned_clientid,
CORE_MQTT_MODULE_NAME)) < STATE_SUCCESS) {
_core_mqtt_sign_clean(mqtt_handle);
return res;
}
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_USERNAME, "%s\r\n", (void *)mqtt_handle->username);
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_PASSWORD, "%s\r\n", (void *)mqtt_handle->password);
/* core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CLIENTID, "%s\r\n", (void *)mqtt_handle->clientid); */
}
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
_core_mqtt_connect_diag(mqtt_handle, 0x00);
mqtt_handle->network_handle = mqtt_handle->sysdep->core_sysdep_network_init();
if (mqtt_handle->network_handle == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
core_global_get_mqtt_backup_ip(mqtt_handle->sysdep, backup_ip);
if (strlen(backup_ip) > 0) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_BACKUP_IP, "%s\r\n", (void *)backup_ip);
}
if ((res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_SOCKET_TYPE,
&socket_type)) < STATE_SUCCESS ||
(res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_HOST,
mqtt_handle->host)) < STATE_SUCCESS ||
(res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_BACKUP_IP,
backup_ip)) < STATE_SUCCESS ||
(res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_PORT,
&mqtt_handle->port)) < STATE_SUCCESS ||
(res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle,
CORE_SYSDEP_NETWORK_CONNECT_TIMEOUT_MS,
&mqtt_handle->connect_timeout_ms)) < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
return _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_INVALID_OPTION);
}
if (mqtt_handle->cred != NULL) {
if ((res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_CRED,
mqtt_handle->cred)) < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
return _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_INVALID_OPTION);
}
if (mqtt_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_SVRCERT_PSK) {
char *psk_id = NULL, psk[65] = {0};
core_sysdep_psk_t sysdep_psk;
res = core_auth_tls_psk(mqtt_handle->sysdep, &psk_id, psk, mqtt_handle->product_key, mqtt_handle->device_name,
mqtt_handle->device_secret, CORE_MQTT_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
memset(&sysdep_psk, 0, sizeof(core_sysdep_psk_t));
sysdep_psk.psk_id = psk_id;
sysdep_psk.psk = psk;
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_TLS_PSK, "%s\r\n", sysdep_psk.psk_id);
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_TLS_PSK, "%s\r\n", sysdep_psk.psk);
res = mqtt_handle->sysdep->core_sysdep_network_setopt(mqtt_handle->network_handle, CORE_SYSDEP_NETWORK_PSK,
(void *)&sysdep_psk);
mqtt_handle->sysdep->core_sysdep_free(psk_id);
if (res < STATE_SUCCESS) {
return _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_INVALID_OPTION);
}
}
mqtt_handle->nwkstats_info.network_type = (uint8_t)mqtt_handle->cred->option;
}
/* Remove All Topic Alias Relationship */
_core_mqtt_topic_alias_list_remove_all(mqtt_handle);
/* network stats */
mqtt_handle->nwkstats_info.connect_timestamp = mqtt_handle->sysdep->core_sysdep_time();
if ((res = mqtt_handle->sysdep->core_sysdep_network_establish(mqtt_handle->network_handle)) < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
mqtt_handle->nwkstats_info.failed_timestamp = mqtt_handle->nwkstats_info.connect_timestamp;
mqtt_handle->nwkstats_info.failed_error_code = res;
return _core_mqtt_sysdep_return(res, STATE_SYS_DEPEND_NWK_EST_FAILED);
}
mqtt_handle->nwkstats_info.connect_time_used = mqtt_handle->sysdep->core_sysdep_time() \
- mqtt_handle->nwkstats_info.connect_timestamp;
/* Get MQTT Connect Packet */
res = _core_mqtt_conn_pkt(mqtt_handle, &conn_pkt, &conn_pkt_len, conn_prop);
if (res < STATE_SUCCESS) {
return res;
}
/* Send MQTT Connect Packet */
res = _core_mqtt_write(mqtt_handle, conn_pkt, conn_pkt_len, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_free(conn_pkt);
if (res < STATE_SUCCESS) {
if (res == STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT_TIMEOUT, "MQTT connect packet send timeout: %d\r\n",
&mqtt_handle->send_timeout_ms);
} else {
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
}
return res;
}
/* Receive MQTT Connect ACK Fixed Header Byte */
res = _core_mqtt_read(mqtt_handle, &connack_fixed_header, CORE_MQTT_FIXED_HEADER_LEN, mqtt_handle->recv_timeout_ms);
if (res < STATE_SUCCESS) {
if (res == STATE_SYS_DEPEND_NWK_READ_LESSDATA) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT_TIMEOUT, "MQTT connack packet recv fixed header timeout: %d\r\n",
&mqtt_handle->recv_timeout_ms);
} else {
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
}
return res;
}
if (connack_fixed_header != CORE_MQTT_CONNACK_PKT_TYPE) {
return STATE_MQTT_CONNACK_FMT_ERROR;
}
/* Receive MQTT Connect ACK remain len */
res = _core_mqtt_read_remainlen(mqtt_handle, &remain_len);
if (res < STATE_SUCCESS) {
if (res == STATE_SYS_DEPEND_NWK_READ_LESSDATA) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT_TIMEOUT, "MQTT connack packet recv remain len timeout: %d\r\n",
&mqtt_handle->recv_timeout_ms);
}
return res;
}
/* Connack Format Error for Mqtt 3.1 */
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle) && remain_len != 0x2) {
return STATE_MQTT_CONNACK_FMT_ERROR;
}
connack_ptr = mqtt_handle->sysdep->core_sysdep_malloc(remain_len, CORE_MQTT_MODULE_NAME);
if (NULL == connack_ptr) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(connack_ptr, 0, remain_len);
/* Receive MQTT Connect ACK Variable Header and Properties */
res = _core_mqtt_read(mqtt_handle, connack_ptr, remain_len, mqtt_handle->recv_timeout_ms);
if (res < STATE_SUCCESS) {
if (res == STATE_SYS_DEPEND_NWK_READ_LESSDATA) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT_TIMEOUT,
"MQTT connack packet variable header and property recv timeout: %d\r\n",
&mqtt_handle->recv_timeout_ms);
}
mqtt_handle->sysdep->core_sysdep_free(connack_ptr);
return res;
}
res = _core_mqtt_connack_handle(mqtt_handle, connack_ptr, remain_len);
mqtt_handle->sysdep->core_sysdep_free(connack_ptr);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
return res;
}
_core_mqtt_connect_diag(mqtt_handle, 0x01);
return STATE_MQTT_CONNECT_SUCCESS;
}
static int32_t _core_mqtt_disconnect(core_mqtt_handle_t *mqtt_handle)
{
int32_t res = 0;
uint8_t pingreq_pkt[2] = {CORE_MQTT_DISCONNECT_PKT_TYPE, 0x00};
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(mqtt_handle, pingreq_pkt, 2, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
return STATE_SUCCESS;
}
static uint16_t _core_mqtt_packet_id(core_mqtt_handle_t *mqtt_handle)
{
uint16_t packet_id = 0;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
if ((uint16_t)(mqtt_handle->packet_id + 1) == 0) {
mqtt_handle->packet_id = 0;
}
packet_id = ++mqtt_handle->packet_id;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
return packet_id;
}
static int32_t _core_mqtt_publist_insert(core_mqtt_handle_t *mqtt_handle, uint8_t *packet, uint32_t len,
uint16_t packet_id)
{
core_mqtt_pub_node_t *node = NULL;
core_list_for_each_entry(node, &mqtt_handle->pub_list, linked_node, core_mqtt_pub_node_t) {
if (node->packet_id == packet_id) {
return STATE_MQTT_PUBLIST_PACKET_ID_ROLL;
}
}
node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_pub_node_t), CORE_MQTT_MODULE_NAME);
if (node == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node, 0, sizeof(core_mqtt_pub_node_t));
CORE_INIT_LIST_HEAD(&node->linked_node);
node->packet_id = packet_id;
node->packet = mqtt_handle->sysdep->core_sysdep_malloc(len, CORE_MQTT_MODULE_NAME);
if (node->packet == NULL) {
mqtt_handle->sysdep->core_sysdep_free(node);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node->packet, 0, len);
memcpy(node->packet, packet, len);
node->len = len;
node->last_send_time = mqtt_handle->sysdep->core_sysdep_time();
core_list_add_tail(&node->linked_node, &mqtt_handle->pub_list);
return STATE_SUCCESS;
}
static void _core_mqtt_publist_remove(core_mqtt_handle_t *mqtt_handle, uint16_t packet_id)
{
core_mqtt_pub_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->pub_list,
linked_node, core_mqtt_pub_node_t) {
if (node->packet_id == packet_id) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node->packet);
mqtt_handle->sysdep->core_sysdep_free(node);
return;
}
}
}
static void _core_mqtt_publist_destroy(core_mqtt_handle_t *mqtt_handle)
{
core_mqtt_pub_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->pub_list,
linked_node, core_mqtt_pub_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node->packet);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static int32_t _core_mqtt_subunsub(core_mqtt_handle_t *mqtt_handle, char *topic, uint16_t topic_len, uint8_t qos,
uint8_t pkt_type, general_property_t *general_property)
{
int32_t res = 0;
uint16_t packet_id = 0;
uint8_t *pkt = NULL;
uint32_t idx = 0, pkt_len = 0, remainlen = 0;
uint32_t property_total_len = 0;
uint32_t property_len = 0, property_len_offset = 0;
uint8_t property_len_array[4] = {0};
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
if (NULL != general_property) {
res = _core_mqtt_general_property_is_valid(general_property);
if (res < STATE_SUCCESS) {
return res;
}
property_len = _core_get_general_property_len(general_property);
}
/* Property Len */
_core_mqtt_remain_len_encode(property_len, &property_len_array[0],
&property_len_offset);
property_total_len = property_len_offset + property_len;
}
remainlen = CORE_MQTT_PACKETID_LEN + CORE_MQTT_UTF8_STR_EXTRA_LEN + topic_len + property_total_len;
if (pkt_type == CORE_MQTT_SUB_PKT_TYPE) {
remainlen += CORE_MQTT_REQUEST_QOS_LEN;
}
pkt_len = CORE_MQTT_FIXED_HEADER_LEN + CORE_MQTT_REMAINLEN_MAXLEN + remainlen;
pkt = mqtt_handle->sysdep->core_sysdep_malloc(pkt_len, CORE_MQTT_MODULE_NAME);
if (pkt == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(pkt, 0, pkt_len);
/* Subscribe/Unsubscribe Packet Type */
if (pkt_type == CORE_MQTT_SUB_PKT_TYPE) {
pkt[idx++] = CORE_MQTT_SUB_PKT_TYPE | CORE_MQTT_SUB_PKT_RESERVE;
} else if (pkt_type == CORE_MQTT_UNSUB_PKT_TYPE) {
uint8_t unsub_flag = 0;
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
unsub_flag = CORE_MQTT_UNSUB_PKT_TYPE | CORE_MQTT_UNSUB_PKT_RESERVE;
} else {
unsub_flag = CORE_MQTT_UNSUB_PKT_TYPE;
}
pkt[idx++] = unsub_flag;
}
/* Remaining Length */
_core_mqtt_remain_len_encode(remainlen, &pkt[idx], &idx);
/* Packet Id */
packet_id = _core_mqtt_packet_id(mqtt_handle);
pkt[idx++] = (uint8_t)((packet_id >> 8) & 0x00FF);
pkt[idx++] = (uint8_t)((packet_id) & 0x00FF);
if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && NULL != general_property) {
_core_write_general_prop(pkt, &idx, general_property, property_len_array, property_len_offset);
}
/* Topic */
pkt[idx++] = (uint8_t)((topic_len >> 8) & 0x00FF);
pkt[idx++] = (uint8_t)((topic_len) & 0x00FF);
memcpy(&pkt[idx], topic, topic_len);
idx += topic_len;
/* QOS */
if (pkt_type == CORE_MQTT_SUB_PKT_TYPE) {
pkt[idx++] = qos;
}
pkt_len = idx;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(mqtt_handle, pkt, pkt_len, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(pkt);
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
mqtt_handle->sysdep->core_sysdep_free(pkt);
return packet_id;
}
static int32_t _core_mqtt_heartbeat(core_mqtt_handle_t *mqtt_handle)
{
int32_t res = 0;
uint8_t pingreq_pkt[2] = { CORE_MQTT_PINGREQ_PKT_TYPE, 0x00 };
_core_mqtt_heartbeat_diag(mqtt_handle, 0x00);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(mqtt_handle, pingreq_pkt, 2, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_repub(core_mqtt_handle_t *mqtt_handle)
{
int32_t res = 0;
uint64_t time_now = 0;
core_mqtt_pub_node_t *node = NULL;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
core_list_for_each_entry(node, &mqtt_handle->pub_list, linked_node, core_mqtt_pub_node_t) {
time_now = mqtt_handle->sysdep->core_sysdep_time();
if (time_now < node->last_send_time) {
node->last_send_time = time_now;
}
if ((time_now - node->last_send_time) >= mqtt_handle->repub_timeout_ms) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(mqtt_handle, node->packet, node->len, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
return STATE_SUCCESS;
}
static int32_t _core_mqtt_process_datalist_insert(core_mqtt_handle_t *mqtt_handle,
core_mqtt_process_data_t *process_data)
{
core_mqtt_process_data_node_t *node = NULL;
core_list_for_each_entry(node, &mqtt_handle->process_data_list,
linked_node, core_mqtt_process_data_node_t) {
if (node->process_data.handler == process_data->handler) {
node->process_data.context = process_data->context;
return STATE_SUCCESS;
}
}
if (&node->linked_node == &mqtt_handle->process_data_list) {
node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_process_data_node_t), CORE_MQTT_MODULE_NAME);
if (node == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(node, 0, sizeof(core_mqtt_process_data_node_t));
CORE_INIT_LIST_HEAD(&node->linked_node);
memcpy(&node->process_data, process_data, sizeof(core_mqtt_process_data_t));
core_list_add_tail(&node->linked_node, &mqtt_handle->process_data_list);
}
return STATE_SUCCESS;
}
static void _core_mqtt_process_datalist_remove(core_mqtt_handle_t *mqtt_handle,
core_mqtt_process_data_t *process_data)
{
core_mqtt_process_data_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->process_data_list,
linked_node, core_mqtt_process_data_node_t) {
if (node->process_data.handler == process_data->handler) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node);
return;
}
}
}
static void _core_mqtt_process_datalist_destroy(core_mqtt_handle_t *mqtt_handle)
{
core_mqtt_process_data_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, &mqtt_handle->process_data_list,
linked_node, core_mqtt_process_data_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static int32_t _core_mqtt_append_process_data(core_mqtt_handle_t *mqtt_handle,
core_mqtt_process_data_t *process_data)
{
int32_t res = STATE_SUCCESS;
if (process_data->handler == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->process_handler_mutex);
res = _core_mqtt_process_datalist_insert(mqtt_handle, process_data);
if (res >= STATE_SUCCESS && mqtt_handle->has_connected == 1) {
aiot_mqtt_event_t event;
memset(&event, 0, sizeof(aiot_mqtt_event_t));
event.type = AIOT_MQTTEVT_CONNECT;
process_data->handler(process_data->context, &event, NULL);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->process_handler_mutex);
return res;
}
static int32_t _core_mqtt_remove_process_data(core_mqtt_handle_t *mqtt_handle,
core_mqtt_process_data_t *process_data)
{
int32_t res = STATE_SUCCESS;
if (process_data->handler == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->process_handler_mutex);
_core_mqtt_process_datalist_remove(mqtt_handle, process_data);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->process_handler_mutex);
return res;
}
static void _core_mqtt_process_data_process(core_mqtt_handle_t *mqtt_handle, core_mqtt_event_t *core_event)
{
core_mqtt_process_data_node_t *node = NULL;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->process_handler_mutex);
core_list_for_each_entry(node, &mqtt_handle->process_data_list,
linked_node, core_mqtt_process_data_node_t) {
node->process_data.handler(node->process_data.context, NULL, core_event);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->process_handler_mutex);
}
static int32_t _core_mqtt_reconnect(core_mqtt_handle_t *mqtt_handle)
{
int32_t res = STATE_SYS_DEPEND_NWK_CLOSED;
uint64_t time_now = 0;
if (mqtt_handle->network_handle != NULL) {
return STATE_SUCCESS;
}
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_RECONNECTING, "MQTT network disconnect, try to reconnecting...\r\n");
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
time_now = mqtt_handle->sysdep->core_sysdep_time();
if (time_now < mqtt_handle->reconnect_params.last_retry_time) {
mqtt_handle->reconnect_params.last_retry_time = time_now;
}
if (time_now >= (mqtt_handle->reconnect_params.last_retry_time + mqtt_handle->reconnect_params.interval_ms)) {
mqtt_handle->reconnect_params.last_retry_time = time_now;
res = _core_mqtt_connect(mqtt_handle, NULL);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
return res;
}
static int32_t _core_mqtt_read_remainlen(core_mqtt_handle_t *mqtt_handle, uint32_t *remainlen)
{
int32_t res = 0;
uint8_t ch = 0;
uint32_t multiplier = 1;
uint32_t mqtt_remainlen = 0;
do {
res = _core_mqtt_read(mqtt_handle, &ch, 1, mqtt_handle->recv_timeout_ms);
if (res < STATE_SUCCESS) {
return res;
}
mqtt_remainlen += (ch & 127) * multiplier;
if (multiplier > 128 * 128 * 128) {
return STATE_MQTT_MALFORMED_REMAINING_LEN;
}
multiplier *= 128;
} while ((ch & 128) != 0);
*remainlen = mqtt_remainlen;
return STATE_SUCCESS;
}
static int32_t _core_mqtt_read_remainbytes(core_mqtt_handle_t *mqtt_handle, uint32_t remainlen, uint8_t **output)
{
int32_t res = 0;
uint8_t *remain = NULL;
if (remainlen > 0) {
remain = mqtt_handle->sysdep->core_sysdep_malloc(remainlen, CORE_MQTT_MODULE_NAME);
if (remain == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(remain, 0, remainlen);
res = _core_mqtt_read(mqtt_handle, remain, remainlen, mqtt_handle->recv_timeout_ms);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(remain);
if (res == STATE_SYS_DEPEND_NWK_READ_LESSDATA) {
return STATE_MQTT_MALFORMED_REMAINING_BYTES;
} else {
return res;
}
}
}
*output = remain;
return STATE_SUCCESS;
}
static int32_t _core_mqtt_pingresp_handler(core_mqtt_handle_t *mqtt_handle, uint8_t *input, uint32_t len)
{
aiot_mqtt_recv_t packet;
uint64_t rtt = mqtt_handle->sysdep->core_sysdep_time() \
- mqtt_handle->heartbeat_params.last_send_time;
if (len != 0) {
return STATE_MQTT_RECV_INVALID_PINRESP_PACKET;
}
/* heartbreat rtt stats */
if (rtt < CORE_MQTT_NWKSTATS_RTT_THRESHOLD) {
mqtt_handle->nwkstats_info.rtt = (mqtt_handle->nwkstats_info.rtt + rtt) / 2;
}
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
if (mqtt_handle->recv_handler != NULL) {
packet.type = AIOT_MQTTRECV_HEARTBEAT_RESPONSE;
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
_core_mqtt_heartbeat_diag(mqtt_handle, 0x01);
return STATE_SUCCESS;
}
static int32_t _core_mqtt_puback_send(core_mqtt_handle_t *mqtt_handle, uint16_t packet_id)
{
int32_t res = 0;
uint8_t pkt[4] = {0};
/* Packet Type */
pkt[0] = CORE_MQTT_PUBACK_PKT_TYPE;
/* Remaining Lengh */
pkt[1] = 2;
/* Packet Id */
pkt[2] = (uint16_t)((packet_id >> 8) & 0x00FF);
pkt[3] = (uint16_t)((packet_id) & 0x00FF);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(mqtt_handle, pkt, 4, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_topic_compare(char *topic, uint32_t topic_len, char *cmp_topic, uint32_t cmp_topic_len)
{
uint32_t idx = 0, cmp_idx = 0;
for (idx = 0, cmp_idx = 0; idx < topic_len; idx++) {
/* compare topic alreay out of bounds */
if (cmp_idx >= cmp_topic_len) {
/* compare success only in case of the left string of topic is "/#" */
if ((topic_len - idx == 2) && (memcmp(&topic[idx], "/#", 2) == 0)) {
return STATE_SUCCESS;
} else {
return STATE_MQTT_TOPIC_COMPARE_FAILED;
}
}
/* if topic reach the '#', compare success */
if (topic[idx] == '#') {
return STATE_SUCCESS;
}
if (topic[idx] == '+') {
/* wildcard + exist */
for (; cmp_idx < cmp_topic_len; cmp_idx++) {
if (cmp_topic[cmp_idx] == '/') {
/* if topic already reach the bound, compare topic should not contain '/' */
if (idx + 1 == topic_len) {
return STATE_MQTT_TOPIC_COMPARE_FAILED;
} else {
break;
}
}
}
} else {
/* compare each character */
if (topic[idx] != cmp_topic[cmp_idx]) {
return STATE_MQTT_TOPIC_COMPARE_FAILED;
}
cmp_idx++;
}
}
/* compare topic should be reach the end */
if (cmp_idx < cmp_topic_len) {
return STATE_MQTT_TOPIC_COMPARE_FAILED;
}
return STATE_SUCCESS;
}
static void _core_mqtt_handlerlist_append(core_mqtt_handle_t *mqtt_handle, struct core_list_head *dest,
struct core_list_head *src, uint8_t *found)
{
core_mqtt_sub_handler_node_t *node = NULL, *copy_node = NULL;
core_list_for_each_entry(node, src, linked_node, core_mqtt_sub_handler_node_t) {
copy_node = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(core_mqtt_sub_handler_node_t), CORE_MQTT_MODULE_NAME);
if (copy_node == NULL) {
continue;
}
memset(copy_node, 0, sizeof(core_mqtt_sub_handler_node_t));
CORE_INIT_LIST_HEAD(©_node->linked_node);
copy_node->handler = node->handler;
copy_node->userdata = node->userdata;
core_list_add_tail(©_node->linked_node, dest);
*found = 1;
}
}
static void _core_mqtt_handlerlist_destroy(core_mqtt_handle_t *mqtt_handle, struct core_list_head *list)
{
core_mqtt_sub_handler_node_t *node = NULL, *next = NULL;
core_list_for_each_entry_safe(node, next, list, linked_node, core_mqtt_sub_handler_node_t) {
core_list_del(&node->linked_node);
mqtt_handle->sysdep->core_sysdep_free(node);
}
}
static int32_t _core_mqtt_parse_pub_properties(core_mqtt_handle_t *mqtt_handle, uint8_t *property,
pub_property_t *pub_prop, uint32_t *parsed_property_len, uint8_t *parsed_offset, uint32_t remain_len)
{
general_property_t general_prop = {0};
int32_t res = _core_mqtt_parse_general_properties(mqtt_handle, property, &general_prop, parsed_property_len,
parsed_offset, remain_len);
if (res != STATE_SUCCESS) {
return res;
}
pub_prop->message_expire_interval = general_prop.message_expire_interval;
pub_prop->topic_alias = general_prop.topic_alias;
memcpy(&(pub_prop->user_property[0]), &(general_prop.user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
pub_prop->subscription_identifier = general_prop.subscription_identifier;
pub_prop->response_topic = general_prop.response_topic;
pub_prop->correlation_data = general_prop.correlation_data;
return STATE_SUCCESS;
}
uint8_t _core_mqtt_process_topic_alias(core_mqtt_handle_t *mqtt_handle, pub_property_t *pub_prop, uint32_t topic_len,
char *topic,
core_mqtt_topic_alias_node_t *alias_node)
{
core_mqtt_topic_alias_node_t *topic_alias_node = NULL;
uint8_t use_alias_topic = 0;
if (NULL != pub_prop && pub_prop->topic_alias > 0) {
if (topic_len > 0) {
/* A topic appears first time during this connection. */
core_mqtt_buff_t alias_topic = {
.buffer = (uint8_t *)topic,
.len = topic_len,
};
/* Insert it into topic alias list */
_core_mqtt_topic_alias_list_insert(mqtt_handle, &alias_topic, pub_prop->topic_alias,
&(mqtt_handle->rx_topic_alias_list));
} else {
/* topic len is 0. User previos topic alias */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->topic_alias_mutex);
core_list_for_each_entry(topic_alias_node, &mqtt_handle->rx_topic_alias_list, linked_node,
core_mqtt_topic_alias_node_t) {
if (topic_alias_node->topic_alias == pub_prop->topic_alias) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "found a rx topic alias\n");
use_alias_topic = 1;
memcpy(alias_node, topic_alias_node, sizeof(core_mqtt_topic_alias_node_t));
break;
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->topic_alias_mutex);
}
}
return use_alias_topic;
}
static int32_t _core_mqtt_pub_handler(core_mqtt_handle_t *mqtt_handle, uint8_t *input, uint32_t len, uint8_t qos,
uint32_t remain_len)
{
uint8_t sub_found = 0;
uint32_t idx = 0;
uint16_t packet_id = 0;
uint16_t utf8_strlen = 0;
aiot_mqtt_recv_t packet;
uint32_t topic_len = 0;
void *userdata;
core_mqtt_sub_node_t *sub_node = NULL;
core_mqtt_topic_alias_node_t topic_alias_node = {0};
core_mqtt_sub_handler_node_t *handler_node = NULL;
struct core_list_head handler_list_copy;
uint8_t use_alias_topic = 0;
pub_property_t pub_prop = {0};
uint32_t total_prop_len = 0;
if (input == NULL || len == 0 || qos > CORE_MQTT_QOS1) {
return STATE_MQTT_RECV_INVALID_PUBLISH_PACKET;
}
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
packet.data.pub.qos = qos;
packet.type = AIOT_MQTTRECV_PUB;
/* Topic Length */
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle) && len < 2) {
return STATE_MQTT_RECV_INVALID_PUBLISH_PACKET;
}
utf8_strlen = input[idx++] << 8;
utf8_strlen |= input[idx++];
packet.data.pub.topic = (char *)&input[idx];
packet.data.pub.topic_len = utf8_strlen;
idx += utf8_strlen;
/* Packet Id For QOS1 */
if (len < idx) {
return STATE_MQTT_RECV_INVALID_PUBLISH_PACKET;
}
if (qos == CORE_MQTT_QOS1) {
if (len < idx + 2) {
return STATE_MQTT_RECV_INVALID_PUBLISH_PACKET;
}
packet_id = input[idx++] << 8;
packet_id |= input[idx++];
}
remain_len -= idx;
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
uint32_t property_len = 0;
uint8_t offset = 0;
int32_t res = _core_mqtt_parse_pub_properties(mqtt_handle, &input[idx], &pub_prop, &property_len, &offset, remain_len);
if (res < STATE_SUCCESS) {
return res;
}
total_prop_len = property_len + offset ;
idx += total_prop_len;
packet.data.pub.pub_prop = &pub_prop;
use_alias_topic = _core_mqtt_process_topic_alias(mqtt_handle, &pub_prop, packet.data.pub.topic_len,
packet.data.pub.topic, &topic_alias_node);
}
/* Payload Len */
if ((int64_t)len - CORE_MQTT_PUBLISH_TOPICLEN_LEN - (int64_t)packet.data.pub.topic_len < 0) {
return STATE_MQTT_RECV_INVALID_PUBLISH_PACKET;
}
packet.data.pub.payload = &input[idx];
packet.data.pub.payload_len = len - CORE_MQTT_PUBLISH_TOPICLEN_LEN - packet.data.pub.topic_len - total_prop_len;
if (qos == CORE_MQTT_QOS1) {
packet.data.pub.payload_len -= CORE_MQTT_PACKETID_LEN;
}
/* Publish Ack For QOS1 */
if (qos == CORE_MQTT_QOS1) {
_core_mqtt_puback_send(mqtt_handle, packet_id);
}
/* User previos topic alias */
if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && 1 == use_alias_topic) {
packet.data.pub.topic = topic_alias_node.topic;
packet.data.pub.topic_len = strlen(packet.data.pub.topic);
}
/* debug */
topic_len = (uint32_t)packet.data.pub.topic_len;
core_log2(mqtt_handle->sysdep, STATE_MQTT_LOG_TOPIC, "pub: %.*s\r\n", &topic_len,
packet.data.pub.topic);
core_log_hexdump(STATE_MQTT_LOG_HEXDUMP, '<', packet.data.pub.payload, packet.data.pub.payload_len);
/* Search Packet Handler In sublist */
CORE_INIT_LIST_HEAD(&handler_list_copy);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->sub_mutex);
core_list_for_each_entry(sub_node, &mqtt_handle->sub_list, linked_node, core_mqtt_sub_node_t) {
if (_core_mqtt_topic_compare(sub_node->topic, (uint32_t)(strlen(sub_node->topic)), packet.data.pub.topic,
packet.data.pub.topic_len) == STATE_SUCCESS) {
_core_mqtt_handlerlist_append(mqtt_handle, &handler_list_copy, &sub_node->handle_list, &sub_found);
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->sub_mutex);
core_list_for_each_entry(handler_node, &handler_list_copy,
linked_node, core_mqtt_sub_handler_node_t) {
userdata = (handler_node->userdata == NULL) ? (mqtt_handle->userdata) : (handler_node->userdata);
handler_node->handler(mqtt_handle, &packet, userdata);
}
_core_mqtt_handlerlist_destroy(mqtt_handle, &handler_list_copy);
/* User Data Default Packet Handler */
if (mqtt_handle->recv_handler && sub_found == 0) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
/* Reclaims Mem of User Properties */
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
_core_reclaim_user_properties_mem(mqtt_handle, pub_prop.user_property);
}
return STATE_SUCCESS;
}
void _core_mqtt_flow_control_inc(core_mqtt_handle_t *mqtt_handle)
{
if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && mqtt_handle->flow_control_enabled) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
mqtt_handle->server_receive_max++;
mqtt_handle->server_receive_max = (mqtt_handle->server_receive_max > CORE_DEFAULT_SERVER_RECEIVE_MAX) ?
CORE_DEFAULT_SERVER_RECEIVE_MAX : mqtt_handle->server_receive_max;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
}
}
static int32_t _core_mqtt_puback_handler(core_mqtt_handle_t *mqtt_handle, uint8_t *input, uint32_t len)
{
aiot_mqtt_recv_t packet;
/* even maltform puback received, flow control should be re-calculated as well */
_core_mqtt_flow_control_inc(mqtt_handle);
if (input == NULL) {
return STATE_MQTT_RECV_INVALID_PUBACK_PACKET;
}
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle) && len != 2) {
return STATE_MQTT_RECV_INVALID_PUBACK_PACKET;
} else if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && len < 2) {
return STATE_MQTT_RECV_INVALID_PUBACK_PACKET;
}
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
packet.type = AIOT_MQTTRECV_PUB_ACK;
/* Packet Id */
packet.data.pub_ack.packet_id = input[0] << 8;
packet.data.pub_ack.packet_id |= input[1];
/* Remove Packet From republist */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
_core_mqtt_publist_remove(mqtt_handle, packet.data.pub_ack.packet_id);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
/* User Ctrl Packet Handler */
if (mqtt_handle->recv_handler) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_server_disconnect_handler(core_mqtt_handle_t *mqtt_handle, uint8_t *input, uint32_t len)
{
aiot_mqtt_recv_t packet;
uint8_t reason_code;
if (input == NULL) {
return STATE_MQTT_RECV_INVALID_SERVER_DISCONNECT_PACKET;
}
if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && len < 2) {
return STATE_MQTT_RECV_INVALID_SERVER_DISCONNECT_PACKET;
}
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
packet.type = AIOT_MQTTRECV_DISCONNECT;
reason_code = input[0];
packet.data.server_disconnect.reason_code = reason_code;
/* User Ctrl Packet Handler */
if (mqtt_handle->recv_handler) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
/* close socket connect with mqtt broker */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT);
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT receives server disconnect, disconnect\r\n");
return STATE_SUCCESS;
}
static void _core_mqtt_subunsuback_handler(core_mqtt_handle_t *mqtt_handle, uint8_t *input, uint32_t len,
uint8_t packet_type)
{
uint32_t idx = 0;
aiot_mqtt_recv_t packet;
int32_t res = STATE_SUCCESS;
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle)) {
if (input == NULL || len == 0 ||
(packet_type == CORE_MQTT_SUBACK_PKT_TYPE && len % 3 != 0) ||
(packet_type == CORE_MQTT_UNSUBACK_PKT_TYPE && len % 2 != 0)) {
return;
}
for (idx = 0; idx < len;) {
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
if (packet_type == CORE_MQTT_SUBACK_PKT_TYPE) {
packet.type = AIOT_MQTTRECV_SUB_ACK;
packet.data.sub_ack.packet_id = input[idx] << 8;
packet.data.sub_ack.packet_id |= input[idx + 1];
} else {
packet.type = AIOT_MQTTRECV_UNSUB_ACK;
packet.data.unsub_ack.packet_id = input[idx] << 8;
packet.data.unsub_ack.packet_id |= input[idx + 1];
}
if (packet_type == CORE_MQTT_SUBACK_PKT_TYPE) {
if (input[idx + 2] == CORE_MQTT_SUBACK_RCODE_MAXQOS0 ||
input[idx + 2] == CORE_MQTT_SUBACK_RCODE_MAXQOS1 ||
input[idx + 2] == CORE_MQTT_SUBACK_RCODE_MAXQOS2) {
packet.data.sub_ack.res = STATE_SUCCESS;
packet.data.sub_ack.max_qos = input[idx + 2];
} else if (input[idx + 2] == CORE_MQTT_SUBACK_RCODE_FAILURE) {
packet.data.sub_ack.res = STATE_MQTT_SUBACK_RCODE_FAILURE;
} else {
packet.data.sub_ack.res = STATE_MQTT_SUBACK_RCODE_UNKNOWN;
}
idx += 3;
} else {
idx += 2;
}
if (mqtt_handle->recv_handler) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
}
} else {
uint32_t idx = 0;
uint32_t property_len = 0;
uint8_t offset = 0;
if (input == NULL || len == 0) {
return;
}
/* Packet ID */
memset(&packet, 0, sizeof(aiot_mqtt_recv_t));
if (packet_type == CORE_MQTT_SUBACK_PKT_TYPE) {
packet.type = AIOT_MQTTRECV_SUB_ACK;
packet.data.sub_ack.packet_id = input[idx] << 8;
packet.data.sub_ack.packet_id |= input[idx + 1];
} else {
packet.type = AIOT_MQTTRECV_UNSUB_ACK;
packet.data.unsub_ack.packet_id = input[idx] << 8;
packet.data.unsub_ack.packet_id |= input[idx + 1];
}
idx += 2;
/* Properties */
res = _read_variable_byte_interger(&(input[idx]), &property_len, &offset);
if (res < STATE_SUCCESS) {
return;
}
idx = idx + offset + property_len;
if (idx +1 > len) {
return;
}
/* Suback Flags */
if (packet_type == CORE_MQTT_SUBACK_PKT_TYPE) {
if (input[idx] == CORE_MQTT_SUBACK_RCODE_MAXQOS0 ||
input[idx] == CORE_MQTT_SUBACK_RCODE_MAXQOS1 ||
input[idx] == CORE_MQTT_SUBACK_RCODE_MAXQOS2) {
packet.data.sub_ack.res = STATE_SUCCESS;
packet.data.sub_ack.max_qos = input[idx];
} else if (input[idx] == CORE_MQTT_SUBACK_RCODE_FAILURE) {
packet.data.sub_ack.res = STATE_MQTT_SUBACK_RCODE_FAILURE;
} else {
packet.data.sub_ack.res = STATE_MQTT_SUBACK_RCODE_UNKNOWN;
}
}
if (mqtt_handle->recv_handler) {
mqtt_handle->recv_handler((void *)mqtt_handle, &packet, mqtt_handle->userdata);
}
}
}
int32_t core_mqtt_setopt(void *handle, core_mqtt_option_t option, void *data)
{
int32_t res = 0;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= CORE_MQTTOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
switch (option) {
case CORE_MQTTOPT_APPEND_PROCESS_HANDLER: {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
res = _core_mqtt_append_process_data(mqtt_handle, (core_mqtt_process_data_t *)data);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
}
break;
case CORE_MQTTOPT_REMOVE_PROCESS_HANDLER: {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
res = _core_mqtt_remove_process_data(mqtt_handle, (core_mqtt_process_data_t *)data);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
return res;
}
void *aiot_mqtt_init(void)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
res = core_global_init(sysdep);
if (res < STATE_SUCCESS) {
return NULL;
}
mqtt_handle = sysdep->core_sysdep_malloc(sizeof(core_mqtt_handle_t), CORE_MQTT_MODULE_NAME);
if (mqtt_handle == NULL) {
core_global_deinit(sysdep);
return NULL;
}
memset(mqtt_handle, 0, sizeof(core_mqtt_handle_t));
mqtt_handle->sysdep = sysdep;
mqtt_handle->keep_alive_s = CORE_MQTT_DEFAULT_KEEPALIVE_S;
mqtt_handle->clean_session = CORE_MQTT_DEFAULT_CLEAN_SESSION;
mqtt_handle->connect_timeout_ms = CORE_MQTT_DEFAULT_CONNECT_TIMEOUT_MS;
mqtt_handle->heartbeat_params.interval_ms = CORE_MQTT_DEFAULT_HEARTBEAT_INTERVAL_MS;
mqtt_handle->heartbeat_params.max_lost_times = CORE_MQTT_DEFAULT_HEARTBEAT_MAX_LOST_TIMES;
mqtt_handle->reconnect_params.enabled = CORE_MQTT_DEFAULT_RECONN_ENABLED;
mqtt_handle->reconnect_params.interval_ms = CORE_MQTT_DEFAULT_RECONN_INTERVAL_MS;
mqtt_handle->send_timeout_ms = CORE_MQTT_DEFAULT_SEND_TIMEOUT_MS;
mqtt_handle->recv_timeout_ms = CORE_MQTT_DEFAULT_RECV_TIMEOUT_MS;
mqtt_handle->repub_timeout_ms = CORE_MQTT_DEFAULT_REPUB_TIMEOUT_MS;
mqtt_handle->deinit_timeout_ms = CORE_MQTT_DEFAULT_DEINIT_TIMEOUT_MS;
mqtt_handle->data_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->send_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->recv_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->sub_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->pub_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->topic_alias_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->process_handler_mutex = sysdep->core_sysdep_mutex_init();
mqtt_handle->protocol_version = AIOT_MQTT_VERSION_3_1;
mqtt_handle->tx_packet_max_size = CORE_TX_PKT_MAX_LENGTH;
CORE_INIT_LIST_HEAD(&mqtt_handle->sub_list);
CORE_INIT_LIST_HEAD(&mqtt_handle->pub_list);
CORE_INIT_LIST_HEAD(&mqtt_handle->process_data_list);
CORE_INIT_LIST_HEAD(&mqtt_handle->rx_topic_alias_list);
CORE_INIT_LIST_HEAD(&mqtt_handle->tx_topic_alias_list);
mqtt_handle->exec_enabled = 1;
mqtt_handle->server_receive_max = CORE_DEFAULT_SERVER_RECEIVE_MAX;
return mqtt_handle;
}
int32_t aiot_mqtt_setopt(void *handle, aiot_mqtt_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= AIOT_MQTTOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
switch (option) {
case AIOT_MQTTOPT_HOST: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->host, (char *)data, CORE_MQTT_MODULE_NAME);
}
break;
case AIOT_MQTTOPT_PORT: {
mqtt_handle->port = *(uint16_t *)data;
}
break;
case AIOT_MQTTOPT_PRODUCT_KEY: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->product_key, (char *)data, CORE_MQTT_MODULE_NAME);
_core_mqtt_sign_clean(mqtt_handle);
}
break;
case AIOT_MQTTOPT_DEVICE_NAME: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->device_name, (char *)data, CORE_MQTT_MODULE_NAME);
_core_mqtt_sign_clean(mqtt_handle);
}
break;
case AIOT_MQTTOPT_DEVICE_SECRET: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->device_secret, (char *)data, CORE_MQTT_MODULE_NAME);
_core_mqtt_sign_clean(mqtt_handle);
}
break;
case AIOT_MQTTOPT_EXTEND_CLIENTID: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->extend_clientid, (char *)data, CORE_MQTT_MODULE_NAME);
_core_mqtt_sign_clean(mqtt_handle);
}
break;
case AIOT_MQTTOPT_SECURITY_MODE: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->security_mode, (char *)data, CORE_MQTT_MODULE_NAME);
_core_mqtt_sign_clean(mqtt_handle);
}
break;
case AIOT_MQTTOPT_USERNAME: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->username, (char *)data, CORE_MQTT_MODULE_NAME);
}
break;
case AIOT_MQTTOPT_PASSWORD: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->password, (char *)data, CORE_MQTT_MODULE_NAME);
}
break;
case AIOT_MQTTOPT_CLIENTID: {
res = core_strdup(mqtt_handle->sysdep, &mqtt_handle->clientid, (char *)data, CORE_MQTT_MODULE_NAME);
}
break;
case AIOT_MQTTOPT_KEEPALIVE_SEC: {
mqtt_handle->keep_alive_s = *(uint16_t *)data;
}
break;
case AIOT_MQTTOPT_CLEAN_SESSION: {
if (*(uint8_t *)data != 0 && *(uint8_t *)data != 1) {
res = STATE_USER_INPUT_OUT_RANGE;
}
mqtt_handle->clean_session = *(uint8_t *)data;
}
break;
case AIOT_MQTTOPT_NETWORK_CRED: {
if (mqtt_handle->cred != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->cred);
mqtt_handle->cred = NULL;
}
mqtt_handle->cred = mqtt_handle->sysdep->core_sysdep_malloc(sizeof(aiot_sysdep_network_cred_t), CORE_MQTT_MODULE_NAME);
if (mqtt_handle->cred != NULL) {
memset(mqtt_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(mqtt_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
} else {
res = STATE_SYS_DEPEND_MALLOC_FAILED;
}
}
break;
case AIOT_MQTTOPT_CONNECT_TIMEOUT_MS: {
mqtt_handle->connect_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_HEARTBEAT_INTERVAL_MS: {
mqtt_handle->heartbeat_params.interval_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_HEARTBEAT_MAX_LOST: {
mqtt_handle->heartbeat_params.max_lost_times = *(uint8_t *)data;
}
break;
case AIOT_MQTTOPT_RECONN_ENABLED: {
if (*(uint8_t *)data != 0 && *(uint8_t *)data != 1) {
res = STATE_USER_INPUT_OUT_RANGE;
}
mqtt_handle->reconnect_params.enabled = *(uint8_t *)data;
}
break;
case AIOT_MQTTOPT_RECONN_INTERVAL_MS: {
mqtt_handle->reconnect_params.interval_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_SEND_TIMEOUT_MS: {
mqtt_handle->send_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_RECV_TIMEOUT_MS: {
mqtt_handle->recv_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_REPUB_TIMEOUT_MS: {
mqtt_handle->repub_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_DEINIT_TIMEOUT_MS: {
mqtt_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
case AIOT_MQTTOPT_RECV_HANDLER: {
mqtt_handle->recv_handler = (aiot_mqtt_recv_handler_t)data;
}
break;
case AIOT_MQTTOPT_EVENT_HANDLER: {
mqtt_handle->event_handler = (aiot_mqtt_event_handler_t)data;
}
break;
case AIOT_MQTTOPT_APPEND_TOPIC_MAP: {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
res = _core_mqtt_append_topic_map(mqtt_handle, (aiot_mqtt_topic_map_t *)data);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
}
break;
case AIOT_MQTTOPT_REMOVE_TOPIC_MAP: {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
res = _core_mqtt_remove_topic_map(mqtt_handle, (aiot_mqtt_topic_map_t *)data);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->data_mutex);
}
break;
case AIOT_MQTTOPT_APPEND_REQUESTID: {
mqtt_handle->append_requestid = *(uint8_t *)data;
}
break;
case AIOT_MQTTOPT_USERDATA: {
mqtt_handle->userdata = data;
}
break;
case AIOT_MQTTOPT_VERSION: {
uint8_t version = *(uint8_t *)data;
mqtt_handle->protocol_version = version;
}
break;
case AIOT_MQTTOPT_ASSIGNED_CLIENTID: {
uint8_t use_assigned_clientid = *(uint8_t *)data;
mqtt_handle->use_assigned_clientid = use_assigned_clientid;
}
break;
case AIOT_MQTTOPT_FLOW_CONTROL_ENABLED: {
mqtt_handle->flow_control_enabled = *(uint8_t *)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->data_mutex);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
int32_t aiot_mqtt_deinit(void **handle)
{
uint64_t deinit_timestart = 0;
core_mqtt_handle_t *mqtt_handle = NULL;
core_mqtt_event_t core_event;
if (handle == NULL || *handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
mqtt_handle = *(core_mqtt_handle_t **)handle;
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
mqtt_handle->exec_enabled = 0;
deinit_timestart = mqtt_handle->sysdep->core_sysdep_time();
do {
if (mqtt_handle->exec_count == 0) {
break;
}
mqtt_handle->sysdep->core_sysdep_sleep(CORE_MQTT_DEINIT_INTERVAL_MS);
} while ((mqtt_handle->sysdep->core_sysdep_time() - deinit_timestart) < mqtt_handle->deinit_timeout_ms);
if (mqtt_handle->exec_count != 0) {
return STATE_MQTT_DEINIT_TIMEOUT;
}
_core_mqtt_topic_alias_list_remove_all(mqtt_handle);
memset(&core_event, 0, sizeof(core_mqtt_event_t));
core_event.type = CORE_MQTTEVT_DEINIT;
_core_mqtt_process_data_process(mqtt_handle, &core_event);
*handle = NULL;
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
if (mqtt_handle->host != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->host);
}
if (mqtt_handle->product_key != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->product_key);
}
if (mqtt_handle->device_name != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->device_name);
}
if (mqtt_handle->device_secret != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->device_secret);
}
if (mqtt_handle->username != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->username);
}
if (mqtt_handle->password != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->password);
}
if (mqtt_handle->clientid != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->clientid);
}
if (mqtt_handle->extend_clientid != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->extend_clientid);
}
if (mqtt_handle->security_mode != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->security_mode);
}
if (mqtt_handle->cred != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->cred);
}
if (mqtt_handle->pre_connect_property != NULL) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->pre_connect_property);
}
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->data_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->sub_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->topic_alias_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->pub_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_deinit(&mqtt_handle->process_handler_mutex);
_core_mqtt_sublist_destroy(mqtt_handle);
_core_mqtt_publist_destroy(mqtt_handle);
_core_mqtt_process_datalist_destroy(mqtt_handle);
core_global_deinit(mqtt_handle->sysdep);
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle);
return STATE_SUCCESS;
}
static int32_t _mqtt_connect_with_prop(void *handle, conn_property_t *connect_property)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
uint64_t time_ent_ms = 0;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
time_ent_ms = mqtt_handle->sysdep->core_sysdep_time();
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
mqtt_handle->disconnect_api_called = 0;
/* if network connection exist, close first */
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "MQTT user calls aiot_mqtt_connect api, connect\r\n");
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
res = _core_mqtt_connect(mqtt_handle, connect_property);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res == STATE_MQTT_CONNECT_SUCCESS) {
uint64_t time_ms = mqtt_handle->sysdep->core_sysdep_time();
uint32_t time_delta = (uint32_t)(time_ms - time_ent_ms);
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "MQTT connect success in %d ms\r\n", (void *)&time_delta);
_core_mqtt_connect_event_notify(mqtt_handle);
res = STATE_SUCCESS;
} else {
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT);
}
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
int32_t aiot_mqtt_connect(void *handle)
{
return _mqtt_connect_with_prop(handle, NULL);
}
int32_t aiot_mqtt_connect_with_prop(void *handle, conn_property_t *connect_property)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle)) {
return STATE_MQTT_INVALID_PROTOCOL_VERSION;
}
/* clear previous connection properties */
if (NULL != mqtt_handle->pre_connect_property) {
mqtt_handle->sysdep->core_sysdep_free(mqtt_handle->pre_connect_property);
mqtt_handle->pre_connect_property = NULL;
}
return _mqtt_connect_with_prop(handle, connect_property);
}
int32_t aiot_mqtt_disconnect(void *handle)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
mqtt_handle->disconnect_api_called = 1;
/* send mqtt disconnect packet to mqtt broker first */
_core_mqtt_disconnect(handle);
/* close socket connect with mqtt broker */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT);
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT user calls aiot_mqtt_disconnect api, disconnect\r\n");
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
int32_t aiot_mqtt_heartbeat(void *handle)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
return _core_mqtt_heartbeat(mqtt_handle);
}
int32_t aiot_mqtt_process(void *handle)
{
int32_t res = STATE_SUCCESS;
uint64_t time_now = 0;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
/* mqtt PINREQ packet */
time_now = mqtt_handle->sysdep->core_sysdep_time();
if (time_now < mqtt_handle->heartbeat_params.last_send_time) {
mqtt_handle->heartbeat_params.last_send_time = time_now;
}
if ((time_now - mqtt_handle->heartbeat_params.last_send_time) >= mqtt_handle->heartbeat_params.interval_ms) {
res = _core_mqtt_heartbeat(mqtt_handle);
if (res == STATE_SUCCESS) {
mqtt_handle->heartbeat_params.last_send_time = time_now;
mqtt_handle->heartbeat_params.lost_times++;
}
}
/* mqtt QoS1 packet republish */
_core_mqtt_repub(mqtt_handle);
/* mqtt process handler process */
_core_mqtt_process_data_process(mqtt_handle, NULL);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
uint32_t _core_get_general_property_len(general_property_t *general_prop)
{
uint32_t property_len = 0;
uint8_t subscription_identifier[4] = {0};
uint32_t subscription_identifer_offset = 0;
user_property_t **list = general_prop->user_property;
uint8_t iter = 0;
if (general_prop->topic_alias > 0) {
/* Topic Alias */
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_TOPIC_ALIAS_LEN;
}
if (general_prop->topic_alias_max > 0) {
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_TOPIC_ALIAS_MAX_LEN;
}
/* receive max */
if (general_prop->client_receive_max > 0) {
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_RECEIVE_MAX_LEN;
}
/* User Properties */
for (iter = 0; iter < USER_PROPERTY_MAX; iter++) {
user_property_t *user_prop = list[iter];
if (NULL != user_prop) {
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN; /* len of user property ID */
property_len += CORE_MQTT_V5_USER_PROPERTY_KEY_LEN; /* len of user property key's len */
property_len += user_prop->key.len;
property_len += CORE_MQTT_V5_USER_PROPERTY_VALUE_LEN; /* len of user property value's len */
property_len += user_prop->value.len;
}
}
/* Response Topic */
if (0 != general_prop->response_topic.len) {
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_RESPONSE_TOPIC_LEN + general_prop->response_topic.len;
}
/* Corelation Data */
if (0 != general_prop->correlation_data.len) {
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_CORELATION_DATA_LEN + general_prop->correlation_data.len;
}
/* Subscription Identifier */
if (general_prop->subscription_identifier > 0) {
_core_mqtt_remain_len_encode(general_prop->subscription_identifier, &subscription_identifier[0],
&subscription_identifer_offset);
property_len += CORE_MQTT_V5_PROPERTY_ID_LEN + subscription_identifer_offset;
}
len_value_t *reason_string = general_prop->reason_string;
if (NULL != reason_string) {
property_len += reason_string->len + CORE_MQTT_V5_PROPERTY_ID_LEN + CORE_MQTT_V5_REASON_STRING_LEN;
}
return property_len;
}
static int32_t _core_mqtt_tx_topic_alias_process(core_mqtt_handle_t *mqtt_handle, core_mqtt_buff_t *topic,
uint16_t *alias_id_prt
)
{
core_mqtt_topic_alias_node_t *topic_alias_node = NULL;
uint16_t alias_id = 0;
int32_t replace_topic_with_alias = 0;
/* Topic Alias */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->topic_alias_mutex);
core_list_for_each_entry(topic_alias_node, &mqtt_handle->tx_topic_alias_list, linked_node,
core_mqtt_topic_alias_node_t) {
if (memcmp(topic_alias_node->topic, topic->buffer, topic->len) == 0) {
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "tx use topic alias\n");
alias_id = topic_alias_node->topic_alias;
replace_topic_with_alias = 1;
break;
}
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->topic_alias_mutex);
/* save the tx topic in tx_topic_alias_list */
if (0 == replace_topic_with_alias) {
alias_id = mqtt_handle->tx_topic_alias;
alias_id++;
/* make sure that it does not exceed tx_topic_alias_max */
if (alias_id <= mqtt_handle->tx_topic_alias_max) {
mqtt_handle->tx_topic_alias = alias_id;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->topic_alias_mutex);
_core_mqtt_topic_alias_list_insert(mqtt_handle, topic, alias_id, &(mqtt_handle->tx_topic_alias_list));
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->topic_alias_mutex);
} else {
/* exceed tx_topic_alias_max, no more alias could be used */
alias_id = 0;
}
}
*alias_id_prt = alias_id;
return replace_topic_with_alias;
}
static int32_t _core_mqtt_check_flow_control(core_mqtt_handle_t *mqtt_handle, uint8_t qos)
{
if (mqtt_handle->flow_control_enabled && qos == CORE_MQTT_QOS1) {
uint16_t server_receive_max = 0;
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
server_receive_max = mqtt_handle->server_receive_max;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
if (server_receive_max <= 0) {
return STATE_MQTT_RECEIVE_MAX_EXCEEDED;
}
}
return STATE_SUCCESS;
}
static void _core_mqtt_check_flow_dec(core_mqtt_handle_t *mqtt_handle)
{
if (_core_mqtt_5_feature_is_enabled(mqtt_handle) && mqtt_handle->flow_control_enabled
&& mqtt_handle->server_receive_max > 0) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
mqtt_handle->server_receive_max--;
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
}
}
static int32_t _core_mqtt_check_tx_payload_len(uint32_t pkt_len, core_mqtt_handle_t *mqtt_handle)
{
if (pkt_len >= mqtt_handle->tx_packet_max_size) {
_core_mqtt_exec_dec(mqtt_handle);
return STATE_MQTT_INVALID_TX_PACK_SIZE;
}
return STATE_SUCCESS;
}
static int32_t _core_mqtt_pub(void *handle, core_mqtt_buff_t *topic, core_mqtt_buff_t *payload, uint8_t qos,
pub_property_t *pub_prop)
{
int32_t res = STATE_SUCCESS;
uint16_t packet_id = 0;
uint8_t *pkt = NULL;
uint32_t idx = 0, remainlen = 0, pkt_len = 0;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
uint16_t alias_id = 0;
uint8_t replace_topic_with_alias = 0;
uint32_t property_len = 0;
uint8_t property_len_array[4] = {0};
uint32_t property_len_offset = 0;
general_property_t general_prop = {0};
if (mqtt_handle == NULL ||
payload == NULL || payload->buffer == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (topic->len == 0 || qos > CORE_MQTT_QOS_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
if (NULL != pub_prop) {
memcpy(&(general_prop.user_property[0]), &(pub_prop->user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
general_prop.response_topic = pub_prop->response_topic;
general_prop.correlation_data = pub_prop->correlation_data;
general_prop.subscription_identifier = pub_prop->subscription_identifier;
}
res = _core_mqtt_general_property_is_valid(&general_prop);
if (res < STATE_SUCCESS) {
return res;
}
/* Flow Control Check*/
res = _core_mqtt_check_flow_control(mqtt_handle, qos);
if (res < STATE_SUCCESS) {
return res;
}
/* Topic Alias*/
replace_topic_with_alias = _core_mqtt_tx_topic_alias_process(mqtt_handle, topic, &alias_id);
general_prop.topic_alias = alias_id;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
core_log2(mqtt_handle->sysdep, STATE_MQTT_LOG_TOPIC, "pub: %.*s\r\n", &topic->len, topic->buffer);
core_log_hexdump(STATE_MQTT_LOG_HEXDUMP, '>', payload->buffer, payload->len);
if (0 == replace_topic_with_alias) {
remainlen = topic->len + payload->len + CORE_MQTT_UTF8_STR_EXTRA_LEN;
} else {
remainlen = payload->len + CORE_MQTT_UTF8_STR_EXTRA_LEN;
}
if (qos == CORE_MQTT_QOS1) {
remainlen += CORE_MQTT_PACKETID_LEN;
}
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
property_len = _core_get_general_property_len(&general_prop);
_core_mqtt_remain_len_encode(property_len, &property_len_array[0],
&property_len_offset);
remainlen += property_len + property_len_offset;
}
pkt_len = CORE_MQTT_FIXED_HEADER_LEN + CORE_MQTT_REMAINLEN_MAXLEN + remainlen;
pkt = mqtt_handle->sysdep->core_sysdep_malloc(pkt_len, CORE_MQTT_MODULE_NAME);
if (pkt == NULL) {
_core_mqtt_exec_dec(mqtt_handle);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(pkt, 0, pkt_len);
/* Publish Packet Type */
pkt[idx++] = CORE_MQTT_PUBLISH_PKT_TYPE | (qos << 1);
/* Remaining Length */
_core_mqtt_remain_len_encode(remainlen, &pkt[idx], &idx);
/* Topic Length */
if (replace_topic_with_alias == 0) {
/* topic len is > 0 when alias DOES NOT replaces topic */
_core_mqtt_set_utf8_encoded_str((uint8_t *)topic->buffer, topic->len, &pkt[idx]);
idx += CORE_MQTT_UTF8_STR_EXTRA_LEN + topic->len;
} else {
/* topic len is 0 when alias replaces topic */
pkt[idx++] = 0;
pkt[idx++] = 0;
}
/* Packet Id For QOS 1*/
if (qos == CORE_MQTT_QOS1) {
packet_id = _core_mqtt_packet_id(handle);
pkt[idx++] = (uint8_t)((packet_id >> 8) & 0x00FF);
pkt[idx++] = (uint8_t)((packet_id) & 0x00FF);
}
if (_core_mqtt_5_feature_is_enabled(mqtt_handle)) {
_core_write_general_prop(pkt, &idx, &general_prop, property_len_array, property_len_offset);
}
/* Payload */
memcpy(&pkt[idx], payload->buffer, payload->len);
idx += payload->len;
pkt_len = idx;
/* Ensure tx pack size does not overflow */
res = _core_mqtt_check_tx_payload_len(pkt_len, mqtt_handle);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(pkt);
return res;
}
if (qos == CORE_MQTT_QOS1) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->pub_mutex);
res = _core_mqtt_publist_insert(mqtt_handle, pkt, pkt_len, packet_id);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->pub_mutex);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(pkt);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
}
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(handle, pkt, pkt_len, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_free(pkt);
if (res != STATE_SYS_DEPEND_NWK_WRITE_LESSDATA) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
mqtt_handle->sysdep->core_sysdep_free(pkt);
if (qos == CORE_MQTT_QOS1) {
_core_mqtt_exec_dec(mqtt_handle);
_core_mqtt_check_flow_dec(mqtt_handle);
return (int32_t)packet_id;
}
_core_mqtt_exec_dec(mqtt_handle);
return STATE_SUCCESS;
}
int32_t _core_mqtt_disconnect_with_prop(void *handle, uint8_t reason_code, disconn_property_t *discon_property)
{
int32_t res = 0;
uint32_t pkt_len = 0;
uint8_t *pkt = NULL;
uint32_t idx = 0;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
uint32_t property_len = 0;
uint32_t property_len_offset = 0;
uint8_t property_len_array[4] = {0};
uint32_t pkt_len_offset = 0;
uint8_t pkt_len_array[4] = {0};
uint32_t property_total_len = 0;
uint32_t pkt_remain_len = 0;
general_property_t general_property = {0};
if (discon_property != NULL) {
memcpy(&(general_property.user_property[0]), &(discon_property->user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
general_property.reason_string = discon_property->reason_string;
int res = _core_mqtt_general_property_is_valid(&general_property);
if (res < STATE_SUCCESS) {
return res;
}
property_len = _core_get_general_property_len(&general_property);
}
_core_mqtt_remain_len_encode(property_len, property_len_array, &property_len_offset);
property_total_len = property_len_offset + property_len;
pkt_remain_len = property_total_len + CORE_MQTT_V5_DISCONNECT_REASON_CODE_LEN;
_core_mqtt_remain_len_encode(pkt_remain_len, pkt_len_array, &pkt_len_offset);
pkt_len = CORE_MQTT_FIXED_HEADER_LEN + pkt_len_offset + pkt_remain_len ;
pkt = mqtt_handle->sysdep->core_sysdep_malloc(pkt_len, CORE_MQTT_MODULE_NAME);
if (NULL == pkt) {
return STATE_PORT_MALLOC_FAILED;
}
memset(pkt, 0, pkt_len);
pkt[idx++] = CORE_MQTT_DISCONNECT_PKT_TYPE;
memcpy(&pkt[idx], pkt_len_array, pkt_len_offset);
idx += pkt_len_offset;
pkt[idx++] = reason_code;
_core_write_general_prop(&pkt[0], &idx, &general_property, property_len_array, property_len_offset);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
res = _core_mqtt_write(handle, pkt, idx, mqtt_handle->send_timeout_ms);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_free(pkt);
return res;
}
int32_t aiot_mqtt_disconnect_with_prop(void *handle, uint8_t reason_code, disconn_property_t *discon_property)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (0 == (_core_mqtt_5_feature_is_enabled(mqtt_handle))) {
return STATE_MQTT_INVALID_PROTOCOL_VERSION;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
mqtt_handle->disconnect_api_called = 1;
/* send mqtt disconnect packet to mqtt broker first */
res = _core_mqtt_disconnect_with_prop(handle, reason_code, discon_property);
if (res <= STATE_SUCCESS) {
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
_core_mqtt_topic_alias_list_remove_all(mqtt_handle);
/* close socket connect with mqtt broker */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT);
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_DISCONNECT, "MQTT user calls aiot_mqtt_disconnect api, disconnect\r\n");
_core_mqtt_exec_dec(mqtt_handle);
if (res > STATE_SUCCESS) {
res = STATE_SUCCESS;
}
return res;
}
static int32_t _mqtt_pub_with_prop(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos,
pub_property_t *pub_prop)
{
core_mqtt_buff_t topic_buff = {0};
core_mqtt_buff_t payload_buff;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
uint8_t append_rid = 0;
int32_t res = STATE_SUCCESS;
if (NULL == topic || NULL == handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (strlen(topic) >= CORE_MQTT_TOPIC_MAXLEN) {
return STATE_MQTT_TOPIC_TOO_LONG;
}
if (payload_len >= CORE_MQTT_PAYLOAD_MAXLEN) {
return STATE_MQTT_PUB_PAYLOAD_TOO_LONG;
}
memset(&topic_buff, 0, sizeof(topic_buff));
memset(&payload_buff, 0, sizeof(payload_buff));
append_rid = mqtt_handle->append_requestid;
if (0 == append_rid) {
topic_buff.buffer = (uint8_t *)topic;
topic_buff.len = strlen(topic);
} else {
char *rid_prefix = "?_rid=";
uint64_t timestamp = core_log_get_timestamp(mqtt_handle->sysdep);
uint32_t rand = 0;
char *buffer = NULL;
uint32_t buffer_len = strlen(topic) + strlen(rid_prefix) + 32;
buffer = mqtt_handle->sysdep->core_sysdep_malloc(buffer_len, CORE_MQTT_MODULE_NAME);
if (NULL == buffer) {
return STATE_PORT_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len);
memcpy(buffer, topic, strlen(topic));
memcpy(buffer + strlen(buffer), rid_prefix, strlen(rid_prefix));
core_uint642str(timestamp, buffer + strlen(buffer), NULL);
mqtt_handle->sysdep->core_sysdep_rand((uint8_t *)&rand, sizeof(rand));
core_uint2str(rand, buffer + strlen(buffer), NULL);
topic_buff.buffer = (uint8_t *)buffer;
topic_buff.len = strlen(buffer);
}
payload_buff.buffer = payload;
payload_buff.len = payload_len;
res = _core_mqtt_pub(handle, &topic_buff, &payload_buff, qos, pub_prop);
if (append_rid != 0) {
mqtt_handle->sysdep->core_sysdep_free(topic_buff.buffer);
}
return res;
}
int32_t aiot_mqtt_pub_with_prop(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos,
pub_property_t *pub_prop)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (NULL == handle) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (0 == (_core_mqtt_5_feature_is_enabled(mqtt_handle))) {
return STATE_MQTT_INVALID_PROTOCOL_VERSION;
}
return _mqtt_pub_with_prop(handle, topic, payload, payload_len, qos, pub_prop);
}
int32_t aiot_mqtt_pub(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos)
{
return _mqtt_pub_with_prop(handle, topic, payload, payload_len, qos, NULL);
}
static int32_t _core_mqtt_sub(void *handle, core_mqtt_buff_t *topic, aiot_mqtt_recv_handler_t handler,
uint8_t qos,
void *userdata, sub_property_t *sub_prop)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL || topic == NULL || topic->buffer == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (topic->len == 0 || qos > CORE_MQTT_QOS_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if ((res = _core_mqtt_topic_is_valid((char *)topic->buffer, topic->len)) < STATE_SUCCESS) {
return STATE_MQTT_TOPIC_INVALID;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
core_log2(mqtt_handle->sysdep, STATE_MQTT_LOG_TOPIC, "sub: %.*s\r\n", &topic->len, topic->buffer);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->sub_mutex);
res = _core_mqtt_sublist_insert(mqtt_handle, topic, handler, userdata);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->sub_mutex);
if (res < STATE_SUCCESS) {
return res;
}
general_property_t general_property = {0};
if (NULL != sub_prop) {
memcpy(&(general_property.user_property[0]), &(sub_prop->user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
}
/* send subscribe packet */
res = _core_mqtt_subunsub(mqtt_handle, (char *)topic->buffer, topic->len, qos, CORE_MQTT_SUB_PKT_TYPE,
&general_property);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
static int32_t _mqtt_sub_with_prop(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos,
void *userdata, sub_property_t *sub_prop)
{
core_mqtt_buff_t topic_buff;
if (NULL == topic) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (strlen(topic) >= CORE_MQTT_TOPIC_MAXLEN) {
return STATE_MQTT_TOPIC_TOO_LONG;
}
memset(&topic_buff, 0, sizeof(topic_buff));
topic_buff.buffer = (uint8_t *)topic;
topic_buff.len = strlen(topic);
return _core_mqtt_sub(handle, &topic_buff, handler, qos, userdata, sub_prop);
}
int32_t aiot_mqtt_sub(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos, void *userdata)
{
return _mqtt_sub_with_prop(handle, topic, handler, qos, userdata, NULL);
}
int32_t aiot_mqtt_sub_with_prop(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos,
void *userdata, sub_property_t *sub_prop)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle)) {
return STATE_MQTT_INVALID_PROTOCOL_VERSION;
}
return _mqtt_sub_with_prop(mqtt_handle, topic, handler, qos, userdata, sub_prop);
}
static int32_t _core_mqtt_unsub(void *handle, core_mqtt_buff_t *topic, unsub_property_t *unsub_prop)
{
int32_t res = STATE_SUCCESS;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL || topic == NULL || topic->buffer == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (topic->len == 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
if ((res = _core_mqtt_topic_is_valid((char *)topic->buffer, topic->len)) < STATE_SUCCESS) {
return STATE_MQTT_TOPIC_INVALID;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
core_log2(mqtt_handle->sysdep, STATE_MQTT_LOG_TOPIC, "unsub: %.*s\r\n", &topic->len, topic->buffer);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->sub_mutex);
_core_mqtt_sublist_remove(mqtt_handle, topic);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->sub_mutex);
general_property_t general_property = {0};
if (NULL != unsub_prop) {
memcpy(&(general_property.user_property[0]), &(unsub_prop->user_property[0]),
USER_PROPERTY_MAX * (sizeof(user_property_t *)));
}
res = _core_mqtt_subunsub(mqtt_handle, (char *)topic->buffer, topic->len, 0, CORE_MQTT_UNSUB_PKT_TYPE,
&general_property);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
static int32_t _mqtt_unsub(void *handle, char *topic, unsub_property_t *unsub_prop)
{
core_mqtt_buff_t topic_buff;
if (NULL == topic) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (strlen(topic) >= CORE_MQTT_TOPIC_MAXLEN) {
return STATE_MQTT_TOPIC_TOO_LONG;
}
memset(&topic_buff, 0, sizeof(topic_buff));
topic_buff.buffer = (uint8_t *)topic;
topic_buff.len = strlen(topic);
return _core_mqtt_unsub(handle, &topic_buff, unsub_prop);
}
int32_t aiot_mqtt_unsub(void *handle, char *topic)
{
return _mqtt_unsub(handle, topic, NULL);
}
int32_t aiot_mqtt_unsub_with_prop(void *handle, char *topic, unsub_property_t *unsub_prop)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (0 == _core_mqtt_5_feature_is_enabled(mqtt_handle)) {
return STATE_MQTT_INVALID_PROTOCOL_VERSION;
}
return _mqtt_unsub(handle, topic, unsub_prop);
}
int32_t aiot_mqtt_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint32_t mqtt_remainlen = 0;
uint8_t mqtt_fixed_header[CORE_MQTT_FIXED_HEADER_LEN] = {0};
uint8_t mqtt_pkt_type = 0, mqtt_pkt_reserved = 0;
uint8_t *remain = NULL;
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (mqtt_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (mqtt_handle->exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_mqtt_exec_inc(mqtt_handle);
/* network error reconnect */
if (mqtt_handle->network_handle == NULL) {
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT);
}
if (mqtt_handle->reconnect_params.enabled == 1 && mqtt_handle->disconnect_api_called == 0) {
res = _core_mqtt_reconnect(mqtt_handle);
if (res < STATE_SUCCESS) {
if (res == STATE_MQTT_CONNECT_SUCCESS) {
mqtt_handle->heartbeat_params.lost_times = 0;
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "MQTT network reconnect success\r\n");
_core_mqtt_connect_event_notify(mqtt_handle);
res = STATE_SUCCESS;
} else {
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
}
}
/* heartbeat missing reconnect */
if (mqtt_handle->heartbeat_params.lost_times > mqtt_handle->heartbeat_params.max_lost_times) {
_core_mqtt_disconnect_event_notify(mqtt_handle, AIOT_MQTTDISCONNEVT_HEARTBEAT_DISCONNECT);
if (mqtt_handle->reconnect_params.enabled == 1 && mqtt_handle->disconnect_api_called == 0) {
core_log1(mqtt_handle->sysdep, STATE_MQTT_LOG_RECONNECTING, "MQTT heartbeat lost %d times, try to reconnecting...\r\n",
&mqtt_handle->heartbeat_params.lost_times);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
res = _core_mqtt_connect(mqtt_handle, NULL);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
if (res < STATE_SUCCESS) {
if (res == STATE_MQTT_CONNECT_SUCCESS) {
mqtt_handle->heartbeat_params.lost_times = 0;
core_log(mqtt_handle->sysdep, STATE_MQTT_LOG_CONNECT, "MQTT network reconnect success\r\n");
_core_mqtt_connect_event_notify(mqtt_handle);
res = STATE_SUCCESS;
} else {
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
}
}
}
/* Read Packet Type Of MQTT Fixed Header, Get And Remaining Packet Length */
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
res = _core_mqtt_read(handle, mqtt_fixed_header, CORE_MQTT_FIXED_HEADER_LEN, mqtt_handle->recv_timeout_ms);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
_core_mqtt_exec_dec(mqtt_handle);
if (res == STATE_SYS_DEPEND_NWK_READ_LESSDATA) {
res = STATE_SUCCESS;
} else {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
return res;
}
/* Read Remaining Packet Length Of MQTT Fixed Header */
res = _core_mqtt_read_remainlen(mqtt_handle, &mqtt_remainlen);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
/* Read Remaining Bytes */
res = _core_mqtt_read_remainbytes(handle, mqtt_remainlen, &remain);
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
/* Get Packet Type */
mqtt_pkt_type = mqtt_fixed_header[0] & 0xF0;
mqtt_pkt_reserved = mqtt_fixed_header[0] & 0x0F;
/* reset ping response missing times */
mqtt_handle->heartbeat_params.lost_times = 0;
switch (mqtt_pkt_type) {
case CORE_MQTT_PINGRESP_PKT_TYPE: {
res = _core_mqtt_pingresp_handler(mqtt_handle, remain, mqtt_remainlen);
}
break;
case CORE_MQTT_PUBLISH_PKT_TYPE: {
res = _core_mqtt_pub_handler(handle, remain, mqtt_remainlen, ((mqtt_pkt_reserved >> 1) & 0x03), mqtt_remainlen);
}
break;
case CORE_MQTT_PUBACK_PKT_TYPE: {
res = _core_mqtt_puback_handler(handle, remain, mqtt_remainlen);
}
break;
case CORE_MQTT_SUBACK_PKT_TYPE: {
_core_mqtt_subunsuback_handler(handle, remain, mqtt_remainlen, CORE_MQTT_SUBACK_PKT_TYPE);
}
break;
case CORE_MQTT_UNSUBACK_PKT_TYPE: {
_core_mqtt_subunsuback_handler(handle, remain, mqtt_remainlen, CORE_MQTT_UNSUBACK_PKT_TYPE);
}
break;
case CORE_MQTT_SERVER_DISCONNECT_PKT_TYPE: {
_core_mqtt_server_disconnect_handler(handle, remain, mqtt_remainlen);
}
break;
case CORE_MQTT_PUBREC_PKT_TYPE:
case CORE_MQTT_PUBREL_PKT_TYPE:
case CORE_MQTT_PUBCOMP_PKT_TYPE: {
}
break;
default: {
res = STATE_MQTT_PACKET_TYPE_UNKNOWN;
}
}
if (remain) {
mqtt_handle->sysdep->core_sysdep_free(remain);
}
if (res < STATE_SUCCESS) {
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->send_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_lock(mqtt_handle->recv_mutex);
if (mqtt_handle->network_handle != NULL) {
mqtt_handle->sysdep->core_sysdep_network_deinit(&mqtt_handle->network_handle);
}
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->recv_mutex);
mqtt_handle->sysdep->core_sysdep_mutex_unlock(mqtt_handle->send_mutex);
}
_core_mqtt_exec_dec(mqtt_handle);
return res;
}
char *core_mqtt_get_product_key(void *handle)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (handle == NULL) {
return NULL;
}
return mqtt_handle->product_key;
}
char *core_mqtt_get_device_name(void *handle)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (handle == NULL) {
return NULL;
}
return mqtt_handle->device_name;
}
uint16_t core_mqtt_get_port(void *handle)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (handle == NULL) {
return 0;
}
return mqtt_handle->port;
}
int32_t core_mqtt_get_nwkstats(void *handle, core_mqtt_nwkstats_info_t *nwk_stats_info)
{
core_mqtt_handle_t *mqtt_handle = (core_mqtt_handle_t *)handle;
if (handle == NULL) {
return 0;
}
memcpy(nwk_stats_info, &mqtt_handle->nwkstats_info, sizeof(core_mqtt_nwkstats_info_t));
mqtt_handle->nwkstats_info.failed_error_code = 0;
mqtt_handle->nwkstats_info.connect_time_used = 0;
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_mqtt_api.c | C | apache-2.0 | 141,397 |
/**
* @file aiot_mqtt_api.h
* @brief MQTT模块头文件, 提供用MQTT协议连接阿里云物联网平台的能力
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
* @details
*
* MQTT模块用于建立与阿里云物联网平台的连接, API使用流程如下:
*
* 1. 调用 @ref aiot_mqtt_init 初始化MQTT会话, 获取会话句柄
*
* 2. 调用 @ref aiot_mqtt_setopt 配置MQTT会话的参数, 常用配置项见 @ref aiot_mqtt_setopt 的说明
*
* 3. 调用 @ref aiot_mqtt_connect 建立与阿里云物联网平台的连接
*
* 4. 启动一个线程, 线程中间歇性调用 @ref aiot_mqtt_process 处理心跳和QoS1的消息
*
* 5. 启动一个线程, 线程中持续调用 @ref aiot_mqtt_recv 接收网络上的MQTT报文
*
* + 当接收到一条报文时, 按以下顺序检查当前MQTT会话的参数, 当满足某条的描述时, 会通过对应的回调函数进行通知, 并停止检查
*
* + 检查收到的报文topic是否已经通过 @ref aiot_mqtt_setopt 的 @ref AIOT_MQTTOPT_APPEND_TOPIC_MAP 参数配置回调函数
*
* + 检查收到的报文topic是否已经通过 @ref aiot_mqtt_sub API配置回调函数
*
* + 检查是否通过 @ref aiot_mqtt_setopt 的 @ref AIOT_MQTTOPT_RECV_HANDLER 参数配置默认回调函数
*
* 6. 经过以上步骤后, MQTT连接已建立并能保持与物联网平台的连接, 接下来按自己的场景用 @ref aiot_mqtt_sub 和 @ref aiot_mqtt_pub 等API实现业务逻辑即可
*
*/
#ifndef _AIOT_MQTT_API_H_
#define _AIOT_MQTT_API_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief MQTT报文类型
*
* @details
*
* 传入@ref aiot_mqtt_recv_handler_t 的MQTT报文类型
*/
typedef enum {
/**
* @brief MQTT PUBLISH报文
*/
AIOT_MQTTRECV_PUB,
/**
* @brief MQTT PINGRESP报文
*/
AIOT_MQTTRECV_HEARTBEAT_RESPONSE,
/**
* @brief MQTT SUBACK报文
*/
AIOT_MQTTRECV_SUB_ACK,
/**
* @brief MQTT UNSUB报文
*/
AIOT_MQTTRECV_UNSUB_ACK,
/**
* @brief MQTT PUBACK报文
*/
AIOT_MQTTRECV_PUB_ACK,
/**
* @brief MQTT CONACK报文
*/
AIOT_MQTTRECV_CON_ACK,
/**
* @brief MQTT SERVER DISCONNECT报文
*/
AIOT_MQTTRECV_DISCONNECT,
} aiot_mqtt_recv_type_t;
/**
* @brief MQTT协议版本
*
* @details
*
* 传入@ref aiot_mqtt_setopt 的MQTT协议版本号
*/
typedef enum {
AIOT_MQTT_VERSION_3_1,
AIOT_MQTT_VERSION_5_0
} aiot_mqtt_protocol_version;
/**
* @brief value-length 结构体.
*
* @details
*
* 用于MQTT 5.0协议中作为表示response topic/corelation data/disconnect reason等属性的通用的数据结构, 同时也是@ref user_property_t 的构成元素
*/
typedef struct {
uint16_t len;
uint8_t *value;
} len_value_t;
/**
* @brief MQTT 5.0协议中用户属性
*
* @details
*
* 作为@ref conn_property_t ,@ref pub_property_t ,@ref disconn_property_t 的结构体的成员
*
*/
typedef struct {
len_value_t key;
len_value_t value;
} user_property_t;
/* MQTT服务端支持的最大的用户属性的数目. */
#define USER_PROPERTY_MAX (20)
/**
* @brief MQTT 5.0协议中, 下行的conack报文conack中的属性
*/
typedef struct {
uint8_t max_qos;
uint16_t topic_alias_max;
uint8_t *assigned_clientid;
uint32_t max_packet_size;
uint16_t server_receive_max;
uint8_t wildcard_subscription_available;
uint8_t subscription_identifier_available;
uint8_t shared_subscription_available;
user_property_t *user_property[USER_PROPERTY_MAX];
} connack_property_t;
/**
* @brief MQTT 5.0协议中, 上行和下行pub报文中的属性.
*/
typedef struct {
uint32_t message_expire_interval;
uint16_t topic_alias;
len_value_t response_topic;
len_value_t correlation_data;
uint32_t subscription_identifier;
user_property_t *user_property[USER_PROPERTY_MAX];
} pub_property_t;
/**
* @brief MQTT 5.0协议中, 上行的connect报文中的属性.
*
* @details
*
* 传入@ref aiot_mqtt_connect_with_prop 的MQTT报文类型
*/
typedef struct {
uint16_t topic_alias_max; /* topic 别名最大数量 */
uint16_t client_receive_max;
user_property_t *user_property[USER_PROPERTY_MAX]; /* 用户属性 */
} conn_property_t;
/**
* @brief MQTT 5.0协议中, 上行的disconnect报文中的属性.
*
* @details
*
* 传入@ref aiot_mqtt_disconnect_with_prop 的MQTT报文类型
*
*/
typedef struct {
len_value_t *reason_string;
user_property_t *user_property[USER_PROPERTY_MAX]; /* 用户属性 */
} disconn_property_t;
/**
* @brief MQTT 5.0协议中, 上行的subscribe报文中的属性.
*
* @details
*
* 传入@ref aiot_mqtt_sub_with_prop 的MQTT报文类型
*
*/
typedef struct {
user_property_t *user_property[USER_PROPERTY_MAX];
} sub_property_t;
/**
* @brief MQTT 5.0协议中, 上行的subscribe报文中的属性.
*
* @details
*
* 传入@ref aiot_mqtt_unsub_with_prop 的MQTT报文类型
*
*/
typedef struct {
user_property_t *user_property[USER_PROPERTY_MAX];
} unsub_property_t;
typedef struct {
/**
* @brief MQTT报文类型, 更多信息请参考@ref aiot_mqtt_recv_type_t
*/
aiot_mqtt_recv_type_t type;
/**
* @brief MQTT报文联合体, 内容根据type进行选择
*/
union {
/**
* @brief MQTT PUBLISH报文
*/
struct {
uint8_t qos;
char *topic;
uint16_t topic_len;
uint8_t *payload;
uint32_t payload_len;
pub_property_t *pub_prop; /* pub报文中的属性. MQTT 5.0 特性*/
} pub;
/**
* @brief AIOT_MQTTRECV_SUB_ACK
*/
struct {
int32_t res;
uint8_t max_qos;
uint16_t packet_id;
} sub_ack;
/**
* @brief AIOT_MQTTRECV_UNSUB_ACK
*/
struct {
uint16_t packet_id;
} unsub_ack;
/**
* @brief AIOT_MQTTRECV_PUB_ACK
*/
struct {
uint16_t packet_id;
} pub_ack;
/**
* @brief AIOT_MQTTRECV_CON_ACK
*/
struct {
uint8_t reason_code;
connack_property_t prop; /* 建连回复报文中的属性. MQTT 5.0 特性 */
} con_ack;
/**
* @brief AIOT_MQTTRECV_DISCONNECT. MQTT 5.0特性.
*/
struct {
uint8_t reason_code;
} server_disconnect;
} data;
} aiot_mqtt_recv_t;
/**
* @brief MQTT报文接收回调函数原型
*
* @param[in] handle MQTT实例句柄
* @param[in] packet MQTT报文结构体, 存放收到的MQTT报文
* @param[in] userdata 用户上下文
*
* @return void
*/
typedef void (*aiot_mqtt_recv_handler_t)(void *handle, const aiot_mqtt_recv_t *packet, void *userdata);
/**
* @brief MQTT内部事件类型
*/
typedef enum {
/**
* @brief 当MQTT实例第一次连接网络成功时, 触发此事件
*/
AIOT_MQTTEVT_CONNECT,
/**
* @brief 当MQTT实例断开网络连接后重连成功时, 触发此事件
*/
AIOT_MQTTEVT_RECONNECT,
/**
* @brief 当MQTT实例断开网络连接时, 触发此事件
*/
AIOT_MQTTEVT_DISCONNECT
} aiot_mqtt_event_type_t;
typedef enum {
/**
* @brief MQTT实例网络连接由于网络故障而断开
*/
AIOT_MQTTDISCONNEVT_NETWORK_DISCONNECT,
/**
* @brief MQTT实例网络连接由于心跳丢失超过指定次数(@ref AIOT_MQTTOPT_HEARTBEAT_MAX_LOST )而断开
*/
AIOT_MQTTDISCONNEVT_HEARTBEAT_DISCONNECT
} aiot_mqtt_disconnect_event_type_t;
/**
* @brief MQTT内部事件
*/
typedef struct {
/**
* @brief MQTT内部事件类型. 更多信息请参考@ref aiot_mqtt_event_type_t
*
*/
aiot_mqtt_event_type_t type;
/**
* @brief MQTT事件数据联合体
*/
union {
/**
* @brief MQTT连接断开时, 具体的断开原因
*/
aiot_mqtt_disconnect_event_type_t disconnect;
} data;
} aiot_mqtt_event_t;
/**
* @brief MQTT事件回调函数
*
* @details
*
* 当MQTT内部事件被触发时, 调用此函数. 如连接成功/断开连接/重连成功
*
*/
typedef void (*aiot_mqtt_event_handler_t)(void *handle, const aiot_mqtt_event_t *event, void *userdata);
/**
* @brief 使用 @ref aiot_mqtt_setopt 配置 @ref AIOT_MQTTOPT_APPEND_TOPIC_MAP 时的数据
*
* @details
*
* 用于在建立MQTT连接前配置topic与相应的回调函数
*
*/
typedef struct {
char *topic;
aiot_mqtt_recv_handler_t handler;
void *userdata;
} aiot_mqtt_topic_map_t;
/**
* @brief @ref aiot_mqtt_setopt 函数的option参数. 对于下文每一个选项中的数据类型, 指的是@ref aiot_mqtt_setopt 中的data参数的数据类型
*
* @details
*
* 1. data的数据类型是char *时, 以配置@ref AIOT_MQTTOPT_HOST 为例:
*
* char *host = "xxx";
*
* aiot_mqtt_setopt(mqtt_handle, AIOT_MQTTOPT_HOST, host);
*
* 2. data的数据类型是其他数据类型时, 以配置@ref AIOT_MQTTOPT_PORT 为例:
*
* uint16_t port = 443;
*
* aiot_mqtt_setopt(mqtt_handle, AIOT_MQTTOPT_PORT, (void *)&port);
*/
typedef enum {
/**
* @brief MQTT 服务器的域名地址或者ip地址
*
* @details
*
* 阿里云物联网平台域名地址列表(必须使用自己的product key替换${pk}):
*
* 使用tcp或tls证书方式建联:
*
* | 域名地址 | 区域 | 端口号
* |-------------------------------------------------|---------|---------
* | ${pk}.iot-as-mqtt.cn-shanghai.aliyuncs.com | 上海 | 443
* | ${pk}.iot-as-mqtt.ap-southeast-1.aliyuncs.com | 新加坡 | 443
* | ${pk}.iot-as-mqtt.ap-northeast-1.aliyuncs.com | 日本 | 443
* | ${pk}.iot-as-mqtt.us-west-1.aliyuncs.com | 美西 | 443
* | ${pk}.iot-as-mqtt.eu-central-1.aliyuncs.com | 德国 | 443
*
* 使用tls psk方式建联:
*
* | 域名地址 | 区域 | 端口号
* |-----------------------------------------|---------|---------
* | ${pk}.itls.cn-shanghai.aliyuncs.com | 上海 | 1883
*
* 使用tls x509客户端证书方式建联:
*
* | 域名地址 | 区域 | 端口号
* |-------------------------------------|---------|---------
* | x509.itls.cn-shanghai.aliyuncs.com | 上海 | 1883
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_HOST,
/**
* @brief MQTT 服务器的端口号
*
* @details
*
* 连接阿里云物联网平台时:
*
* 1. 如果使用的是tcp或者tls证书方式, 端口号设置为443
*
* 2. 如果使用的是tls psk和tls x509客户端证书方式, 端口号设置为1883
*
* 数据类型: (uint16_t *)
*/
AIOT_MQTTOPT_PORT,
/**
* @brief 设备的product key, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_PRODUCT_KEY,
/**
* @brief 设备的device name, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_DEVICE_NAME,
/**
* @brief 设备的device secret, 可从<a href="http://iot.console.aliyun.com/">阿里云物联网平台控制台</a>获取
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_DEVICE_SECRET,
/**
* @brief 设备连接阿里云物联网平台时的扩展clientid
*
* @details
*
* 若需要上报模组商id和模组id以及os信息, 按以下格式填写:
*
* "mid=<模组ID>,pid=<模组商ID>,os=<操作系统>"
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_EXTEND_CLIENTID,
/**
* @brief 设备连接阿里云物联网平台时的安全模式, 使用标准的tcp或tls时无需配置
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_SECURITY_MODE,
/**
* @brief 使用自定义连接凭据连接mqtt服务器时, 凭据的username
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_USERNAME,
/**
* @brief 使用自定义连接凭据连接mqtt服务器时, 凭据的password
*
* @brief
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_PASSWORD,
/**
* @brief 使用自定义连接凭据连接mqtt服务器时, 凭据的clientid
*
* @details
*
* 数据类型: (char *)
*/
AIOT_MQTTOPT_CLIENTID,
/**
* @brief MQTT建联时, CONNECT报文中的心跳间隔参数
*
* @details
*
* 受阿里云物联网平台限制, 取值范围为30 ~ 1200s
*
* 1. 如果设置的值小于30, mqtt建联会被云端拒绝, @ref aiot_mqtt_connect 函数会返回@ref STATE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE 错误
*
* 2. 如果设置的值大于1200, mqtt连接仍然可以建立, 但此参数会被服务器覆盖为1200
*
* 数据类型: (uint16_t *) 取值范围: 30 ~ 1200s 默认值: 1200s
*/
AIOT_MQTTOPT_KEEPALIVE_SEC,
/**
* @brief MQTT建联时, CONNECT报文中的clean session参数
*
* @details
*
* 1. 设备上线时如果clean session为0, 那么上线前服务器推送QoS1的消息会在此时推送给设备
*
* 2. 设备上线时如果clean session为1, 那么上线前服务器推送的QoS1的消息会被丢弃
*
* 数据类型: (uint8_t *) 取值范围: 0, 1 默认值: 1
*/
AIOT_MQTTOPT_CLEAN_SESSION,
/**
* @brief MQTT建联时, 网络使用的安全凭据
*
* @details
*
* 该配置项用于为底层网络配置@ref aiot_sysdep_network_cred_t 安全凭据数据
*
* 1. 若该选项不配置, 那么MQTT将以tcp方式直接建联
*
* 2. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_NONE , MQTT将以tcp方式直接建联
*
* 3. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA , MQTT将以tls方式建联
*
* 4. 若@ref aiot_sysdep_network_cred_t 中option配置为@ref AIOT_SYSDEP_NETWORK_CRED_SVRCERT_PSK , MQTT将以tls psk方式建联
*
* 数据类型: (aiot_sysdep_network_cred_t *)
*/
AIOT_MQTTOPT_NETWORK_CRED,
/**
* @brief MQTT建联时, 建立网络连接的超时时间
*
* @details
*
* 指建立socket连接的超时时间
*
* 数据类型: (uint32_t *) 默认值: (5 *1000) ms
*
*/
AIOT_MQTTOPT_CONNECT_TIMEOUT_MS,
/**
* @brief 配置MQTT PINGREQ报文发送时间间隔. (心跳发送间隔)
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (25 * 1000) ms
*/
AIOT_MQTTOPT_HEARTBEAT_INTERVAL_MS,
/**
* @brief 配置MQTT PINGRESP报文允许连续丢失的最大次数, 当超过这个次数时, 触发重连机制
*
* @details
*
* 数据类型: (uint8_t *) 默认值: (2)
*/
AIOT_MQTTOPT_HEARTBEAT_MAX_LOST,
/**
* @brief 打开/关闭MQTT重连机制
*
* @details
*
* 数据类型: (uint8_t *) 取值范围: 0, 1 默认值: 1
*/
AIOT_MQTTOPT_RECONN_ENABLED,
/**
* @brief 当由于心跳丢失或者网络断开触发重连机制时, 尝试重连的时间间隔
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_MQTTOPT_RECONN_INTERVAL_MS,
/**
* @brief MQTT发送数据时, 在协议栈花费的最长时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_MQTTOPT_SEND_TIMEOUT_MS,
/**
* @brief MQTT接收数据时, 在协议栈花费的最长时间
*
* @details
*
* 数据类型: (uint32_t *) 默认值: (5 * 1000) ms
*/
AIOT_MQTTOPT_RECV_TIMEOUT_MS,
/**
* @brief QoS1消息重发间隔
*
* @details
*
* 当发送qos1 MQTT PUBLISH报文后, 如果在@ref AIOT_MQTTOPT_REPUB_TIMEOUT_MS 时间内未收到mqtt PUBACK报文,
* @ref aiot_mqtt_process 会重新发送此qo1 MQTT PUBLISH报文, 直到收到PUBACK报文为止
*
* 数据类型: (uint32_t *) 默认值: (3 * 1000) ms
*/
AIOT_MQTTOPT_REPUB_TIMEOUT_MS,
/**
* @brief 销毁MQTT实例时, 等待其他api执行完毕的时间
*
* @details
*
* 当调用@ref aiot_mqtt_deinit 销毁MQTT实例时, 若继续调用其他aiot_mqtt_xxx API, API会返回@ref STATE_USER_INPUT_EXEC_DISABLED 错误
*
* 此时, 用户应该停止调用其他aiot_mqtt_xxx API
*
* 数据类型: (uint32_t *) 默认值: (2 * 1000) ms
*/
AIOT_MQTTOPT_DEINIT_TIMEOUT_MS,
/**
* @brief 从MQTT服务器收取的数据从此默认回调函数进行通知
*
* @details
*
* 1. 若没有配置该回调函数, 当有消息到达但找不到对应的已注册topic时, 消息会被丢弃
*
* 2. 若已配置该回调函数, 当有消息到达但找不到对应的已注册topic时, 消息从此默认回调函数进行通知
*
* 数据类型: ( @ref aiot_mqtt_recv_handler_t )
*/
AIOT_MQTTOPT_RECV_HANDLER,
/**
* @brief MQTT客户端内部发生的事件会从此回调函数进行通知, 如上线/断线/重新上线
*
* @details
*
* 数据类型: ( @ref aiot_mqtt_event_handler_t )
*/
AIOT_MQTTOPT_EVENT_HANDLER,
/**
* @brief 可在MQTT建立连接之前配置MQTT topic与其对应的回调函数
*
* @details
*
* 数据类型: ( @ref aiot_mqtt_topic_map_t )
*/
AIOT_MQTTOPT_APPEND_TOPIC_MAP,
/**
* @brief 取消之前建立的MQTT topic与其回调函数的对应关系
*
* @details
*
* 数据类型: ( @ref aiot_mqtt_topic_map_t )
*/
AIOT_MQTTOPT_REMOVE_TOPIC_MAP,
/**
* @brief 在publish消息的topic上附加请求ID字符串, 用于全链路日志追踪
*
* @details
*
* 数据类型: (uint8_t *) 默认值: 0
*
* 配置为0则不附加请求ID字符串, 配置为1将附加请求ID字符串
*/
AIOT_MQTTOPT_APPEND_REQUESTID,
/**
* @brief 用户需要SDK暂存的上下文
*
* @details
*
* 1. 该上下文会在@ref AIOT_MQTTOPT_RECV_HANDLER 和@ref AIOT_MQTTOPT_EVENT_HANDLER 中传回给用户
*
* 2. 当使用@ref AIOT_MQTTOPT_APPEND_TOPIC_MAP 或者@ref aiot_mqtt_sub 时未指定userdata, 该上下文也会传给这些回调函数
*
* 数据类型: (void *)
*/
AIOT_MQTTOPT_USERDATA,
/**
* @brief 设置MQTT 协议的版本号
*
* @details
*
* 1. 默认协议版本号是3.1.1
*
* 2. 用户可以使用该选项将版本号设置为AIOT_MQTT_VERSION_5_0
*
* 数据类型: (void *)
*/
AIOT_MQTTOPT_VERSION,
/**
* @brief MQTT 5.0特性. 设置是否要使能assigned clentid功能
*
* @details
*
* 1. 默认不使能
*
* 2. 用户可以设置值1将该功能使能
*
* 数据类型: (void *)
*/
AIOT_MQTTOPT_ASSIGNED_CLIENTID,
/**
* @brief MQTT 5.0特性. 设置是否要使能设备端流控功能
*
* @details
*
* 1. 默认不使能
*
* 2. 用户可以设置值1将该功能使能
*
* 数据类型: (void *)
*/
AIOT_MQTTOPT_FLOW_CONTROL_ENABLED,
AIOT_MQTTOPT_MAX
} aiot_mqtt_option_t;
/**
* @brief 初始化mqtt实例并设置默认参数
*
* @return void*
* @retval 非NULL MQTT实例句柄
* @retval NULL 初始化失败, 一般是内存分配失败导致
*
*/
void *aiot_mqtt_init(void);
/**
* @brief 设置mqtt参数
*
* @details
*
* 下面列出常用的配置选项, 至少需要配置以下选项才可使用MQTT的基本功能
*
* 其余配置选项均设有默认值, 可按业务需要进行调整
*
* + `AIOT_MQTTOPT_HOST`: 配置连接的阿里云MQTT站点地址
*
* + `AIOT_MQTTOPT_PORT`: 配置连接的阿里云MQTT站点端口号
*
* + `AIOT_MQTTOPT_PRODUCT_KEY`: 配置设备的 productKey
*
* + `AIOT_MQTTOPT_DEVICE_NAME`: 配置设备的 deviceName
*
* + `AIOT_MQTTOPT_DEVICE_SECRET`: 配置设备的 deviceSecret
*
* + `AIOT_MQTTOPT_NETWORK_CRED`: 配置建立MQTT连接时的安全凭据
*
* + `AIOT_MQTTOPT_RECV_HANDLER`: 配置默认的数据接收回调函数
*
* + `AIOT_MQTTOPT_EVENT_HANDLER`: 配置MQTT事件通知回调函数
*
* @param[in] handle mqtt句柄
* @param[in] option 配置选项, 更多信息请参考@ref aiot_mqtt_option_t
* @param[in] data 配置选项数据, 更多信息请参考@ref aiot_mqtt_option_t
*
* @return int32_t
* @retval <STATE_SUCCESS 参数设置失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 参数设置成功
*
*/
int32_t aiot_mqtt_setopt(void *handle, aiot_mqtt_option_t option, void *data);
/**
* @brief 释放mqtt实例句柄的资源
*
* @param[in] handle 指向mqtt实例句柄的指针
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*
*/
int32_t aiot_mqtt_deinit(void **handle);
/**
* @brief 与MQTT服务器建立连接
*
* @details
*
* 使用@ref aiot_mqtt_setopt 配置的mqtt连接参数连接mqtt服务器, 使用的建联参数按如下顺序选择
*
* 1. 若配置了以下选项, 直接用配置的连接参数连接 @ref AIOT_MQTTOPT_HOST 选项指定的任意MQTT服务器
*
* + @ref AIOT_MQTTOPT_USERNAME
* + @ref AIOT_MQTTOPT_PASSWORD
* + @ref AIOT_MQTTOPT_CLIENTID
*
* 2. 若配置了以下选项, 则强制以阿里云平台的签名算法计算连接参数作为MQTT的用户名/密码, 连接阿里云平台
*
* + @ref AIOT_MQTTOPT_PRODUCT_KEY
* + @ref AIOT_MQTTOPT_DEVICE_NAME
* + @ref AIOT_MQTTOPT_DEVICE_SECRET
*
* @param[in] handle MQTT实例句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*
* @note
*
* 当配置@ref AIOT_MQTTOPT_USERNAME , @ref AIOT_MQTTOPT_PASSWORD 和@ref AIOT_MQTTOPT_CLIENTID 配置自定义连接凭据时,
*
* 此函数会忽略@ref AIOT_MQTTOPT_PRODUCT_KEY , @ref AIOT_MQTTOPT_DEVICE_NAME 和@ref AIOT_MQTTOPT_DEVICE_SECRET,
*
* 直接使用自定义凭据连接指定的MQTT服务器
*/
int32_t aiot_mqtt_connect(void *handle);
/**
* @brief 与MQTT服务器断开连接
*
* @details
*
* 向MQTT服务器发送MQTT DISCONNECT报文, 然后断开网络连接
*
* 如果需要再次与MQTT服务器建立连接, 调用@ref aiot_mqtt_connect 即可
*
* @param[in] handle MQTT实例句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_disconnect(void *handle);
/**
* @brief 发送MQTT PINGREQ报文, 用于维持心跳
*
* @details
*
* @ref aiot_mqtt_process 包含了定时发送心跳的机制, 如果有特殊需要的话, 可以使用此函数直接发送心跳报文
*
* @param[in] handle MQTT实例句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_heartbeat(void *handle);
/**
* @brief 此函数用于处理定时心跳发送和qos1消息的重传逻辑
*
* @details
*
* 1. 发送心跳至mqtt broker以维护mqtt连接, 心跳发送间隔由@ref AIOT_MQTTOPT_HEARTBEAT_INTERVAL_MS 配置项控制
*
* 2. 如果一条qos1的mqtt PUBLISH报文在@ref AIOT_MQTTOPT_REPUB_TIMEOUT_MS 时间内没有收到mqtt PUBACK应答报文, 该函数会重发此消息, 直到成功为止
*
* @param[in] handle MQTT实例句柄
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*
* @note
*
* 该函数为非阻塞, 需要间歇性被调用, 调用间隔应当小于@ref AIOT_MQTTOPT_HEARTBEAT_INTERVAL_MS 和@ref AIOT_MQTTOPT_REPUB_TIMEOUT_MS 时间内没有收到mqtt的最小值,
*
* 以确保心跳发送和QoS1消息的重传逻辑正常工作
*/
int32_t aiot_mqtt_process(void *handle);
/**
* @brief 发送一条PUBLISH报文到MQTT服务器, QoS为0, 用于发布指定的消息
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT PUBLISH报文的topic
* @param[in] payload 指定MQTT PUBLISH报文的payload
* @param[in] payload_len 指定MQTT PUBLISH报文的payload_len
* @param[in] qos 指定mqtt的qos值, 仅支持qos0和qos1
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_pub(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos);
/**
* @brief 发送一条mqtt SUBSCRIBE报文到MQTT服务器, 用于订阅指定的topic
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT SUBSCRIBE报文的topic
* @param[in] handler 与topic对应的MQTT PUBLISH报文回调函数, 当有消息发布到topic时, 该回调函数被调用
若handler为NULL传入, 则SDK调用@ref AIOT_MQTTOPT_RECV_HANDLER 配置的回调函数
若多次调用aiot_mqtt_sub()并对同一topic指定不同的handler, 有消息到达时不同handler都会被调用到
* @param[in] qos 指定topic期望mqtt服务器支持的最大qos值, 仅支持qos0和qos1
* @param[in] userdata 可让SDK代为保存的用户上下文, 当回调函数被调用时, 此上下文会通过handler传回给用户
* 若未指定该上下文, 那么通过@ref AIOT_MQTTOPT_USERDATA 配置的上下文会通过handler传回给用户
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_sub(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos, void *userdata);
/**
* @brief 发送一条mqtt UNSUBSCRIBE报文到MQTT服务器, 用于取消订阅指定的topic
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT UNSUBSCRIBE报文的topic
*
* @return int32_t
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_unsub(void *handle, char *topic);
/**
* @brief 尝试从网络上接收MQTT报文
*
* @details
*
* 除了从网络上接收MQTT报文之外, 本函数也包含了重连机制
*
* 1. 当MQTT心跳丢失超过@ref AIOT_MQTTOPT_HEARTBEAT_MAX_LOST 配置的次数时, 触发重连机制
*
* + 重连间隔由 @ref AIOT_MQTTOPT_RECONN_INTERVAL_MS 指定
*
* 2. 当SDK检测到网络断开时, 触发重连机制
*
* + 重连间隔由 @ref AIOT_MQTTOPT_RECONN_INTERVAL_MS 指定
*
* @param[in] handle
*
* @retval STATE_SYS_DEPEND_NWK_READ_LESSDATA 执行成功, 此时网络上暂无可以收取的MQTT报文
* @retval >=STATE_SUCCESS 执行成功
* @retval 其他返回值 执行失败, 更多信息请参考@ref aiot_state_api.h
*
* @note
*
* 当网络连接正常并且@ref aiot_mqtt_deinit 未被调用时, 该函数为阻塞, 需要持续被调用
*
* 1. 当网络连接断开时, 该函数会立即返回, 此时返回值为@ref STATE_SYS_DEPEND_NWK_CLOSED
*
* 2. 当@ref aiot_mqtt_deinit 被调用时, 该函数会立即返回, 此时返回值为@ref STATE_USER_INPUT_EXEC_DISABLED
*/
int32_t aiot_mqtt_recv(void *handle);
/**
* @brief 与MQTT服务器建立连接. 以MQTT 5.0协议的方式接入, 支持5.0的特性.
* 在调用这个接口前, 需要确保已经通过AIOT_MQTTOPT_VERSION的方式, 设置过版本号为AIOT_MQTT_VERSION_5_0
* @details
*
* 使用@ref aiot_mqtt_setopt 配置的mqtt连接参数连接mqtt服务器, 使用的建联参数按如下顺序选择
*
* 1. 若配置了以下选项, 直接用配置的连接参数连接 @ref AIOT_MQTTOPT_HOST 选项指定的任意MQTT服务器
*
* + @ref AIOT_MQTTOPT_USERNAME
* + @ref AIOT_MQTTOPT_PASSWORD
* + @ref AIOT_MQTTOPT_CLIENTID
*
* 2. 若配置了以下选项, 则强制以阿里云平台的签名算法计算连接参数作为MQTT的用户名/密码, 连接阿里云平台
*
* + @ref AIOT_MQTTOPT_PRODUCT_KEY
* + @ref AIOT_MQTTOPT_DEVICE_NAME
* + @ref AIOT_MQTTOPT_DEVICE_SECRET
*
* @param[in] handle MQTT实例句柄
* @param[in] conn_prop 指定MQTT CONNECT报文的属性
*
* @return int32_t
* @retval STATE_MQTT_INVALID_PROTOCOL_VERSION mqtt协议的版本号不对, 没有通过AIOT_MQTTOPT_VERSION将版本号将设置为5.0
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*
* @note
*
* 当配置@ref AIOT_MQTTOPT_USERNAME , @ref AIOT_MQTTOPT_PASSWORD 和@ref AIOT_MQTTOPT_CLIENTID 配置自定义连接凭据时,
*
* 此函数会忽略@ref AIOT_MQTTOPT_PRODUCT_KEY , @ref AIOT_MQTTOPT_DEVICE_NAME 和@ref AIOT_MQTTOPT_DEVICE_SECRET,
*
* 直接使用自定义凭据连接指定的MQTT服务器
*/
int32_t aiot_mqtt_connect_with_prop(void *handle, conn_property_t *conn_prop);
/**
* @brief 发送一条PUBLISH报文到MQTT服务器, QoS为0, 用于发布指定的消息
* 以MQTT 5.0协议的方式接入, 支持5.0的特性.
* 在调用这个接口前, 需要确保已经通过AIOT_MQTTOPT_VERSION的方式, 设置过版本号为AIOT_MQTT_VERSION_5_0
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT PUBLISH报文的topic
* @param[in] payload 指定MQTT PUBLISH报文的payload
* @param[in] payload_len 指定MQTT PUBLISH报文的payload_len
* @param[in] qos 指定mqtt的qos值, 仅支持qos0和qos1
* @param[in] pub_prop 指定MQTT PUB报文的属性
*
* @return int32_t
* @retval STATE_MQTT_INVALID_PROTOCOL_VERSION mqtt协议的版本号不对, 没有通过AIOT_MQTTOPT_VERSION将版本号将设置为5.0
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_pub_with_prop(void *handle, char *topic, uint8_t *payload, uint32_t payload_len, uint8_t qos,
pub_property_t *pub_prop);
/**
* @brief 与MQTT服务器断开连接
* 以MQTT 5.0协议的方式接入, 支持5.0的特性.
* 在调用这个接口前, 需要确保已经通过AIOT_MQTTOPT_VERSION的方式, 设置过版本号为AIOT_MQTT_VERSION_5_0
* @details
*
* 向MQTT服务器发送MQTT DISCONNECT报文, 然后断开网络连接
*
* 如果需要再次与MQTT服务器建立连接, 调用@ref aiot_mqtt_connect 即可
*
* @param[in] handle MQTT实例句柄
* @param[in] reason_code 指定MQTT DISCONNECT的原因
* @param[in] disconn_property 指定MQTT DISCONNECT报文的属性
*
* @return int32_t
* @retval STATE_MQTT_INVALID_PROTOCOL_VERSION mqtt协议的版本号不对, 没有通过AIOT_MQTTOPT_VERSION将版本号将设置为5.0
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_disconnect_with_prop(void *handle, uint8_t reason_code, disconn_property_t *disconn_property);
/**
* @brief 发送一条mqtt SUBSCRIBE报文到MQTT服务器, 用于订阅指定的topic
* 以MQTT 5.0协议的方式接入, 支持5.0的特性.
* 在调用这个接口前, 需要确保已经通过AIOT_MQTTOPT_VERSION的方式, 设置过版本号为AIOT_MQTT_VERSION_5_0
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT SUBSCRIBE报文的topic
* @param[in] handler 与topic对应的MQTT PUBLISH报文回调函数, 当有消息发布到topic时, 该回调函数被调用
若handler为NULL传入, 则SDK调用@ref AIOT_MQTTOPT_RECV_HANDLER 配置的回调函数
若多次调用aiot_mqtt_sub()并对同一topic指定不同的handler, 有消息到达时不同handler都会被调用到
* @param[in] qos 指定topic期望mqtt服务器支持的最大qos值, 仅支持qos0和qos1
* @param[in] userdata 可让SDK代为保存的用户上下文, 当回调函数被调用时, 此上下文会通过handler传回给用户
* 若未指定该上下文, 那么通过@ref AIOT_MQTTOPT_USERDATA 配置的上下文会通过handler传回给用户
* @param[in] sub_prop 指定MQTT SUBSCRIBE报文的属性
*
* @return int32_t
* @retval STATE_MQTT_INVALID_PROTOCOL_VERSION mqtt协议的版本号不对, 没有通过AIOT_MQTTOPT_VERSION将版本号将设置为5.0
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_sub_with_prop(void *handle, char *topic, aiot_mqtt_recv_handler_t handler, uint8_t qos,
void *userdata, sub_property_t *sub_prop);
/**
* @brief 发送一条mqtt UNSUBSCRIBE报文到MQTT服务器, 用于取消订阅指定的topic
* 以MQTT 5.0协议的方式接入, 支持5.0的特性.
* 在调用这个接口前, 需要确保已经通过AIOT_MQTTOPT_VERSION的方式, 设置过版本号为AIOT_MQTT_VERSION_5_0
*
* @param[in] handle MQTT实例句柄
* @param[in] topic 指定MQTT UNSUBSCRIBE报文的topic
* @param[in] unsub_prop 指定MQTT UNSUBSCRIBE报文的属性
*
* @return int32_t
* @retval STATE_MQTT_INVALID_PROTOCOL_VERSION mqtt协议的版本号不对, 没有通过AIOT_MQTTOPT_VERSION将版本号将设置为5.0
* @retval <STATE_SUCCESS 执行失败, 更多信息请参考@ref aiot_state_api.h
* @retval >=STATE_SUCCESS 执行成功
*/
int32_t aiot_mqtt_unsub_with_prop(void *handle, char *topic, unsub_property_t *unsub_prop);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_mqtt_api.h | C | apache-2.0 | 34,365 |
/**
* @file aiot_state_api.c
* @brief 状态码模块实现
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#include "core_stdinc.h"
#include "aiot_state_api.h"
aiot_state_logcb_t g_logcb_handler = NULL;
int32_t aiot_state_set_logcb(aiot_state_logcb_t handler)
{
g_logcb_handler = handler;
return 0;
}
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_state_api.c | C | apache-2.0 | 366 |
/**
* @file aiot_state_api.h
* @brief SDK Core状态码头文件, 所有Core中的api返回值均在此列出
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#ifndef _AIOT_STATE_API_H_
#define _AIOT_STATE_API_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
/**
* @brief SDK的日志信息输出回调函数原型
*/
typedef int32_t (* aiot_state_logcb_t)(int32_t code, char *message);
/**
* @brief 设置SDK的日志信息输出使用的回调函数
*
* @param handler 日志回调函数
*
* @return int32_t 保留
*/
int32_t aiot_state_set_logcb(aiot_state_logcb_t handler);
/**
* @brief API执行成功
*
*/
#define STATE_SUCCESS (0x0000)
/**
* @brief -0x0100~-0x01FF表达SDK检查用户输入参数时反馈的状态码
*
*/
#define STATE_USER_INPUT_BASE (-0x0100)
/**
* @brief 用户输入参数中包含非法的空指针
*
*/
#define STATE_USER_INPUT_NULL_POINTER (-0x0101)
/**
* @brief 用户输入参数中包含越界的值
*
*/
#define STATE_USER_INPUT_OUT_RANGE (-0x0102)
/**
* @brief 用户输入的配置项不能被SDK的模块所理解
*
*/
#define STATE_USER_INPUT_UNKNOWN_OPTION (-0x0103)
/**
* @brief 用户输入参数中缺少productKey
*
*/
#define STATE_USER_INPUT_MISSING_PRODUCT_KEY (-0x0104)
/**
* @brief 用户输入参数中缺少deviceName
*
*/
#define STATE_USER_INPUT_MISSING_DEVICE_NAME (-0x0105)
/**
* @brief 用户输入参数中缺少deviceSecret
*
*/
#define STATE_USER_INPUT_MISSING_DEVICE_SECRET (-0x0106)
/**
* @brief 用户输入参数中缺少productSecret
*
*/
#define STATE_USER_INPUT_MISSING_PRODUCT_SECRET (-0x0107)
/**
* @brief 用户输入参数中缺少域名地址或IP地址
*
*/
#define STATE_USER_INPUT_MISSING_HOST (-0x0108)
/**
* @brief 用户已调用销毁函数销毁了实例(如@ref aiot_mqtt_deinit), 其余对该实例操作的API不应该再被调用
*
*/
#define STATE_USER_INPUT_EXEC_DISABLED (-0x0109)
/**
* @brief 用户输入的JSON字符串解析失败
*
*/
#define STATE_USER_INPUT_JSON_PARSE_FAILED (-0x010A)
/**
* @brief -0x0200~-0x02FF表达SDK调用系统依赖函数时反馈的状态码
*
*/
#define STATE_SYS_DEPEND_BASE (-0x0200)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_malloc 申请内存失败
*
*/
#define STATE_SYS_DEPEND_MALLOC_FAILED (-0x0201)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_setopt 的某个cred之外的入参非法
*
*/
#define STATE_SYS_DEPEND_NWK_INVALID_OPTION (-0x0202)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_establish 建立网络失败
*
*/
#define STATE_SYS_DEPEND_NWK_EST_FAILED (-0x0203)
/**
* @brief SDK检测到网络已断开
*
*/
#define STATE_SYS_DEPEND_NWK_CLOSED (-0x0204)
/**
* @brief SDK从网络上实际读取的数据比期望读取的少
*
*/
#define STATE_SYS_DEPEND_NWK_READ_LESSDATA (-0x0205)
/**
* @brief SDK向网络上写入的实际数据比期望写入的少
*
*/
#define STATE_SYS_DEPEND_NWK_WRITE_LESSDATA (-0x0206)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_recv 超时返回
*
*/
#define STATE_SYS_DEPEND_NWK_READ_OVERTIME (-0x0207)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_setopt 的cred入参非法
*
*/
#define STATE_SYS_DEPEND_NWK_INVALID_CRED (-0x0208)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_send 发送数据遭遇异常
*
*/
#define STATE_SYS_DEPEND_NWK_SEND_ERR (-0x0209)
/**
* @brief @ref aiot_sysdep_portfile_t::core_sysdep_network_recv 接收数据遭遇异常
*
*/
#define STATE_SYS_DEPEND_NWK_RECV_ERR (-0x020A)
/**
* @brief -0x0300~-0x03FF表达SDK在MQTT模块内的状态码
*
*/
#define STATE_MQTT_BASE (-0x0300)
/**
* @brief MQTT尝试建立连接时, 从服务端返回的CONNACK报文格式错误
*
*/
#define STATE_MQTT_CONNACK_FMT_ERROR (-0x0301)
/**
* @brief MQTT建连时, 服务端报错与当前客户端使用的MQTT协议版本不兼容
*
*/
#define STATE_MQTT_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION (-0x0302)
/**
* @brief MQTT建连时, 服务端报错服务不可用, 可能是clientId取值不正确或心跳间隔不合理
*
*/
#define STATE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE (-0x0303)
/**
* @brief MQTT建连时, 服务端返回用户名密码不合法
*
*/
#define STATE_MQTT_CONNACK_RCODE_BAD_USERNAME_PASSWORD (-0x0304)
/**
* @brief MQTT建连时, 服务端返回认证失败, 用户名或者密码错误, 一般为三元组错误导致
*
*/
#define STATE_MQTT_CONNACK_RCODE_NOT_AUTHORIZED (-0x0305)
/**
* @brief MQTT建连时, 服务端返回未知的CONNACK报文
*
*/
#define STATE_MQTT_CONNACK_RCODE_UNKNOWN (-0x0306)
/**
* @brief MQTT缓存QoS1消息时, 检测到packetId发生卷绕
*
*/
#define STATE_MQTT_PUBLIST_PACKET_ID_ROLL (-0x0307)
/**
* @brief MQTT发布或订阅时, 检测到Topic格式不符合协议规范
*
*/
#define STATE_MQTT_TOPIC_INVALID (-0x0308)
/**
* @brief MQTT发布或订阅或取消订阅时, SDK反馈Topic内容的状态码
*
*/
#define STATE_MQTT_LOG_TOPIC (-0x0309)
/**
* @brief MQTT收发消息时, SDK反馈MQTT消息内容的状态码
*
*/
#define STATE_MQTT_LOG_HEXDUMP (-0x030A)
/**
* @brief MQTT连接建立成功
*
*/
#define STATE_MQTT_CONNECT_SUCCESS (-0x030B)
/**
* @brief SDK读取到的MQTT报文含有不符合协议规范的报文长度字段
*
*/
#define STATE_MQTT_MALFORMED_REMAINING_LEN (-0x030C)
/**
* @brief SDK读取到的MQTT报文不符合按协议规范所解析的字节数
*
*/
#define STATE_MQTT_MALFORMED_REMAINING_BYTES (-0x030D)
/**
* @brief SDK读取到尚不支持的MQTT报文类型
*
*/
#define STATE_MQTT_PACKET_TYPE_UNKNOWN (-0x030E)
/**
* @brief MQTT订阅或取消订阅时, 从服务端得到操作失败的回应
*
*/
#define STATE_MQTT_SUBACK_RCODE_FAILURE (-0x030F)
/**
* @brief MQTT订阅或取消订阅时, 从服务端得到无法解析的应答
*
*/
#define STATE_MQTT_SUBACK_RCODE_UNKNOWN (-0x0310)
/**
* @brief MQTT接收消息时, 消息中的Topic与可理解的Topic列表匹配失败
*
*/
#define STATE_MQTT_TOPIC_COMPARE_FAILED (-0x0311)
/**
* @brief 执行@ref aiot_mqtt_deinit 时, 为等待其他API执行结束, 超过设定的超时时间, MQTT实例销毁失败
*
*/
#define STATE_MQTT_DEINIT_TIMEOUT (-0x0312)
/**
* @brief MQTT主动连接服务器相关的日志状态码
*
*/
#define STATE_MQTT_LOG_CONNECT (-0x0313)
/**
* @brief MQTT断线后, 自动重连服务器相关的日志状态码
*
*/
#define STATE_MQTT_LOG_RECONNECTING (-0x0314)
/**
* @brief MQTT连接服务器超时相关的日志状态码
*
*/
#define STATE_MQTT_LOG_CONNECT_TIMEOUT (-0x0315)
/**
* @brief MQTT主动与服务器断开连接相关的日志状态码
*
*/
#define STATE_MQTT_LOG_DISCONNECT (-0x0316)
/**
* @brief MQTT连接服务器时, 使用的用户名相关的日志状态码
*
*/
#define STATE_MQTT_LOG_USERNAME (-0x0317)
/**
* @brief MQTT连接服务器时, 使用的密码相关的日志状态码
*
*/
#define STATE_MQTT_LOG_PASSWORD (-0x0318)
/**
* @brief MQTT连接服务器时, 使用的clientId相关的日志状态码
*
*/
#define STATE_MQTT_LOG_CLIENTID (-0x0319)
/**
* @brief MQTT连接服务器时, 使用的PSK-TLS密钥相关的日志状态码
*
*/
#define STATE_MQTT_LOG_TLS_PSK (-0x031A)
/**
* @brief MQTT发布或订阅或取消订阅时, Topic的长度超出物联网平台的限制, 中止执行
*
*/
#define STATE_MQTT_TOPIC_TOO_LONG (-0x031B)
/**
* @brief MQTT发布消息时, Payload的长度超出物联网平台的限制, 中止执行
*
*/
#define STATE_MQTT_PUB_PAYLOAD_TOO_LONG (-0x031C)
/**
* @brief MQTT连接服务器时, 使用的备用ip地址
*
*/
#define STATE_MQTT_LOG_BACKUP_IP (-0x031D)
/**
* @brief 接收到非法的MQTT PINRESP报文
*
*/
#define STATE_MQTT_RECV_INVALID_PINRESP_PACKET (-0x031E)
/**
* @brief 接收到非法的MQTT PUBLISH报文
*
*/
#define STATE_MQTT_RECV_INVALID_PUBLISH_PACKET (-0x031F)
/**
* @brief 接收到非法的MQTT PUBACK报文
*
*/
#define STATE_MQTT_RECV_INVALID_PUBACK_PACKET (-0x0320)
/**
* @brief mqtt 5.0属性未解析成功
*
*/
#define STATE_MQTT_UNKNOWN_PROPERTY_OPTION (-0x0321)
/**
* @brief mqtt协议版本号未设置正确. 在使用5.0协议的接口(_with_prop结尾)时, 如果没有通过AIOT_MQTTOPT_VERSION将版本号设置为AIOT_MQTT_VERSION_5_0就会报这个错误
*
*/
#define STATE_MQTT_INVALID_PROTOCOL_VERSION (-0x0322)
/**
* @brief 云端下行的server disconnect报文格式不对
*
*/
#define STATE_MQTT_RECV_INVALID_SERVER_DISCONNECT_PACKET (-0x0323)
/**
* @brief 在用户输入的用户属性的len值>0的情况下, 用户输入的user property的value为空指针
*
*/
#define STATE_MQTT_INVALID_USER_PERPERTY_DATA (-0x0324)
/**
* @brief 用户属性的长度值超出范围(当前是0-128个字节)
*
*/
#define STATE_MQTT_INVALID_USER_PERPERTY_LEN (-0x0325)
/**
* @brief 用户上行报文的大小超过平台限制(默认是256KB)
*
*/
#define STATE_MQTT_INVALID_TX_PACK_SIZE (-0x0326)
/**
* @brief 设备上行的qos 1报文超过流控限制
*
*/
#define STATE_MQTT_RECEIVE_MAX_EXCEEDED (-0x0327)
/**
* @brief 用户输入的subscription identifier值超过限制(0-0xFFFFFFF)
*
*/
#define STATE_MQTT_INVALID_SUBSCRIPTION_IDENTIFIER (-0x0328)
/**
* @brief 属性的长度为非法值, 比如大于MQTT的remainLen长度值
*
*/
#define STATE_MQTT_INVALID_PROPERTY_LEN (-0x0329)
/**
* @brief -0x0400~-0x04FF表达SDK在HTTP模块内的状态码
*
*/
#define STATE_HTTP_BASE (-0x0400)
/**
* @brief 解析收到的HTTP报文时, 无法获取有效的状态行, 得不到HTTP StatusCode
*
*/
#define STATE_HTTP_STATUS_LINE_INVALID (-0x0401)
/**
* @brief 解析收到的HTTP报文时, 报文的body部分已接收完毕, 没有更多数据
*
*/
#define STATE_HTTP_READ_BODY_FINISHED (-0x0402)
/**
* @brief 执行@ref aiot_http_deinit 时, 等待其他API执行结束超过设定的超时时间, HTTP实例销毁失败
*
*/
#define STATE_HTTP_DEINIT_TIMEOUT (-0x0403)
/**
* @brief 因为HTTP认证应答的StatusCode不是200, 认证失败
*
*/
#define STATE_HTTP_AUTH_CODE_FAILED (-0x0404)
/**
* @brief 因为HTTP认证应答接收未完成, 认证失败
*
*/
#define STATE_HTTP_AUTH_NOT_FINISHED (-0x0405)
/**
* @brief 因为HTTP认证应答中未能解析到Token, 认证失败
*
*/
#define STATE_HTTP_AUTH_TOKEN_FAILED (-0x0406)
/**
* @brief 设备尚未认证, 需要先调用@ref aiot_http_auth 进行设备认证
*
*/
#define STATE_HTTP_NEED_AUTH (-0x0407)
/**
* @brief HTTP应答数据接收未完成, 需确认网络是否异常
*
*/
#define STATE_HTTP_RECV_NOT_FINISHED (-0x0408)
/**
* @brief 内部buffer长度过短, 需调用@ref aiot_http_setopt 配置@ref AIOT_HTTPOPT_HEADER_BUFFER_LEN 选项增大buffer长度
*
*/
#define STATE_HTTP_HEADER_BUFFER_TOO_SHORT (-0x0409)
/**
* @brief HTTP首部接收异常
*
*/
#define STATE_HTTP_HEADER_INVALID (-0x040A)
/**
* @brief HTTP首部发送相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_SEND_HEADER (-0x040B)
/**
* @brief HTTP内容发送相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_SEND_CONTENT (-0x040C)
/**
* @brief HTTP首部接收相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_RECV_HEADER (-0x040D)
/**
* @brief HTTP内容接收相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_RECV_CONTENT (-0x040E)
/**
* @brief HTTP连接断开相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_DISCONNECT (-0x040F)
/**
* @brief HTTP认证交互相关日志使用的状态码
*
*/
#define STATE_HTTP_LOG_AUTH (-0x0410)
/**
* @brief 因为HTTP应答报文的内容不符合预期, 认证失败
*
*/
#define STATE_HTTP_AUTH_NOT_EXPECTED (-0x0411)
/**
* @brief HTTP报文的负载部分为空, 接收已完成
*
*/
#define STATE_HTTP_READ_BODY_EMPTY (-0x0412)
/**
* @brief -0x0F00~-0x0FFF表达SDK在系统底层依赖模块内的状态码
*
*/
#define STATE_PORT_BASE (-0x0F00)
/**
* @brief 底层依赖函数遇到非法的空指针参数, 执行失败
*
*/
#define STATE_PORT_INPUT_NULL_POINTER (-0x0F01)
/**
* @brief 底层依赖函数遇到输入参数超出合理值域, 执行失败
*
*/
#define STATE_PORT_INPUT_OUT_RANGE (-0x0F02)
/**
* @brief 底层依赖函数遇到申请内存错误, 执行失败
*
*/
#define STATE_PORT_MALLOC_FAILED (-0x0F03)
/**
* @brief 底层依赖函数遇到域名地址或IP地址缺失, 执行失败
*
*/
#define STATE_PORT_MISSING_HOST (-0x0F04)
/**
* @brief 底层依赖函数遇到TCP客户端建立过程尚未实现, 执行失败
*
*/
#define STATE_PORT_TCP_CLIENT_NOT_IMPLEMENT (-0x0F05)
/**
* @brief 底层依赖函数遇到TCP服务端建立过程尚未实现, 执行失败
*
*/
#define STATE_PORT_TCP_SERVER_NOT_IMPLEMENT (-0x0F06)
/**
* @brief 底层依赖函数遇到UDP客户端建立过程尚未实现, 执行失败
*
*/
#define STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT (-0x0F07)
/**
* @brief 底层依赖函数遇到UDP服务端建立过程尚未实现, 执行失败
*
*/
#define STATE_PORT_UDP_SERVER_NOT_IMPLEMENT (-0x0F08)
/**
* @brief 底层依赖函数遇到不能理解的网络层设置选项, 执行失败
*
*/
#define STATE_PORT_NETWORK_UNKNOWN_OPTION (-0x0F09)
/**
* @brief 底层依赖函数遇到不能理解的socket类型, 执行失败
*
*/
#define STATE_PORT_NETWORK_UNKNOWN_SOCKET_TYPE (-0x0F0A)
/**
* @brief 底层依赖函数遇到域名DNS解析错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_DNS_FAILED (-0x0F0B)
/**
* @brief 底层依赖函数建立网络连接时遇到socket创建错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_SOCKET_CREATE_FAILED (-0x0F0C)
/**
* @brief 底层依赖函数建立网络连接时遇到socket配置错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_SOCKET_CONFIG_FAILED (-0x0F0D)
/**
* @brief 底层依赖函数建立网络连接时遇到bind错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_SOCKET_BIND_FAILED (-0x0F0E)
/**
* @brief 底层依赖函数遇到TCP连接超时未成功, 执行失败
*
*/
#define STATE_PORT_NETWORK_CONNECT_TIMEOUT (-0x0F0F)
/**
* @brief 底层依赖函数遇到TCP连接建立错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_CONNECT_FAILED (-0x0F10)
/**
* @brief 底层依赖函数遇到套接字select错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_SELECT_FAILED (-0x0F11)
/**
* @brief 底层依赖函数遇到网络层发送数据错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_SEND_FAILED (-0x0F12)
/**
* @brief 底层依赖函数遇到网络层接收数据错误, 执行失败
*
*/
#define STATE_PORT_NETWORK_RECV_FAILED (-0x0F13)
/**
* @brief 底层依赖函数发送数据时遇到连接已关闭, 执行失败
*
*/
#define STATE_PORT_NETWORK_SEND_CONNECTION_CLOSED (-0x0F14)
/**
* @brief 底层依赖函数接收数据时遇到连接已关闭, 执行失败
*
*/
#define STATE_PORT_NETWORK_RECV_CONNECTION_CLOSED (-0x0F15)
/**
* @brief 底层依赖函数遇到不能理解的安全凭据选项, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_CRED_OPTION (-0x0F16)
/**
* @brief 底层依赖函数遇到不合法的最大TLS分片长度配置, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_MAX_FRAGMENT (-0x0F17)
/**
* @brief 底层依赖函数遇到不合法的服务端证书, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_SERVER_CERT (-0x0F18)
/**
* @brief 底层依赖函数遇到不合法的客户端证书, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_CLIENT_CERT (-0x0F19)
/**
* @brief 底层依赖函数遇到不合法的客户端密钥, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_CLIENT_KEY (-0x0F1A)
/**
* @brief 底层依赖函数建立TLS连接时遇到socket创建错误, 执行失败
*
*/
#define STATE_PORT_TLS_SOCKET_CREATE_FAILED (-0x0F1B)
/**
* @brief 底层依赖函数建立TLS连接时遇到socket连接建立错误, 执行失败
*
*/
#define STATE_PORT_TLS_SOCKET_CONNECT_FAILED (-0x0F1C)
/**
* @brief 底层依赖函数建立TLS连接时遇到握手失败, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_RECORD (-0x0F1D)
/**
* @brief 底层依赖函数在TLS连接上, 遇到数据接收错误, 执行失败
*
*/
#define STATE_PORT_TLS_RECV_FAILED (-0x0F1E)
/**
* @brief 底层依赖函数在TLS连接上, 遇到数据发送错误, 执行失败
*
*/
#define STATE_PORT_TLS_SEND_FAILED (-0x0F1F)
/**
* @brief 底层依赖函数在TLS连接上, 接收数据时遇到连接已关闭, 执行失败
*
*/
#define STATE_PORT_TLS_RECV_CONNECTION_CLOSED (-0x0F20)
/**
* @brief 底层依赖函数在TLS连接上, 发送数据时遇到连接已关闭, 执行失败
*
*/
#define STATE_PORT_TLS_SEND_CONNECTION_CLOSED (-0x0F21)
/**
* @brief 底层依赖函数建立TLS连接时遇到PSK配置错误, 执行失败
*
*/
#define STATE_PORT_TLS_CONFIG_PSK_FAILED (-0x0F22)
/**
* @brief 底层依赖函数建立TLS连接时遇到非法记录以外的握手错误, 执行失败
*
*/
#define STATE_PORT_TLS_INVALID_HANDSHAKE (-0x0F23)
/**
* @brief DTLS握手时设置PSK配置错误, 执行失败
*
*/
#define STATE_PORT_DTLS_CONFIG_PSK_FAILED (-0x0F24)
/**
* @brief DTLS握手失败, 执行失败
*
*/
#define STATE_PORT_DTLS_HANDSHAKE_FAILED (-0x0F25)
/**
* @brief DTLS建立连接时失败, 执行失败
*
*/
#define STATE_PORT_NETWORK_DTLS_CONNECT_FAILED (-0x0F26)
/**
* @brief 之前的DTLS握手还在进行中
*
*/
#define STATE_PORT_DTLS_HANDSHAKE_IN_PROGRESS (-0x0F27)
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef _AIOT_STATE_API_H_ */
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_state_api.h | C | apache-2.0 | 21,210 |
/**
* @file aiot_sysdep_api.h
* @brief SDK Core系统依赖头文件, 所有Core中的系统依赖均在此文件中列出
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#ifndef _AIOT_SYSDEP_API_H_
#define _AIOT_SYSDEP_API_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
typedef enum {
AIOT_SYSDEP_NETWORK_CRED_NONE,
AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA,
AIOT_SYSDEP_NETWORK_CRED_SVRCERT_PSK,
AIOT_SYSDEP_NETWORK_CRED_MAX
} aiot_sysdep_network_cred_option_t;
typedef struct {
aiot_sysdep_network_cred_option_t option; /* 安全策略 */
uint32_t max_tls_fragment;
uint8_t sni_enabled;
const char *x509_server_cert; /* 必须位于静态存储区, SDK内部不做拷贝 */
uint32_t x509_server_cert_len;
const char *x509_client_cert; /* 必须位于静态存储区, SDK内部不做拷贝 */
uint32_t x509_client_cert_len;
const char *x509_client_privkey; /* 必须位于静态存储区, SDK内部不做拷贝 */
uint32_t x509_client_privkey_len;
char *tls_extend_info;
} aiot_sysdep_network_cred_t;
typedef enum {
CORE_SYSDEP_SOCKET_TCP_CLIENT,
CORE_SYSDEP_SOCKET_TCP_SERVER,
CORE_SYSDEP_SOCKET_UDP_CLIENT,
CORE_SYSDEP_SOCKET_UDP_SERVER
} core_sysdep_socket_type_t;
typedef struct {
char *psk_id;
char *psk;
} core_sysdep_psk_t;
typedef enum {
CORE_SYSDEP_NETWORK_SOCKET_TYPE, /* 需要建立的socket类型 数据类型: (core_sysdep_socket_type_t *) */
CORE_SYSDEP_NETWORK_HOST, /* 用于建立网络连接的域名地址或ip地址, 内存与上层模块共用 数据类型: (char *) */
CORE_SYSDEP_NETWORK_BACKUP_IP, /* 当建联DNS解析失败时, 使用此备用ip重试 */
CORE_SYSDEP_NETWORK_PORT, /* 用于建立网络连接的端口号 数据类型: (uint16_t *) */
CORE_SYSDEP_NETWORK_CONNECT_TIMEOUT_MS, /* 建立网络连接的超时时间 数据类型: (uint32_t *) */
CORE_SYSDEP_NETWORK_CRED, /* 用于设置网络层安全参数 数据类型: (aiot_sysdep_network_cred_t *) */
CORE_SYSDEP_NETWORK_PSK, /* 用于配合PSK模式下的psk-id和psk 数据类型: (core_sysdep_psk_t *) */
CORE_SYSDEP_NETWORK_MAX
} core_sysdep_network_option_t;
typedef struct {
char addr[16]; /* ipv4地址点分十进制字符串, 最大长度15字节. */
uint16_t port; /* 端口号 */
} core_sysdep_addr_t;
/* 这不是一个面向用户的编译配置开关, 多数情况下, 不必用户关心 */
/**
* @brief 用以向SDK描述其运行硬件平台的资源如何使用的方法结构体
*/
typedef struct {
/**
* @brief 申请内存
*/
void *(*core_sysdep_malloc)(uint32_t size, char *name);
/**
* @brief 释放内存
*/
void (*core_sysdep_free)(void *ptr);
/**
* @brief 获取当前的时间戳，SDK用于差值计算
*/
uint64_t (*core_sysdep_time)(void);
/**
* @brief 睡眠指定的毫秒数
*/
void (*core_sysdep_sleep)(uint64_t time_ms);
/**
* @brief 创建1个网络会话(L3层)
*/
void *(*core_sysdep_network_init)(void);
/**
* @brief 配置1个网络会话的连接参数
*/
int32_t (*core_sysdep_network_setopt)(void *handle, core_sysdep_network_option_t option, void *data);
/**
* @brief 建立1个网络会话, 作为MQTT/HTTP等协议的底层承载
*/
int32_t (*core_sysdep_network_establish)(void *handle);
/**
* @brief 从指定的网络会话上读取
*/
int32_t (*core_sysdep_network_recv)(void *handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms,
core_sysdep_addr_t *addr);
/**
* @brief 在指定的网络会话上发送
*/
int32_t (*core_sysdep_network_send)(void *handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms,
core_sysdep_addr_t *addr);
/**
* @brief 销毁1个网络会话
*/
int32_t (*core_sysdep_network_deinit)(void **handle);
/**
* @brief 随机数生成方法
*/
void (*core_sysdep_rand)(uint8_t *output, uint32_t output_len);
/**
* @brief 创建互斥锁
*/
void *(*core_sysdep_mutex_init)(void);
/**
* @brief 申请互斥锁
*/
void (*core_sysdep_mutex_lock)(void *mutex);
/**
* @brief 释放互斥锁
*/
void (*core_sysdep_mutex_unlock)(void *mutex);
/**
* @brief 销毁互斥锁
*/
void (*core_sysdep_mutex_deinit)(void **mutex);
} aiot_sysdep_portfile_t;
void aiot_sysdep_set_portfile(aiot_sysdep_portfile_t *portfile);
aiot_sysdep_portfile_t *aiot_sysdep_get_portfile(void);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/aiot_sysdep_api.h | C | apache-2.0 | 4,908 |
#ifndef _CORE_STDINC_H_
#define _CORE_STDINC_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include <stdint.h>
#include <string.h>
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/sysdep/core_stdinc.h | C | apache-2.0 | 179 |
#include "core_sysdep.h"
static aiot_sysdep_portfile_t *g_sysdep_portfile = NULL;
void aiot_sysdep_set_portfile(aiot_sysdep_portfile_t *portfile)
{
g_sysdep_portfile = portfile;
}
aiot_sysdep_portfile_t * aiot_sysdep_get_portfile(void)
{
if (g_sysdep_portfile == NULL ||
g_sysdep_portfile->core_sysdep_malloc == NULL ||
g_sysdep_portfile->core_sysdep_free == NULL ||
g_sysdep_portfile->core_sysdep_time == NULL ||
g_sysdep_portfile->core_sysdep_sleep == NULL ||
g_sysdep_portfile->core_sysdep_network_init == NULL ||
g_sysdep_portfile->core_sysdep_network_setopt == NULL ||
g_sysdep_portfile->core_sysdep_network_establish == NULL ||
g_sysdep_portfile->core_sysdep_network_recv == NULL ||
g_sysdep_portfile->core_sysdep_network_send == NULL ||
g_sysdep_portfile->core_sysdep_network_deinit == NULL ||
g_sysdep_portfile->core_sysdep_rand == NULL ||
g_sysdep_portfile->core_sysdep_mutex_init == NULL ||
g_sysdep_portfile->core_sysdep_mutex_lock == NULL ||
g_sysdep_portfile->core_sysdep_mutex_unlock == NULL ||
g_sysdep_portfile->core_sysdep_mutex_deinit == NULL) {
return NULL;
}
return g_sysdep_portfile;
}
| YifuLiu/AliOS-Things | components/linksdk/core/sysdep/core_sysdep.c | C | apache-2.0 | 1,255 |
#ifndef _CORE_SYSDEP_H_
#define _CORE_SYSDEP_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "aiot_sysdep_api.h"
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/sysdep/core_sysdep.h | C | apache-2.0 | 193 |
#include "core_auth.h"
int32_t core_auth_tls_psk(aiot_sysdep_portfile_t *sysdep, char **psk_id, char psk[65], char *product_key, char *device_name, char *device_secret, char *module_name)
{
int32_t res = STATE_SUCCESS;
char *tmp_psk_id = NULL, *auth_type = "devicename", *sign_method = "hmacsha256";
char *psk_id_src[] = { auth_type, sign_method, product_key, device_name, CORE_AUTH_TIMESTAMP};
char *psk_plain_text = NULL, *psk_plain_text_src[] = { product_key, device_name, CORE_AUTH_TIMESTAMP};
uint8_t psk_hex[32] = {0};
if (NULL == device_secret) {
return STATE_USER_INPUT_MISSING_DEVICE_SECRET;
}
res = core_sprintf(sysdep, &tmp_psk_id, "%s|%s|%s&%s|%s", psk_id_src, sizeof(psk_id_src)/sizeof(char *), module_name);
if (res < STATE_SUCCESS) {
return res;
}
res = core_sprintf(sysdep, &psk_plain_text, "id%s&%stimestamp%s", psk_plain_text_src, sizeof(psk_plain_text_src)/sizeof(char *), module_name);
if (res < STATE_SUCCESS) {
sysdep->core_sysdep_free(tmp_psk_id);
return res;
}
core_hmac_sha256((const uint8_t *)psk_plain_text, (uint32_t)strlen(psk_plain_text), (const uint8_t *)device_secret, (uint32_t)strlen(device_secret), psk_hex);
core_hex2str(psk_hex, 32, psk, 0);
*psk_id = tmp_psk_id;
sysdep->core_sysdep_free(psk_plain_text);
return res;
}
int32_t core_auth_mqtt_username(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *module_name)
{
char *src[] = { device_name, product_key };
return core_sprintf(sysdep, dest, "%s&%s", src, sizeof(src)/sizeof(char *), module_name);
}
int32_t core_auth_mqtt_password(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *device_secret, uint8_t assigned_clientid, char *module_name)
{
int32_t res = 0;
char *plain_text = NULL;
uint8_t sign[32] = {0};
if(1 == assigned_clientid) {
char *src[] = { device_name, product_key, CORE_AUTH_TIMESTAMP };
res = core_sprintf(sysdep, &plain_text, "clientIddeviceName%sproductKey%stimestamp%s", src, sizeof(src)/sizeof(char *), module_name);
} else {
char *src[] = { product_key, device_name, device_name, product_key, CORE_AUTH_TIMESTAMP };
res = core_sprintf(sysdep, &plain_text, "clientId%s.%sdeviceName%sproductKey%stimestamp%s", src, sizeof(src)/sizeof(char *), module_name);
}
if (res < STATE_SUCCESS) {
return res;
}
*dest = sysdep->core_sysdep_malloc(65, module_name);
if (*dest == NULL) {
sysdep->core_sysdep_free(plain_text);
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(*dest, 0, 65);
core_hmac_sha256((const uint8_t *)plain_text, (uint32_t)strlen(plain_text), (const uint8_t *)device_secret, (uint32_t)strlen(device_secret),sign);
core_hex2str(sign, 32, *dest, 0);
sysdep->core_sysdep_free(plain_text);
return 0;
}
int32_t core_auth_mqtt_clientid(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *secure_mode, char *extend_clientid, uint8_t assigned_clientid, char *module_name)
{
if(1 == assigned_clientid) {
char *src[] = { CORE_AUTH_TIMESTAMP, CORE_AUTH_SDK_VERSION, secure_mode, extend_clientid};
return core_sprintf(sysdep, dest, "|timestamp=%s,_ss=1,_v=%s,securemode=%s,signmethod=hmacsha256,ext=3,%s|", src, sizeof(src)/sizeof(char *), module_name); /* ext bitmap: bit0-rrpc, bit1-ext_notify */
} else {
char *src[] = { product_key, device_name, CORE_AUTH_TIMESTAMP, CORE_AUTH_SDK_VERSION, secure_mode, extend_clientid};
return core_sprintf(sysdep, dest, "%s.%s|timestamp=%s,_ss=1,_v=%s,securemode=%s,signmethod=hmacsha256,ext=3,%s|", src, sizeof(src)/sizeof(char *), module_name); /* ext bitmap: bit0-rrpc, bit1-ext_notify */
}
}
int32_t core_auth_http_body(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *device_secret, char *module_name)
{
int32_t res = 0;
char *sign_ele[] = { product_key, device_name, device_name, product_key, NULL };
char *plain_text = NULL;
uint8_t sign_hex[32] = {0};
char sign_str[65] = {0};
res = core_sprintf(sysdep, &plain_text, "clientId%s.%sdeviceName%sproductKey%s", sign_ele, 4, module_name);
if (res < STATE_SUCCESS) {
return res;
}
core_hmac_sha256((const uint8_t *)plain_text, (uint32_t)strlen(plain_text), (const uint8_t *)device_secret, (uint32_t)strlen(device_secret), sign_hex);
core_hex2str(sign_hex, 32, sign_str, 0);
sysdep->core_sysdep_free(plain_text);
sign_ele[4] = sign_str;
res = core_sprintf(sysdep,
dest,
"{\"clientId\":\"%s.%s\",\"signmethod\":\"hmacsha256\",\"deviceName\":\"%s\",\"productKey\":\"%s\",\"sign\":\"%s\"}",
sign_ele,
sizeof(sign_ele)/sizeof(char *),
module_name);
return res;
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_auth.c | C | apache-2.0 | 4,996 |
#ifndef _CORE_AUTH_H_
#define _CORE_AUTH_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_string.h"
#include "core_sha256.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#define CORE_AUTH_SDK_VERSION "sdk-c-4.0.0"
#define CORE_AUTH_TIMESTAMP "2524608000000"
int32_t core_auth_tls_psk(aiot_sysdep_portfile_t *sysdep, char **psk_id, char psk[65], char *product_key, char *device_name, char *device_secret, char *module_name);
int32_t core_auth_mqtt_username(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *module_name);
int32_t core_auth_mqtt_password(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *device_secret, uint8_t assigned_clientid, char *module_name);
int32_t core_auth_mqtt_clientid(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *secure_mode, char *extend_clientid, uint8_t assigned_clientid, char *module_name);
int32_t core_auth_http_body(aiot_sysdep_portfile_t *sysdep, char **dest, char *product_key, char *device_name, char *device_secret, char *module_name);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_auth.h | C | apache-2.0 | 1,199 |
#include "core_diag.h"
static void _core_diag_default_callback(void *diag_handle, uint64_t timestamp, int32_t code, uint8_t *data, uint32_t data_len);
static void *g_diag_handle = NULL;
static core_diag_callback g_diag_cb = _core_diag_default_callback;
static void _core_diag_default_callback(void *diag_handle, uint64_t timestamp, int32_t code, uint8_t *data, uint32_t data_len)
{
}
void core_diag_set_cb(void *diag_handle, core_diag_callback cb)
{
if (cb == NULL) {
g_diag_cb = _core_diag_default_callback;
g_diag_handle = NULL;
}else{
g_diag_handle = diag_handle;
g_diag_cb = cb;
}
}
void core_diag(aiot_sysdep_portfile_t *sysdep, int32_t code, uint8_t *data, uint32_t data_len)
{
g_diag_cb(g_diag_handle, core_log_get_timestamp(sysdep), code, data, data_len);
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_diag.c | C | apache-2.0 | 824 |
#ifndef _CORE_DIAG_H_
#define _CORE_DIAG_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_log.h"
typedef void (*core_diag_callback)(void * diag_handle, uint64_t timestamp, int32_t code, uint8_t *data, uint32_t data_len);
void core_diag_set_cb(void *diag_handle, core_diag_callback cb);
void core_diag(aiot_sysdep_portfile_t *sysdep, int32_t code, uint8_t *data, uint32_t data_len);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_diag.h | C | apache-2.0 | 468 |
#include "core_global.h"
typedef struct {
void *mutex;
uint8_t is_inited;
uint32_t used_count;
int32_t alink_id;
char mqtt_backup_ip[16];
} g_core_global_t;
g_core_global_t g_core_global = {NULL, 0, 0, 0, {0}};
int32_t core_global_init(aiot_sysdep_portfile_t *sysdep)
{
if (g_core_global.is_inited == 1) {
g_core_global.used_count++;
return STATE_SUCCESS;
}
g_core_global.is_inited = 1;
g_core_global.mutex = sysdep->core_sysdep_mutex_init();
g_core_global.used_count++;
return STATE_SUCCESS;
}
int32_t core_global_alink_id_next(aiot_sysdep_portfile_t *sysdep, int32_t *alink_id)
{
int32_t id = 0;
sysdep->core_sysdep_mutex_lock(g_core_global.mutex);
g_core_global.alink_id++;
if (g_core_global.alink_id < 0) {
g_core_global.alink_id = 0;
}
id = g_core_global.alink_id;
sysdep->core_sysdep_mutex_unlock(g_core_global.mutex);
*alink_id = id;
return STATE_SUCCESS;
}
int32_t core_global_set_mqtt_backup_ip(aiot_sysdep_portfile_t *sysdep, char ip[16])
{
int cpy_len = strlen(ip) > 15 ? 15 : strlen(ip);
sysdep->core_sysdep_mutex_lock(g_core_global.mutex);
memset(g_core_global.mqtt_backup_ip, 0, 16);
memcpy(g_core_global.mqtt_backup_ip, ip, cpy_len);
sysdep->core_sysdep_mutex_unlock(g_core_global.mutex);
return STATE_SUCCESS;
}
int32_t core_global_get_mqtt_backup_ip(aiot_sysdep_portfile_t *sysdep, char ip[16])
{
sysdep->core_sysdep_mutex_lock(g_core_global.mutex);
memcpy(ip, g_core_global.mqtt_backup_ip, strlen(g_core_global.mqtt_backup_ip));
sysdep->core_sysdep_mutex_unlock(g_core_global.mutex);
return STATE_SUCCESS;
}
int32_t core_global_deinit(aiot_sysdep_portfile_t *sysdep)
{
if (g_core_global.used_count > 0) {
g_core_global.used_count--;
}
if (g_core_global.used_count != 0) {
return STATE_SUCCESS;
}
sysdep->core_sysdep_mutex_deinit(&g_core_global.mutex);
g_core_global.mutex = NULL;
g_core_global.is_inited = 0;
g_core_global.used_count = 0;
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_global.c | C | apache-2.0 | 2,094 |
#ifndef _CORE_GLOBAL_H_
#define _CORE_GLOBAL_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#define CORE_GLOBAL_MODULE_NAME "global"
int32_t core_global_init(aiot_sysdep_portfile_t *sysdep);
int32_t core_global_alink_id_next(aiot_sysdep_portfile_t *sysdep, int32_t *alink_id);
int32_t core_global_set_mqtt_backup_ip(aiot_sysdep_portfile_t *sysdep, char ip[16]);
int32_t core_global_get_mqtt_backup_ip(aiot_sysdep_portfile_t *sysdep, char ip[16]);
int32_t core_global_deinit(aiot_sysdep_portfile_t *sysdep);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_global.h | C | apache-2.0 | 638 |
/**
* @file aiot_http_api.c
* @brief HTTP模块实现, 其中包含了向物联网平台认证和上报数据的API接口
* @date 2019-12-27
*
* @copyright Copyright (C) 2015-2018 Alibaba Group Holding Limited
*
*/
#include "core_http.h"
static void _core_http_exec_inc(core_http_handle_t *http_handle)
{
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
http_handle->core_exec_count++;
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
}
static void _core_http_exec_dec(core_http_handle_t *http_handle)
{
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
http_handle->core_exec_count--;
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
}
static int32_t _core_http_sysdep_return(int32_t sysdep_code, int32_t core_code)
{
if (sysdep_code >= (STATE_PORT_BASE - 0x00FF) && sysdep_code < (STATE_PORT_BASE)) {
return sysdep_code;
} else {
return core_code;
}
}
static int32_t _core_http_connect(core_http_handle_t *http_handle)
{
int32_t res = STATE_SUCCESS;
/* disconnect first if network is already established */
if (http_handle->network_handle != NULL) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
}
/* establish network connection */
core_sysdep_socket_type_t socket_type = CORE_SYSDEP_SOCKET_TCP_CLIENT;
if (http_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
http_handle->network_handle = http_handle->sysdep->core_sysdep_network_init();
if (http_handle->network_handle == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
if ((res = http_handle->sysdep->core_sysdep_network_setopt(http_handle->network_handle, CORE_SYSDEP_NETWORK_SOCKET_TYPE,
&socket_type)) < 0 ||
(res = http_handle->sysdep->core_sysdep_network_setopt(http_handle->network_handle, CORE_SYSDEP_NETWORK_HOST,
http_handle->host)) < 0 ||
(res = http_handle->sysdep->core_sysdep_network_setopt(http_handle->network_handle, CORE_SYSDEP_NETWORK_PORT,
&http_handle->port)) < 0 ||
(res = http_handle->sysdep->core_sysdep_network_setopt(http_handle->network_handle,
CORE_SYSDEP_NETWORK_CONNECT_TIMEOUT_MS,
&http_handle->connect_timeout_ms)) < 0) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
return _core_http_sysdep_return(res, STATE_SYS_DEPEND_NWK_INVALID_OPTION);
}
if (http_handle->cred != NULL) {
res = http_handle->sysdep->core_sysdep_network_setopt(http_handle->network_handle, CORE_SYSDEP_NETWORK_CRED,
http_handle->cred);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
return _core_http_sysdep_return(res, STATE_SYS_DEPEND_NWK_INVALID_CRED);
}
}
res = http_handle->sysdep->core_sysdep_network_establish(http_handle->network_handle);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
return _core_http_sysdep_return(res, STATE_SYS_DEPEND_NWK_EST_FAILED);
}
return STATE_SUCCESS;
}
static int32_t _core_http_send(core_http_handle_t *http_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms)
{
int32_t res = STATE_SUCCESS;
if (http_handle->network_handle != NULL) {
res = http_handle->sysdep->core_sysdep_network_send(http_handle->network_handle, buffer, len, timeout_ms, NULL);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
core_log(http_handle->sysdep, STATE_HTTP_LOG_DISCONNECT, "HTTP network error when sending data, disconnect\r\n");
res = _core_http_sysdep_return(res, STATE_SYS_DEPEND_NWK_SEND_ERR);
} else if (res != len) {
res = STATE_SYS_DEPEND_NWK_WRITE_LESSDATA;
}
} else {
res = STATE_SYS_DEPEND_NWK_CLOSED;
}
return res;
}
static int32_t _core_http_send_body(core_http_handle_t *http_handle, uint8_t *content, uint32_t len)
{
int32_t res = STATE_SUCCESS;
core_log_hexdump(STATE_HTTP_LOG_SEND_CONTENT, '>', content, len);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->send_mutex);
res = _core_http_send(http_handle, content, len, http_handle->send_timeout_ms);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->send_mutex);
return res;
}
static void _core_http_header_print(core_http_handle_t *http_handle, char *prefix, char *header, uint32_t header_len)
{
char *prev = header, *pos = header;
uint32_t line_len = 0;
while (pos != header + header_len) {
if (*(pos) == '\n' && *(pos - 1) == '\r') {
line_len = (uint32_t)(pos - prev + 1);
core_log3(http_handle->sysdep, STATE_HTTP_LOG_SEND_HEADER, "%s %.*s", prefix, &line_len, prev);
prev = pos + 1;
}
pos++;
}
}
static int32_t _core_http_send_header(core_http_handle_t *http_handle, char *method, char *path, char *host,
char *header, char *content_lenstr)
{
int32_t res = STATE_SUCCESS;
char *combine_header = NULL;
char *combine_header_src[] = { method, path, host, header, content_lenstr};
uint32_t combine_header_len = 0;
res = core_sprintf(http_handle->sysdep, &combine_header, "%s %s HTTP/1.1\r\nHost: %s\r\n%sContent-Length: %s\r\n\r\n",
combine_header_src, sizeof(combine_header_src) / sizeof(char *), CORE_HTTP_MODULE_NAME);
if (res < STATE_SUCCESS) {
return res;
}
combine_header_len = (uint32_t)strlen(combine_header);
_core_http_header_print(http_handle, ">", combine_header, combine_header_len);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->send_mutex);
res = _core_http_send(http_handle, (uint8_t *)combine_header, combine_header_len, http_handle->send_timeout_ms);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->send_mutex);
http_handle->sysdep->core_sysdep_free(combine_header);
return res;
}
void *core_http_init(void)
{
core_http_handle_t *http_handle = NULL;
aiot_sysdep_portfile_t *sysdep = NULL;
sysdep = aiot_sysdep_get_portfile();
if (sysdep == NULL) {
return NULL;
}
http_handle = sysdep->core_sysdep_malloc(sizeof(core_http_handle_t), CORE_HTTP_MODULE_NAME);
if (http_handle == NULL) {
return NULL;
}
memset(http_handle, 0, sizeof(core_http_handle_t));
http_handle->sysdep = sysdep;
http_handle->connect_timeout_ms = CORE_HTTP_DEFAULT_CONNECT_TIMEOUT_MS;
http_handle->send_timeout_ms = CORE_HTTP_DEFAULT_SEND_TIMEOUT_MS;
http_handle->recv_timeout_ms = CORE_HTTP_DEFAULT_RECV_TIMEOUT_MS;
http_handle->header_line_max_len = CORE_HTTP_DEFAULT_HEADER_LINE_MAX_LEN;
http_handle->body_buffer_max_len = CORE_HTTP_DEFAULT_BODY_MAX_LEN;
http_handle->deinit_timeout_ms = CORE_HTTP_DEFAULT_DEINIT_TIMEOUT_MS;
http_handle->data_mutex = http_handle->sysdep->core_sysdep_mutex_init();
http_handle->send_mutex = http_handle->sysdep->core_sysdep_mutex_init();
http_handle->recv_mutex = http_handle->sysdep->core_sysdep_mutex_init();
http_handle->core_exec_enabled = 1;
return http_handle;
}
int32_t core_http_setopt(void *handle, core_http_option_t option, void *data)
{
int32_t res = STATE_SUCCESS;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL || data == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (option >= CORE_HTTPOPT_MAX) {
return STATE_USER_INPUT_OUT_RANGE;
}
if (http_handle->core_exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_http_exec_inc(http_handle);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->data_mutex);
switch (option) {
case CORE_HTTPOPT_HOST: {
res = core_strdup(http_handle->sysdep, &http_handle->host, (char *)data, CORE_HTTP_MODULE_NAME);
}
break;
case CORE_HTTPOPT_PORT: {
http_handle->port = *(uint16_t *)data;
}
break;
case CORE_HTTPOPT_NETWORK_CRED: {
if (http_handle->cred != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->cred);
http_handle->cred = NULL;
}
http_handle->cred = http_handle->sysdep->core_sysdep_malloc(sizeof(aiot_sysdep_network_cred_t), CORE_HTTP_MODULE_NAME);
if (http_handle->cred != NULL) {
memset(http_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(http_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
} else {
res = STATE_SYS_DEPEND_MALLOC_FAILED;
}
}
break;
case CORE_HTTPOPT_CONNECT_TIMEOUT_MS: {
http_handle->connect_timeout_ms = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_SEND_TIMEOUT_MS: {
http_handle->send_timeout_ms = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_RECV_TIMEOUT_MS: {
http_handle->recv_timeout_ms = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_DEINIT_TIMEOUT_MS: {
http_handle->deinit_timeout_ms = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_HEADER_LINE_MAX_LEN: {
http_handle->header_line_max_len = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_BODY_BUFFER_MAX_LEN: {
http_handle->body_buffer_max_len = *(uint32_t *)data;
}
break;
case CORE_HTTPOPT_EVENT_HANDLER: {
http_handle->event_handler = (aiot_http_event_handler_t)data;
}
break;
case CORE_HTTPOPT_USERDATA: {
http_handle->core_userdata = data;
}
break;
case CORE_HTTPOPT_RECV_HANDLER: {
http_handle->core_recv_handler = (aiot_http_recv_handler_t)data;
}
break;
default: {
res = STATE_USER_INPUT_UNKNOWN_OPTION;
}
break;
}
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->data_mutex);
_core_http_exec_dec(http_handle);
return res;
}
int32_t core_http_connect(void *handle)
{
int32_t res = STATE_SUCCESS;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (http_handle->core_exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_http_exec_inc(http_handle);
/* connect to host */
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->send_mutex);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->recv_mutex);
res = _core_http_connect(http_handle);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->recv_mutex);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->send_mutex);
_core_http_exec_dec(http_handle);
return res;
}
int32_t core_http_send(void *handle, const core_http_request_t *request)
{
int32_t res = STATE_SUCCESS;
char content_lenstr[11] = {0};
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL || request == NULL ||
request->path == NULL || request->method == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (http_handle->host == NULL) {
return STATE_USER_INPUT_MISSING_HOST;
}
if (http_handle->network_handle == NULL) {
return STATE_SYS_DEPEND_NWK_CLOSED;
}
if (http_handle->core_exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
memset(&http_handle->session, 0, sizeof(core_http_session_t));
_core_http_exec_inc(http_handle);
/* send http header */
core_uint2str(request->content_len, content_lenstr, NULL);
res = _core_http_send_header(http_handle, request->method, request->path, http_handle->host, request->header,
content_lenstr);
if (res < STATE_SUCCESS) {
_core_http_exec_dec(http_handle);
return res;
} else {
res = STATE_SUCCESS;
}
/* send http content */
if (request->content != NULL && request->content_len > 0) {
res = _core_http_send_body(http_handle, request->content, request->content_len);
if (res < STATE_SUCCESS) {
_core_http_exec_dec(http_handle);
return res;
}
}
_core_http_exec_dec(http_handle);
return res;
}
static void _core_http_recv_status_code(core_http_handle_t *http_handle, uint32_t status_code)
{
aiot_http_recv_t packet;
if (http_handle->core_recv_handler == NULL) {
return;
}
memset(&packet, 0, sizeof(aiot_http_recv_t));
packet.type = AIOT_HTTPRECV_STATUS_CODE;
packet.data.status_code.code = status_code;
http_handle->core_recv_handler(http_handle, &packet, http_handle->core_userdata);
}
static void _core_http_recv_header_pair(core_http_handle_t *http_handle, char *key, uint32_t key_len, char *value,
uint32_t value_len)
{
char *pair_key = NULL, *pair_value = NULL;
aiot_http_recv_t packet;
if (http_handle->core_recv_handler == NULL) {
return;
}
pair_key = http_handle->sysdep->core_sysdep_malloc(key_len + 1, CORE_HTTP_MODULE_NAME);
if (pair_key == NULL) {
return;
}
memset(pair_key, 0, key_len + 1);
memcpy(pair_key, key, key_len);
pair_value = http_handle->sysdep->core_sysdep_malloc(value_len + 1, CORE_HTTP_MODULE_NAME);
if (pair_value == NULL) {
http_handle->sysdep->core_sysdep_free(pair_key);
return;
}
memset(pair_value, 0, value_len + 1);
memcpy(pair_value, value, value_len);
packet.type = AIOT_HTTPRECV_HEADER;
packet.data.header.key = pair_key;
packet.data.header.value = pair_value;
http_handle->core_recv_handler(http_handle, &packet, http_handle->core_userdata);
http_handle->sysdep->core_sysdep_free(pair_key);
http_handle->sysdep->core_sysdep_free(pair_value);
}
static int32_t _core_http_recv(core_http_handle_t *http_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms)
{
int32_t res = STATE_SUCCESS;
if (http_handle->network_handle != NULL) {
res = http_handle->sysdep->core_sysdep_network_recv(http_handle->network_handle, buffer, len, timeout_ms, NULL);
if (res < STATE_SUCCESS) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
core_log(http_handle->sysdep, STATE_HTTP_LOG_DISCONNECT, "HTTP network error when receving data, disconnect\r\n");
res = _core_http_sysdep_return(res, STATE_SYS_DEPEND_NWK_RECV_ERR);
}
} else {
res = STATE_SYS_DEPEND_NWK_CLOSED;
}
return res;
}
static int32_t _core_http_recv_header(core_http_handle_t *http_handle, uint32_t *body_total_len)
{
int32_t res = STATE_SUCCESS;
char *line = NULL;
uint32_t idx = 0, line_max_len = http_handle->header_line_max_len;
uint64_t timenow_ms = 0;
line = http_handle->sysdep->core_sysdep_malloc(line_max_len, CORE_HTTP_MODULE_NAME);
if (line == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(line, 0, line_max_len);
timenow_ms = http_handle->sysdep->core_sysdep_time();
for (idx = 0; idx < line_max_len;) {
if (timenow_ms > http_handle->sysdep->core_sysdep_time()) {
timenow_ms = http_handle->sysdep->core_sysdep_time();
}
if (idx + 2 > line_max_len) {
res = STATE_HTTP_HEADER_BUFFER_TOO_SHORT;
break;
}
/* read http header, "\r\n" in the end */
if ((res = _core_http_recv(http_handle, (uint8_t *)&line[idx], 1,
http_handle->recv_timeout_ms)) < STATE_SUCCESS) {
break;
}
idx++;
if (res == 0 || (line[idx - 1] != '\r')) {
continue;
}
if ((res = _core_http_recv(http_handle, (uint8_t *)&line[idx], 1,
http_handle->recv_timeout_ms)) < STATE_SUCCESS) {
break;
}
idx++;
if (res == 0 || (line[idx - 1] != '\n')) {
continue;
}
core_log2(http_handle->sysdep, STATE_HTTP_LOG_RECV_HEADER, "< %.*s", &idx, line);
/* next line should be http response body */
if (idx == 2) {
break;
}
/* status code */
if ((idx > (strlen("HTTP/1.1 ") + 3)) && (memcmp(line, "HTTP/1.1 ", strlen("HTTP/1.1 "))) == 0) {
uint32_t status_code = 0, code_idx = 0;
for (code_idx = strlen("HTTP/1.1 "); code_idx < idx; code_idx++) {
if (line[code_idx] < '0' || line[code_idx] > '9') {
break;
}
}
res = core_str2uint(&line[strlen("HTTP/1.1 ")], (code_idx - strlen("HTTP/1.1 ")), &status_code);
if (res < STATE_SUCCESS) {
res = STATE_HTTP_STATUS_LINE_INVALID;
break;
}
_core_http_recv_status_code(http_handle, status_code);
}
/* header */
{
uint32_t deli_idx = 0;
for (deli_idx = 0; deli_idx < idx; deli_idx++) {
if (line[deli_idx] == ':' && line[deli_idx + 1] == ' ') {
if ((deli_idx + 2 == strlen("Content-Length: ")) && (memcmp(line, "Content-Length: ", deli_idx + 2) == 0)) {
core_str2uint(&line[deli_idx + 2], (uint32_t)(idx - deli_idx - 4), body_total_len);
}
_core_http_recv_header_pair(http_handle, line, deli_idx, &line[deli_idx + 2], (uint32_t)(idx - deli_idx - 4));
}
}
}
idx = 0;
memset(line, 0, line_max_len);
}
http_handle->sysdep->core_sysdep_free(line);
return res;
}
static int32_t _core_http_recv_body(core_http_handle_t *http_handle, uint32_t body_total_len)
{
int32_t res = STATE_SUCCESS;
char *buffer = NULL;
uint32_t remaining_len = 0, buffer_len = 0;
if (http_handle->session.body_total_len == 0 && body_total_len == 0) {
return STATE_HTTP_READ_BODY_EMPTY;
}
if (body_total_len != 0) {
http_handle->session.body_total_len = body_total_len;
remaining_len = body_total_len;
} else {
remaining_len = http_handle->session.body_total_len - http_handle->session.body_read_len;
}
if (remaining_len == 0) {
return STATE_HTTP_READ_BODY_FINISHED;
}
buffer_len = (remaining_len < http_handle->body_buffer_max_len) ? (remaining_len) : (http_handle->body_buffer_max_len);
buffer = http_handle->sysdep->core_sysdep_malloc(buffer_len, CORE_HTTP_MODULE_NAME);
if (buffer == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len);
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->recv_mutex);
res = _core_http_recv(http_handle, (uint8_t *)buffer, buffer_len, http_handle->recv_timeout_ms);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->recv_mutex);
if (res > 0) {
aiot_http_recv_t packet;
core_log_hexdump(STATE_HTTP_LOG_RECV_CONTENT, '<', (uint8_t *)buffer, res);
if (http_handle->core_recv_handler != NULL) {
http_handle->session.body_read_len += res;
memset(&packet, 0, sizeof(aiot_http_recv_t));
packet.type = AIOT_HTTPRECV_BODY;
packet.data.body.buffer = (uint8_t *)buffer;
packet.data.body.len = res;
http_handle->core_recv_handler(http_handle, &packet, http_handle->core_userdata);
}
}
http_handle->sysdep->core_sysdep_free(buffer);
return res;
}
int32_t core_http_recv(void *handle)
{
int32_t res = STATE_SUCCESS;
uint32_t body_total_len = 0;
core_http_handle_t *http_handle = (core_http_handle_t *)handle;
if (http_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
if (http_handle->network_handle == NULL) {
return STATE_SYS_DEPEND_NWK_CLOSED;
}
if (http_handle->core_exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
_core_http_exec_inc(http_handle);
if (http_handle->session.sm == CORE_HTTP_SM_READ_HEADER) {
http_handle->sysdep->core_sysdep_mutex_lock(http_handle->recv_mutex);
res = _core_http_recv_header(http_handle, &body_total_len);
http_handle->sysdep->core_sysdep_mutex_unlock(http_handle->recv_mutex);
if (res < STATE_SUCCESS) {
_core_http_exec_dec(http_handle);
return res;
}
}
http_handle->session.sm = CORE_HTTP_SM_READ_BODY;
res = _core_http_recv_body(http_handle, body_total_len);
if (res == STATE_HTTP_READ_BODY_FINISHED || res == STATE_HTTP_READ_BODY_EMPTY) {
memset(&http_handle->session, 0, sizeof(core_http_session_t));
}
_core_http_exec_dec(http_handle);
return res;
}
int32_t core_http_deinit(void **p_handle)
{
uint32_t deinit_timeout_ms = 0;
core_http_handle_t *http_handle = NULL;
if (p_handle == NULL || *p_handle == NULL) {
return STATE_USER_INPUT_NULL_POINTER;
}
http_handle = *(core_http_handle_t **)p_handle;
if (http_handle->core_exec_enabled == 0) {
return STATE_USER_INPUT_EXEC_DISABLED;
}
http_handle->exec_enabled = 0;
deinit_timeout_ms = http_handle->deinit_timeout_ms;
do {
if (http_handle->exec_count == 0) {
break;
}
http_handle->sysdep->core_sysdep_sleep(CORE_HTTP_DEINIT_INTERVAL_MS);
} while ((deinit_timeout_ms > CORE_HTTP_DEINIT_INTERVAL_MS) && (deinit_timeout_ms - CORE_HTTP_DEINIT_INTERVAL_MS > 0));
if (http_handle->exec_count != 0) {
return STATE_HTTP_DEINIT_TIMEOUT;
}
if (http_handle->network_handle != NULL) {
http_handle->sysdep->core_sysdep_network_deinit(&http_handle->network_handle);
}
if (http_handle->host != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->host);
}
if (http_handle->cred != NULL) {
http_handle->sysdep->core_sysdep_free(http_handle->cred);
}
http_handle->sysdep->core_sysdep_mutex_deinit(&http_handle->data_mutex);
http_handle->sysdep->core_sysdep_mutex_deinit(&http_handle->send_mutex);
http_handle->sysdep->core_sysdep_mutex_deinit(&http_handle->recv_mutex);
http_handle->sysdep->core_sysdep_free(http_handle);
*p_handle = NULL;
return STATE_SUCCESS;
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_http.c | C | apache-2.0 | 22,895 |
#ifndef _CORE_HTTP_H_
#define _CORE_HTTP_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "core_string.h"
#include "core_log.h"
#include "core_auth.h"
#include "aiot_http_api.h"
typedef enum {
CORE_HTTP_SM_READ_HEADER,
CORE_HTTP_SM_READ_BODY
} core_http_sm_t;
typedef struct {
core_http_sm_t sm;
uint32_t body_total_len;
uint32_t body_read_len;
} core_http_session_t;
typedef struct {
uint32_t code;
uint8_t *content;
uint32_t content_len;
uint32_t content_total_len;
} core_http_response_t;
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *network_handle;
char *host;
uint16_t port;
char *product_key;
char *device_name;
char *device_secret;
char *extend_devinfo;
uint32_t connect_timeout_ms;
uint32_t send_timeout_ms;
uint32_t recv_timeout_ms;
uint32_t auth_timeout_ms;
uint32_t deinit_timeout_ms;
uint32_t header_line_max_len;
uint32_t body_buffer_max_len;
aiot_sysdep_network_cred_t *cred;
char *token;
uint8_t long_connection;
uint8_t exec_enabled;
uint32_t exec_count;
uint8_t core_exec_enabled;
uint32_t core_exec_count;
void *data_mutex;
void *send_mutex;
void *recv_mutex;
core_http_session_t session;
aiot_http_event_handler_t event_handler;
aiot_http_recv_handler_t recv_handler;
aiot_http_recv_handler_t core_recv_handler;
void *userdata;
void *core_userdata;
} core_http_handle_t;
#define CORE_HTTP_MODULE_NAME "HTTP"
#define CORE_HTTP_DEINIT_INTERVAL_MS (100)
#define CORE_HTTP_DEFAULT_CONNECT_TIMEOUT_MS (10 * 1000)
#define CORE_HTTP_DEFAULT_AUTH_TIMEOUT_MS (5 * 1000)
#define CORE_HTTP_DEFAULT_SEND_TIMEOUT_MS (5 * 1000)
#define CORE_HTTP_DEFAULT_RECV_TIMEOUT_MS (5 * 1000)
#define CORE_HTTP_DEFAULT_HEADER_LINE_MAX_LEN (128)
#define CORE_HTTP_DEFAULT_BODY_MAX_LEN (128)
#define CORE_HTTP_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
typedef enum {
CORE_HTTPOPT_HOST, /* 数据类型: (char *), 服务器域名, 默认值: iot-as-http.cn-shanghai.aliyuncs.com */
CORE_HTTPOPT_PORT, /* 数据类型: (uint16_t), 服务器端口号, 默认值: 443 */
CORE_HTTPOPT_NETWORK_CRED, /* 数据类型: (aiot_sysdep_network_cred_t *), 网络安全凭证, 默认值: NULL */
CORE_HTTPOPT_CONNECT_TIMEOUT_MS, /* 数据类型: (uint32_t), 建立网络连接的超时时间 */
CORE_HTTPOPT_SEND_TIMEOUT_MS, /* 数据类型: (uint32_t), 网络发送超时时间(单位ms), 默认值: 5000ms */
CORE_HTTPOPT_RECV_TIMEOUT_MS, /* 数据类型: (uint32_t), 网络接受超时时间(单位ms), 默认值: 5000ms */
CORE_HTTPOPT_DEINIT_TIMEOUT_MS, /* 数据类型: (uint32_t), 销毁http实例时, 等地啊其他api执行完毕的时间 */
CORE_HTTPOPT_HEADER_LINE_MAX_LEN, /* 数据类型: (uint32_t), http协议中单行header的最大长度 */
CORE_HTTPOPT_BODY_BUFFER_MAX_LEN, /* 数据类型: (uint32_t), 每次读取的body最大长度 */
CORE_HTTPOPT_EVENT_HANDLER, /* 数据类型: (aiot_http_event_handler_t), 用户事件回调函数, 默认值: NULL */
/* 以上选项配置的数据与 AIOT_HTTPOPT_XXX 共用 */
CORE_HTTPOPT_USERDATA, /* 数据类型: (void *), 用户上下文数据指针, 默认值: NULL */
CORE_HTTPOPT_RECV_HANDLER, /* 数据类型: (aiot_http_event_handler_t), 用户数据接受回调函数, 默认值: NULL */
CORE_HTTPOPT_MAX
} core_http_option_t;
typedef struct {
char *method; /* HTTP请求方法, 可为"POST", "GET"等 */
char *path; /* HTTP请求的路径 */
char *header; /* HTTP请求的头部, 必须以单个\r\n结尾, 无需包含Content-Length */
uint8_t *content; /* 指向用户待发送Content的指针 */
uint32_t content_len; /* 用户待发送Content的长度 */
} core_http_request_t;
/**
* @brief 初始化一个HTTP实例, 并返回实例句柄
*
* @return void*
* @retval NotNull core HTTP句柄
* @retval Null 初始化HTTP实例失败
*/
void *core_http_init(void);
/**
* @brief 设置HTTP实例选项
*
* @param[in] handle HTTP句柄
* @param option 配置选项, 可查看枚举类型 @ref core_http_option_t
* @param[in] data 配置数据, 每个选项对应的数据类型可查看 @ref core_http_option_t
* @return int32_t
* @retval STATE_SUCCESS, 成功
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_OUT_RANGE, 用户输入参数无效
* @retval STATE_SYS_DEPEND_MALLOC_FAILED, 内存分配失败
*
*/
int32_t core_http_setopt(void *handle, core_http_option_t option, void *data);
/**
* @brief 建立网络连接
*
* @param handle HTTP句柄
* @return int32_t
* @retval STATE_SUCCESS 网络连接建立成功
* @retval <STATE_SUCCESS 网络连接建立失败
*/
int32_t core_http_connect(void *handle);
/**
* @brief 发送HTTP请求
*
* @param[in] handle HTTP句柄
* @param request 请求结构体, 查看 @ref core_http_request_t
* @return int32_t
* @retval > 0, 已发送的数据长度
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_NULL_POINTER, 用户输入参数为NULL
* @retval STATE_USER_INPUT_MISSING_HOST, 用户未配置Host
* @retval STATE_SYS_DEPEND_MALLOC_FAILED, 内存分配失败
* @retval STATE_SYS_DEPEND_NWK_EST_FAILED, 网络建立连接失败
* @retval STATE_SYS_DEPEND_NWK_CLOSED, 网络连接已关闭
* @retval STATE_SYS_DEPEND_NWK_WRITE_LESSDATA, 网络发送超时
*/
int32_t core_http_send(void *handle, const core_http_request_t *request);
/**
* @brief 接受HTTP应答数据, 内部将解析状态码和Header并通过回调函数通知用户, 若应答中有body则保存到用户缓冲区中
*
* @param[in] handle HTTP句柄
* @param buffer 指向存放接受
* @param buffer_len
* @return int32_t
* @retval >= 0, 接受到的HTTP body数据长度
* @retval STATE_HTTP_HANDLE_IS_NULL, HTTP句柄为NULL
* @retval STATE_USER_INPUT_NULL_POINTER, 用户输入参数为NULL
* @retval STATE_USER_INPUT_OUT_RANGE, buffer_len为0
* @retval STATE_SYS_DEPEND_NWK_CLOSED, 网络连接已关闭
* @retval STATE_SYS_DEPEND_NWK_READ_OVERTIME, 网络接收超时
* @retval STATE_HTTP_RECV_LINE_TOO_LONG, HTTP单行数据过长, 内部无法解析
* @retval STATE_HTTP_PARSE_STATUS_LINE_FAILED, 无法解析状态码
* @retval STATE_HTTP_GET_CONTENT_LEN_FAILED, 获取Content-Length失败
*
*/
int32_t core_http_recv(void *handle);
/**
* @brief 销毁参数p_handle所指定的HTTP实例
*
* @param[in] p_handle 指向HTTP句柄的指针
* @return int32_t
* @retval STATE_SUCCESS 成功
* @retval STATE_USER_INPUT_NULL_POINTER 参数p_handle为NULL或者p_handle指向的句柄为NULL
*/
int32_t core_http_deinit(void **p_handle);
#if defined(__cplusplus)
}
#endif
#endif /* #ifndef _CORE_HTTP_H_ */
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_http.h | C | apache-2.0 | 7,352 |
#ifndef _CORE_LIST_H_
#define _CORE_LIST_H_
#if defined(__cplusplus)
extern "C" {
#endif
#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) || defined(__GNUC__)) && \
!defined(inline) && !defined(__cplusplus)
#define inline __inline
#endif
struct core_list_head {
struct core_list_head *prev;
struct core_list_head *next;
};
/*
* Get offset of a member variable.
*
* @param[in] type the type of the struct this is embedded in.
* @param[in] member the name of the variable within the struct.
*/
#ifdef offsetof
#undef offsetof
#endif
#define offsetof(type, member) ((size_t)&(((type *)0)->member))
/*
* Get the struct for this entry.
*
* @param[in] ptr the list head to take the element from.
* @param[in] type the type of the struct this is embedded in.
* @param[in] member the name of the variable within the struct.
*/
#define container_of(ptr, type, member) \
((type *) ((char *) (ptr) - offsetof(type, member)))
static inline void CORE_INIT_LIST_HEAD(struct core_list_head *list)
{
list->next = list;
list->prev = list;
}
/*
* Insert a new entry between two known consecutive entries.
*
* This is only for internal list manipulation where we know
* the prev/next entries already!
*/
static inline void __core_list_add(struct core_list_head *node,
struct core_list_head *prev,
struct core_list_head *next)
{
next->prev = node;
node->next = next;
node->prev = prev;
prev->next = node;
}
/**
* core_list_add - add a new entry
* @node: new entry to be added
* @head: list head to add it after
*
* Insert a new entry after the specified head.
* This is good for implementing stacks.
*/
static inline void core_list_add(struct core_list_head *node, struct core_list_head *head)
{
__core_list_add(node, head, head->next);
}
/**
* core_list_add_tail - add a new entry
* @node: new entry to be added
* @head: list head to add it before
*
* Insert a new entry before the specified head.
* This is useful for implementing queues.
*/
static inline void core_list_add_tail(struct core_list_head *node, struct core_list_head *head)
{
__core_list_add(node, head->prev, head);
}
/*
* Delete a list entry by making the prev/next entries
* point to each other.
*
* This is only for internal list manipulation where we know
* the prev/next entries already!
*/
static inline void __core_list_del(struct core_list_head *prev, struct core_list_head *next)
{
next->prev = prev;
prev->next = next;
}
/**
* core_list_del - deletes entry from list.
* @entry: the element to delete from the list.
* Note: list_empty() on entry does not return true after this, the entry is
* in an undefined state.
*/
static inline void __core_list_del_entry(struct core_list_head *entry)
{
__core_list_del(entry->prev, entry->next);
}
static inline void core_list_del(struct core_list_head *entry)
{
__core_list_del_entry(entry);
entry->next = entry;
entry->prev = entry;
}
/**
* core_list_empty - tests whether a list is empty
* @head: the list to test.
*/
static inline int core_list_empty(const struct core_list_head *head)
{
return head->next == head;
}
/**
* core_list_entry - get the struct for this entry
* @ptr: the &struct core_list_head pointer.
* @type: the type of the struct this is embedded in.
* @member: the name of the core_list_head within the struct.
*/
#define core_list_entry(ptr, type, member) \
container_of(ptr, type, member)
/**
* core_list_first_entry - get the first element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the core_list_head within the struct.
*
* Note, that list is expected to be not empty.
*/
#define core_list_first_entry(ptr, type, member) \
core_list_entry((ptr)->next, type, member)
/**
* core_list_next_entry - get the next element in list
* @pos: the type * to cursor
* @member: the name of the core_list_head within the struct.
* @type: the type of the struct this is embedded in
*/
#define core_list_next_entry(pos, member, type) \
core_list_entry((pos)->member.next, type, member)
/**
* core_list_for_each_entry - iterate over list of given type
* @pos: the type * to use as a loop cursor.
* @head: the head for your list.
* @member: the name of the core_list_head within the struct.
* @type: the type of the struct this is embedded in
*/
#define core_list_for_each_entry(pos, head, member, type) \
for (pos = core_list_first_entry(head, type, member); \
&pos->member != (head); \
pos = core_list_next_entry(pos, member, type))
/**
* core_list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
* @member: the name of the core_list_head within the struct.
* @type: the type of the struct this is embedded in
*/
#define core_list_for_each_entry_safe(pos, n, head, member, type) \
for (pos = core_list_first_entry(head, type, member), \
n = core_list_next_entry(pos, member, type); \
&pos->member != (head); \
pos = n, n = core_list_next_entry(n, member, type))
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_list.h | C | apache-2.0 | 5,550 |
#include "core_log.h"
extern aiot_state_logcb_t g_logcb_handler;
static core_log_t g_core_log = { .time_start = 0, .time_interval = 0, .timestamp = 0, .log_stamp = 1, .log_date = 0};
static void _core_log_append_code(int32_t code, char *buffer)
{
uint8_t code_hex[4] = {0};
char code_str[9] = {0};
code_hex[0] = ((uint16_t)(-code) >> 8) & 0x000000FF;
code_hex[1] = ((uint16_t)(-code)) & 0x000000FF;
core_hex2str(code_hex, 2, code_str, 0);
memcpy(buffer + strlen(buffer), "[LK-", strlen("[LK-"));
memcpy(buffer + strlen(buffer), code_str, strlen(code_str));
memcpy(buffer + strlen(buffer), "] ", strlen("] "));
}
static uint64_t _core_log_get_timestamp(aiot_sysdep_portfile_t *sysdep)
{
uint64_t timenow = sysdep->core_sysdep_time();
/*NTP同步过时间，判断系统时间是否已更新，没更新进入if分支使用网络时间log*/
if (g_core_log.timestamp != 0 && g_core_log.timestamp > timenow)
{
if (timenow >= g_core_log.time_start) {
g_core_log.time_interval += timenow - g_core_log.time_start;
}else{
/* loss (max_time - g_core_log.time_start) ms */
g_core_log.time_interval += timenow;
}
g_core_log.time_start = timenow;
timenow = g_core_log.timestamp + g_core_log.time_interval;
}
return timenow;
}
void _core_log_append_date(aiot_sysdep_portfile_t *sysdep, uint64_t timestamp, char *buffer)
{
int32_t res = STATE_SUCCESS;
char date_str[7][11] = {{0}};
char *time = NULL;
char *time_src[] = { date_str[0], date_str[1], date_str[2], date_str[3], date_str[4], date_str[5] };
char *time_fmt = "%s/%s/%s %s:%s:%s";
core_date_t date;
memset(&date, 0, sizeof(core_date_t));
core_utc2date(timestamp, 8, &date);
core_uint2str(date.year, date_str[0], NULL);
core_uint2str(date.mon, date_str[1], NULL);
core_uint2str(date.day, date_str[2], NULL);
core_uint2str(date.hour, date_str[3], NULL);
core_uint2str(date.min, date_str[4], NULL);
core_uint2str(date.sec, date_str[5], NULL);
res = core_sprintf(sysdep, &time, time_fmt, time_src, sizeof(time_src)/sizeof(char *), CORE_LOG_MODULE_NAME);
if (res >= STATE_SUCCESS) {
memcpy(buffer + strlen(buffer), time, strlen(time));
sysdep->core_sysdep_free(time);
}
}
static void _core_log_append_prefix(aiot_sysdep_portfile_t *sysdep, int32_t code, char *buffer)
{
uint64_t timenow = 0;
if (sysdep == NULL) {
return;
}
timenow = _core_log_get_timestamp(sysdep);
if (1 == g_core_log.log_date) {
memcpy(buffer + strlen(buffer), "[", strlen("["));
_core_log_append_date(sysdep, timenow, buffer);
memcpy(buffer + strlen(buffer), "]", strlen("]"));
}
if(1 == g_core_log.log_stamp){
char timestamp_str[24] = {0};
uint8_t timestamp_len = 0;
core_uint642str(timenow, timestamp_str, ×tamp_len);
if (timestamp_len > 3) {
memcpy(×tamp_str[timestamp_len - 2], ×tamp_str[timestamp_len - 3], 3);
timestamp_str[timestamp_len - 3] = '.';
}
memcpy(buffer + strlen(buffer), "[", strlen("["));
memcpy(buffer + strlen(buffer), timestamp_str, strlen(timestamp_str));
memcpy(buffer + strlen(buffer), "]", strlen("]"));
}
_core_log_append_code(code, buffer);
}
static void _core_log(aiot_sysdep_portfile_t *sysdep, int32_t code, char *buffer, char *fmt, void *datas[],
uint8_t count)
{
uint32_t idx = 0, buffer_idx = 0, copy_len = 0, arg_flag = 0, arg_idx = 0;
void *arg = datas[arg_idx];
_core_log_append_prefix(sysdep, code, buffer);
buffer_idx += strlen(buffer);
for (idx = 0; idx < strlen(fmt);) {
if (buffer_idx >= CORE_LOG_MAXLEN) {
break;
}
if (arg_flag == 1) {
if (arg_idx < count - 1) {
arg = datas[++arg_idx];
} else {
arg = NULL;
}
arg_flag = 0;
}
if (fmt[idx] == '%' && fmt[idx + 1] == 's' && arg != NULL) {
char *value = arg;
copy_len = (strlen(buffer) + strlen(value) > CORE_LOG_MAXLEN) ? (CORE_LOG_MAXLEN - strlen(buffer)) : (strlen(value));
memcpy(buffer + strlen(buffer), value, copy_len);
buffer_idx += copy_len;
idx += 2;
arg_flag = 1;
} else if (memcmp(&fmt[idx], "%.*s", strlen("%.*s")) == 0 && arg != NULL && (arg_idx + 1) < count) {
char *value = (datas[arg_idx + 1] == NULL) ? ("") : (datas[arg_idx + 1]);
uint32_t len = (datas[arg_idx + 1] == NULL) ? (0) : (*(uint32_t *)arg);
copy_len = (strlen(buffer) + len > CORE_LOG_MAXLEN) ? (CORE_LOG_MAXLEN - strlen(buffer)) : (len);
memcpy(buffer + strlen(buffer), value, copy_len);
buffer_idx += copy_len;
idx += strlen("%.*s");
arg_flag = 1;
arg_idx++;
} else if (fmt[idx] == '%' && fmt[idx + 1] == 'd' && arg != NULL) {
char uint32_str[11] = {0};
core_uint2str(*(uint32_t *)arg, uint32_str, NULL);
copy_len = (strlen(buffer) + strlen(uint32_str) > CORE_LOG_MAXLEN) ? (CORE_LOG_MAXLEN - strlen(buffer)) : (strlen(
uint32_str));
memcpy(buffer + strlen(buffer), uint32_str, copy_len);
buffer_idx += copy_len;
idx += 2;
arg_flag = 1;
} else {
buffer[buffer_idx++] = fmt[idx++];
}
}
}
void core_log_set_timestamp(aiot_sysdep_portfile_t *sysdep, uint64_t timestamp)
{
g_core_log.timestamp = timestamp;
g_core_log.time_start = sysdep->core_sysdep_time();
g_core_log.time_interval = 0;
}
uint64_t core_log_get_timestamp(aiot_sysdep_portfile_t *sysdep)
{
return _core_log_get_timestamp(sysdep);
}
void core_log(aiot_sysdep_portfile_t *sysdep, int32_t code, char *data)
{
char buffer[CORE_LOG_MAXLEN + 3] = {0};
uint32_t len = 0;
if (g_logcb_handler == NULL) {
return;
}
buffer[CORE_LOG_MAXLEN] = '\r';
buffer[CORE_LOG_MAXLEN + 1] = '\n';
_core_log_append_prefix(sysdep, code, buffer);
len = (strlen(buffer) + strlen(data) > CORE_LOG_MAXLEN) ? (CORE_LOG_MAXLEN - strlen(buffer)) : (strlen(data));
memcpy(buffer + strlen(buffer), data, len);
g_logcb_handler(code, buffer);
}
void core_log1(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data)
{
char buffer[CORE_LOG_MAXLEN + 3] = {0};
void *datas[] = {data};
if (g_logcb_handler == NULL) {
return;
}
buffer[CORE_LOG_MAXLEN] = '\r';
buffer[CORE_LOG_MAXLEN + 1] = '\n';
_core_log(sysdep, code, buffer, fmt, datas, 1);
g_logcb_handler(code, buffer);
}
void core_log2(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2)
{
char buffer[CORE_LOG_MAXLEN + 3] = {0};
void *datas[] = {data1, data2};
if (g_logcb_handler == NULL) {
return;
}
buffer[CORE_LOG_MAXLEN] = '\r';
buffer[CORE_LOG_MAXLEN + 1] = '\n';
_core_log(sysdep, code, buffer, fmt, datas, 2);
g_logcb_handler(code, buffer);
}
void core_log3(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2, void *data3)
{
char buffer[CORE_LOG_MAXLEN + 3] = {0};
void *datas[] = {data1, data2, data3};
if (g_logcb_handler == NULL) {
return;
}
buffer[CORE_LOG_MAXLEN] = '\r';
buffer[CORE_LOG_MAXLEN + 1] = '\n';
_core_log(sysdep, code, buffer, fmt, datas, 3);
g_logcb_handler(code, buffer);
}
#if 0
void core_log4(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2, void *data3,
void *data4)
{
char buffer[CORE_LOG_MAXLEN + 3] = {0};
void *datas[] = {data1, data2, data3, data4};
if (g_logcb_handler == NULL) {
return;
}
buffer[CORE_LOG_MAXLEN] = '\r';
buffer[CORE_LOG_MAXLEN + 1] = '\n';
_core_log(sysdep, code, buffer, fmt, datas, 4);
g_logcb_handler(code, buffer);
}
#endif
void core_log_hexdump(int32_t code, char prefix, uint8_t *buffer, uint32_t len)
{
uint32_t idx = 0, line_idx = 0, ch_idx = 0, code_len = 0;
/* [LK-XXXX] + 1 + 1 + 16*3 + 1 + 1 + 1 + 16 + 2*/
char hexdump[25 + 72] = {0};
if (g_logcb_handler == NULL || len == 0) {
return;
}
g_logcb_handler(code, "\r\n");
_core_log_append_code(code, hexdump);
code_len = strlen(hexdump);
for (idx = 0; idx < len;) {
memset(hexdump + code_len, ' ', 71);
ch_idx = 2;
hexdump[code_len + 0] = prefix;
hexdump[code_len + 51] = '|';
hexdump[code_len + 52] = ' ';
for (line_idx = idx; ((line_idx - idx) < 16) && (line_idx < len); line_idx++) {
if ((line_idx - idx) == 8) {
ch_idx++;
}
core_hex2str((uint8_t *)&buffer[line_idx], 1, &hexdump[code_len + ch_idx], 0);
hexdump[code_len + ch_idx + 2] = ' ';
if (buffer[line_idx] >= 0x20 && buffer[line_idx] <= 0x7E) {
hexdump[code_len + 53 + (line_idx - idx)] = buffer[line_idx];
} else {
hexdump[code_len + 53 + (line_idx - idx)] = '.';
}
ch_idx += 3;
}
hexdump[code_len + 69] = '\r';
hexdump[code_len + 70] = '\n';
idx += (line_idx - idx);
g_logcb_handler(code, hexdump);
}
g_logcb_handler(code, "\r\n");
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_log.c | C | apache-2.0 | 9,556 |
#ifndef _CORE_LOG_H_
#define _CORE_LOG_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_string.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#define CORE_LOG_MODULE_NAME "LOG"
#define CORE_LOG_MAXLEN (160)
typedef struct {
uint64_t time_start;
uint64_t time_interval;
uint64_t timestamp;
uint8_t log_stamp;
uint8_t log_date;
} core_log_t;
void core_log_set_timestamp(aiot_sysdep_portfile_t *sysdep, uint64_t timestamp);
uint64_t core_log_get_timestamp(aiot_sysdep_portfile_t *sysdep);
void core_log(aiot_sysdep_portfile_t *sysdep, int32_t code, char *data);
void core_log1(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data);
void core_log2(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2);
void core_log3(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2, void *data3);
void core_log4(aiot_sysdep_portfile_t *sysdep, int32_t code, char *fmt, void *data1, void *data2, void *data3, void *data4);
void core_log_hexdump(int32_t code, char prefix, uint8_t *buffer, uint32_t len);
void _core_log_append_date(aiot_sysdep_portfile_t *sysdep, uint64_t timestamp, char *buffer);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_log.h | C | apache-2.0 | 1,278 |
#ifndef _CORE_MQTT_H_
#define _CORE_MQTT_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "core_list.h"
#include "core_string.h"
#include "core_log.h"
#include "core_auth.h"
#include "core_global.h"
#include "core_diag.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
/**
*
* MQTT3.1 Fixed Header
* | Bit | 7 ~ 4 | 3 ~ 0 |
* | byte 1 | MQTT Control Packet Type | Flags specific to each Type |
* | byte 2... | Remaining Length(1 ~ 4 bytes) |
*
* MQTT3.1 UTF-8 Encoded Strings
* | Bit | 7 ~ 0 |
* | byte 1 | String Length MSB |
* | byte 2 | String Length LSB |
* | byte 3... | UTF-8 Encoded Character Data |
*
*/
#define CORE_MQTT_FIXED_HEADER_LEN (1)
#define CORE_MQTT_REMAINLEN_MAXLEN (4)
#define CORE_MQTT_UTF8_STR_EXTRA_LEN (2)
#define CORE_MQTT_PACKETID_LEN (2)
#define CORE_MQTT_REQUEST_QOS_LEN (1)
#define CORE_MQTT_QOS0 (0x00)
#define CORE_MQTT_QOS1 (0x01)
#define CORE_MQTT_QOS_MAX (1)
#define CORE_MQTT_TOPIC_MAXLEN (128)
#define CORE_MQTT_PAYLOAD_MAXLEN (1024 * 1024 + 1)
/* MQTT 3.1 Connect Packet */
#define CORE_MQTT_CONN_PKT_TYPE (0x10)
#define CORE_MQTT_CONN_FIXED_HEADER_LEN (CORE_MQTT_FIXED_HEADER_LEN) /* value: 0x10 */
#define CORE_MQTT_CONN_REMAINLEN_MAXLEN (CORE_MQTT_REMAINLEN_MAXLEN)
#define CORE_MQTT_CONN_PROTOCOL_NAME_LEN (6) /* value: 0x00, 0x04, 0x4D, 0x51, 0x54, 0x54 */
#define CORE_MQTT_CONN_PROTOCOL_LEVEL_LEN (1) /* value: 0x04 */
#define CORE_MQTT_CONN_CONNECT_FLAG_LEN (1) /* value: 0xC0 */
#define CORE_MQTT_CONN_KEEP_ALIVE_LEN (2) /* value: CORE_MQTT_conn_pkt_t.keep_alive */
#define CORE_MQTT_CONN_FIXED_HEADER_TOTAL_LEN (CORE_MQTT_CONN_FIXED_HEADER_LEN + \
CORE_MQTT_CONN_REMAINLEN_MAXLEN + \
CORE_MQTT_CONN_PROTOCOL_NAME_LEN + \
CORE_MQTT_CONN_PROTOCOL_LEVEL_LEN + \
CORE_MQTT_CONN_CONNECT_FLAG_LEN + \
CORE_MQTT_CONN_KEEP_ALIVE_LEN)
#define CORE_MQTT_CONN_REMAINLEN_FIXED_LEN (CORE_MQTT_CONN_PROTOCOL_NAME_LEN + \
CORE_MQTT_CONN_PROTOCOL_LEVEL_LEN + \
CORE_MQTT_CONN_CONNECT_FLAG_LEN + \
CORE_MQTT_CONN_KEEP_ALIVE_LEN)
/* MQTT 3.1 Connect ACK Packet */
#define CORE_MQTT_CONNACK_PKT_TYPE (0x20)
#define CORE_MQTT_CONNACK_FIXED_HEADER_LEN (CORE_MQTT_FIXED_HEADER_LEN) /* value: 0x20 */
#define CORE_MQTT_CONNACK_REMAINLEN_MAXLEN (1) /* value: 0x02 */
#define CORE_MQTT_CONNACK_FLAGS_LEN (1) /* value: 0x00 */
#define CORE_MQTT_CONNACK_RETURN_CODE_LEN (1)
#define CORE_MQTT_CONNACK_FIXED_HEADER_TOTAL_LEN (CORE_MQTT_CONNACK_FIXED_HEADER_LEN + \
CORE_MQTT_CONNACK_REMAINLEN_MAXLEN + \
CORE_MQTT_CONNACK_FLAGS_LEN + \
CORE_MQTT_CONNACK_RETURN_CODE_LEN)
#define CORE_MQTT_CONNACK_RCODE_ACCEPTED (0x00)
#define CORE_MQTT_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION (0x01)
#define CORE_MQTT_CONNACK_RCODE_SERVER_UNAVAILABLE (0x02)
#define CORE_MQTT_CONNACK_RCODE_BAD_USERNAME_PASSWORD (0x03)
#define CORE_MQTT_CONNACK_RCODE_NOT_AUTHORIZED (0x04)
#define CORE_MQTT_DYNREG_CONNACK_RCODE_ACCEPTED (0x00)
#define CORE_MQTT_DYNREG_CONNACK_RCODE_IDENTIFIER_REJECTED (0x02)
#define CORE_MQTT_DYNREG_CONNACK_RCODE_SERVER_UNAVAILABLE (0x03)
#define CORE_MQTT_DYNREG_CONNACK_RCODE_BAD_USERNAME_PASSWORD (0x04)
/* MQTT 5.0 conack error code */
#define CORE_MQTT_V5_CONNACK_RCODE_UNACCEPTABLE_PROTOCOL_VERSION (0x84)
#define CORE_MQTT_V5_CONNACK_RCODE_BAD_USERNAME_PASSWORD (0x86)
#define CORE_MQTT_V5_CONNACK_RCODE_SERVER_UNAVAILABLE (0x88)
#define CORE_MQTT_V5_CONNACK_RCODE_NOT_AUTHORIZED (0x87)
/* MQTT 5.0 conack error code */
#define CORE_MQTT_V5_PROPERTY_ID_LEN (1)
#define CORE_MQTT_V5_USER_PROPERTY_KEY_LEN (2)
#define CORE_MQTT_V5_USER_PROPERTY_VALUE_LEN (2)
#define CORE_MQTT_V5_TOPIC_ALIAS_LEN (2)
#define CORE_MQTT_V5_TOPIC_ALIAS_MAX_LEN (2)
#define CORE_MQTT_V5_RECEIVE_MAX_LEN (2)
#define CORE_MQTT_V5_RESPONSE_TOPIC_LEN (2)
#define CORE_MQTT_V5_CORELATION_DATA_LEN (2)
#define CORE_MQTT_V5_REASON_STRING_LEN (2)
#define CORE_MQTT_V5_DISCONNECT_REASON_CODE_LEN (1)
/* MQTT 3.1 Disconnect Packet */
#define CORE_MQTT_DISCONNECT_PKT_TYPE (0xE0)
/* MQTT 3.1 Ping Request Packet */
#define CORE_MQTT_PINGREQ_PKT_TYPE (0xC0)
/* MQTT 3.1 Ping Response Packet */
#define CORE_MQTT_PINGRESP_PKT_TYPE (0xD0)
#define CORE_MQTT_PINGRESP_FIXED_HEADER_LEN (CORE_MQTT_FIXED_HEADER_LEN) /* value: 0xD0 */
#define CORE_MQTT_PINGRESP_REMAINLEN_MAXLEN (1) /* value: 0x00 */
/* MQTT 3.1 Publish Packet */
#define CORE_MQTT_PUBLISH_PKT_TYPE (0x30)
#define CORE_MQTT_PUBLISH_TOPICLEN_LEN (2)
/* MQTT 3.1 Publish ACK Packet */
#define CORE_MQTT_PUBACK_PKT_TYPE (0x40)
/* MQTT 3.1 Subscribe Packet */
#define CORE_MQTT_SUB_PKT_TYPE (0x80)
#define CORE_MQTT_SUB_PKT_RESERVE (0x02)
#define CORE_MQTT_UNSUB_PKT_RESERVE (0x02)
/* MQTT 3.1 Subscribe ACK Packet */
#define CORE_MQTT_SUBACK_PKT_TYPE (0x90)
#define CORE_MQTT_SUBACK_RCODE_MAXQOS0 (0x00)
#define CORE_MQTT_SUBACK_RCODE_MAXQOS1 (0x01)
#define CORE_MQTT_SUBACK_RCODE_MAXQOS2 (0x02)
#define CORE_MQTT_SUBACK_RCODE_FAILURE (0x80)
/* MQTT 3.1 Unsubscribe Packet */
#define CORE_MQTT_UNSUB_PKT_TYPE (0xA0)
/* MQTT 3.1 Unsubscribe ACK Packet */
#define CORE_MQTT_UNSUBACK_PKT_TYPE (0xB0)
/* MQTT 3.1 unimplemented Packet */
#define CORE_MQTT_PUBREC_PKT_TYPE (0x50)
#define CORE_MQTT_PUBREL_PKT_TYPE (0x60)
#define CORE_MQTT_PUBCOMP_PKT_TYPE (0x70)
/* MQTT 5.0 implemented Packet */
#define CORE_MQTT_SERVER_DISCONNECT_PKT_TYPE (0xE0)
typedef struct {
uint8_t *buffer;
uint32_t len;
} core_mqtt_buff_t;
typedef struct {
aiot_mqtt_recv_handler_t handler;
void *userdata;
struct core_list_head linked_node;
} core_mqtt_sub_handler_node_t;
typedef struct {
char *topic;
struct core_list_head linked_node;
struct core_list_head handle_list;
} core_mqtt_sub_node_t;
typedef struct {
uint16_t packet_id;
uint8_t *packet;
uint32_t len;
uint64_t last_send_time;
struct core_list_head linked_node;
} core_mqtt_pub_node_t;
typedef enum {
CORE_MQTTEVT_DEINIT
} core_mqtt_event_type_t;
typedef struct {
core_mqtt_event_type_t type;
} core_mqtt_event_t;
typedef void (*core_mqtt_process_handler_t)(void *context, aiot_mqtt_event_t *event, core_mqtt_event_t *core_event);
typedef struct {
core_mqtt_process_handler_t handler;
void *context;
} core_mqtt_process_data_t;
typedef struct {
core_mqtt_process_data_t process_data;
struct core_list_head linked_node;
} core_mqtt_process_data_node_t;
typedef struct {
uint32_t interval_ms;
uint8_t max_lost_times;
uint32_t lost_times;
uint64_t last_send_time;
} core_mqtt_heartbeat_t;
typedef struct {
uint8_t enabled;
uint32_t interval_ms;
uint64_t last_retry_time;
} core_mqtt_reconnect_t;
typedef struct {
/* network info */
uint8_t network_type; /* 0: TCP, 1: TLS */
uint64_t connect_timestamp;
uint32_t connect_time_used;
uint64_t failed_timestamp;
int32_t failed_error_code;
/* heartbeat rtt info */
uint64_t rtt;
} core_mqtt_nwkstats_info_t;
typedef struct {
aiot_sysdep_portfile_t *sysdep;
void *network_handle;
char *host;
uint16_t port;
char *product_key;
char *device_name;
char *device_secret;
char *username;
char *password;
char *clientid;
char *extend_clientid;
char *security_mode;
uint16_t keep_alive_s;
uint8_t clean_session;
uint8_t append_requestid;
uint32_t connect_timeout_ms;
core_mqtt_heartbeat_t heartbeat_params;
core_mqtt_reconnect_t reconnect_params;
uint32_t send_timeout_ms;
uint32_t recv_timeout_ms;
uint32_t repub_timeout_ms;
aiot_sysdep_network_cred_t *cred;
uint8_t has_connected;
uint8_t disconnected;
uint8_t disconnect_api_called;
uint8_t exec_enabled;
uint32_t exec_count;
uint32_t deinit_timeout_ms;
uint16_t packet_id;
void *data_mutex;
void *send_mutex;
void *recv_mutex;
void *sub_mutex;
void *pub_mutex;
void *process_handler_mutex;
struct core_list_head sub_list;
struct core_list_head pub_list;
struct core_list_head process_data_list;
aiot_mqtt_recv_handler_t recv_handler;
aiot_mqtt_event_handler_t event_handler;
/* network info stats */
core_mqtt_nwkstats_info_t nwkstats_info;
void *userdata;
/* mqtt protovol version */
uint8_t protocol_version;
/* mqtt 5.0 specific*/
void *topic_alias_mutex;
struct core_list_head rx_topic_alias_list;
struct core_list_head tx_topic_alias_list;
uint8_t *pre_connect_property;
uint8_t use_assigned_clientid;
uint32_t tx_packet_max_size;
uint32_t tx_topic_alias_max;
uint32_t tx_topic_alias;
uint16_t server_receive_max;
uint8_t flow_control_enabled;
} core_mqtt_handle_t;
/* topic alias node. mqtt 5.0 specific*/
typedef struct {
char *topic;
uint16_t topic_alias;
struct core_list_head linked_node;
} core_mqtt_topic_alias_node_t;
/**
* @brief MQTT5.0 属性的枚举
*
* @details
*
* 传入@ref conn_property_t 等数据结构的MQTT报文类型
*
*/
typedef enum {
CORE_MQTTPROP_UNRESOLVED = 0x00,
CORE_MQTTPROP_PAYLOAD_FORMAT_INDICATOR = 0x01,
CORE_MQTTPROP_PUBLICATION_EXPIRY_INTERVAL = 0x2,
CORE_MQTTPROP_CONTENT_TYPE = 0x3,
CORE_MQTTPROP_RESPONSE_TOPIC = 0x8,
CORE_MQTTPROP_CORRELATION_DATA = 0x9,
CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER = 0xB,
CORE_MQTTPROP_SESSION_EXPIRY_INTERVAL = 0x11,
CORE_MQTTPROP_ASSIGNED_CLIENT_IDENTIFIER = 0x12,
CORE_MQTTPROP_SERVER_KEEP_ALIVE = 0x13,
CORE_MQTTPROP_AUTHENTICATION_METHOD = 0x15,
CORE_MQTTPROP_AUTHENTICATION_DATA = 0x16,
CORE_MQTTPROP_REQUEST_PROBLEM_INFORMATION = 0x17,
CORE_MQTTPROP_WILL_DELAY_INTERVAL = 0x18,
CORE_MQTTPROP_REQUEST_RESPONSE_INFORMATION = 0x19,
CORE_MQTTPROP_RESPONSE_INFORMATION = 0x1A,
CORE_MQTTPROP_SERVER_REFERENCE = 0x1C,
CORE_MQTTPROP_REASON_STRING = 0x1F,
CORE_MQTTPROP_RECEIVE_MAXIMUM = 0x21,
CORE_MQTTPROP_TOPIC_ALIAS_MAX = 0x22,
CORE_MQTTPROP_TOPIC_ALIAS = 0x23,
CORE_MQTTPROP_MAX_QOS = 0x24,
CORE_MQTTPROP_RETAIN_AVAILABLE = 0x25,
CORE_MQTTPROP_USER_PROPERTY = 0x26,
CORE_MQTTPROP_MAX_PACK_SIZE = 0x27,
CORE_MQTTPROP_WILDCARD_SUBSCRIPTION_AVAILABLE = 0x28,
CORE_MQTTPROP_SUBSCRIPTION_IDENTIFIER_AVAILABLE = 0x29,
CORE_MQTTPROP_SHARED_SUBSCRIPTION_AVAILABLE = 0x2A,
CORE_MQTTPROP_MAX,
} core_mqtt_property_t;
/* tlv structure. mqtt 5.0 specific */
typedef struct {
core_mqtt_property_t type;
uint16_t len;
uint8_t *value;
} type_len_value_t;
/**
* @brief MQTT 5.0协议中, 上下行报文中所能携带属性
*/
typedef struct {
uint8_t max_qos;
uint16_t topic_alias_max; /* 服务端/设备端能够支持的topic alias最大值 */
uint8_t *assigned_clientid;
uint32_t max_packet_size;
uint8_t wildcard_subscription_available;
uint8_t subscription_identifier_available;
uint8_t shared_subscription_available;
uint32_t message_expire_interval;
uint16_t topic_alias;
len_value_t response_topic; /*response topic */
len_value_t correlation_data; /* 关联数据 */
uint32_t subscription_identifier;
user_property_t
*user_property[USER_PROPERTY_MAX]; /* 用户属性的列表 todo 改成**的结构 */
uint16_t server_receive_max; /* 服务端的qos1流控值 */
uint16_t client_receive_max; /* 设备端的qos1流控值 */
len_value_t *reason_string;
} general_property_t;
/* default configuration */
#define CORE_MQTT_MODULE_NAME "MQTT"
#define CORE_MQTT_DEINIT_INTERVAL_MS (100)
#define CORE_MQTT_DEFAULT_KEEPALIVE_S (1200)
#define CORE_MQTT_DEFAULT_CLEAN_SESSION (1)
#define CORE_MQTT_DEFAULT_CONNECT_TIMEOUT_MS (10 * 1000)
#define CORE_MQTT_DEFAULT_HEARTBEAT_INTERVAL_MS (25 * 1000)
#define CORE_MQTT_DEFAULT_HEARTBEAT_MAX_LOST_TIMES (2)
#define CORE_MQTT_DEFAULT_SEND_TIMEOUT_MS (5 * 1000)
#define CORE_MQTT_DEFAULT_RECV_TIMEOUT_MS (5 * 1000)
#define CORE_MQTT_DEFAULT_REPUB_TIMEOUT_MS (3 * 1000)
#define CORE_MQTT_DEFAULT_RECONN_ENABLED (1)
#define CORE_MQTT_DEFAULT_RECONN_INTERVAL_MS (2 * 1000)
#define CORE_MQTT_DEFAULT_DEINIT_TIMEOUT_MS (2 * 1000)
#define CORE_MQTT_DIAG_TLV_MQTT_CONNECTION (0x0010)
#define CORE_MQTT_DIAG_TLV_MQTT_HEARTBEAT (0x0020)
#define CORE_MQTT_NWKSTATS_RTT_THRESHOLD (10000)
/* default settings for mqtt 5.0 */
#define CORE_TX_PKT_MAX_LENGTH (1024 * 256)
#define CORE_DEFAULT_SERVER_RECEIVE_MAX (10)
#define CORE_MQTT_USER_PROPERTY_KEY_MAX_LEN (128) /* max key length for user property */
#define CORE_MQTT_USER_PROPERTY_VALUE_MAX_LEN (128) /* max value length for user property */
typedef enum {
CORE_MQTTOPT_APPEND_PROCESS_HANDLER,
CORE_MQTTOPT_REMOVE_PROCESS_HANDLER,
CORE_MQTTOPT_MAX
} core_mqtt_option_t;
int32_t core_mqtt_setopt(void *handle, core_mqtt_option_t option, void *data);
char *core_mqtt_get_product_key(void *handle);
char *core_mqtt_get_device_name(void *handle);
uint16_t core_mqtt_get_port(void *handle);
int32_t core_mqtt_get_nwkstats(void *handle, core_mqtt_nwkstats_info_t *nwk_stats_info);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_mqtt.h | C | apache-2.0 | 14,733 |
#include "core_sha256.h"
#define MINI_SHA256_SMALLER
#define SHA256_KEY_IOPAD_SIZE (64)
#define SHA256_DIGEST_SIZE (32)
/*
* 32-bit integer manipulation macros (big endian)
*/
#ifndef GET_UINT32_BE
#define GET_UINT32_BE(n,b,i) \
do { \
(n) = ( (uint32_t) (b)[(i) ] << 24 ) \
| ( (uint32_t) (b)[(i) + 1] << 16 ) \
| ( (uint32_t) (b)[(i) + 2] << 8 ) \
| ( (uint32_t) (b)[(i) + 3] ); \
} while( 0 )
#endif
#ifndef PUT_UINT32_BE
#define PUT_UINT32_BE(n,b,i) \
do { \
(b)[(i) ] = (unsigned char) ( (n) >> 24 ); \
(b)[(i) + 1] = (unsigned char) ( (n) >> 16 ); \
(b)[(i) + 2] = (unsigned char) ( (n) >> 8 ); \
(b)[(i) + 3] = (unsigned char) ( (n) ); \
} while( 0 )
#endif
static void utils_sha256_zeroize(void *v, uint32_t n)
{
volatile unsigned char *p = v;
while (n--) {
*p++ = 0;
}
}
void core_sha256_init(core_sha256_context_t *ctx)
{
memset(ctx, 0, sizeof(core_sha256_context_t));
}
void core_sha256_free(core_sha256_context_t *ctx)
{
if (NULL == ctx) {
return;
}
utils_sha256_zeroize(ctx, sizeof(core_sha256_context_t));
}
void core_sha256_starts(core_sha256_context_t *ctx)
{
uint8_t is224 = 0;
ctx->total[0] = 0;
ctx->total[1] = 0;
if (is224 == 0) {
/* SHA-256 */
ctx->state[0] = 0x6A09E667;
ctx->state[1] = 0xBB67AE85;
ctx->state[2] = 0x3C6EF372;
ctx->state[3] = 0xA54FF53A;
ctx->state[4] = 0x510E527F;
ctx->state[5] = 0x9B05688C;
ctx->state[6] = 0x1F83D9AB;
ctx->state[7] = 0x5BE0CD19;
}
ctx->is224 = is224;
}
static const uint32_t K[] = {
0x428A2F98, 0x71374491, 0xB5C0FBCF, 0xE9B5DBA5,
0x3956C25B, 0x59F111F1, 0x923F82A4, 0xAB1C5ED5,
0xD807AA98, 0x12835B01, 0x243185BE, 0x550C7DC3,
0x72BE5D74, 0x80DEB1FE, 0x9BDC06A7, 0xC19BF174,
0xE49B69C1, 0xEFBE4786, 0x0FC19DC6, 0x240CA1CC,
0x2DE92C6F, 0x4A7484AA, 0x5CB0A9DC, 0x76F988DA,
0x983E5152, 0xA831C66D, 0xB00327C8, 0xBF597FC7,
0xC6E00BF3, 0xD5A79147, 0x06CA6351, 0x14292967,
0x27B70A85, 0x2E1B2138, 0x4D2C6DFC, 0x53380D13,
0x650A7354, 0x766A0ABB, 0x81C2C92E, 0x92722C85,
0xA2BFE8A1, 0xA81A664B, 0xC24B8B70, 0xC76C51A3,
0xD192E819, 0xD6990624, 0xF40E3585, 0x106AA070,
0x19A4C116, 0x1E376C08, 0x2748774C, 0x34B0BCB5,
0x391C0CB3, 0x4ED8AA4A, 0x5B9CCA4F, 0x682E6FF3,
0x748F82EE, 0x78A5636F, 0x84C87814, 0x8CC70208,
0x90BEFFFA, 0xA4506CEB, 0xBEF9A3F7, 0xC67178F2,
};
#define SHR(x,n) ((x & 0xFFFFFFFF) >> n)
#define ROTR(x,n) (SHR(x,n) | (x << (32 - n)))
#define S0(x) (ROTR(x, 7) ^ ROTR(x,18) ^ SHR(x, 3))
#define S1(x) (ROTR(x,17) ^ ROTR(x,19) ^ SHR(x,10))
#define S2(x) (ROTR(x, 2) ^ ROTR(x,13) ^ ROTR(x,22))
#define S3(x) (ROTR(x, 6) ^ ROTR(x,11) ^ ROTR(x,25))
#define F0(x,y,z) ((x & y) | (z & (x | y)))
#define F1(x,y,z) (z ^ (x & (y ^ z)))
#define R(t) \
( \
W[t] = S1(W[t - 2]) + W[t - 7] + \
S0(W[t - 15]) + W[t - 16] \
)
#define P(a,b,c,d,e,f,g,h,x,K) \
{ \
temp1 = h + S3(e) + F1(e,f,g) + K + x; \
temp2 = S2(a) + F0(a,b,c); \
d += temp1; h = temp1 + temp2; \
}
void core_sha256_process(core_sha256_context_t *ctx, const unsigned char data[64])
{
uint32_t temp1, temp2, W[64];
uint32_t A[8];
unsigned int i;
for (i = 0; i < 8; i++) {
A[i] = ctx->state[i];
}
#if defined(MINI_SHA256_SMALLER)
for (i = 0; i < 64; i++) {
if (i < 16) {
GET_UINT32_BE(W[i], data, 4 * i);
} else {
R(i);
}
P(A[0], A[1], A[2], A[3], A[4], A[5], A[6], A[7], W[i], K[i]);
temp1 = A[7];
A[7] = A[6];
A[6] = A[5];
A[5] = A[4];
A[4] = A[3];
A[3] = A[2];
A[2] = A[1];
A[1] = A[0];
A[0] = temp1;
}
#else /* MINI_SHA256_SMALLER */
for (i = 0; i < 16; i++) {
GET_UINT32_BE(W[i], data, 4 * i);
}
for (i = 0; i < 16; i += 8) {
P(A[0], A[1], A[2], A[3], A[4], A[5], A[6], A[7], W[i + 0], K[i + 0]);
P(A[7], A[0], A[1], A[2], A[3], A[4], A[5], A[6], W[i + 1], K[i + 1]);
P(A[6], A[7], A[0], A[1], A[2], A[3], A[4], A[5], W[i + 2], K[i + 2]);
P(A[5], A[6], A[7], A[0], A[1], A[2], A[3], A[4], W[i + 3], K[i + 3]);
P(A[4], A[5], A[6], A[7], A[0], A[1], A[2], A[3], W[i + 4], K[i + 4]);
P(A[3], A[4], A[5], A[6], A[7], A[0], A[1], A[2], W[i + 5], K[i + 5]);
P(A[2], A[3], A[4], A[5], A[6], A[7], A[0], A[1], W[i + 6], K[i + 6]);
P(A[1], A[2], A[3], A[4], A[5], A[6], A[7], A[0], W[i + 7], K[i + 7]);
}
for (i = 16; i < 64; i += 8) {
P(A[0], A[1], A[2], A[3], A[4], A[5], A[6], A[7], R(i + 0), K[i + 0]);
P(A[7], A[0], A[1], A[2], A[3], A[4], A[5], A[6], R(i + 1), K[i + 1]);
P(A[6], A[7], A[0], A[1], A[2], A[3], A[4], A[5], R(i + 2), K[i + 2]);
P(A[5], A[6], A[7], A[0], A[1], A[2], A[3], A[4], R(i + 3), K[i + 3]);
P(A[4], A[5], A[6], A[7], A[0], A[1], A[2], A[3], R(i + 4), K[i + 4]);
P(A[3], A[4], A[5], A[6], A[7], A[0], A[1], A[2], R(i + 5), K[i + 5]);
P(A[2], A[3], A[4], A[5], A[6], A[7], A[0], A[1], R(i + 6), K[i + 6]);
P(A[1], A[2], A[3], A[4], A[5], A[6], A[7], A[0], R(i + 7), K[i + 7]);
}
#endif /* MINI_SHA256_SMALLER */
for (i = 0; i < 8; i++) {
ctx->state[i] += A[i];
}
}
void core_sha256_update(core_sha256_context_t *ctx, const unsigned char *input, uint32_t ilen)
{
size_t fill;
uint32_t left;
if (ilen == 0) {
return;
}
left = ctx->total[0] & 0x3F;
fill = 64 - left;
ctx->total[0] += (uint32_t) ilen;
ctx->total[0] &= 0xFFFFFFFF;
if (ctx->total[0] < (uint32_t) ilen) {
ctx->total[1]++;
}
if (left && ilen >= fill) {
memcpy((void *)(ctx->buffer + left), input, fill);
core_sha256_process(ctx, ctx->buffer);
input += fill;
ilen -= fill;
left = 0;
}
while (ilen >= 64) {
core_sha256_process(ctx, input);
input += 64;
ilen -= 64;
}
if (ilen > 0) {
memcpy((void *)(ctx->buffer + left), input, ilen);
}
}
static const unsigned char sha256_padding[64] = {
0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
};
void core_sha256_finish(core_sha256_context_t *ctx, uint8_t output[32])
{
uint32_t last, padn;
uint32_t high, low;
unsigned char msglen[8];
high = (ctx->total[0] >> 29)
| (ctx->total[1] << 3);
low = (ctx->total[0] << 3);
PUT_UINT32_BE(high, msglen, 0);
PUT_UINT32_BE(low, msglen, 4);
last = ctx->total[0] & 0x3F;
padn = (last < 56) ? (56 - last) : (120 - last);
core_sha256_update(ctx, sha256_padding, padn);
core_sha256_update(ctx, msglen, 8);
PUT_UINT32_BE(ctx->state[0], output, 0);
PUT_UINT32_BE(ctx->state[1], output, 4);
PUT_UINT32_BE(ctx->state[2], output, 8);
PUT_UINT32_BE(ctx->state[3], output, 12);
PUT_UINT32_BE(ctx->state[4], output, 16);
PUT_UINT32_BE(ctx->state[5], output, 20);
PUT_UINT32_BE(ctx->state[6], output, 24);
if (ctx->is224 == 0) {
PUT_UINT32_BE(ctx->state[7], output, 28);
}
}
void core_sha256(const uint8_t *input, uint32_t ilen, uint8_t output[32])
{
core_sha256_context_t ctx;
core_sha256_init(&ctx);
core_sha256_starts(&ctx);
core_sha256_update(&ctx, input, ilen);
core_sha256_finish(&ctx, output);
core_sha256_free(&ctx);
}
void core_hmac_sha256(const uint8_t *msg, uint32_t msg_len, const uint8_t *key, uint32_t key_len, uint8_t output[32])
{
core_sha256_context_t context;
uint8_t k_ipad[SHA256_KEY_IOPAD_SIZE]; /* inner padding - key XORd with ipad */
uint8_t k_opad[SHA256_KEY_IOPAD_SIZE]; /* outer padding - key XORd with opad */
int32_t i;
if ((NULL == msg) || (NULL == key) || (NULL == output)) {
return;
}
if (key_len > SHA256_KEY_IOPAD_SIZE) {
return;
}
/* start out by storing key in pads */
memset(k_ipad, 0, sizeof(k_ipad));
memset(k_opad, 0, sizeof(k_opad));
memcpy(k_ipad, key, key_len);
memcpy(k_opad, key, key_len);
/* XOR key with ipad and opad values */
for (i = 0; i < SHA256_KEY_IOPAD_SIZE; i++) {
k_ipad[i] ^= 0x36;
k_opad[i] ^= 0x5c;
}
/* perform inner SHA */
core_sha256_init(&context); /* init context for 1st pass */
core_sha256_starts(&context); /* setup context for 1st pass */
core_sha256_update(&context, k_ipad, SHA256_KEY_IOPAD_SIZE); /* start with inner pad */
core_sha256_update(&context, msg, msg_len); /* then text of datagram */
core_sha256_finish(&context, output); /* finish up 1st pass */
/* perform outer SHA */
core_sha256_init(&context); /* init context for 2nd pass */
core_sha256_starts(&context); /* setup context for 2nd pass */
core_sha256_update(&context, k_opad, SHA256_KEY_IOPAD_SIZE); /* start with outer pad */
core_sha256_update(&context, output, SHA256_DIGEST_SIZE); /* then results of 1st hash */
core_sha256_finish(&context, output); /* finish up 2nd pass */
}
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_sha256.c | C | apache-2.0 | 10,019 |
#ifndef _CORE_SHA256_H_
#define _CORE_SHA256_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#define CORE_SHA256_DIGEST_LENGTH (32)
#define CORE_SHA256_BLOCK_LENGTH (64)
#define CORE_SHA256_SHORT_BLOCK_LENGTH (CORE_SHA256_BLOCK_LENGTH - 8)
#define CORE_SHA256_DIGEST_STRING_LENGTH (CORE_SHA256_DIGEST_LENGTH * 2 + 1)
/**
* \brief SHA-256 context structure
*/
typedef struct {
uint32_t total[2]; /*!< number of bytes processed */
uint32_t state[8]; /*!< intermediate digest state */
unsigned char buffer[64]; /*!< data block being processed */
uint8_t is224; /*!< 0 => SHA-256, else SHA-224 */
} core_sha256_context_t;
/**
* \brief Initialize SHA-256 context
*
* \param ctx SHA-256 context to be initialized
*/
void core_sha256_init(core_sha256_context_t *ctx);
/**
* \brief Clear SHA-256 context
*
* \param ctx SHA-256 context to be cleared
*/
void core_sha256_free(core_sha256_context_t *ctx);
/**
* \brief SHA-256 context setup
*
* \param ctx context to be initialized
*/
void core_sha256_starts(core_sha256_context_t *ctx);
/**
* \brief SHA-256 process buffer
*
* \param ctx SHA-256 context
* \param input buffer holding the data
* \param ilen length of the input data
*/
void core_sha256_update(core_sha256_context_t *ctx, const unsigned char *input, uint32_t ilen);
/**
* \brief SHA-256 final digest
*
* \param ctx SHA-256 context
* \param output SHA-256 checksum result
*/
void core_sha256_finish(core_sha256_context_t *ctx, uint8_t output[32]);
/* Internal use */
void core_sha256_process(core_sha256_context_t *ctx, const unsigned char data[64]);
/**
* \brief Output = SHA-256( input buffer )
*
* \param input buffer holding the data
* \param ilen length of the input data
* \param output SHA-256 checksum result
*/
void core_sha256(const uint8_t *input, uint32_t ilen, uint8_t output[32]);
void core_hmac_sha256(const uint8_t *msg, uint32_t msg_len, const uint8_t *key, uint32_t key_len, uint8_t output[32]);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_sha256.h | C | apache-2.0 | 2,227 |
#include "core_string.h"
int32_t core_str2uint(char *input, uint8_t input_len, uint32_t *output)
{
uint8_t index = 0;
uint32_t temp = 0;
for (index = 0; index < input_len; index++) {
if (input[index] < '0' || input[index] > '9') {
return STATE_USER_INPUT_OUT_RANGE;
}
temp = temp * 10 + input[index] - '0';
}
*output = temp;
return STATE_SUCCESS;
}
int32_t core_str2uint64(char *input, uint8_t input_len, uint64_t *output)
{
uint8_t index = 0;
uint64_t temp = 0;
for (index = 0; index < input_len; index++) {
if (input[index] < '0' || input[index] > '9') {
return STATE_USER_INPUT_OUT_RANGE;
}
temp = temp * 10 + input[index] - '0';
}
*output = temp;
return STATE_SUCCESS;
}
int32_t core_uint2str(uint32_t input, char *output, uint8_t *output_len)
{
uint8_t i = 0, j = 0;
char temp[10] = {0};
do {
temp[i++] = input % 10 + '0';
} while ((input /= 10) > 0);
do {
output[--i] = temp[j++];
} while (i > 0);
if (output_len) {
*output_len = j;
}
return STATE_SUCCESS;
}
int32_t core_uint642str(uint64_t input, char *output, uint8_t *output_len)
{
uint8_t i = 0, j = 0;
char temp[20] = {0};
do {
temp[i++] = input % 10 + '0';
} while ((input /= 10) > 0);
do {
output[--i] = temp[j++];
} while (i > 0);
if (output_len) {
*output_len = j;
}
return STATE_SUCCESS;
}
int32_t core_int2str(int32_t input, char *output, uint8_t *output_len)
{
uint8_t i = 0, j = 0, minus = 0;
char temp[11] = {0};
int64_t in = input;
if (in < 0) {
minus = 1;
in = -in;
}
do {
temp[minus + (i++)] = in % 10 + '0';
} while ((in /= 10) > 0);
do {
output[minus + (--i)] = temp[minus + (j++)];
} while (i > 0);
if (minus == 1) {
output[0] = '-';
}
if (output_len) {
*output_len = j + minus;
}
return STATE_SUCCESS;
}
int32_t core_hex2str(uint8_t *input, uint32_t input_len, char *output, uint8_t lowercase)
{
char *upper = "0123456789ABCDEF";
char *lower = "0123456789abcdef";
char *encode = upper;
int i = 0, j = 0;
if (lowercase) {
encode = lower;
}
for (i = 0; i < input_len; i++) {
output[j++] = encode[(input[i] >> 4) & 0xf];
output[j++] = encode[(input[i]) & 0xf];
}
return STATE_SUCCESS;
}
int32_t core_str2hex(char *input, uint32_t input_len, uint8_t *output)
{
uint32_t idx = 0;
if (input_len % 2 != 0) {
return STATE_USER_INPUT_OUT_RANGE;
}
for (idx = 0; idx < input_len; idx += 2) {
if (input[idx] >= '0' && input[idx] <= '9') {
output[idx / 2] = (input[idx] - '0') << 4;
} else if (input[idx] >= 'A' && input[idx] <= 'F') {
output[idx / 2] = (input[idx] - 'A' + 0x0A) << 4;
} else if (input[idx] >= 'a' && input[idx] <= 'f') {
output[idx / 2] = (input[idx] - 'a' + 0x0A) << 4;
}
if (input[idx + 1] >= '0' && input[idx + 1] <= '9') {
output[idx / 2] |= (input[idx + 1] - '0');
} else if (input[idx + 1] >= 'A' && input[idx + 1] <= 'F') {
output[idx / 2] |= (input[idx + 1] - 'A' + 0x0A);
} else if (input[idx + 1] >= 'a' && input[idx + 1] <= 'f') {
output[idx / 2] |= (input[idx + 1] - 'a' + 0x0A);
}
}
return STATE_SUCCESS;
}
int32_t core_strdup(aiot_sysdep_portfile_t *sysdep, char **dest, char *src, char *module_name)
{
if (*dest != NULL) {
sysdep->core_sysdep_free(*dest);
*dest = NULL;
}
*dest = sysdep->core_sysdep_malloc((uint32_t)(strlen(src) + 1), module_name);
if (*dest == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(*dest, 0, strlen(src) + 1);
memcpy(*dest, src, strlen(src));
return STATE_SUCCESS;
}
int32_t core_sprintf(aiot_sysdep_portfile_t *sysdep, char **dest, char *fmt, char *src[], uint8_t count,
char *module_name)
{
char *buffer = NULL, *value = NULL;
uint8_t idx = 0, percent_idx = 0;
uint32_t buffer_len = 0;
buffer_len += strlen(fmt) - 2 * count;
for (percent_idx = 0; percent_idx < count; percent_idx++) {
value = (*(src + percent_idx) == NULL) ? ("") : (*(src + percent_idx));
buffer_len += strlen(value);
}
buffer = sysdep->core_sysdep_malloc(buffer_len + 1, module_name);
if (buffer == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(buffer, 0, buffer_len + 1);
for (idx = 0, percent_idx = 0; idx < strlen(fmt);) {
if (fmt[idx] == '%' && fmt[idx + 1] == 's') {
value = (*(src + percent_idx) == NULL) ? ("") : (*(src + percent_idx));
memcpy(buffer + strlen(buffer), value, strlen(value));
percent_idx++;
idx += 2;
} else {
buffer[strlen(buffer)] = fmt[idx++];
}
}
*dest = buffer;
return STATE_SUCCESS;
}
int32_t core_json_value(const char *input, uint32_t input_len, const char *key, uint32_t key_len, char **value,
uint32_t *value_len)
{
uint32_t idx = 0;
for (idx = 0; idx < input_len; idx++) {
if (idx + key_len >= input_len) {
return STATE_USER_INPUT_JSON_PARSE_FAILED;
}
if ((memcmp(&input[idx], key, key_len) == 0) &&
((idx > 0) && (input[idx - 1] == '"')) &&
((idx + key_len < input_len) && (input[idx + key_len] == '"'))) {
idx += key_len;
/* shortest ":x, or ":x} or ":x] */
if ((idx + 2 >= input_len) ||
(input[idx + 1] != ':')) {
return STATE_USER_INPUT_JSON_PARSE_FAILED;
}
idx += 2;
if (input[idx] == '"') {
*value = (char *)&input[++idx];
for (; idx < input_len; idx++) {
if ((input[idx] == '"')) {
*value_len = (uint32_t)(idx - (*value - input));
return STATE_SUCCESS;
}
}
} else if (input[idx] == '{' || input[idx] == '[') {
char start = input[idx];
char end = (start == '{') ? ('}') : (']');
uint8_t count = 0;
*value = (char *)&input[idx];
for (; idx < input_len; idx++) {
if ((input[idx] == start)) {
count++;
} else if ((input[idx] == end)) {
if (--count == 0) {
*value_len = (uint32_t)(idx - (*value - input) + 1);
return STATE_SUCCESS;
}
}
}
} else {
*value = (char *)&input[idx];
for (; idx < input_len; idx++) {
if ((input[idx] == ',' || input[idx] == ']' || input[idx] == '}')) {
*value_len = (uint32_t)(idx - (*value - input));
return STATE_SUCCESS;
}
}
}
}
}
return STATE_USER_INPUT_JSON_PARSE_FAILED;
}
int32_t core_utc2date(uint64_t utc, int8_t zone, core_date_t *date)
{
uint32_t day_sec = 0, day_num = 0;
uint64_t utc_zone_s = 0;
#define DAYS_IN_YEAR(year) (IS_LEAP_YEAR(year) ? 366 : 365)
#define IS_LEAP_YEAR(year) (!((year) % 400) || (((year) % 100) && !((year) % 4)))
#define DAYS_IN_MONTH(lpyr, mon) ((mon == 1)?(28 + lpyr):((mon > 6)?(((mon - 1) & 1)?(30):(31)):((mon & 1)?(30):(31))))
date->msec = utc % 1000;
utc_zone_s = (utc / 1000) + (zone * 60 * 60);
day_sec = utc_zone_s % (24 * 60 * 60);
day_num = utc_zone_s / (24 * 60 * 60);
date->sec = day_sec % 60;
date->min = (day_sec % 3600) / 60;
date->hour = day_sec / 3600;
date->year = 1970;
while (day_num >= DAYS_IN_YEAR(date->year)) {
day_num -= DAYS_IN_YEAR(date->year);
date->year++;
}
date->mon = 0;
while (day_num >= DAYS_IN_MONTH(IS_LEAP_YEAR(date->year), date->mon)) {
day_num -= DAYS_IN_MONTH(IS_LEAP_YEAR(date->year), date->mon);
date->mon++;
}
date->mon++;
date->day = day_num + 1;
return 0;
}
#if 0
int32_t core_strcat(aiot_sysdep_portfile_t *sysdep, char **dest, char *src1, char *src2, char *module_name)
{
uint32_t dest_len = 0;
char *tmp_dest = NULL;
dest_len = strlen(src1) + strlen(src2) + 1;
tmp_dest = sysdep->core_sysdep_malloc(dest_len, module_name);
if (tmp_dest == NULL) {
return STATE_SYS_DEPEND_MALLOC_FAILED;
}
memset(tmp_dest, 0, dest_len);
memcpy(tmp_dest + strlen(tmp_dest), src1, strlen(src1));
memcpy(tmp_dest + strlen(tmp_dest), src2, strlen(src2));
if (*dest != NULL) {
sysdep->core_sysdep_free(*dest);
*dest = NULL;
}
*dest = tmp_dest;
return STATE_SUCCESS;
}
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_string.c | C | apache-2.0 | 9,085 |
#ifndef _CORE_STRING_H_
#define _CORE_STRING_H_
#if defined(__cplusplus)
extern "C" {
#endif
#include "core_stdinc.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
typedef struct {
uint32_t year;
uint32_t mon;
uint32_t day;
uint32_t hour;
uint32_t min;
uint32_t sec;
uint32_t msec;
} core_date_t;
int32_t core_str2uint(char *input, uint8_t input_len, uint32_t *output);
int32_t core_str2uint64(char *input, uint8_t input_len, uint64_t *output);
int32_t core_uint2str(uint32_t input, char *output, uint8_t *output_len);
int32_t core_uint642str(uint64_t input, char *output, uint8_t *output_len);
int32_t core_int2str(int32_t input, char *output, uint8_t *output_len);
int32_t core_hex2str(uint8_t *input, uint32_t input_len, char *output, uint8_t lowercase);
int32_t core_str2hex(char *input, uint32_t input_len, uint8_t *output);
int32_t core_strdup(aiot_sysdep_portfile_t *sysdep, char **dest, char *src, char *module_name);
int32_t core_sprintf(aiot_sysdep_portfile_t *sysdep, char **dest, char *fmt, char *src[], uint8_t count,
char *module_name);
int32_t core_json_value(const char *input, uint32_t input_len, const char *key, uint32_t key_len, char **value,
uint32_t *value_len);
int32_t core_utc2date(uint64_t utc, int8_t zone, core_date_t *date);
int32_t core_strcat(aiot_sysdep_portfile_t *sysdep, char **dest, char *src1, char *src2, char *module_name);
#if defined(__cplusplus)
}
#endif
#endif
| YifuLiu/AliOS-Things | components/linksdk/core/utils/core_string.h | C | apache-2.0 | 1,495 |
#include "dm_export.h"
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
#include "aiot_mqtt_api.h"
#include "aiot_dm_api.h"
extern const char *ali_ca_cert;
SYMBOL_EXPORT(ali_ca_cert);
extern aiot_sysdep_portfile_t g_aiot_sysdep_portfile;
SYMBOL_EXPORT(g_aiot_sysdep_portfile);
SYMBOL_EXPORT(aiot_dm_send);
SYMBOL_EXPORT(aiot_mqtt_deinit);
SYMBOL_EXPORT(aiot_mqtt_connect);
SYMBOL_EXPORT(aiot_mqtt_recv);
SYMBOL_EXPORT(aiot_sysdep_set_portfile);
SYMBOL_EXPORT(aiot_mqtt_process);
SYMBOL_EXPORT(aiot_state_set_logcb);
SYMBOL_EXPORT(aiot_mqtt_setopt);
SYMBOL_EXPORT(aiot_dm_setopt);
SYMBOL_EXPORT(aiot_dm_init);
SYMBOL_EXPORT(aiot_mqtt_init);
| YifuLiu/AliOS-Things | components/linksdk/export.c | C | apache-2.0 | 649 |
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <stddef.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/time.h>
#include <sys/types.h>
#include <aos/kernel.h>
#include <sys/socket.h>
#include <netdb.h>
#include <errno.h>
#include "aiot_state_api.h"
#include "aiot_sysdep_api.h"
/* socket建连时间默认最大值 */
#define CORE_SYSDEP_DEFAULT_CONNECT_TIMEOUT_MS (10 * 1000)
/*
* CORE_SYSDEP_MBEDTLS_ENABLED 不是一个用户需要关心的编译开关
*
* 大多数情况下, 就保持它如下的设置即可
* 只有少数时候, SDK的用户关心对接层代码的ROM尺寸, 并且也没有选择用TLS连接服务器
* 那时才会出现, 将 CORE_SYSDEP_MBEDTLS_ENABLED 宏定义关闭的改动, 以减小对接尺寸
*
* 我们不建议去掉 #define CORE_SYSDEP_MBEDTLS_ENABLED 这行代码
* 虽然物联网平台接收TCP方式的连接, 但我们不推荐这样做, TLS是更安全的通信方式
*
*/
#define CORE_SYSDEP_MBEDTLS_ENABLED
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
#include "mbedtls/sha256.h"
#include "mbedtls/net_sockets.h"
#include "mbedtls/ssl.h"
#include "mbedtls/ctr_drbg.h"
#include "mbedtls/debug.h"
#include "mbedtls/platform.h"
#include "mbedtls/timing.h"
#include "mbedtls/x509_crt.h"
#endif
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
typedef struct {
mbedtls_net_context net_ctx;
mbedtls_ssl_context ssl_ctx;
mbedtls_ssl_config ssl_config;
mbedtls_timing_delay_context timer_delay_ctx;
mbedtls_x509_crt x509_server_cert;
mbedtls_x509_crt x509_client_cert;
mbedtls_pk_context x509_client_pk;
} core_sysdep_mbedtls_t;
#endif
typedef struct {
int fd;
core_sysdep_socket_type_t socket_type;
aiot_sysdep_network_cred_t *cred;
char *host;
char backup_ip[16];
uint16_t port;
uint32_t connect_timeout_ms;
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
core_sysdep_psk_t psk;
core_sysdep_mbedtls_t mbedtls;
#endif
} core_network_handle_t;
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
#define MBEDTLS_MEM_INFO_MAGIC (0x12345678)
static unsigned int g_mbedtls_total_mem_used = 0;
static unsigned int g_mbedtls_max_mem_used = 0;
typedef struct {
int magic;
int size;
} mbedtls_mem_info_t;
static void *_core_mbedtls_calloc(size_t n, size_t size)
{
unsigned char *buf = NULL;
mbedtls_mem_info_t *mem_info = NULL;
if (n == 0 || size == 0) {
return NULL;
}
buf = (unsigned char *)malloc(n * size + sizeof(mbedtls_mem_info_t));
if (NULL == buf) {
return NULL;
} else {
memset(buf, 0, n * size + sizeof(mbedtls_mem_info_t));
}
mem_info = (mbedtls_mem_info_t *)buf;
mem_info->magic = MBEDTLS_MEM_INFO_MAGIC;
mem_info->size = n * size;
buf += sizeof(mbedtls_mem_info_t);
g_mbedtls_total_mem_used += mem_info->size;
if (g_mbedtls_total_mem_used > g_mbedtls_max_mem_used) {
g_mbedtls_max_mem_used = g_mbedtls_total_mem_used;
}
/* printf("INFO -- mbedtls malloc: %p %d total used: %d max used: %d\r\n",
buf, (int)size, g_mbedtls_total_mem_used, g_mbedtls_max_mem_used); */
return buf;
}
static void _core_mbedtls_free(void *ptr)
{
mbedtls_mem_info_t *mem_info = NULL;
if (NULL == ptr) {
return;
}
mem_info = (mbedtls_mem_info_t *)((unsigned char *)ptr - sizeof(mbedtls_mem_info_t));
if (mem_info->magic != MBEDTLS_MEM_INFO_MAGIC) {
printf("Warning - invalid mem info magic: 0x%x\r\n", mem_info->magic);
return;
}
g_mbedtls_total_mem_used -= mem_info->size;
/* printf("INFO -- mbedtls free: %p %d total used: %d max used: %d\r\n",
ptr, mem_info->size, g_mbedtls_total_mem_used, g_mbedtls_max_mem_used); */
aos_free(mem_info);
}
#endif
void *core_sysdep_malloc(uint32_t size, char *name)
{
return aos_malloc(size);
}
void core_sysdep_free(void *ptr)
{
aos_free(ptr);
}
uint64_t core_sysdep_time(void)
{
struct timeval time;
memset(&time, 0, sizeof(struct timeval));
gettimeofday(&time, NULL);
return (time.tv_sec * 1000 + time.tv_usec / 1000);
}
void core_sysdep_sleep(uint64_t time_ms)
{
aos_msleep(time_ms);
}
void *core_sysdep_network_init(void)
{
core_network_handle_t *handle = NULL;
handle = aos_malloc(sizeof(core_network_handle_t));
if (handle == NULL) {
return NULL;
}
memset(handle, 0, sizeof(core_network_handle_t));
handle->connect_timeout_ms = CORE_SYSDEP_DEFAULT_CONNECT_TIMEOUT_MS;
return handle;
}
int32_t core_sysdep_network_setopt(void *handle, core_sysdep_network_option_t option, void *data)
{
core_network_handle_t *network_handle = (core_network_handle_t *)handle;
if (handle == NULL || data == NULL) {
return STATE_PORT_INPUT_NULL_POINTER;
}
if (option >= CORE_SYSDEP_NETWORK_MAX) {
return STATE_PORT_INPUT_OUT_RANGE;
}
switch (option) {
case CORE_SYSDEP_NETWORK_SOCKET_TYPE: {
network_handle->socket_type = *(core_sysdep_socket_type_t *)data;
}
break;
case CORE_SYSDEP_NETWORK_HOST: {
network_handle->host = aos_malloc(strlen(data) + 1);
if (network_handle->host == NULL) {
printf("malloc failed\n");
return STATE_PORT_MALLOC_FAILED;
}
memset(network_handle->host, 0, strlen(data) + 1);
memcpy(network_handle->host, data, strlen(data));
}
break;
case CORE_SYSDEP_NETWORK_BACKUP_IP: {
memcpy(network_handle->backup_ip, data, strlen(data));
}
break;
case CORE_SYSDEP_NETWORK_PORT: {
network_handle->port = *(uint16_t *)data;
}
break;
case CORE_SYSDEP_NETWORK_CONNECT_TIMEOUT_MS: {
network_handle->connect_timeout_ms = *(uint32_t *)data;
}
break;
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
case CORE_SYSDEP_NETWORK_CRED: {
network_handle->cred = aos_malloc(sizeof(aiot_sysdep_network_cred_t));
if (network_handle->cred == NULL) {
printf("malloc failed\n");
return STATE_PORT_MALLOC_FAILED;
}
memset(network_handle->cred, 0, sizeof(aiot_sysdep_network_cred_t));
memcpy(network_handle->cred, data, sizeof(aiot_sysdep_network_cred_t));
}
break;
case CORE_SYSDEP_NETWORK_PSK: {
core_sysdep_psk_t *psk = (core_sysdep_psk_t *)data;
network_handle->psk.psk_id = aos_malloc(strlen(psk->psk_id) + 1);
if (network_handle->psk.psk_id == NULL) {
printf("malloc failed\n");
return STATE_PORT_MALLOC_FAILED;
}
memset(network_handle->psk.psk_id, 0, strlen(psk->psk_id) + 1);
memcpy(network_handle->psk.psk_id, psk->psk_id, strlen(psk->psk_id));
network_handle->psk.psk = aos_malloc(strlen(psk->psk) + 1);
if (network_handle->psk.psk == NULL) {
aos_free(network_handle->psk.psk_id);
printf("malloc failed\n");
return STATE_PORT_MALLOC_FAILED;
}
memset(network_handle->psk.psk, 0, strlen(psk->psk) + 1);
memcpy(network_handle->psk.psk, psk->psk, strlen(psk->psk));
}
break;
#endif
default: {
printf("unknown option\n");
}
}
return STATE_SUCCESS;
}
static void _port_uint2str(uint16_t input, char *output)
{
uint8_t i = 0, j = 0;
char temp[6] = {0};
do {
temp[i++] = input % 10 + '0';
} while ((input /= 10) > 0);
do {
output[--i] = temp[j++];
} while (i > 0);
}
static int32_t _core_sysdep_network_connect(char *host, uint16_t port, int family, int socktype, int protocol, uint32_t timeout_ms, int *fd_out)
{
int32_t res = STATE_SUCCESS;
int fd = 0, sock_option = 0;
char service[6] = {0};
struct addrinfo hints;
struct addrinfo *addrInfoList = NULL, *pos = NULL;
memset(&hints, 0, sizeof(struct addrinfo));
hints.ai_family = family; /* only IPv4 */
hints.ai_socktype = socktype;
hints.ai_protocol = protocol;
hints.ai_flags = 0;
_port_uint2str(port, service);
res = getaddrinfo(host, service, &hints, &addrInfoList);
if (res == 0) {
for (pos = addrInfoList; pos != NULL; pos = pos->ai_next) {
fd = socket(pos->ai_family, pos->ai_socktype, pos->ai_protocol);
if (fd < 0) {
res = STATE_PORT_NETWORK_SOCKET_CREATE_FAILED;
continue;
}
res = fcntl(fd, F_GETFL, 0);
if (res != -1) {
res = fcntl(fd, F_SETFL, sock_option | O_NONBLOCK);
}
if (res == -1) {
/* block connect */
if (connect(fd, pos->ai_addr, pos->ai_addrlen) == 0) {
*fd_out = fd;
res = STATE_SUCCESS;
break;
} else {
res = STATE_PORT_NETWORK_CONNECT_FAILED;
}
} else {
/* non-block connect */
fd_set write_sets;
struct timeval timeselect;
FD_ZERO(&write_sets);
FD_SET(fd, &write_sets);
timeselect.tv_sec = timeout_ms / 1000;
timeselect.tv_usec = timeout_ms % 1000 * 1000;
if (connect(fd, pos->ai_addr, pos->ai_addrlen) == 0) {
*fd_out = fd;
res = STATE_SUCCESS;
break;
} else if (errno != EINPROGRESS) {
res = STATE_PORT_NETWORK_CONNECT_FAILED;
} else {
res = select(fd + 1, NULL, &write_sets, NULL, ×elect);
if (res == 0 ) {
res = STATE_MQTT_LOG_CONNECT_TIMEOUT;
} else if (res < 0) {
res = STATE_PORT_NETWORK_CONNECT_FAILED;
} else {
if (FD_ISSET(fd, &write_sets)) {
res = connect(fd, pos->ai_addr, pos->ai_addrlen);
if ((res != 0 && errno == EISCONN) || res == 0) {
*fd_out = fd;
res = STATE_SUCCESS;
break;
} else {
res = STATE_PORT_NETWORK_CONNECT_FAILED;
}
}
}
}
}
close(fd);
}
} else {
res = STATE_PORT_NETWORK_DNS_FAILED;
}
freeaddrinfo(addrInfoList);
return res;
}
static int32_t _core_sysdep_network_tcp_establish(core_network_handle_t *network_handle)
{
int32_t res = STATE_SUCCESS;
printf("establish tcp connection with server(host='%s', port=[%u])\n", network_handle->host, network_handle->port);
res = _core_sysdep_network_connect(network_handle->host, network_handle->port,
AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP, network_handle->connect_timeout_ms, &network_handle->fd);
if (res == STATE_PORT_NETWORK_DNS_FAILED && strlen(network_handle->backup_ip) > 0) {
printf("using backup ip: %s\n", network_handle->backup_ip);
res = _core_sysdep_network_connect(network_handle->backup_ip, network_handle->port,
AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP, network_handle->connect_timeout_ms, &network_handle->fd);
}
return res;
}
static int32_t _core_sysdep_network_udp_server_establish(core_network_handle_t *network_handle)
{
int32_t sockfd;
struct sockaddr_in servaddr;
int opt_val = 1;
sockfd = socket(AF_INET, SOCK_DGRAM, 0);
if (sockfd < 0) {
printf("create socket error, errno: %d\n", errno);
perror("create socket error");
return STATE_PORT_NETWORK_SOCKET_CREATE_FAILED;
}
if (0 != setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt_val, sizeof(opt_val))) {
printf("setsockopt(SO_REUSEADDR) falied, errno: %d\n", errno);
perror("setsockopt(SO_REUSEADDR) error");
close(sockfd);
return STATE_PORT_NETWORK_SOCKET_CONFIG_FAILED;
}
memset(&servaddr, 0, sizeof(struct sockaddr_in));
servaddr.sin_addr.s_addr = htonl(INADDR_ANY);
servaddr.sin_family = AF_INET;
servaddr.sin_port = htons(network_handle->port);
if (-1 == bind(sockfd, (struct sockaddr *)&servaddr, sizeof(struct sockaddr_in))) {
printf("bind(%d) falied, errno: %d\n", (int)sockfd, errno);
perror("bind(%d) error");
close(sockfd);
return STATE_PORT_NETWORK_SOCKET_BIND_FAILED;
}
network_handle->fd = sockfd;
printf("success to establish udp, fd=%d\n", (int)sockfd);
return 0;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
void core_sysdep_rand(uint8_t *output, uint32_t output_len);
static int _mbedtls_random(void *handle, unsigned char *output, size_t output_len)
{
core_sysdep_rand(output, output_len);
return 0;
}
static uint8_t _host_is_ip(char *host)
{
uint32_t idx = 0;
if (strlen(host) >= 16) {
return 0;
}
for (idx = 0;idx < strlen(host);idx++) {
if ((host[idx] != '.') && (host[idx] < '0' || host[idx] > '9')) {
return 0;
}
}
return 1;
}
static void _mbedtls_debug(void *ctx, int level, const char *file, int line, const char *str)
{
((void) level);
if (NULL != ctx) {
printf("%s\n", str);
}
}
static int32_t _core_sysdep_network_mbedtls_establish(core_network_handle_t *network_handle)
{
int32_t res = 0;
char port_str[6] = {0};
#if defined(MBEDTLS_DEBUG_C)
mbedtls_debug_set_threshold(0);
#endif /* #if defined(MBEDTLS_DEBUG_C) */
mbedtls_net_init(&network_handle->mbedtls.net_ctx);
mbedtls_ssl_init(&network_handle->mbedtls.ssl_ctx);
mbedtls_ssl_config_init(&network_handle->mbedtls.ssl_config);
/*mbedtls_platform_set_calloc_free(_core_mbedtls_calloc, _core_mbedtls_free);*/
g_mbedtls_total_mem_used = g_mbedtls_max_mem_used = 0;
if (network_handle->cred->max_tls_fragment == 0) {
printf("invalid max_tls_fragment parameter\n");
return STATE_PORT_TLS_INVALID_MAX_FRAGMENT;
}
_port_uint2str(network_handle->port, port_str);
if (network_handle->cred->max_tls_fragment <= 512) {
res = mbedtls_ssl_conf_max_frag_len(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAX_FRAG_LEN_512);
} else if (network_handle->cred->max_tls_fragment <= 1024) {
res = mbedtls_ssl_conf_max_frag_len(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAX_FRAG_LEN_1024);
} else if (network_handle->cred->max_tls_fragment <= 2048) {
res = mbedtls_ssl_conf_max_frag_len(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAX_FRAG_LEN_2048);
} else if (network_handle->cred->max_tls_fragment <= 4096) {
res = mbedtls_ssl_conf_max_frag_len(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAX_FRAG_LEN_4096);
} else {
res = mbedtls_ssl_conf_max_frag_len(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAX_FRAG_LEN_NONE);
}
if (res < 0) {
printf("mbedtls_ssl_conf_max_frag_len error, res: -0x%04X\n", -res);
return res;
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
res = _core_sysdep_network_connect(network_handle->host, network_handle->port,
AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP, network_handle->connect_timeout_ms, &network_handle->mbedtls.net_ctx.fd);
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
res = _core_sysdep_network_connect(network_handle->host, network_handle->port,
AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP, network_handle->connect_timeout_ms, &network_handle->mbedtls.net_ctx.fd);
}
if (res == STATE_PORT_NETWORK_DNS_FAILED && (strlen(network_handle->backup_ip) > 0)) {
printf("using backup ip: %s\n", network_handle->backup_ip);
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
res = _core_sysdep_network_connect(network_handle->host, network_handle->port,
AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP, network_handle->connect_timeout_ms, &network_handle->mbedtls.net_ctx.fd);
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
res = _core_sysdep_network_connect(network_handle->host, network_handle->port,
AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP, network_handle->connect_timeout_ms, &network_handle->mbedtls.net_ctx.fd);
}
}
if (res < STATE_SUCCESS) {
return res;
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
res = mbedtls_ssl_config_defaults(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_IS_CLIENT,
MBEDTLS_SSL_TRANSPORT_STREAM, MBEDTLS_SSL_PRESET_DEFAULT);
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
res = mbedtls_ssl_config_defaults(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_IS_CLIENT,
MBEDTLS_SSL_TRANSPORT_DATAGRAM, MBEDTLS_SSL_PRESET_DEFAULT);
}
if (res < 0) {
printf("mbedtls_ssl_config_defaults error, res: -0x%04X\n", -res);
return res;
}
mbedtls_ssl_conf_max_version(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAJOR_VERSION_3,
MBEDTLS_SSL_MINOR_VERSION_3);
mbedtls_ssl_conf_min_version(&network_handle->mbedtls.ssl_config, MBEDTLS_SSL_MAJOR_VERSION_3,
MBEDTLS_SSL_MINOR_VERSION_3);
// mbedtls_ssl_conf_handshake_timeout(&network_handle->mbedtls.ssl_config,(MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN * 2),
// (MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN * 2 * 4));
mbedtls_ssl_conf_rng(&network_handle->mbedtls.ssl_config, _mbedtls_random, NULL);
mbedtls_ssl_conf_dbg(&network_handle->mbedtls.ssl_config, _mbedtls_debug, stdout);
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA) {
if (network_handle->cred->x509_server_cert == NULL && network_handle->cred->x509_server_cert_len == 0) {
printf("invalid x509 server cert\n");
return STATE_PORT_TLS_INVALID_SERVER_CERT;
}
mbedtls_x509_crt_init(&network_handle->mbedtls.x509_server_cert);
res = mbedtls_x509_crt_parse(&network_handle->mbedtls.x509_server_cert,
(const unsigned char *)network_handle->cred->x509_server_cert, (size_t)network_handle->cred->x509_server_cert_len + 1);
if (res < 0) {
printf("mbedtls_x509_crt_parse server cert error, res: -0x%04X\n", -res);
return STATE_PORT_TLS_INVALID_SERVER_CERT;
}
if (network_handle->cred->x509_client_cert != NULL && network_handle->cred->x509_client_cert_len > 0 &&
network_handle->cred->x509_client_privkey != NULL && network_handle->cred->x509_client_privkey_len > 0) {
mbedtls_x509_crt_init(&network_handle->mbedtls.x509_client_cert);
mbedtls_pk_init(&network_handle->mbedtls.x509_client_pk);
res = mbedtls_x509_crt_parse(&network_handle->mbedtls.x509_client_cert,
(const unsigned char *)network_handle->cred->x509_client_cert, (size_t)network_handle->cred->x509_client_cert_len + 1);
if (res < 0) {
printf("mbedtls_x509_crt_parse client cert error, res: -0x%04X\n", -res);
return STATE_PORT_TLS_INVALID_CLIENT_CERT;
}
res = mbedtls_pk_parse_key(&network_handle->mbedtls.x509_client_pk,
(const unsigned char *)network_handle->cred->x509_client_privkey,
(size_t)network_handle->cred->x509_client_privkey_len + 1, NULL, 0);
if (res < 0) {
printf("mbedtls_pk_parse_key client pk error, res: -0x%04X\n", -res);
return STATE_PORT_TLS_INVALID_CLIENT_KEY;
}
res = mbedtls_ssl_conf_own_cert(&network_handle->mbedtls.ssl_config, &network_handle->mbedtls.x509_client_cert,
&network_handle->mbedtls.x509_client_pk);
if (res < 0) {
printf("mbedtls_ssl_conf_own_cert error, res: -0x%04X\n", -res);
return STATE_PORT_TLS_INVALID_CLIENT_CERT;
}
}
mbedtls_ssl_conf_ca_chain(&network_handle->mbedtls.ssl_config, &network_handle->mbedtls.x509_server_cert, NULL);
} else if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_SVRCERT_PSK) {
static const int ciphersuites[1] = {MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA};
res = mbedtls_ssl_conf_psk(&network_handle->mbedtls.ssl_config,
(const unsigned char *)network_handle->psk.psk, (size_t)strlen(network_handle->psk.psk),
(const unsigned char *)network_handle->psk.psk_id, (size_t)strlen(network_handle->psk.psk_id));
if (res < 0) {
printf("mbedtls_ssl_conf_psk error, res = -0x%04X\n", -res);
return STATE_PORT_TLS_CONFIG_PSK_FAILED;
}
mbedtls_ssl_conf_ciphersuites(&network_handle->mbedtls.ssl_config, ciphersuites);
} else {
printf("unsupported security option\n");
return STATE_PORT_TLS_INVALID_CRED_OPTION;
}
res = mbedtls_ssl_setup(&network_handle->mbedtls.ssl_ctx, &network_handle->mbedtls.ssl_config);
if (res < 0) {
printf("mbedtls_ssl_setup error, res: -0x%04X\n", -res);
return res;
}
if (_host_is_ip(network_handle->host) == 0) {
res = mbedtls_ssl_set_hostname(&network_handle->mbedtls.ssl_ctx, network_handle->host);
if (res < 0) {
printf("mbedtls_ssl_set_hostname error, res: -0x%04X\n", -res);
return res;
}
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
mbedtls_ssl_set_timer_cb(&network_handle->mbedtls.ssl_ctx, (void *)&network_handle->mbedtls.timer_delay_ctx,
mbedtls_timing_set_delay, mbedtls_timing_get_delay);
}
mbedtls_ssl_set_bio(&network_handle->mbedtls.ssl_ctx, &network_handle->mbedtls.net_ctx, mbedtls_net_send,
mbedtls_net_recv, mbedtls_net_recv_timeout);
mbedtls_ssl_conf_read_timeout(&network_handle->mbedtls.ssl_config, network_handle->connect_timeout_ms);
while ((res = mbedtls_ssl_handshake(&network_handle->mbedtls.ssl_ctx)) != 0) {
if ((res != MBEDTLS_ERR_SSL_WANT_READ) && (res != MBEDTLS_ERR_SSL_WANT_WRITE)) {
printf("mbedtls_ssl_handshake error, res: -0x%04X\n", -res);
if (res == MBEDTLS_ERR_SSL_INVALID_RECORD) {
res = STATE_PORT_TLS_INVALID_RECORD;
} else {
res = STATE_PORT_TLS_INVALID_HANDSHAKE;
}
return res;
}
}
res = mbedtls_ssl_get_verify_result(&network_handle->mbedtls.ssl_ctx);
if (res < 0) {
printf("mbedtls_ssl_get_verify_result error, res: -0x%04X\n", -res);
return res;
}
/*
printf("success to establish mbedtls connection, fd = %d(cost %d bytes in total, max used %d bytes)\n",
(int)network_handle->mbedtls.net_ctx.fd,
g_mbedtls_total_mem_used, g_mbedtls_max_mem_used);
*/
return 0;
}
#endif
int32_t core_sysdep_network_establish(void *handle)
{
core_network_handle_t *network_handle = (core_network_handle_t *)handle;
if (handle == NULL) {
return STATE_PORT_INPUT_NULL_POINTER;
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
if (network_handle->host == NULL) {
return STATE_PORT_MISSING_HOST;
}
if (network_handle->cred == NULL) {
return _core_sysdep_network_tcp_establish(network_handle);
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return _core_sysdep_network_tcp_establish(network_handle);
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_establish(network_handle);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_SERVER) {
return STATE_PORT_TCP_SERVER_NOT_IMPLEMENT;
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
if (network_handle->host == NULL) {
return STATE_PORT_MISSING_HOST;
}
if (network_handle->cred == NULL) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_establish(network_handle);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_SERVER) {
return _core_sysdep_network_udp_server_establish(network_handle);
}
printf("unknown nwk type or tcp host absent\n");
return STATE_PORT_NETWORK_UNKNOWN_SOCKET_TYPE;
}
static int32_t _core_sysdep_network_tcp_recv(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len,
uint32_t timeout_ms)
{
int res = 0;
int32_t recv_bytes = 0;
ssize_t recv_res = 0;
uint64_t timestart_ms = 0, timenow_ms = 0, timeselect_ms = 0;
fd_set recv_sets;
struct timeval timestart, timenow, timeselect;
FD_ZERO(&recv_sets);
FD_SET(network_handle->fd, &recv_sets);
/* Start Time */
gettimeofday(×tart, NULL);
timestart_ms = timestart.tv_sec * 1000 + timestart.tv_usec / 1000;
timenow_ms = timestart_ms;
do {
gettimeofday(&timenow, NULL);
timenow_ms = timenow.tv_sec * 1000 + timenow.tv_usec / 1000;
if (timenow_ms - timestart_ms >= timenow_ms ||
timeout_ms - (timenow_ms - timestart_ms) > timeout_ms) {
break;
}
timeselect_ms = timeout_ms - (timenow_ms - timestart_ms);
timeselect.tv_sec = timeselect_ms / 1000;
timeselect.tv_usec = timeselect_ms % 1000 * 1000;
res = select(network_handle->fd + 1, &recv_sets, NULL, NULL, ×elect);
if (res == 0) {
/* printf("_core_sysdep_network_tcp_recv, nwk select timeout\n"); */
continue;
} else if (res < 0) {
printf("_core_sysdep_network_tcp_recv, errno: %d\n", errno);
perror("_core_sysdep_network_tcp_recv, nwk select failed: ");
return STATE_PORT_NETWORK_SELECT_FAILED;
} else {
if (FD_ISSET(network_handle->fd, &recv_sets)) {
recv_res = recv(network_handle->fd, buffer + recv_bytes, len - recv_bytes, 0);
if (recv_res == 0) {
printf("_core_sysdep_network_tcp_recv, nwk connection closed\n");
return STATE_PORT_NETWORK_RECV_CONNECTION_CLOSED;
} else if (recv_res < 0) {
printf("_core_sysdep_network_tcp_recv, errno: %d\n", errno);
perror("_core_sysdep_network_tcp_recv, nwk recv error: ");
if (errno == EINTR) {
continue;
}
return STATE_PORT_NETWORK_RECV_FAILED;
} else {
recv_bytes += recv_res;
/* printf("recv_bytes: %d, len: %d\n",recv_bytes,len); */
if (recv_bytes == len) {
break;
}
}
}
}
} while (((timenow_ms - timestart_ms) < timeout_ms) && (recv_bytes < len));
/* printf("%s: recv over\n",__FUNCTION__); */
return recv_bytes;
}
static int32_t _core_sysdep_network_udp_recv(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms, core_sysdep_addr_t *addr)
{
int res;
struct sockaddr_in cliaddr;
socklen_t addr_len = sizeof(cliaddr);
fd_set read_fds;
struct timeval timeout = {timeout_ms / 1000, (timeout_ms % 1000) * 1000};
FD_ZERO(&read_fds);
FD_SET(network_handle->fd, &read_fds);
res = select(network_handle->fd + 1, &read_fds, NULL, NULL, &timeout);
if (res == 0) {
printf("select timeout\n");
return 0;
}
else if (res < 0) {
printf("_linux_nwk_udp_read select errno: %d\n", errno);
perror("_linux_nwk_udp_read select error: ");
return STATE_PORT_NETWORK_SELECT_FAILED;
}
res = recvfrom(network_handle->fd, buffer, len, 0, (struct sockaddr *)&cliaddr, &addr_len);
if (res >= 0) {
if (NULL != addr) {
addr->port = ntohs(cliaddr.sin_port);
strncpy((char *)addr->addr, inet_ntoa(cliaddr.sin_addr), sizeof(addr->addr));
}
return res;
} else {
printf("_linux_nwk_udp_read errno: %d\n", errno);
perror("_linux_nwk_udp_read error: ");
return STATE_PORT_NETWORK_RECV_FAILED;
}
return res;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
static int32_t _core_sysdep_network_mbedtls_recv(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len,
uint32_t timeout_ms)
{
int res = 0;
int32_t recv_bytes = 0;
mbedtls_ssl_conf_read_timeout(&network_handle->mbedtls.ssl_config, timeout_ms);
do {
res = mbedtls_ssl_read(&network_handle->mbedtls.ssl_ctx, buffer + recv_bytes, len - recv_bytes);
if (res < 0) {
if (res == MBEDTLS_ERR_SSL_TIMEOUT) {
break;
} else if (res != MBEDTLS_ERR_SSL_WANT_READ &&
res != MBEDTLS_ERR_SSL_WANT_WRITE &&
res != MBEDTLS_ERR_SSL_CLIENT_RECONNECT) {
if (recv_bytes == 0) {
printf("mbedtls_ssl_recv error, res: -0x%04X\n", -res);
if (res == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
return STATE_PORT_TLS_RECV_CONNECTION_CLOSED;
} else if (res == MBEDTLS_ERR_SSL_INVALID_RECORD) {
return STATE_PORT_TLS_INVALID_RECORD;
} else {
return STATE_PORT_TLS_RECV_FAILED;
}
}
break;
}
} else if (res == 0) {
break;
} else {
recv_bytes += res;
}
} while (recv_bytes < len);
return recv_bytes;
}
#endif
int32_t core_sysdep_network_recv(void *handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms,
core_sysdep_addr_t *addr)
{
core_network_handle_t *network_handle = (core_network_handle_t *)handle;
if (handle == NULL || buffer == NULL) {
return STATE_PORT_INPUT_NULL_POINTER;
}
if (len == 0 || timeout_ms == 0) {
return STATE_PORT_INPUT_OUT_RANGE;
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
if (network_handle->cred == NULL) {
return _core_sysdep_network_tcp_recv(network_handle, buffer, len, timeout_ms);
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return _core_sysdep_network_tcp_recv(network_handle, buffer, len, timeout_ms);
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_recv(network_handle, buffer, len, timeout_ms);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_SERVER) {
return STATE_PORT_TCP_SERVER_NOT_IMPLEMENT;
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
if (network_handle->cred == NULL) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_recv(network_handle, buffer, len, timeout_ms);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_SERVER) {
return _core_sysdep_network_udp_recv(network_handle, buffer, len, timeout_ms, addr);
}
printf("unknown nwk type\n");
return STATE_PORT_NETWORK_UNKNOWN_SOCKET_TYPE;
}
int32_t _core_sysdep_network_tcp_send(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len,
uint32_t timeout_ms)
{
int res = 0;
int32_t send_bytes = 0;
ssize_t send_res = 0;
uint64_t timestart_ms = 0, timenow_ms = 0, timeselect_ms = 0;
fd_set send_sets;
struct timeval timestart, timenow, timeselect;
FD_ZERO(&send_sets);
FD_SET(network_handle->fd, &send_sets);
/* Start Time */
gettimeofday(×tart, NULL);
timestart_ms = timestart.tv_sec * 1000 + timestart.tv_usec / 1000;
timenow_ms = timestart_ms;
do {
gettimeofday(&timenow, NULL);
timenow_ms = timenow.tv_sec * 1000 + timenow.tv_usec / 1000;
if (timenow_ms - timestart_ms >= timenow_ms ||
timeout_ms - (timenow_ms - timestart_ms) > timeout_ms) {
break;
}
timeselect_ms = timeout_ms - (timenow_ms - timestart_ms);
timeselect.tv_sec = timeselect_ms / 1000;
timeselect.tv_usec = timeselect_ms % 1000 * 1000;
res = select(network_handle->fd + 1, NULL, &send_sets, NULL, ×elect);
if (res == 0) {
printf("_core_sysdep_network_tcp_send, nwk select timeout\n");
continue;
} else if (res < 0) {
printf("_core_sysdep_network_tcp_send, errno: %d\n", errno);
perror("_core_sysdep_network_tcp_send, nwk select failed: ");
return STATE_PORT_NETWORK_SELECT_FAILED;
} else {
if (FD_ISSET(network_handle->fd, &send_sets)) {
send_res = send(network_handle->fd, buffer + send_bytes, len - send_bytes, 0);
if (send_res == 0) {
printf("_core_sysdep_network_tcp_send, nwk connection closed\n");
return STATE_PORT_NETWORK_SEND_CONNECTION_CLOSED;
} else if (send_res < 0) {
printf("_core_sysdep_network_tcp_send, errno: %d\n", errno);
perror("_core_sysdep_network_tcp_send, nwk recv error: ");
if (errno == EINTR) {
continue;
}
return STATE_PORT_NETWORK_SEND_FAILED;
} else {
send_bytes += send_res;
if (send_bytes == len) {
break;
}
}
}
}
} while (((timenow_ms - timestart_ms) < timeout_ms) && (send_bytes < len));
return send_bytes;
}
int32_t _core_sysdep_network_udp_send(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms, core_sysdep_addr_t *addr)
{
int res;
struct sockaddr_in cliaddr;
fd_set write_fds;
struct timeval timeout = {timeout_ms / 1000, (timeout_ms % 1000) * 1000};
if (addr == NULL) {
printf("invalid parameter addr\n");
return STATE_PORT_NETWORK_SEND_FAILED;
}
FD_ZERO(&write_fds);
FD_SET(network_handle->fd, &write_fds);
res = select(network_handle->fd + 1, NULL, &write_fds, NULL, &timeout);
if (res == 0) {
printf("select timeout\n");
return 0;
} else if (res < 0) {
printf("_linux_nwk_udp_write select errno: %d\n", errno);
perror("_linux_nwk_udp_write select error");
return STATE_PORT_NETWORK_SELECT_FAILED;
}
res = inet_aton((char *)addr->addr, &cliaddr.sin_addr);
if (res < 0) {
printf("sys_nwk_write, addr error\r\n");
return STATE_PORT_NETWORK_SEND_FAILED;
}
cliaddr.sin_family = AF_INET;
cliaddr.sin_port = htons(addr->port);
res = sendto(network_handle->fd, buffer, len, 0, (struct sockaddr *)&cliaddr, sizeof(struct sockaddr_in));
if (res < 0) {
printf("_linux_nwk_udp_write errno: %d\n", errno);
perror("_linux_nwk_udp_write error");
return STATE_PORT_NETWORK_SEND_FAILED;
}
return res;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
int32_t _core_sysdep_network_mbedtls_send(core_network_handle_t *network_handle, uint8_t *buffer, uint32_t len,
uint32_t timeout_ms)
{
int32_t res = 0;
int32_t send_bytes = 0;
uint64_t timestart_ms = 0, timenow_ms = 0;
struct timeval timestart, timenow, timeout;
/* timeout */
timeout.tv_sec = timeout_ms / 1000;
timeout.tv_usec = (timeout_ms % 1000) * 1000;
/* Start Time */
gettimeofday(×tart, NULL);
timestart_ms = timestart.tv_sec * 1000 + timestart.tv_usec / 1000;
timenow_ms = timestart_ms;
res = setsockopt(network_handle->mbedtls.net_ctx.fd, SOL_SOCKET, SO_SNDTIMEO, &timeout, sizeof(timeout));
if (res < 0) {
printf("setsockopt error, errno: %d\r\n", errno);
return STATE_PORT_TLS_SEND_FAILED;
}
do {
gettimeofday(&timenow, NULL);
timenow_ms = timenow.tv_sec * 1000 + timenow.tv_usec / 1000;
if (timenow_ms - timestart_ms >= timenow_ms ||
timeout_ms - (timenow_ms - timestart_ms) > timeout_ms) {
break;
}
res = mbedtls_ssl_write(&network_handle->mbedtls.ssl_ctx, buffer + send_bytes, len - send_bytes);
if (res < 0) {
if (res != MBEDTLS_ERR_SSL_WANT_READ &&
res != MBEDTLS_ERR_SSL_WANT_WRITE) {
if (send_bytes == 0) {
printf("mbedtls_ssl_send error, res: -0x%04X\n", -res);
if (res == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
return STATE_PORT_TLS_SEND_CONNECTION_CLOSED;
} else if (res == MBEDTLS_ERR_SSL_INVALID_RECORD) {
return STATE_PORT_TLS_INVALID_RECORD;
} else {
return STATE_PORT_TLS_SEND_FAILED;
}
}
break;
}
} else if (res == 0) {
break;
} else {
send_bytes += res;
}
} while (((timenow_ms - timestart_ms) < timeout_ms) && (send_bytes < len));
return send_bytes;
}
#endif
int32_t core_sysdep_network_send(void *handle, uint8_t *buffer, uint32_t len, uint32_t timeout_ms,
core_sysdep_addr_t *addr)
{
core_network_handle_t *network_handle = (core_network_handle_t *)handle;
if (handle == NULL || buffer == NULL) {
printf("invalid parameter\n");
return STATE_PORT_INPUT_NULL_POINTER;
}
if (len == 0 || timeout_ms == 0) {
return STATE_PORT_INPUT_OUT_RANGE;
}
if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT) {
if (network_handle->cred == NULL) {
return _core_sysdep_network_tcp_send(network_handle, buffer, len, timeout_ms);
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return _core_sysdep_network_tcp_send(network_handle, buffer, len, timeout_ms);
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_send(network_handle, buffer, len, timeout_ms);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_SERVER) {
return STATE_PORT_TCP_SERVER_NOT_IMPLEMENT;
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) {
if (network_handle->cred == NULL) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
return STATE_PORT_UDP_CLIENT_NOT_IMPLEMENT;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
return _core_sysdep_network_mbedtls_send(network_handle, buffer, len, timeout_ms);
}
#endif
}
} else if (network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_SERVER) {
return _core_sysdep_network_udp_send(network_handle, buffer, len, timeout_ms, addr);
}
printf("unknown nwk type\n");
return STATE_PORT_NETWORK_UNKNOWN_SOCKET_TYPE;
}
static void _core_sysdep_network_tcp_disconnect(core_network_handle_t *network_handle)
{
if (network_handle->fd > 0) {
shutdown(network_handle->fd, 2);
close(network_handle->fd);
}
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
static void _core_sysdep_network_mbedtls_disconnect(core_network_handle_t *network_handle)
{
mbedtls_ssl_close_notify(&network_handle->mbedtls.ssl_ctx);
mbedtls_net_free(&network_handle->mbedtls.net_ctx);
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_SVRCERT_CA) {
mbedtls_x509_crt_free(&network_handle->mbedtls.x509_server_cert);
mbedtls_x509_crt_free(&network_handle->mbedtls.x509_client_cert);
mbedtls_pk_free(&network_handle->mbedtls.x509_client_pk);
}
mbedtls_ssl_free(&network_handle->mbedtls.ssl_ctx);
mbedtls_ssl_config_free(&network_handle->mbedtls.ssl_config);
g_mbedtls_total_mem_used = g_mbedtls_max_mem_used = 0;
}
#endif
int32_t core_sysdep_network_deinit(void **handle)
{
core_network_handle_t *network_handle = NULL;
if (handle == NULL || *handle == NULL) {
return STATE_PORT_INPUT_NULL_POINTER;
}
network_handle = *(core_network_handle_t **)handle;
/* Shutdown both send and receive operations. */
if ((network_handle->socket_type == CORE_SYSDEP_SOCKET_TCP_CLIENT ||
network_handle->socket_type == CORE_SYSDEP_SOCKET_UDP_CLIENT) && network_handle->host != NULL) {
if (network_handle->cred == NULL) {
_core_sysdep_network_tcp_disconnect(network_handle);
} else {
if (network_handle->cred->option == AIOT_SYSDEP_NETWORK_CRED_NONE) {
_core_sysdep_network_tcp_disconnect(network_handle);
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
else {
_core_sysdep_network_mbedtls_disconnect(network_handle);
}
#endif
}
}
if (network_handle->host != NULL) {
aos_free(network_handle->host);
network_handle->host = NULL;
}
if (network_handle->cred != NULL) {
aos_free(network_handle->cred);
network_handle->cred = NULL;
}
#ifdef CORE_SYSDEP_MBEDTLS_ENABLED
if (network_handle->psk.psk_id != NULL) {
aos_free(network_handle->psk.psk_id);
network_handle->psk.psk_id = NULL;
}
if (network_handle->psk.psk != NULL) {
aos_free(network_handle->psk.psk);
network_handle->psk.psk = NULL;
}
#endif
aos_free(network_handle);
*handle = NULL;
return 0;
}
void core_sysdep_rand(uint8_t *output, uint32_t output_len)
{
uint32_t idx = 0, bytes = 0, rand_num = 0;
struct timeval time;
memset(&time, 0, sizeof(struct timeval));
gettimeofday(&time, NULL);
aos_srand((unsigned int)(time.tv_sec * 1000 + time.tv_usec / 1000) + aos_rand());
for (idx = 0; idx < output_len;) {
if (output_len - idx < 4) {
bytes = output_len - idx;
} else {
bytes = 4;
}
rand_num = aos_rand();
while (bytes-- > 0) {
output[idx++] = (uint8_t)(rand_num >> bytes * 8);
}
}
}
void *core_sysdep_mutex_init(void)
{
int res = 0;
aos_mutex_t mutex;
res = aos_mutex_new(&mutex);
if(res != 0) {
return NULL;
}
return mutex;
}
void core_sysdep_mutex_lock(void *hdl)
{
aos_mutex_t mutex;
if (hdl == NULL) {
return;
}
mutex = (aos_mutex_t)hdl;
aos_mutex_lock(&mutex, -1);
}
void core_sysdep_mutex_unlock(void *hdl)
{
aos_mutex_t mutex;
if (hdl == NULL) {
return;
}
mutex = (aos_mutex_t)hdl;
aos_mutex_unlock(&mutex);
}
void core_sysdep_mutex_deinit(void **hdl)
{
aos_mutex_t mutex;
if (hdl == NULL) {
return;
}
mutex = (aos_mutex_t)(*hdl);
aos_mutex_free(&mutex);
*hdl = NULL;
}
aiot_sysdep_portfile_t g_aiot_sysdep_portfile = {
core_sysdep_malloc,
core_sysdep_free,
core_sysdep_time,
core_sysdep_sleep,
core_sysdep_network_init,
core_sysdep_network_setopt,
core_sysdep_network_establish,
core_sysdep_network_recv,
core_sysdep_network_send,
core_sysdep_network_deinit,
core_sysdep_rand,
core_sysdep_mutex_init,
core_sysdep_mutex_lock,
core_sysdep_mutex_unlock,
core_sysdep_mutex_deinit,
};
| YifuLiu/AliOS-Things | components/linksdk/portfiles/aiot_port/aos_port.c | C | apache-2.0 | 45,276 |
if (ESP_PLATFORM)
idf_component_register(
SRCS "axp192.c"
INCLUDE_DIRS "."
)
add_definitions("-DAXP192_INCLUDE_SDKCONFIG_H")
endif()
| YifuLiu/AliOS-Things | components/little_ui/driver/axp192/CMakeLists.txt | CMake | apache-2.0 | 161 |
/*
MIT License
Copyright (c) 2019-2021 Mika Tuupola
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-cut-
This file is part of hardware agnostic I2C driver for AXP192:
https://github.com/tuupola/axp192
SPDX-License-Identifier: MIT
Version: 0.6.0-dev
*/
#include <stdarg.h>
#include <stdint.h>
#include "axp192_config.h"
#include "axp192.h"
static axp192_err_t read_coloumb_counter(const axp192_t *axp, float *buffer);
static axp192_err_t read_battery_power(const axp192_t *axp, float *buffer);
static const axp192_init_command_t init_commands[] = {
#ifdef AXP192_INCLUDE_SDKCONFIG_H
/* Currently you have to use menuconfig to be able to use axp192_init() */
{AXP192_DCDC1_VOLTAGE, {CONFIG_AXP192_DCDC1_VOLTAGE}, 1},
{AXP192_DCDC3_VOLTAGE, {CONFIG_AXP192_DCDC3_VOLTAGE}, 1},
{AXP192_LDO23_VOLTAGE, {CONFIG_AXP192_LDO23_VOLTAGE}, 1},
{AXP192_GPIO0_LDOIO0_VOLTAGE, {CONFIG_AXP192_GPIO0_LDOIO0_VOLTAGE}, 1},
{AXP192_DCDC13_LDO23_CONTROL, {CONFIG_AXP192_DCDC13_LDO23_CONTROL}, 1},
{AXP192_EXTEN_DCDC2_CONTROL, {CONFIG_AXP192_EXTEN_DCDC2_CONTROL}, 1},
{AXP192_GPIO0_CONTROL, {CONFIG_AXP192_GPIO0_CONTROL}, 1},
{AXP192_GPIO1_CONTROL, {CONFIG_AXP192_GPIO1_CONTROL}, 1},
{AXP192_GPIO2_CONTROL, {CONFIG_AXP192_GPIO2_CONTROL}, 1},
{AXP192_GPIO43_FUNCTION_CONTROL, {CONFIG_AXP192_GPIO43_FUNCTION_CONTROL}, 1},
{AXP192_ADC_ENABLE_1, {CONFIG_AXP192_ADC_ENABLE_1}, 1},
{AXP192_CHARGE_CONTROL_1, {CONFIG_AXP192_CHARGE_CONTROL_1}, 1},
{AXP192_BATTERY_CHARGE_CONTROL, {CONFIG_AXP192_BATTERY_CHARGE_CONTROL}, 1},
#endif /* AXP192_INCLUDE_SDKCONFIG_H */
/* End of commands. */
{0, {0}, 0xff},
};
axp192_err_t axp192_init(const axp192_t *axp)
{
uint8_t cmd = 0;
axp192_err_t status;
/* Send all the commands. */
while (init_commands[cmd].count != 0xff) {
status = axp->write(
axp->handle,
AXP192_ADDRESS,
init_commands[cmd].command,
init_commands[cmd].data,
init_commands[cmd].count & 0x1f
);
if (AXP192_OK != status) {
return status;
}
cmd++;
}
return AXP192_OK;
}
static axp192_err_t axp192_read_adc(const axp192_t *axp, uint8_t reg, float *buffer)
{
uint8_t tmp[4];
float sensitivity = 1.0;
float offset = 0.0;
axp192_err_t status;
switch (reg) {
case AXP192_ACIN_VOLTAGE:
case AXP192_VBUS_VOLTAGE:
/* 1.7mV per LSB */
sensitivity = 1.7 / 1000;
break;
case AXP192_ACIN_CURRENT:
/* 0.375mA per LSB */
sensitivity = 0.625 / 1000;
break;
case AXP192_VBUS_CURRENT:
/* 0.375mA per LSB */
sensitivity = 0.375 / 1000;
break;
case AXP192_TEMP:
/* 0.1C per LSB, 0x00 = -144.7C */
sensitivity = 0.1;
offset = -144.7;
break;
case AXP192_TS_INPUT:
/* 0.8mV per LSB */
sensitivity = 0.8 / 1000;
break;
case AXP192_BATTERY_POWER:
/* 1.1mV * 0.5mA per LSB */
return read_battery_power(axp, buffer);
break;
case AXP192_BATTERY_VOLTAGE:
/* 1.1mV per LSB */
sensitivity = 1.1 / 1000;
break;
case AXP192_CHARGE_CURRENT:
case AXP192_DISCHARGE_CURRENT:
/* 0.5mV per LSB */
sensitivity = 0.5 / 1000;
break;
case AXP192_APS_VOLTAGE:
/* 1.4mV per LSB */
sensitivity = 1.4 / 1000;
break;
case AXP192_COULOMB_COUNTER:
/* This is currently untested. */
return read_coloumb_counter(axp, buffer);
break;
}
status = axp->read(axp->handle, AXP192_ADDRESS, reg, tmp, 2);
if (AXP192_OK != status) {
return status;
}
*buffer = (((tmp[0] << 4) + tmp[1]) * sensitivity) + offset;
return AXP192_OK;
}
axp192_err_t axp192_read(const axp192_t *axp, uint8_t reg, void *buffer) {
switch (reg) {
case AXP192_ACIN_VOLTAGE:
case AXP192_VBUS_VOLTAGE:
case AXP192_ACIN_CURRENT:
case AXP192_VBUS_CURRENT:
case AXP192_TEMP:
case AXP192_TS_INPUT:
case AXP192_BATTERY_POWER:
case AXP192_BATTERY_VOLTAGE:
case AXP192_CHARGE_CURRENT:
case AXP192_DISCHARGE_CURRENT:
case AXP192_APS_VOLTAGE:
case AXP192_COULOMB_COUNTER:
/* Return ADC value. */
return axp192_read_adc(axp, reg, buffer);
break;
default:
/* Return raw register value. */
return axp->read(axp->handle, AXP192_ADDRESS, reg, buffer, 1);
}
}
axp192_err_t axp192_write(const axp192_t *axp, uint8_t reg, const uint8_t *buffer) {
switch (reg) {
case AXP192_ACIN_VOLTAGE:
case AXP192_VBUS_VOLTAGE:
case AXP192_ACIN_CURRENT:
case AXP192_VBUS_CURRENT:
case AXP192_TEMP:
case AXP192_TS_INPUT:
case AXP192_BATTERY_POWER:
case AXP192_BATTERY_VOLTAGE:
case AXP192_CHARGE_CURRENT:
case AXP192_DISCHARGE_CURRENT:
case AXP192_APS_VOLTAGE:
case AXP192_COULOMB_COUNTER:
/* Read only register. */
return AXP192_ERROR_ENOTSUP;
break;
default:
/* Write raw register value. */
return axp->write(axp->handle, AXP192_ADDRESS, reg, buffer, 1);
}
}
axp192_err_t axp192_ioctl(const axp192_t *axp, int command, ...)
{
uint8_t reg = command >> 8;
uint8_t tmp;
uint16_t argument;
va_list ap;
switch (command) {
case AXP192_COULOMB_COUNTER_ENABLE:
tmp = 0b10000000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_COULOMB_COUNTER_DISABLE:
tmp = 0b00000000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_COULOMB_COUNTER_SUSPEND:
tmp = 0b11000000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_COULOMB_COUNTER_CLEAR:
tmp = 0b10100000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_LDOIO0_ENABLE:
/* 0x02 = LDO */
tmp = 0b00000010;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_LDOIO0_DISABLE:
/* 0x07 = float */
tmp = 0b00000111;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_LDO2_ENABLE:
/* This is currently untested. */
case AXP192_EXTEN_ENABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp |= 0b00000100;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_LDO2_DISABLE:
/* This is currently untested. */
case AXP192_EXTEN_DISABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0b00000100;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_GPIO2_SET_LEVEL:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
va_start(ap, command);
argument = (uint8_t) va_arg(ap, int);
va_end(ap);
if (argument) {
tmp |= 0b00000100;
} else {
tmp &= ~0b00000100;
}
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_LDO3_ENABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp |= 0b00001000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_LDO3_DISABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0b00001000;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_DCDC1_ENABLE:
/* This is currently untested. */
case AXP192_DCDC2_ENABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp |= 0b00000001;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_DCDC1_DISABLE:
/* This is currently untested. */
case AXP192_DCDC2_DISABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0b00000001;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_DCDC3_ENABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp |= 0b00000010;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_DCDC3_DISABLE:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0b00000010;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_GPIO1_SET_LEVEL:
case AXP192_GPIO4_SET_LEVEL:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
va_start(ap, command);
argument = (uint8_t) va_arg(ap, int);
va_end(ap);
if (argument) {
tmp |= 0b00000010;
} else {
tmp &= ~0b00000010;
}
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_GPIO0_SET_LEVEL:
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
va_start(ap, command);
argument = (uint8_t) va_arg(ap, int);
va_end(ap);
if (argument) {
tmp |= 0b00000001;
} else {
tmp &= ~0b00000001;
}
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
case AXP192_DCDC1_SET_VOLTAGE:
case AXP192_DCDC3_SET_VOLTAGE:
va_start(ap, command);
argument = (uint16_t) va_arg(ap, int);
va_end(ap);
/* 700-3500mv 25mV per step */
if ((argument < 700) || (argument > 3500)) {
return AXP192_ERROR_EINVAL;
}
tmp = (argument - 700) / 25;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_DCDC2_SET_VOLTAGE:
va_start(ap, command);
argument = (uint16_t) va_arg(ap, int);
va_end(ap);
/* 700-2275mV 25mV per step */
if ((argument < 700) || (argument > 2275)) {
return AXP192_ERROR_EINVAL;
}
tmp = (argument - 700) / 25;
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_LDO2_SET_VOLTAGE:
va_start(ap, command);
argument = (uint16_t) va_arg(ap, int);
va_end(ap);
/* 1800-3300mV 100mV per step */
if ((argument < 1800) || (argument > 3300)) {
return AXP192_ERROR_EINVAL;
}
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0xf0;
tmp |= (((argument - 1800) / 100) << 4);
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_LDO3_SET_VOLTAGE:
va_start(ap, command);
argument = (uint16_t) va_arg(ap, int);
va_end(ap);
/* 1800-3300mV 100mV per step */
if ((argument < 1800) || (argument > 3300)) {
return AXP192_ERROR_EINVAL;
}
axp->read(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
tmp &= ~0x0f;
tmp |= ((argument - 1800) / 100);
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
/* This is currently untested. */
case AXP192_LDOIO0_SET_VOLTAGE:
va_start(ap, command);
argument = (uint16_t) va_arg(ap, int);
va_end(ap);
/* 1800-3300mV 100mV per step, 2800mV default. */
if ((argument < 1800) || (argument > 3300)) {
return AXP192_ERROR_EINVAL;
}
tmp = (((argument - 1800) / 100) << 4);
return axp->write(axp->handle, AXP192_ADDRESS, reg, &tmp, 1);
break;
}
return AXP192_ERROR_NOTTY;
}
static axp192_err_t read_coloumb_counter(const axp192_t *axp, float *buffer)
{
uint8_t tmp[4];
int32_t coin, coout;
axp192_err_t status;
status = axp->read(axp->handle, AXP192_ADDRESS, AXP192_CHARGE_COULOMB, tmp, sizeof(coin));
if (AXP192_OK != status) {
return status;
}
coin = (tmp[0] << 24) + (tmp[1] << 16) + (tmp[2] << 8) + tmp[3];
status = axp->read(axp->handle, AXP192_ADDRESS, AXP192_DISCHARGE_COULOMB, tmp, sizeof(coout));
if (AXP192_OK != status) {
return status;
}
coout = (tmp[0] << 24) + (tmp[1] << 16) + (tmp[2] << 8) + tmp[3];
/* CmAh = 65536 * 0.5mA *（coin - cout) / 3600 / ADC sample rate */
*buffer = 32768 * (coin - coout) / 3600 / 25;
return AXP192_OK;
}
static axp192_err_t read_battery_power(const axp192_t *axp, float *buffer)
{
uint8_t tmp[4];
float sensitivity;
axp192_err_t status;
/* 1.1mV * 0.5mA per LSB */
sensitivity = 1.1 * 0.5 / 1000;
status = axp->read(axp->handle, AXP192_ADDRESS, AXP192_BATTERY_POWER, tmp, 3);
if (AXP192_OK != status) {
return status;
}
*buffer = (((tmp[0] << 16) + (tmp[1] << 8) + tmp[2]) * sensitivity);
return AXP192_OK;
} | YifuLiu/AliOS-Things | components/little_ui/driver/axp192/axp192.c | C | apache-2.0 | 14,282 |
/*
MIT License
Copyright (c) 2019-2021 Mika Tuupola
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-cut-
This file is part of hardware agnostic I2C driver for AXP192:
https://github.com/tuupola/axp192
SPDX-License-Identifier: MIT
Version: 0.6.0-dev
*/
#ifndef _AXP192_H
#define _AXP192_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#define AXP192_ADDRESS (0x34)
/* Power control registers */
#define AXP192_POWER_STATUS (0x00)
#define AXP192_CHARGE_STATUS (0x01)
#define AXP192_OTG_VBUS_STATUS (0x04)
#define AXP192_DATA_BUFFER0 (0x06)
#define AXP192_DATA_BUFFER1 (0x07)
#define AXP192_DATA_BUFFER2 (0x08)
#define AXP192_DATA_BUFFER3 (0x09)
#define AXP192_DATA_BUFFER4 (0x0a)
#define AXP192_DATA_BUFFER5 (0x0b)
/* Output control: 2 EXTEN, 0 DCDC2 */
#define AXP192_EXTEN_DCDC2_CONTROL (0x10)
/* Power output control: 6 EXTEN, 4 DCDC2, 3 LDO3, 2 LDO2, 1 DCDC3, 0 DCDC1 */
#define AXP192_DCDC13_LDO23_CONTROL (0x12)
#define AXP192_DCDC2_VOLTAGE (0x23)
#define AXP192_DCDC2_SLOPE (0x25)
#define AXP192_DCDC1_VOLTAGE (0x26)
#define AXP192_DCDC3_VOLTAGE (0x27)
/* Output voltage control: 7-4 LDO2, 3-0 LDO3 */
#define AXP192_LDO23_VOLTAGE (0x28)
#define AXP192_VBUS_IPSOUT_CHANNEL (0x30)
#define AXP192_SHUTDOWN_VOLTAGE (0x31)
#define AXP192_SHUTDOWN_BATTERY_CHGLED_CONTROL (0x32)
#define AXP192_CHARGE_CONTROL_1 (0x33)
#define AXP192_CHARGE_CONTROL_2 (0x34)
#define AXP192_BATTERY_CHARGE_CONTROL (0x35)
#define AXP192_PEK (0x36)
#define AXP192_DCDC_FREQUENCY (0x37)
#define AXP192_BATTERY_CHARGE_LOW_TEMP (0x38)
#define AXP192_BATTERY_CHARGE_HIGH_TEMP (0x39)
#define AXP192_APS_LOW_POWER1 (0x3A)
#define AXP192_APS_LOW_POWER2 (0x3B)
#define AXP192_BATTERY_DISCHARGE_LOW_TEMP (0x3c)
#define AXP192_BATTERY_DISCHARGE_HIGH_TEMP (0x3d)
#define AXP192_DCDC_MODE (0x80)
#define AXP192_ADC_ENABLE_1 (0x82)
#define AXP192_ADC_ENABLE_2 (0x83)
#define AXP192_ADC_RATE_TS_PIN (0x84)
#define AXP192_GPIO30_INPUT_RANGE (0x85)
#define AXP192_GPIO0_ADC_IRQ_RISING (0x86)
#define AXP192_GPIO0_ADC_IRQ_FALLING (0x87)
#define AXP192_TIMER_CONTROL (0x8a)
#define AXP192_VBUS_MONITOR (0x8b)
#define AXP192_TEMP_SHUTDOWN_CONTROL (0x8f)
/* GPIO control registers */
#define AXP192_GPIO0_CONTROL (0x90)
#define AXP192_GPIO0_LDOIO0_VOLTAGE (0x91)
#define AXP192_GPIO1_CONTROL (0x92)
#define AXP192_GPIO2_CONTROL (0x93)
#define AXP192_GPIO20_SIGNAL_STATUS (0x94)
#define AXP192_GPIO43_FUNCTION_CONTROL (0x95)
#define AXP192_GPIO43_SIGNAL_STATUS (0x96)
#define AXP192_GPIO20_PULLDOWN_CONTROL (0x97)
#define AXP192_PWM1_FREQUENCY (0x98)
#define AXP192_PWM1_DUTY_CYCLE_1 (0x99)
#define AXP192_PWM1_DUTY_CYCLE_2 (0x9a)
#define AXP192_PWM2_FREQUENCY (0x9b)
#define AXP192_PWM2_DUTY_CYCLE_1 (0x9c)
#define AXP192_PWM2_DUTY_CYCLE_2 (0x9d)
#define AXP192_N_RSTO_GPIO5_CONTROL (0x9e)
/* Interrupt control registers */
#define AXP192_ENABLE_CONTROL_1 (0x40)
#define AXP192_ENABLE_CONTROL_2 (0x41)
#define AXP192_ENABLE_CONTROL_3 (0x42)
#define AXP192_ENABLE_CONTROL_4 (0x43)
#define AXP192_ENABLE_CONTROL_5 (0x4a)
#define AXP192_IRQ_STATUS_1 (0x44)
#define AXP192_IRQ_STATUS_2 (0x45)
#define AXP192_IRQ_STATUS_3 (0x46)
#define AXP192_IRQ_STATUS_4 (0x47)
#define AXP192_IRQ_STATUS_5 (0x4d)
/* ADC data registers */
#define AXP192_ACIN_VOLTAGE (0x56)
#define AXP192_ACIN_CURRENT (0x58)
#define AXP192_VBUS_VOLTAGE (0x5a)
#define AXP192_VBUS_CURRENT (0x5c)
#define AXP192_TEMP (0x5e)
#define AXP192_TS_INPUT (0x62)
#define AXP192_GPIO0_VOLTAGE (0x64)
#define AXP192_GPIO1_VOLTAGE (0x66)
#define AXP192_GPIO2_VOLTAGE (0x68)
#define AXP192_GPIO3_VOLTAGE (0x6a)
#define AXP192_BATTERY_POWER (0x70)
#define AXP192_BATTERY_VOLTAGE (0x78)
#define AXP192_CHARGE_CURRENT (0x7a)
#define AXP192_DISCHARGE_CURRENT (0x7c)
#define AXP192_APS_VOLTAGE (0x7e)
#define AXP192_CHARGE_COULOMB (0xb0)
#define AXP192_DISCHARGE_COULOMB (0xb4)
#define AXP192_COULOMB_COUNTER_CONTROL (0xb8)
/* Computed ADC */
#define AXP192_COULOMB_COUNTER (0xff)
/* IOCTL commands */
#define AXP192_READ_POWER_STATUS (0x0001)
#define AXP192_READ_CHARGE_STATUS (0x0101)
#define AXP192_COULOMB_COUNTER_ENABLE (0xb801)
#define AXP192_COULOMB_COUNTER_DISABLE (0xb802)
#define AXP192_COULOMB_COUNTER_SUSPEND (0xb803)
#define AXP192_COULOMB_COUNTER_CLEAR (0xb804)
#define AXP192_LDOIO0_ENABLE (0x9000)
#define AXP192_LDOIO0_DISABLE (0x9001)
#define AXP192_DCDC2_ENABLE (0x1000)
#define AXP192_DCDC2_DISABLE (0x1001)
#define AXP192_EXTEN_ENABLE (0x1002)
#define AXP192_EXTEN_DISABLE (0x1003)
#define AXP192_LDO2_ENABLE (0x1200)
#define AXP192_LDO2_DISABLE (0x1201)
#define AXP192_LDO3_ENABLE (0x1202)
#define AXP192_LDO3_DISABLE (0x1203)
#define AXP192_DCDC1_ENABLE (0x1204)
#define AXP192_DCDC1_DISABLE (0x1205)
#define AXP192_DCDC3_ENABLE (0x1206)
#define AXP192_DCDC3_DISABLE (0x1207)
#define AXP192_DCDC1_SET_VOLTAGE (0x2600)
#define AXP192_DCDC2_SET_VOLTAGE (0x2300)
#define AXP192_DCDC3_SET_VOLTAGE (0x2700)
#define AXP192_LDO2_SET_VOLTAGE (0x2800)
#define AXP192_LDO3_SET_VOLTAGE (0x2801)
#define AXP192_LDOIO0_SET_VOLTAGE (0x9100)
#define AXP192_LOW (0)
#define AXP192_HIGH (1)
#define AXP192_GPIO0_SET_LEVEL (0x9400)
#define AXP192_GPIO1_SET_LEVEL (0x9401)
#define AXP192_GPIO2_SET_LEVEL (0x9402)
#define AXP192_GPIO4_SET_LEVEL (0x9601)
/* Error codes */
#define AXP192_OK (0)
#define AXP192_ERROR_NOTTY (-1)
#define AXP192_ERROR_EINVAL (-22)
#define AXP192_ERROR_ENOTSUP (-95)
typedef struct {
uint8_t command;
uint8_t data[2];
uint8_t count;
} axp192_init_command_t;
/* These should be provided by the HAL. */
typedef struct {
int32_t (* read)(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t (* write)(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
void *handle;
} axp192_t;
typedef int32_t axp192_err_t;
axp192_err_t axp192_init(const axp192_t *axp);
axp192_err_t axp192_read(const axp192_t *axp, uint8_t reg, void *buffer);
axp192_err_t axp192_write(const axp192_t *axp, uint8_t reg, const uint8_t *buffer);
axp192_err_t axp192_ioctl(const axp192_t *axp, int command, ...);
#ifdef __cplusplus
}
#endif
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/axp192/axp192.h | C | apache-2.0 | 8,174 |
/*
MIT License
Copyright (c) 2019-2021 Mika Tuupola
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-cut-
This file is part of hardware agnostic I2C driver for AXP192:
https://github.com/tuupola/axp192
SPDX-License-Identifier: MIT
Version: 0.6.0-dev
*/
#ifndef _AXP192_CONFIG_H
#define _AXP192_CONFIG_H
#ifdef __cplusplus
extern "C" {
#endif
#ifdef AXP192_INCLUDE_SDKCONFIG_H
#include "sdkconfig.h"
/* This requires you to run menuconfig first. */
#define CONFIG_AXP192_EXTEN_DCDC2_CONTROL ( \
CONFIG_AXP192_EXTEN_DCDC2_CONTROL_BIT2 | \
CONFIG_AXP192_EXTEN_DCDC2_CONTROL_BIT0 \
)
#define CONFIG_AXP192_DCDC13_LDO23_CONTROL ( \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT6 | \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT4 | \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT3 | \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT2 | \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT1 | \
CONFIG_AXP192_DCDC13_LDO23_CONTROL_BIT0 \
)
#define CONFIG_AXP192_LDO23_VOLTAGE ( \
CONFIG_AXP192_LDO23_VOLTAGE_BIT74 | \
CONFIG_AXP192_LDO23_VOLTAGE_BIT30 \
)
#define CONFIG_AXP192_DCDC1_VOLTAGE ( \
CONFIG_AXP192_DCDC1_VOLTAGE_BIT60 \
)
#define CONFIG_AXP192_DCDC3_VOLTAGE ( \
CONFIG_AXP192_DCDC3_VOLTAGE_BIT60 \
)
#define CONFIG_AXP192_ADC_ENABLE_1 ( \
CONFIG_AXP192_ADC_ENABLE_1_BIT7 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT6 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT5 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT4 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT3 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT2 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT1 | \
CONFIG_AXP192_ADC_ENABLE_1_BIT0 \
)
#define CONFIG_AXP192_CHARGE_CONTROL_1 ( \
CONFIG_AXP192_CHARGE_CONTROL_1_BIT7 | \
CONFIG_AXP192_CHARGE_CONTROL_1_BIT65 | \
CONFIG_AXP192_CHARGE_CONTROL_1_BIT4 | \
CONFIG_AXP192_CHARGE_CONTROL_1_BIT30 \
)
#define CONFIG_AXP192_BATTERY_CHARGE_CONTROL ( \
CONFIG_AXP192_BATTERY_CHARGE_CONTROL_BIT7 | \
CONFIG_AXP192_BATTERY_CHARGE_CONTROL_BIT65 | \
CONFIG_AXP192_BATTERY_CHARGE_CONTROL_BIT10 \
)
#define CONFIG_AXP192_GPIO0_CONTROL ( \
CONFIG_AXP192_GPIO0_CONTROL_BIT20 \
)
#define CONFIG_AXP192_GPIO1_CONTROL ( \
CONFIG_AXP192_GPIO1_CONTROL_BIT20 \
)
#define CONFIG_AXP192_GPIO2_CONTROL ( \
CONFIG_AXP192_GPIO2_CONTROL_BIT20 \
)
#define CONFIG_AXP192_GPIO43_FUNCTION_CONTROL ( \
CONFIG_AXP192_GPIO43_FUNCTION_CONTROL_BIT7 | \
CONFIG_AXP192_GPIO43_FUNCTION_CONTROL_BIT32 | \
CONFIG_AXP192_GPIO43_FUNCTION_CONTROL_BIT10 \
)
#define CONFIG_AXP192_GPIO0_LDOIO0_VOLTAGE ( \
CONFIG_AXP192_GPIO0_LDOIO0_VOLTAGE_BIT74 \
)
#endif /* AXP192_INCLUDE_SDKCONFIG_H */
#ifdef __cplusplus
}
#endif
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/axp192/axp192_config.h | C | apache-2.0 | 3,615 |
COMPONENT_SRCDIRS:=./
COMPONENT_ADD_INCLUDEDIRS:=./
CFLAGS += -DAXP192_INCLUDE_SDKCONFIG_H
| YifuLiu/AliOS-Things | components/little_ui/driver/axp192/component.mk | Makefile | apache-2.0 | 91 |
set(SOURCES "i2c_manager/i2c_manager.c")
set(INCLUDES "i2c_manager")
if (CONFIG_I2C_MANAGER_I2CDEV)
list(APPEND SOURCES "i2cdev/i2cdev.c")
list(APPEND INCLUDES "i2cdev")
endif()
idf_component_register(
SRCS ${SOURCES}
INCLUDE_DIRS ${INCLUDES}
)
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/CMakeLists.txt | CMake | apache-2.0 | 263 |
COMPONENT_SRCDIRS := i2c_manager
COMPONENT_ADD_INCLUDEDIRS := i2c_manager
ifdef CONFIG_I2C_MANAGER_I2CDEV
COMPONENT_ADD_INCLUDEDIRS += i2cdev
COMPONENT_SRCDIRS += i2cdev
endif
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/component.mk | Makefile | apache-2.0 | 180 |
/*
SPDX-License-Identifier: MIT
MIT License
Copyright (c) 2021 Rop Gonggrijp. Based on esp_i2c_helper by Mika Tuupola.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include <stdint.h>
#include <stddef.h>
#include <esp_log.h>
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "freertos/task.h"
#include <driver/i2c.h>
#include "sdkconfig.h"
#include "i2c_manager.h"
#if defined __has_include
#if __has_include ("esp_idf_version.h")
#include "esp_idf_version.h"
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 3, 0)
#define HAS_CLK_FLAGS
#endif
#endif
#endif
static const char* TAG = I2C_TAG;
static SemaphoreHandle_t I2C_FN(_local_mutex)[2] = { NULL, NULL };
static SemaphoreHandle_t* I2C_FN(_mutex) = &I2C_FN(_local_mutex)[0];
static const uint8_t ACK_CHECK_EN = 1;
#if defined (I2C_NUM_0) && defined (CONFIG_I2C_MANAGER_0_ENABLED)
#define I2C_ZERO I2C_NUM_0
#if defined (CONFIG_I2C_MANAGER_0_PULLUPS)
#define I2C_MANAGER_0_PULLUPS true
#else
#define I2C_MANAGER_0_PULLUPS false
#endif
#define I2C_MANAGER_0_TIMEOUT ( CONFIG_I2C_MANAGER_0_TIMEOUT / portTICK_RATE_MS )
#define I2C_MANAGER_0_LOCK_TIMEOUT ( CONFIG_I2C_MANAGER_0_LOCK_TIMEOUT / portTICK_RATE_MS )
#endif
#if defined (I2C_NUM_1) && defined (CONFIG_I2C_MANAGER_1_ENABLED)
#define I2C_ONE I2C_NUM_1
#if defined (CONFIG_I2C_MANAGER_1_PULLUPS)
#define I2C_MANAGER_1_PULLUPS true
#else
#define I2C_MANAGER_1_PULLUPS false
#endif
#define I2C_MANAGER_1_TIMEOUT ( CONFIG_I2C_MANAGER_1_TIMEOUT / portTICK_RATE_MS )
#define I2C_MANAGER_1_LOCK_TIMEOUT ( CONFIG_I2C_MANAGER_1_LOCK_TIMEOUT / portTICK_RATE_MS )
#endif
#define ERROR_PORT(port, fail) { \
ESP_LOGE(TAG, "Invalid port or not configured for I2C Manager: %d", (int)port); \
return fail; \
}
#if defined(I2C_ZERO) && defined (I2C_ONE)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_0 && port != I2C_NUM_1) ERROR_PORT(port, fail);
#else
#if defined(I2C_ZERO)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_0) ERROR_PORT(port, fail);
#elif defined(I2C_ONE)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_1) ERROR_PORT(port, fail);
#else
#define I2C_PORT_CHECK(port, fail) \
ERROR_PORT(port, fail);
#endif
#endif
static void i2c_send_address(i2c_cmd_handle_t cmd, uint16_t addr, i2c_rw_t rw) {
if (addr & I2C_ADDR_10) {
i2c_master_write_byte(cmd, 0xF0 | ((addr & 0x3FF) >> 7) | rw, ACK_CHECK_EN);
i2c_master_write_byte(cmd, addr & 0xFF, ACK_CHECK_EN);
} else {
i2c_master_write_byte(cmd, (addr << 1) | rw, ACK_CHECK_EN);
}
}
static void i2c_send_register(i2c_cmd_handle_t cmd, uint32_t reg) {
if (reg & I2C_REG_16) {
i2c_master_write_byte(cmd, (reg & 0xFF00) >> 8, ACK_CHECK_EN);
}
i2c_master_write_byte(cmd, reg & 0xFF, ACK_CHECK_EN);
}
esp_err_t I2C_FN(_init)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t ret = ESP_OK;
if (I2C_FN(_mutex)[port] == 0) {
ESP_LOGI(TAG, "Starting I2C master at port %d.", (int)port);
I2C_FN(_mutex)[port] = xSemaphoreCreateMutex();
i2c_config_t conf = {0};
#ifdef HAS_CLK_FLAGS
conf.clk_flags = 0;
#endif
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
conf.sda_io_num = CONFIG_I2C_MANAGER_0_SDA;
conf.scl_io_num = CONFIG_I2C_MANAGER_0_SCL;
conf.sda_pullup_en = I2C_MANAGER_0_PULLUPS ? GPIO_PULLUP_ENABLE : GPIO_PULLUP_DISABLE;
conf.scl_pullup_en = conf.sda_pullup_en;
conf.master.clk_speed = CONFIG_I2C_MANAGER_0_FREQ_HZ;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
conf.sda_io_num = CONFIG_I2C_MANAGER_1_SDA;
conf.scl_io_num = CONFIG_I2C_MANAGER_1_SCL;
conf.sda_pullup_en = I2C_MANAGER_1_PULLUPS ? GPIO_PULLUP_ENABLE : GPIO_PULLUP_DISABLE;
conf.scl_pullup_en = conf.sda_pullup_en;
conf.master.clk_speed = CONFIG_I2C_MANAGER_1_FREQ_HZ;
}
#endif
conf.mode = I2C_MODE_MASTER;
ret = i2c_param_config(port, &conf);
ret |= i2c_driver_install(port, conf.mode, 0, 0, 0);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialise I2C port %d.", (int)port);
ESP_LOGW(TAG, "If it was already open, we'll use it with whatever settings were used "
"to open it. See I2C Manager README for details.");
} else {
ESP_LOGI(TAG, "Initialised port %d (SDA: %d, SCL: %d, speed: %d Hz.)",
port, conf.sda_io_num, conf.scl_io_num, conf.master.clk_speed);
}
}
return ret;
}
esp_err_t I2C_FN(_read)(i2c_port_t port, uint16_t addr, uint32_t reg, uint8_t *buffer, uint16_t size) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t result;
// May seem weird, but init starts with a check if it's needed, no need for that check twice.
I2C_FN(_init)(port);
ESP_LOGV(TAG, "Reading port %d, addr 0x%03x, reg 0x%04x", port, addr, reg);
TickType_t timeout = 0;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = I2C_MANAGER_0_TIMEOUT;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = I2C_MANAGER_1_TIMEOUT;
}
#endif
if (I2C_FN(_lock)((int)port) == ESP_OK) {
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
if (!(reg & I2C_NO_REG)) {
/* When reading specific register set the addr pointer first. */
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_WRITE);
i2c_send_register(cmd, reg);
}
/* Read size bytes from the current pointer. */
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_READ);
i2c_master_read(cmd, buffer, size, I2C_MASTER_LAST_NACK);
i2c_master_stop(cmd);
result = i2c_master_cmd_begin(port, cmd, timeout);
i2c_cmd_link_delete(cmd);
I2C_FN(_unlock)((int)port);
} else {
ESP_LOGE(TAG, "Lock could not be obtained for port %d.", (int)port);
return ESP_ERR_TIMEOUT;
}
if (result != ESP_OK) {
ESP_LOGW(TAG, "Error: %d", result);
}
ESP_LOG_BUFFER_HEX_LEVEL(TAG, buffer, size, ESP_LOG_VERBOSE);
return result;
}
esp_err_t I2C_FN(_write)(i2c_port_t port, uint16_t addr, uint32_t reg, const uint8_t *buffer, uint16_t size) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t result;
// May seem weird, but init starts with a check if it's needed, no need for that check twice.
I2C_FN(_init)(port);
ESP_LOGV(TAG, "Writing port %d, addr 0x%03x, reg 0x%04x", port, addr, reg);
TickType_t timeout = 0;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = (CONFIG_I2C_MANAGER_0_TIMEOUT) / portTICK_RATE_MS;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = (CONFIG_I2C_MANAGER_1_TIMEOUT) / portTICK_RATE_MS;
}
#endif
if (I2C_FN(_lock)((int)port) == ESP_OK) {
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_WRITE);
if (!(reg & I2C_NO_REG)) {
i2c_send_register(cmd, reg);
}
i2c_master_write(cmd, (uint8_t *)buffer, size, ACK_CHECK_EN);
i2c_master_stop(cmd);
result = i2c_master_cmd_begin( port, cmd, timeout);
i2c_cmd_link_delete(cmd);
I2C_FN(_unlock)((int)port);
} else {
ESP_LOGE(TAG, "Lock could not be obtained for port %d.", (int)port);
return ESP_ERR_TIMEOUT;
}
if (result != ESP_OK) {
ESP_LOGW(TAG, "Error: %d", result);
}
ESP_LOG_BUFFER_HEX_LEVEL(TAG, buffer, size, ESP_LOG_VERBOSE);
return result;
}
esp_err_t I2C_FN(_close)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
vSemaphoreDelete(I2C_FN(_mutex)[port]);
I2C_FN(_mutex)[port] = NULL;
ESP_LOGI(TAG, "Closing I2C master at port %d", port);
return i2c_driver_delete(port);
}
esp_err_t I2C_FN(_lock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
ESP_LOGV(TAG, "Mutex lock set for %d.", (int)port);
TickType_t timeout;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = (CONFIG_I2C_MANAGER_0_LOCK_TIMEOUT) / portTICK_RATE_MS;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = (CONFIG_I2C_MANAGER_1_LOCK_TIMEOUT) / portTICK_RATE_MS;
}
#endif
if (xSemaphoreTake(I2C_FN(_mutex)[port], timeout) == pdTRUE) {
return ESP_OK;
} else {
ESP_LOGE(TAG, "Removing stale mutex lock from port %d.", (int)port);
I2C_FN(_force_unlock)(port);
return (xSemaphoreTake(I2C_FN(_mutex)[port], timeout) == pdTRUE ? ESP_OK : ESP_FAIL);
}
}
esp_err_t I2C_FN(_unlock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
ESP_LOGV(TAG, "Mutex lock removed for %d.", (int)port);
return (xSemaphoreGive(I2C_FN(_mutex)[port]) == pdTRUE) ? ESP_OK : ESP_FAIL;
}
esp_err_t I2C_FN(_force_unlock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
if (I2C_FN(_mutex)[port]) {
vSemaphoreDelete(I2C_FN(_mutex)[port]);
}
I2C_FN(_mutex)[port] = xSemaphoreCreateMutex();
return ESP_OK;
}
#ifdef I2C_OEM
void I2C_FN(_locking)(void* leader) {
if (leader) {
ESP_LOGI(TAG, "Now following I2C Manager for locking");
I2C_FN(_mutex) = (SemaphoreHandle_t*)leader;
}
}
#else
void* i2c_manager_locking() {
return (void*)i2c_manager_mutex;
}
int32_t i2c_hal_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size) {
return i2c_manager_read(*(i2c_port_t*)handle, address, reg, buffer, size);
}
int32_t i2c_hal_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size) {
return i2c_manager_write(*(i2c_port_t*)handle, address, reg, buffer, size);
}
static i2c_port_t port_zero = (i2c_port_t)0;
static i2c_port_t port_one = (i2c_port_t)1;
static i2c_hal_t _i2c_hal[2] = {
{&i2c_hal_read, &i2c_hal_write, &port_zero},
{&i2c_hal_read, &i2c_hal_write, &port_one}
};
void* i2c_hal(i2c_port_t port) {
I2C_PORT_CHECK(port, NULL);
return (void*)&_i2c_hal[port];
}
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/i2c_manager/i2c_manager.c | C | apache-2.0 | 10,692 |
#ifndef _I2C_MANAGER_H
#define _I2C_MANAGER_H
#ifdef __cplusplus
extern "C" {
#endif
/*
If you copy the i2c_manager files to your own component instead of
depending on i2c_manager, you MUST uncomment the define below
and put in some short string that identifies your component (such
as 'xyz'). This will cause i2c_manager to create functions named
xyz_i2c_* instead of i2c_manager_*. See README.md for details.
*/
// #define I2C_OEM xyz
// Only here to get the I2C_NUM_0 and I2C_NUM_1 defines.
#include <driver/i2c.h>
#define CONCATX(A, B) A ## B
#define CONCAT(A, B) CONCATX(A, B)
#define STR_LITERAL(s) # s
#define STR_EXPAND(s) STR_LITERAL(s)
#define STR_QUOTE(s) STR_EXPAND(STR_EXPAND(s))
#ifdef I2C_OEM
#define I2C_NAME_PREFIX CONCAT(I2C_OEM, _i2c)
#else
#define I2C_NAME_PREFIX i2c_manager
#endif
#define I2C_TAG STR_EXPAND(I2C_NAME_PREFIX)
#define I2C_FN(s) CONCAT(I2C_NAME_PREFIX, s)
#define I2C_ADDR_10 ( 1 << 15 )
#define I2C_REG_16 ( 1 << 31 )
#define I2C_NO_REG ( 1 << 30 )
esp_err_t I2C_FN(_init)(i2c_port_t port);
esp_err_t I2C_FN(_read)(i2c_port_t port, uint16_t addr, uint32_t reg, uint8_t *buffer, uint16_t size);
esp_err_t I2C_FN(_write)(i2c_port_t port, uint16_t addr, uint32_t reg, const uint8_t *buffer, uint16_t size);
esp_err_t I2C_FN(_close)(i2c_port_t port);
esp_err_t I2C_FN(_lock)(i2c_port_t port);
esp_err_t I2C_FN(_unlock)(i2c_port_t port);
esp_err_t I2C_FN(_force_unlock)(i2c_port_t port);
#ifdef I2C_OEM
void I2C_FN(_locking)(void* leader);
#else
void* i2c_manager_locking();
typedef struct {
int32_t (* read)(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t (* write)(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
void *handle;
} i2c_hal_t;
void* i2c_hal(i2c_port_t port);
#endif
#ifdef __cplusplus
}
#endif
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/i2c_manager/i2c_manager.h | C | apache-2.0 | 1,918 |
/*
SPDX-License-Identifier: MIT
MIT License
Copyright (c) 2021 Rop Gonggrijp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include <i2c_manager.h>
#include "i2cdev.h"
#include <esp_log.h>
static const char *TAG = I2C_TAG;
esp_err_t i2cdev_init() {
return ESP_OK;
}
esp_err_t i2cdev_done() {
return ESP_OK;
}
esp_err_t i2c_dev_create_mutex(i2c_dev_t *dev) {
return ESP_OK;
}
esp_err_t i2c_dev_delete_mutex(i2c_dev_t *dev) {
return ESP_OK;
}
esp_err_t i2c_dev_take_mutex(i2c_dev_t *dev) {
return i2c_manager_lock(dev->port);
}
esp_err_t i2c_dev_give_mutex(i2c_dev_t *dev) {
return i2c_manager_unlock(dev->port);
}
esp_err_t i2c_dev_read(const i2c_dev_t *dev, const void *out_data, size_t out_size, void *in_data, size_t in_size) {
if (!dev || !in_data || !in_size) return ESP_ERR_INVALID_ARG;
uint32_t reg;
switch(out_size) {
case 0:
reg = I2C_NO_REG;
break;
case 1:
reg = *(uint8_t*)out_data;
break;
case 2:
reg = *(uint16_t*)out_data | I2C_REG_16;
break;
default:
ESP_LOGE(TAG, "i2cdev emulation only supports 0, 8 and 16-bit registers");
return ESP_ERR_INVALID_ARG;
}
return i2c_manager_read(dev->port, dev->addr, reg, in_data, (uint16_t)in_size);
}
esp_err_t i2c_dev_write(const i2c_dev_t *dev, const void *out_reg, size_t out_reg_size, const void *out_data, size_t out_size) {
if (!dev || !out_data || !out_size) return ESP_ERR_INVALID_ARG;
uint32_t reg;
switch(out_reg_size) {
case 0:
reg = I2C_NO_REG;
break;
case 1:
reg = *(uint8_t*)out_reg;
break;
case 2:
reg = *(uint16_t*)out_reg | I2C_REG_16;
break;
default:
ESP_LOGE(TAG, "i2cdev emulation only supports 0, 8 and 16-bit registers");
return ESP_ERR_INVALID_ARG;
}
return i2c_manager_write(dev->port, dev->addr, reg, out_data, (uint16_t)out_size);
}
esp_err_t i2c_dev_read_reg(const i2c_dev_t *dev, uint8_t reg, void *in_data, size_t in_size) {
return i2c_manager_read(dev->port, dev->addr, reg, in_data, (uint16_t)in_size);
}
esp_err_t i2c_dev_write_reg(const i2c_dev_t *dev, uint8_t reg, const void *out_data, size_t out_size) {
return i2c_manager_write(dev->port, dev->addr, reg, out_data, (uint16_t)out_size);
}
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/i2cdev/i2cdev.c | C | apache-2.0 | 3,403 |
/*
SPDX-License-Identifier: MIT
MIT License
Copyright (c) 2021 Rop Gonggrijp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#ifndef __I2CDEV_H__
#define __I2CDEV_H__
#ifdef __cplusplus
extern "C" {
#endif
// i2cdev-compatible I2C device descriptor.
// Everything but the port and addr is ignored, port properties handled by I2C Manager
typedef struct
{
i2c_port_t port;
i2c_config_t cfg;
uint8_t addr;
SemaphoreHandle_t mutex;
uint32_t timeout_ticks;
} i2c_dev_t;
esp_err_t i2cdev_init();
esp_err_t i2cdev_done();
esp_err_t i2c_dev_create_mutex(i2c_dev_t *dev);
esp_err_t i2c_dev_delete_mutex(i2c_dev_t *dev);
esp_err_t i2c_dev_take_mutex(i2c_dev_t *dev);
esp_err_t i2c_dev_give_mutex(i2c_dev_t *dev);
esp_err_t i2c_dev_read(const i2c_dev_t *dev, const void *out_data,
size_t out_size, void *in_data, size_t in_size);
esp_err_t i2c_dev_write(const i2c_dev_t *dev, const void *out_reg,
size_t out_reg_size, const void *out_data, size_t out_size);
esp_err_t i2c_dev_read_reg(const i2c_dev_t *dev, uint8_t reg,
void *in_data, size_t in_size);
esp_err_t i2c_dev_write_reg(const i2c_dev_t *dev, uint8_t reg,
const void *out_data, size_t out_size);
#ifdef __cplusplus
}
#endif
#endif /* __I2CDEV_H__ */
| YifuLiu/AliOS-Things | components/little_ui/driver/i2c_manager/i2cdev/i2cdev.h | C | apache-2.0 | 2,243 |
if(ESP_PLATFORM)
file(GLOB SOURCES *.c)
set(LVGL_INCLUDE_DIRS . lvgl_tft)
list(APPEND SOURCES "lvgl_tft/disp_driver.c")
list(APPEND SOURCES "lvgl_tft/esp_lcd_backlight.c")
# Include only the source file of the selected
# display controller.
if(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341)
list(APPEND SOURCES "lvgl_tft/ili9341.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9481)
list(APPEND SOURCES "lvgl_tft/ili9481.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9486)
list(APPEND SOURCES "lvgl_tft/ili9486.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9488)
list(APPEND SOURCES "lvgl_tft/ili9488.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789)
list(APPEND SOURCES "lvgl_tft/st7789.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7735S)
list(APPEND SOURCES "lvgl_tft/st7735s.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7796S)
list(APPEND SOURCES "lvgl_tft/st7796s.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_HX8357)
list(APPEND SOURCES "lvgl_tft/hx8357.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_SH1107)
list(APPEND SOURCES "lvgl_tft/sh1107.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_SSD1306)
list(APPEND SOURCES "lvgl_tft/ssd1306.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
list(APPEND SOURCES "lvgl_tft/EVE_commands.c")
list(APPEND SOURCES "lvgl_tft/FT81x.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_IL3820)
list(APPEND SOURCES "lvgl_tft/il3820.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_JD79653A)
list(APPEND SOURCES "lvgl_tft/jd79653a.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_UC8151D)
list(APPEND SOURCES "lvgl_tft/uc8151d.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_RA8875)
list(APPEND SOURCES "lvgl_tft/ra8875.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_GC9A01)
list(APPEND SOURCES "lvgl_tft/GC9A01.c")
elseif(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C)
list(APPEND SOURCES "lvgl_tft/ili9163c.c")
else()
message(WARNING "LVGL ESP32 drivers: Display controller not defined.")
endif()
if(CONFIG_LV_TFT_DISPLAY_PROTOCOL_SPI)
list(APPEND SOURCES "lvgl_tft/disp_spi.c")
endif()
# Add touch driver to compilation only if it is selected in menuconfig
if(CONFIG_LV_TOUCH_CONTROLLER)
list(APPEND SOURCES "lvgl_touch/touch_driver.c")
list(APPEND LVGL_INCLUDE_DIRS lvgl_touch)
# Include only the source file of the selected
# touch controller.
if(CONFIG_LV_TOUCH_CONTROLLER_XPT2046)
list(APPEND SOURCES "lvgl_touch/xpt2046.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_FT6X06)
list(APPEND SOURCES "lvgl_touch/ft6x36.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_STMPE610)
list(APPEND SOURCES "lvgl_touch/stmpe610.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_ADCRAW)
list(APPEND SOURCES "lvgl_touch/adcraw.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_FT81X)
list(APPEND SOURCES "lvgl_touch/FT81x.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_RA8875)
list(APPEND SOURCES "lvgl_touch/ra8875_touch.c")
elseif(CONFIG_LV_TOUCH_CONTROLLER_GT911)
list(APPEND SOURCES "lvgl_touch/gt911.c")
endif()
if(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)
list(APPEND SOURCES "lvgl_touch/tp_spi.c")
endif()
endif()
if(CONFIG_LV_I2C)
list(APPEND SOURCES "lvgl_i2c/i2c_manager.c")
endif()
idf_component_register(SRCS ${SOURCES}
INCLUDE_DIRS ${LVGL_INCLUDE_DIRS}
REQUIRES lvgl)
target_compile_definitions(${COMPONENT_LIB} PUBLIC "-DLV_LVGL_H_INCLUDE_SIMPLE")
else()
message(FATAL_ERROR "LVGL ESP32 drivers: ESP_PLATFORM is not defined. Try reinstalling ESP-IDF.")
endif()
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/CMakeLists.txt | CMake | apache-2.0 | 3,579 |
# LVGL ESP32 drivers
# Define sources and include dirs
COMPONENT_SRCDIRS := . lvgl_tft lvgl_touch lvgl_i2c
COMPONENT_ADD_INCLUDEDIRS := .
# LVGL is supposed to be used as a ESP-IDF component
# -> lvlg is already in the include path
# -> we use simple include
CFLAGS += -DLV_LVGL_H_INCLUDE_SIMPLE
# TFT display drivers
COMPONENT_ADD_INCLUDEDIRS += lvgl_tft
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341),lvgl_tft/ili9341.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9481),lvgl_tft/ili9481.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9486),lvgl_tft/ili9486.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9488),lvgl_tft/ili9488.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789),lvgl_tft/st7789.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7735S),lvgl_tft/st7735s.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7796S),lvgl_tft/st7796s.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_HX8357),lvgl_tft/hx8357.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_SH1107),lvgl_tft/sh1107.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_SSD1306),lvgl_tft/ssd1306.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X),lvgl_tft/EVE_commands.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X),lvgl_tft/FT81x.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_IL3820),lvgl_tft/il3820.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_JD79653A),lvgl_tft/jd79653a.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_UC8151D),lvgl_tft/uc8151d.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_RA8875),lvgl_tft/ra8875.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_CONTROLLER_GC9A01),lvgl_tft/GC9A01.o)
$(call compile_only_if,$(CONFIG_LV_TFT_DISPLAY_PROTOCOL_SPI),lvgl_tft/disp_spi.o)
# Touch controller drivers
COMPONENT_ADD_INCLUDEDIRS += lvgl_touch
$(call compile_only_if,$(CONFIG_LV_TOUCH_CONTROLLER),lvgl_touch/touch_driver.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_XPT2046)), lvgl_touch/xpt2046.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_FT6X06)), lvgl_touch/ft6x36.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_STMPE610)), lvgl_touch/stmpe610.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_ADCRAW)), lvgl_touch/adcraw.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_FT81X)), lvgl_touch/FT81x.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_CONTROLLER_RA8875)), lvgl_touch/ra8875_touch.o)
$(call compile_only_if,$(and $(CONFIG_LV_TOUCH_CONTROLLER),$(CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)), lvgl_touch/tp_spi.o)
# I2C Manager
$(call compile_only_if,$(CONFIG_LV_I2C), lvgl_i2c/i2c_manager.o)
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/component.mk | Makefile | apache-2.0 | 2,986 |
/**
* @file lvgl_helpers.c
*
*/
/*********************
* INCLUDES
*********************/
#include "sdkconfig.h"
#include "lvgl_helpers.h"
#include "esp_log.h"
#include "lvgl_tft/disp_spi.h"
#include "lvgl_touch/tp_spi.h"
#include "lvgl_spi_conf.h"
#include "lvgl_i2c/i2c_manager.h"
#ifdef LV_LVGL_H_INCLUDE_SIMPLE
#include "lvgl.h"
#else
#include "lvgl/lvgl.h"
#endif
/*********************
* DEFINES
*********************/
#define TAG "lvgl_helpers"
/**********************
* TYPEDEFS
**********************/
/**********************
* STATIC PROTOTYPES
**********************/
/**********************
* STATIC VARIABLES
**********************/
/**********************
* MACROS
**********************/
/**********************
* GLOBAL FUNCTIONS
**********************/
/* Interface and driver initialization */
void lvgl_driver_init(void)
{
/* Since LVGL v8 LV_HOR_RES_MAX and LV_VER_RES_MAX are not defined, so
* print it only if they are defined. */
#if (LVGL_VERSION_MAJOR < 8)
ESP_LOGI(TAG, "Display hor size: %d, ver size: %d", LV_HOR_RES_MAX, LV_VER_RES_MAX);
#endif
ESP_LOGI(TAG, "Display buffer size: %d", DISP_BUF_SIZE);
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
ESP_LOGI(TAG, "Initializing SPI master for FT81X");
lvgl_spi_driver_init(TFT_SPI_HOST,
DISP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
SPI_BUS_MAX_TRANSFER_SZ, 1,
DISP_SPI_IO2, DISP_SPI_IO3);
disp_spi_add_device(TFT_SPI_HOST);
disp_driver_init();
#if defined (CONFIG_LV_TOUCH_CONTROLLER_FT81X)
touch_driver_init();
#endif
return;
#endif
#if defined (SHARED_SPI_BUS)
ESP_LOGI(TAG, "Initializing shared SPI master");
lvgl_spi_driver_init(TFT_SPI_HOST,
TP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
SPI_BUS_MAX_TRANSFER_SZ, 1,
-1, -1);
disp_spi_add_device(TFT_SPI_HOST);
tp_spi_add_device(TOUCH_SPI_HOST);
disp_driver_init();
touch_driver_init();
return;
#endif
/* Display controller initialization */
#if defined CONFIG_LV_TFT_DISPLAY_PROTOCOL_SPI
ESP_LOGI(TAG, "Initializing SPI master for display");
lvgl_spi_driver_init(TFT_SPI_HOST,
DISP_SPI_MISO, DISP_SPI_MOSI, DISP_SPI_CLK,
SPI_BUS_MAX_TRANSFER_SZ, 1,
DISP_SPI_IO2, DISP_SPI_IO3);
disp_spi_add_device(TFT_SPI_HOST);
disp_driver_init();
#elif defined (CONFIG_LV_I2C_DISPLAY)
disp_driver_init();
#else
#error "No protocol defined for display controller"
#endif
/* Touch controller initialization */
#if CONFIG_LV_TOUCH_CONTROLLER != TOUCH_CONTROLLER_NONE
#if defined (CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI)
ESP_LOGI(TAG, "Initializing SPI master for touch");
lvgl_spi_driver_init(TOUCH_SPI_HOST,
TP_SPI_MISO, TP_SPI_MOSI, TP_SPI_CLK,
0 /* Defaults to 4094 */, 2,
-1, -1);
tp_spi_add_device(TOUCH_SPI_HOST);
touch_driver_init();
#elif defined (CONFIG_LV_I2C_TOUCH)
touch_driver_init();
#elif defined (CONFIG_LV_TOUCH_DRIVER_ADC)
touch_driver_init();
#elif defined (CONFIG_LV_TOUCH_DRIVER_DISPLAY)
touch_driver_init();
#else
#error "No protocol defined for touch controller"
#endif
#else
#endif
}
/* Initialize spi bus master
*
* NOTE: dma_chan type and value changed to int instead of spi_dma_chan_t
* for backwards compatibility with ESP-IDF versions prior v4.3.
*
* We could use the ESP_IDF_VERSION_VAL macro available in the "esp_idf_version.h"
* header available since ESP-IDF v4.
*/
bool lvgl_spi_driver_init(int host,
int miso_pin, int mosi_pin, int sclk_pin,
int max_transfer_sz,
int dma_channel,
int quadwp_pin, int quadhd_pin)
{
int dma_chan = 0 /* SPI_DMA_DISABLED */;
#if defined (CONFIG_IDF_TARGET_ESP32)
assert((SPI_HOST <= host) && (VSPI_HOST >= host));
const char *spi_names[] = {
"SPI_HOST", "HSPI_HOST", "VSPI_HOST"
};
dma_chan = dma_channel;
#elif defined (CONFIG_IDF_TARGET_ESP32S2)
assert((SPI_HOST <= host) && (HSPI_HOST >= host));
const char *spi_names[] = {
"SPI_HOST", "", ""
};
dma_chan = dma_channel;
#elif defined (CONFIG_IDF_TARGET_ESP32C3)
assert((SPI1_HOST <= host) && (SPI3_HOST >= host));
const char *spi_names[] = {
"SPI1_HOST", "SPI2_HOST", "SPI3_HOST"
};
dma_chan = 3 /* SPI_DMA_CH_AUTO */;
#else
#error "Target chip not selected"
#endif
ESP_LOGI(TAG, "Configuring SPI host %s (%d)", spi_names[host], host);
ESP_LOGI(TAG, "MISO pin: %d, MOSI pin: %d, SCLK pin: %d, IO2/WP pin: %d, IO3/HD pin: %d",
miso_pin, mosi_pin, sclk_pin, quadwp_pin, quadhd_pin);
ESP_LOGI(TAG, "Max transfer size: %d (bytes)", max_transfer_sz);
spi_bus_config_t buscfg = {
.miso_io_num = miso_pin,
.mosi_io_num = mosi_pin,
.sclk_io_num = sclk_pin,
.quadwp_io_num = quadwp_pin,
.quadhd_io_num = quadhd_pin,
.max_transfer_sz = max_transfer_sz
};
ESP_LOGI(TAG, "Initializing SPI bus...");
esp_err_t ret = spi_bus_initialize(host, &buscfg, dma_chan);
assert(ret == ESP_OK);
return ESP_OK != ret;
}
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_helpers.c | C | apache-2.0 | 5,157 |
/**
* @file lvgl_helpers.h
*/
#ifndef LVGL_HELPERS_H
#define LVGL_HELPERS_H
#ifdef __cplusplus
extern "C" {
#endif
/*********************
* INCLUDES
*********************/
#include <stdbool.h>
#include "lvgl_spi_conf.h"
#include "lvgl_tft/disp_driver.h"
#include "lvgl_tft/esp_lcd_backlight.h"
#include "lvgl_touch/touch_driver.h"
/*********************
* DEFINES
*********************/
/* DISP_BUF_SIZE value doesn't have an special meaning, but it's the size
* of the buffer(s) passed to LVGL as display buffers. The default values used
* were the values working for the contributor of the display controller.
*
* As LVGL supports partial display updates the DISP_BUF_SIZE doesn't
* necessarily need to be equal to the display size.
*
* When using RGB displays the display buffer size will also depends on the
* color format being used, for RGB565 each pixel needs 2 bytes.
* When using the mono theme, the display pixels can be represented in one bit,
* so the buffer size can be divided by 8, e.g. see SSD1306 display size. */
#if defined (CONFIG_CUSTOM_DISPLAY_BUFFER_SIZE)
#define DISP_BUF_SIZE CONFIG_CUSTOM_DISPLAY_BUFFER_BYTES
#else
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789)
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7735S
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7796S
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_HX8357
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_SH1107
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * LV_VER_RES_MAX)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9481
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9486
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9488
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_SSD1306
#if defined (CONFIG_LV_THEME_MONO)
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * (LV_VER_RES_MAX / 8))
#else
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * LV_VER_RES_MAX)
#endif
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
#define DISP_BUF_LINES 40
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * DISP_BUF_LINES)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_IL3820)
#define DISP_BUF_SIZE (LV_VER_RES_MAX * IL3820_COLUMNS)
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_RA8875
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_GC9A01)
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_JD79653A)
#define DISP_BUF_SIZE ((LV_VER_RES_MAX * LV_VER_RES_MAX) / 8) // 5KB
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_UC8151D)
#define DISP_BUF_SIZE ((LV_VER_RES_MAX * LV_VER_RES_MAX) / 8) // 2888 bytes
#elif defined CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C
#define DISP_BUF_SIZE (LV_HOR_RES_MAX * 40)
#else
#error "No display controller selected"
#endif
#endif
/**********************
* TYPEDEFS
**********************/
/**********************
* GLOBAL PROTOTYPES
**********************/
void lvgl_i2c_locking(void* leader);
/* Initialize detected SPI and I2C bus and devices */
void lvgl_driver_init(void);
/* Initialize SPI master */
bool lvgl_spi_driver_init(int host, int miso_pin, int mosi_pin, int sclk_pin,
int max_transfer_sz, int dma_channel, int quadwp_pin, int quadhd_pin);
/**********************
* MACROS
**********************/
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* LVGL_HELPERS_H */
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_helpers.h | C | apache-2.0 | 3,763 |
/*
SPDX-License-Identifier: MIT
MIT License
Copyright (c) 2021 Rop Gonggrijp. Based on esp_i2c_helper by Mika Tuupola.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include <stdint.h>
#include <stddef.h>
#include <esp_log.h>
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "freertos/task.h"
#include <driver/i2c.h>
#include "sdkconfig.h"
#include "i2c_manager.h"
#if defined __has_include
#if __has_include ("esp_idf_version.h")
#include "esp_idf_version.h"
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 3, 0)
#define HAS_CLK_FLAGS
#endif
#endif
#endif
static const char* TAG = I2C_TAG;
static SemaphoreHandle_t I2C_FN(_local_mutex)[2] = { NULL, NULL };
static SemaphoreHandle_t* I2C_FN(_mutex) = &I2C_FN(_local_mutex)[0];
static const uint8_t ACK_CHECK_EN = 1;
#if defined (I2C_NUM_0) && defined (CONFIG_I2C_MANAGER_0_ENABLED)
#define I2C_ZERO I2C_NUM_0
#if defined (CONFIG_I2C_MANAGER_0_PULLUPS)
#define I2C_MANAGER_0_PULLUPS true
#else
#define I2C_MANAGER_0_PULLUPS false
#endif
#define I2C_MANAGER_0_TIMEOUT ( CONFIG_I2C_MANAGER_0_TIMEOUT / portTICK_RATE_MS )
#define I2C_MANAGER_0_LOCK_TIMEOUT ( CONFIG_I2C_MANAGER_0_LOCK_TIMEOUT / portTICK_RATE_MS )
#endif
#if defined (I2C_NUM_1) && defined (CONFIG_I2C_MANAGER_1_ENABLED)
#define I2C_ONE I2C_NUM_1
#if defined (CONFIG_I2C_MANAGER_1_PULLUPS)
#define I2C_MANAGER_1_PULLUPS true
#else
#define I2C_MANAGER_1_PULLUPS false
#endif
#define I2C_MANAGER_1_TIMEOUT ( CONFIG_I2C_MANAGER_1_TIMEOUT / portTICK_RATE_MS )
#define I2C_MANAGER_1_LOCK_TIMEOUT ( CONFIG_I2C_MANAGER_1_LOCK_TIMEOUT / portTICK_RATE_MS )
#endif
#define ERROR_PORT(port, fail) { \
ESP_LOGE(TAG, "Invalid port or not configured for I2C Manager: %d", (int)port); \
return fail; \
}
#if defined(I2C_ZERO) && defined (I2C_ONE)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_0 && port != I2C_NUM_1) ERROR_PORT(port, fail);
#else
#if defined(I2C_ZERO)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_0) ERROR_PORT(port, fail);
#elif defined(I2C_ONE)
#define I2C_PORT_CHECK(port, fail) \
if (port != I2C_NUM_1) ERROR_PORT(port, fail);
#else
#define I2C_PORT_CHECK(port, fail) \
ERROR_PORT(port, fail);
#endif
#endif
static void i2c_send_address(i2c_cmd_handle_t cmd, uint16_t addr, i2c_rw_t rw) {
if (addr & I2C_ADDR_10) {
i2c_master_write_byte(cmd, 0xF0 | ((addr & 0x3FF) >> 7) | rw, ACK_CHECK_EN);
i2c_master_write_byte(cmd, addr & 0xFF, ACK_CHECK_EN);
} else {
i2c_master_write_byte(cmd, (addr << 1) | rw, ACK_CHECK_EN);
}
}
static void i2c_send_register(i2c_cmd_handle_t cmd, uint32_t reg) {
if (reg & I2C_REG_16) {
i2c_master_write_byte(cmd, (reg & 0xFF00) >> 8, ACK_CHECK_EN);
}
i2c_master_write_byte(cmd, reg & 0xFF, ACK_CHECK_EN);
}
esp_err_t I2C_FN(_init)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t ret = ESP_OK;
if (I2C_FN(_mutex)[port] == 0) {
ESP_LOGI(TAG, "Starting I2C master at port %d.", (int)port);
I2C_FN(_mutex)[port] = xSemaphoreCreateMutex();
i2c_config_t conf = {0};
#ifdef HAS_CLK_FLAGS
conf.clk_flags = 0;
#endif
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
conf.sda_io_num = CONFIG_I2C_MANAGER_0_SDA;
conf.scl_io_num = CONFIG_I2C_MANAGER_0_SCL;
conf.sda_pullup_en = I2C_MANAGER_0_PULLUPS ? GPIO_PULLUP_ENABLE : GPIO_PULLUP_DISABLE;
conf.scl_pullup_en = conf.sda_pullup_en;
conf.master.clk_speed = CONFIG_I2C_MANAGER_0_FREQ_HZ;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
conf.sda_io_num = CONFIG_I2C_MANAGER_1_SDA;
conf.scl_io_num = CONFIG_I2C_MANAGER_1_SCL;
conf.sda_pullup_en = I2C_MANAGER_1_PULLUPS ? GPIO_PULLUP_ENABLE : GPIO_PULLUP_DISABLE;
conf.scl_pullup_en = conf.sda_pullup_en;
conf.master.clk_speed = CONFIG_I2C_MANAGER_1_FREQ_HZ;
}
#endif
conf.mode = I2C_MODE_MASTER;
ret = i2c_param_config(port, &conf);
ret |= i2c_driver_install(port, conf.mode, 0, 0, 0);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialise I2C port %d.", (int)port);
ESP_LOGW(TAG, "If it was already open, we'll use it with whatever settings were used "
"to open it. See I2C Manager README for details.");
} else {
ESP_LOGI(TAG, "Initialised port %d (SDA: %d, SCL: %d, speed: %d Hz.)",
port, conf.sda_io_num, conf.scl_io_num, conf.master.clk_speed);
}
}
return ret;
}
esp_err_t I2C_FN(_read)(i2c_port_t port, uint16_t addr, uint32_t reg, uint8_t *buffer, uint16_t size) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t result;
// May seem weird, but init starts with a check if it's needed, no need for that check twice.
I2C_FN(_init)(port);
ESP_LOGV(TAG, "Reading port %d, addr 0x%03x, reg 0x%04x", port, addr, reg);
TickType_t timeout = 0;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = I2C_MANAGER_0_TIMEOUT;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = I2C_MANAGER_1_TIMEOUT;
}
#endif
if (I2C_FN(_lock)((int)port) == ESP_OK) {
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
if (!(reg & I2C_NO_REG)) {
/* When reading specific register set the addr pointer first. */
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_WRITE);
i2c_send_register(cmd, reg);
}
/* Read size bytes from the current pointer. */
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_READ);
i2c_master_read(cmd, buffer, size, I2C_MASTER_LAST_NACK);
i2c_master_stop(cmd);
result = i2c_master_cmd_begin(port, cmd, timeout);
i2c_cmd_link_delete(cmd);
I2C_FN(_unlock)((int)port);
} else {
ESP_LOGE(TAG, "Lock could not be obtained for port %d.", (int)port);
return ESP_ERR_TIMEOUT;
}
if (result != ESP_OK) {
ESP_LOGW(TAG, "Error: %d", result);
}
ESP_LOG_BUFFER_HEX_LEVEL(TAG, buffer, size, ESP_LOG_VERBOSE);
return result;
}
esp_err_t I2C_FN(_write)(i2c_port_t port, uint16_t addr, uint32_t reg, const uint8_t *buffer, uint16_t size) {
I2C_PORT_CHECK(port, ESP_FAIL);
esp_err_t result;
// May seem weird, but init starts with a check if it's needed, no need for that check twice.
I2C_FN(_init)(port);
ESP_LOGV(TAG, "Writing port %d, addr 0x%03x, reg 0x%04x", port, addr, reg);
TickType_t timeout = 0;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = (CONFIG_I2C_MANAGER_0_TIMEOUT) / portTICK_RATE_MS;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = (CONFIG_I2C_MANAGER_1_TIMEOUT) / portTICK_RATE_MS;
}
#endif
if (I2C_FN(_lock)((int)port) == ESP_OK) {
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
i2c_master_start(cmd);
i2c_send_address(cmd, addr, I2C_MASTER_WRITE);
if (!(reg & I2C_NO_REG)) {
i2c_send_register(cmd, reg);
}
i2c_master_write(cmd, (uint8_t *)buffer, size, ACK_CHECK_EN);
i2c_master_stop(cmd);
result = i2c_master_cmd_begin( port, cmd, timeout);
i2c_cmd_link_delete(cmd);
I2C_FN(_unlock)((int)port);
} else {
ESP_LOGE(TAG, "Lock could not be obtained for port %d.", (int)port);
return ESP_ERR_TIMEOUT;
}
if (result != ESP_OK) {
ESP_LOGW(TAG, "Error: %d", result);
}
ESP_LOG_BUFFER_HEX_LEVEL(TAG, buffer, size, ESP_LOG_VERBOSE);
return result;
}
esp_err_t I2C_FN(_close)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
vSemaphoreDelete(I2C_FN(_mutex)[port]);
I2C_FN(_mutex)[port] = NULL;
ESP_LOGI(TAG, "Closing I2C master at port %d", port);
return i2c_driver_delete(port);
}
esp_err_t I2C_FN(_lock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
ESP_LOGV(TAG, "Mutex lock set for %d.", (int)port);
TickType_t timeout;
#if defined (I2C_ZERO)
if (port == I2C_NUM_0) {
timeout = (CONFIG_I2C_MANAGER_0_LOCK_TIMEOUT) / portTICK_RATE_MS;
}
#endif
#if defined (I2C_ONE)
if (port == I2C_NUM_1) {
timeout = (CONFIG_I2C_MANAGER_1_LOCK_TIMEOUT) / portTICK_RATE_MS;
}
#endif
if (xSemaphoreTake(I2C_FN(_mutex)[port], timeout) == pdTRUE) {
return ESP_OK;
} else {
ESP_LOGE(TAG, "Removing stale mutex lock from port %d.", (int)port);
I2C_FN(_force_unlock)(port);
return (xSemaphoreTake(I2C_FN(_mutex)[port], timeout) == pdTRUE ? ESP_OK : ESP_FAIL);
}
}
esp_err_t I2C_FN(_unlock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
ESP_LOGV(TAG, "Mutex lock removed for %d.", (int)port);
return (xSemaphoreGive(I2C_FN(_mutex)[port]) == pdTRUE) ? ESP_OK : ESP_FAIL;
}
esp_err_t I2C_FN(_force_unlock)(i2c_port_t port) {
I2C_PORT_CHECK(port, ESP_FAIL);
if (I2C_FN(_mutex)[port]) {
vSemaphoreDelete(I2C_FN(_mutex)[port]);
}
I2C_FN(_mutex)[port] = xSemaphoreCreateMutex();
return ESP_OK;
}
#ifdef I2C_OEM
void I2C_FN(_locking)(void* leader) {
if (leader) {
ESP_LOGI(TAG, "Now following I2C Manager for locking");
I2C_FN(_mutex) = (SemaphoreHandle_t*)leader;
}
}
#else
void* i2c_manager_locking() {
return (void*)i2c_manager_mutex;
}
int32_t i2c_hal_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size) {
return i2c_manager_read(*(i2c_port_t*)handle, address, reg, buffer, size);
}
int32_t i2c_hal_write(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size) {
return i2c_manager_write(*(i2c_port_t*)handle, address, reg, buffer, size);
}
static i2c_port_t port_zero = (i2c_port_t)0;
static i2c_port_t port_one = (i2c_port_t)1;
static i2c_hal_t _i2c_hal[2] = {
{&i2c_hal_read, &i2c_hal_write, &port_zero},
{&i2c_hal_read, &i2c_hal_write, &port_one}
};
void* i2c_hal(i2c_port_t port) {
I2C_PORT_CHECK(port, NULL);
return (void*)&_i2c_hal[port];
}
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_i2c/i2c_manager.c | C | apache-2.0 | 10,692 |
#ifndef _I2C_MANAGER_H
#define _I2C_MANAGER_H
#ifdef __cplusplus
extern "C" {
#endif
/*
If you copy the i2c_manager files to your own component instead of
depending on i2c_manager, you MUST uncomment the define below
and put in some short string that identifies your component (such
as 'xyz'). This will cause i2c_manager to create functions named
xyz_i2c_* instead of i2c_manager_*. See README.md for details.
*/
#define I2C_OEM lvgl
// Only here to get the I2C_NUM_0 and I2C_NUM_1 defines.
#include <driver/i2c.h>
#define CONCATX(A, B) A ## B
#define CONCAT(A, B) CONCATX(A, B)
#define STR_LITERAL(s) # s
#define STR_EXPAND(s) STR_LITERAL(s)
#define STR_QUOTE(s) STR_EXPAND(STR_EXPAND(s))
#ifdef I2C_OEM
#define I2C_NAME_PREFIX CONCAT(I2C_OEM, _i2c)
#else
#define I2C_NAME_PREFIX i2c_manager
#endif
#define I2C_TAG STR_EXPAND(I2C_NAME_PREFIX)
#define I2C_FN(s) CONCAT(I2C_NAME_PREFIX, s)
#define I2C_ADDR_10 ( 1 << 15 )
#define I2C_REG_16 ( 1 << 31 )
#define I2C_NO_REG ( 1 << 30 )
esp_err_t I2C_FN(_init)(i2c_port_t port);
esp_err_t I2C_FN(_read)(i2c_port_t port, uint16_t addr, uint32_t reg, uint8_t *buffer, uint16_t size);
esp_err_t I2C_FN(_write)(i2c_port_t port, uint16_t addr, uint32_t reg, const uint8_t *buffer, uint16_t size);
esp_err_t I2C_FN(_close)(i2c_port_t port);
esp_err_t I2C_FN(_lock)(i2c_port_t port);
esp_err_t I2C_FN(_unlock)(i2c_port_t port);
esp_err_t I2C_FN(_force_unlock)(i2c_port_t port);
#ifdef I2C_OEM
void I2C_FN(_locking)(void* leader);
#else
void* i2c_manager_locking();
typedef struct {
int32_t (* read)(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size);
int32_t (* write)(void *handle, uint8_t address, uint8_t reg, const uint8_t *buffer, uint16_t size);
void *handle;
} i2c_hal_t;
void* i2c_hal(i2c_port_t port);
#endif
#ifdef __cplusplus
}
#endif
#endif
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_i2c/i2c_manager.h | C | apache-2.0 | 1,916 |
/**
* @file lvgl_spi_conf.h
*
*/
#ifndef LVGL_SPI_CONF_H
#define LVGL_SPI_CONF_H
#ifdef __cplusplus
extern "C" {
#endif
/*********************
* INCLUDES
*********************/
/*********************
* DEFINES
*********************/
// DISPLAY PINS
#define DISP_SPI_MOSI CONFIG_LV_DISP_SPI_MOSI
#if defined (CONFIG_LV_DISPLAY_USE_SPI_MISO)
#define DISP_SPI_MISO CONFIG_LV_DISP_SPI_MISO
#define DISP_SPI_INPUT_DELAY_NS CONFIG_LV_DISP_SPI_INPUT_DELAY_NS
#else
#define DISP_SPI_MISO (-1)
#define DISP_SPI_INPUT_DELAY_NS (0)
#endif
#if defined(CONFIG_LV_DISP_SPI_IO2)
#define DISP_SPI_IO2 CONFIG_LV_DISP_SPI_IO2
#else
#define DISP_SPI_IO2 (-1)
#endif
#if defined(CONFIG_LV_DISP_SPI_IO3)
#define DISP_SPI_IO3 CONFIG_LV_DISP_SPI_IO3
#else
#define DISP_SPI_IO3 (-1)
#endif
#define DISP_SPI_CLK CONFIG_LV_DISP_SPI_CLK
#if defined (CONFIG_LV_DISPLAY_USE_SPI_CS)
#define DISP_SPI_CS CONFIG_LV_DISP_SPI_CS
#else
#define DISP_SPI_CS (-1)
#endif
/* Define TOUCHPAD PINS when selecting a touch controller */
#if !defined (CONFIG_LV_TOUCH_CONTROLLER_NONE)
/* Handle FT81X special case */
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X) && \
defined (CONFIG_LV_TOUCH_CONTROLLER_FT81X)
#define TP_SPI_MOSI CONFIG_LV_DISP_SPI_MOSI
#define TP_SPI_MISO CONFIG_LV_DISP_SPI_MISO
#define TP_SPI_CLK CONFIG_LV_DISP_SPI_CLK
#define TP_SPI_CS CONFIG_LV_DISP_SPI_CS
#else
#define TP_SPI_MOSI CONFIG_LV_TOUCH_SPI_MOSI
#define TP_SPI_MISO CONFIG_LV_TOUCH_SPI_MISO
#define TP_SPI_CLK CONFIG_LV_TOUCH_SPI_CLK
#define TP_SPI_CS CONFIG_LV_TOUCH_SPI_CS
#endif
#endif
#define ENABLE_TOUCH_INPUT CONFIG_LV_ENABLE_TOUCH
#if defined (CONFIG_LV_TFT_DISPLAY_SPI_HSPI)
#if defined (CONFIG_IDF_TARGET_ESP32C3)
#define TFT_SPI_HOST SPI2_HOST
#else
#define TFT_SPI_HOST HSPI_HOST
#endif
#elif defined (CONFIG_LV_TFT_DISPLAY_SPI_VSPI)
#define TFT_SPI_HOST VSPI_HOST
#elif defined (CONFIG_LV_TFT_DISPLAY_SPI_FSPI)
#define TFT_SPI_HOST FSPI_HOST
#endif
#if defined (CONFIG_LV_TFT_DISPLAY_SPI_HALF_DUPLEX)
#define DISP_SPI_HALF_DUPLEX
#else
#define DISP_SPI_FULL_DUPLEX
#endif
#if defined (CONFIG_LV_TFT_DISPLAY_SPI_TRANS_MODE_DIO)
#define DISP_SPI_TRANS_MODE_DIO
#elif defined (CONFIG_LV_TFT_DISPLAY_SPI_TRANS_MODE_QIO)
#define DISP_SPI_TRANS_MODE_QIO
#else
#define DISP_SPI_TRANS_MODE_SIO
#endif
#if defined (CONFIG_LV_TOUCH_CONTROLLER_SPI_HSPI)
#define TOUCH_SPI_HOST HSPI_HOST
#elif defined (CONFIG_LV_TOUCH_CONTROLLER_SPI_VSPI)
#define TOUCH_SPI_HOST VSPI_HOST
#elif defined (CONFIG_LV_TOUCH_CONTROLLER_SPI_FSPI)
#define TOUCH_SPI_HOST FSPI_HOST
#endif
/* Handle the FT81X Special case */
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
#if defined (CONFIG_LV_TOUCH_CONTROLLER_FT81X)
#define SHARED_SPI_BUS
#else
/* Empty */
#endif
#else
// Detect the use of a shared SPI Bus and verify the user specified the same SPI bus for both touch and tft
#if defined (CONFIG_LV_TOUCH_DRIVER_PROTOCOL_SPI) && TP_SPI_MOSI == DISP_SPI_MOSI && TP_SPI_CLK == DISP_SPI_CLK
#if TFT_SPI_HOST != TOUCH_SPI_HOST
#error You must specify the same SPI host (HSPI, VSPI or FSPI) for both display and touch driver
#endif
#define SHARED_SPI_BUS
#endif
#endif
/**********************
* TYPEDEFS
**********************/
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9481) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9488)
#define SPI_BUS_MAX_TRANSFER_SZ (DISP_BUF_SIZE * 3)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7735S) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_HX8357) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_SH1107) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_IL3820) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_JD79653A) || \
defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C)
#define SPI_BUS_MAX_TRANSFER_SZ (DISP_BUF_SIZE * 2)
#else
#define SPI_BUS_MAX_TRANSFER_SZ (DISP_BUF_SIZE * 2)
#endif
#if defined (CONFIG_LV_TFT_USE_CUSTOM_SPI_CLK_DIVIDER)
#define SPI_TFT_CLOCK_SPEED_HZ ((80 * 1000 * 1000) / CONFIG_LV_TFT_CUSTOM_SPI_CLK_DIVIDER)
#else
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789)
#define SPI_TFT_CLOCK_SPEED_HZ (20*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7735S)
#define SPI_TFT_CLOCK_SPEED_HZ (40*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_HX8357)
#define SPI_TFT_CLOCK_SPEED_HZ (26*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_SH1107)
#define SPI_TFT_CLOCK_SPEED_HZ (8*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9481)
#define SPI_TFT_CLOCK_SPEED_HZ (16*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9486)
#define SPI_TFT_CLOCK_SPEED_HZ (20*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9488)
#define SPI_TFT_CLOCK_SPEED_HZ (40*1000*1000)
#elif defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9341)
#define SPI_TFT_CLOCK_SPEED_HZ (40*1000*1000)
#elif defined(CONFIG_LV_TFT_DISPLAY_CONTROLLER_ILI9163C)
#define SPI_TFT_CLOCK_SPEED_HZ (40 * 1000 * 1000)
#elif defined(CONFIG_LV_TFT_DISPLAY_CONTROLLER_FT81X)
#define SPI_TFT_CLOCK_SPEED_HZ (32*1000*1000)
#else
#define SPI_TFT_CLOCK_SPEED_HZ (40*1000*1000)
#endif
#endif
#if defined (CONFIG_LV_TFT_DISPLAY_CONTROLLER_ST7789)
#define SPI_TFT_SPI_MODE (2)
#else
#define SPI_TFT_SPI_MODE (0)
#endif
/* Touch driver */
#if (CONFIG_LV_TOUCH_CONTROLLER == TOUCH_CONTROLLER_STMPE610)
#define SPI_TOUCH_CLOCK_SPEED_HZ (1*1000*1000)
#define SPI_TOUCH_SPI_MODE (1)
#else
#define SPI_TOUCH_CLOCK_SPEED_HZ (2*1000*1000)
#define SPI_TOUCH_SPI_MODE (0)
#endif
/**********************
* GLOBAL PROTOTYPES
**********************/
/**********************
* MACROS
**********************/
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /*LVGL_SPI_CONF_H*/
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_spi_conf.h | C | apache-2.0 | 6,006 |
/*
@file EVE.h
@brief Contains FT80x/FT81x/BT81x API definitions
@version 4.1 LvGL edition
@date 2020-04-15
@author Rudolph Riedel, David Jade
@section LICENSE
MIT License
Copyright (c) 2016-2020 Rudolph Riedel and David Jade
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@section History
4.1 LvGL edition
- This version is a heavily modified version of the MIT licensed FT81x code from https://github.com/RudolphRiedel/FT800-FT813
This version is based on a fork by David Jade that added native SPI DMA support and stripped out non-ESP32 code.
It has also been trimmed down to suit LvGL's needs. Extra features can be enabled by defining FT81X_FULL
*/
#if defined (ESP_PLATFORM)
#include <stddef.h>
#include <stdint.h>
#endif
#include "EVE_config.h"
#ifndef EVE_H_
#define EVE_H_
#define DL_CLEAR 0x26000000UL /* requires OR'd arguments */
#define DL_CLEAR_RGB 0x02000000UL /* requires OR'd arguments */
#define DL_COLOR_RGB 0x04000000UL /* requires OR'd arguments */
#define DL_POINT_SIZE 0x0D000000UL /* requires OR'd arguments */
#define DL_END 0x21000000UL
#define DL_BEGIN 0x1F000000UL /* requires OR'd arguments */
#define DL_DISPLAY 0x00000000UL
#define CLR_COL 0x4
#define CLR_STN 0x2
#define CLR_TAG 0x1
/* SPI SIO/DIO/QIO tranfer widths */
#define SPI_WIDTH_SIO 0x0
#define SPI_WIDTH_DIO 0x1
#define SPI_WIDTH_QIO 0x2
/* Host commands */
#define EVE_ACTIVE 0x00 /* place FT8xx in active state */
#define EVE_STANDBY 0x41 /* place FT8xx in Standby (clk running) */
#define EVE_SLEEP 0x42 /* place FT8xx in Sleep (clk off) */
#define EVE_PWRDOWN 0x50 /* place FT8xx in Power Down (core off) */
#define EVE_CLKEXT 0x44 /* select external clock source */
#define EVE_CLKINT 0x48 /* select internal clock source */
#define EVE_CORERST 0x68 /* reset core - all registers default and processors reset */
#define EVE_CLK48M 0x62 /* select 48MHz PLL output */
#define EVE_CLK36M 0x61 /* select 36MHz PLL output */
/* defines used for graphics commands */
#define EVE_NEVER 0UL
#define EVE_LESS 1UL
#define EVE_LEQUAL 2UL
#define EVE_GREATER 3UL
#define EVE_GEQUAL 4UL
#define EVE_EQUAL 5UL
#define EVE_NOTEQUAL 6UL
#define EVE_ALWAYS 7UL
/* Bitmap formats */
#define EVE_ARGB1555 0UL
#define EVE_L1 1UL
#define EVE_L4 2UL
#define EVE_L8 3UL
#define EVE_RGB332 4UL
#define EVE_ARGB2 5UL
#define EVE_ARGB4 6UL
#define EVE_RGB565 7UL
#define EVE_PALETTED 8UL
#define EVE_TEXT8X8 9UL
#define EVE_TEXTVGA 10UL
#define EVE_BARGRAPH 11UL
/* Bitmap filter types */
#define EVE_NEAREST 0UL
#define EVE_BILINEAR 1UL
/* Bitmap wrap types */
#define EVE_BORDER 0UL
#define EVE_REPEAT 1UL
/* Stencil defines */
#define EVE_KEEP 1UL
#define EVE_REPLACE 2UL
#define EVE_INCR 3UL
#define EVE_DECR 4UL
#define EVE_INVERT 5UL
/* Graphics display list swap defines */
#define EVE_DLSWAP_DONE 0UL
#define EVE_DLSWAP_LINE 1UL
#define EVE_DLSWAP_FRAME 2UL
/* Interrupt bits */
#define EVE_INT_SWAP 0x01
#define EVE_INT_TOUCH 0x02
#define EVE_INT_TAG 0x04
#define EVE_INT_SOUND 0x08
#define EVE_INT_PLAYBACK 0x10
#define EVE_INT_CMDEMPTY 0x20
#define EVE_INT_CMDFLAG 0x40
#define EVE_INT_CONVCOMPLETE 0x80
/* Touch mode */
#define EVE_TMODE_OFF 0
#define EVE_TMODE_ONESHOT 1
#define EVE_TMODE_FRAME 2
#define EVE_TMODE_CONTINUOUS 3
/* Alpha blending */
#define EVE_ZERO 0UL
#define EVE_ONE 1UL
#define EVE_SRC_ALPHA 2UL
#define EVE_DST_ALPHA 3UL
#define EVE_ONE_MINUS_SRC_ALPHA 4UL
#define EVE_ONE_MINUS_DST_ALPHA 5UL
/* Graphics primitives */
#define EVE_BITMAPS 1UL
#define EVE_POINTS 2UL
#define EVE_LINES 3UL
#define EVE_LINE_STRIP 4UL
#define EVE_EDGE_STRIP_R 5UL
#define EVE_EDGE_STRIP_L 6UL
#define EVE_EDGE_STRIP_A 7UL
#define EVE_EDGE_STRIP_B 8UL
#define EVE_RECTS 9UL
/* Widget command */
#define EVE_OPT_MONO 1
#define EVE_OPT_NODL 2
#define EVE_OPT_FLAT 256
#define EVE_OPT_CENTERX 512
#define EVE_OPT_CENTERY 1024
#define EVE_OPT_CENTER (EVE_OPT_CENTERX | EVE_OPT_CENTERY)
#define EVE_OPT_NOBACK 4096
#define EVE_OPT_NOTICKS 8192
#define EVE_OPT_NOHM 16384
#define EVE_OPT_NOPOINTER 16384
#define EVE_OPT_NOSECS 32768
#define EVE_OPT_NOHANDS 49152
#define EVE_OPT_RIGHTX 2048
#define EVE_OPT_SIGNED 256
/* Defines related to inbuilt font */
#define EVE_NUMCHAR_PERFONT (128L) /* number of font characters per bitmap handle */
#define EVE_FONT_TABLE_SIZE (148L) /* size of the font table - utilized for loopup by the graphics engine */
#define EVE_FONT_TABLE_POINTER (0xFFFFCUL) /* pointer to the inbuilt font tables starting from bitmap handle 16 */
/* Audio sample type defines */
#define EVE_LINEAR_SAMPLES 0UL /* 8bit signed samples */
#define EVE_ULAW_SAMPLES 1UL /* 8bit ulaw samples */
#define EVE_ADPCM_SAMPLES 2UL /* 4bit ima adpcm samples */
/* Synthesized sound */
#define EVE_SILENCE 0x00
#define EVE_SQUAREWAVE 0x01
#define EVE_SINEWAVE 0x02
#define EVE_SAWTOOTH 0x03
#define EVE_TRIANGLE 0x04
#define EVE_BEEPING 0x05
#define EVE_ALARM 0x06
#define EVE_WARBLE 0x07
#define EVE_CAROUSEL 0x08
#define EVE_PIPS(n) (0x0F + (n))
#define EVE_HARP 0x40
#define EVE_XYLOPHONE 0x41
#define EVE_TUBA 0x42
#define EVE_GLOCKENSPIEL 0x43
#define EVE_ORGAN 0x44
#define EVE_TRUMPET 0x45
#define EVE_PIANO 0x46
#define EVE_CHIMES 0x47
#define EVE_MUSICBOX 0x48
#define EVE_BELL 0x49
#define EVE_CLICK 0x50
#define EVE_SWITCH 0x51
#define EVE_COWBELL 0x52
#define EVE_NOTCH 0x53
#define EVE_HIHAT 0x54
#define EVE_KICKDRUM 0x55
#define EVE_POP 0x56
#define EVE_CLACK 0x57
#define EVE_CHACK 0x58
#define EVE_MUTE 0x60
#define EVE_UNMUTE 0x61
/* Synthesized sound frequencies, midi note */
#define EVE_MIDI_A0 21
#define EVE_MIDI_A_0 22
#define EVE_MIDI_B0 23
#define EVE_MIDI_C1 24
#define EVE_MIDI_C_1 25
#define EVE_MIDI_D1 26
#define EVE_MIDI_D_1 27
#define EVE_MIDI_E1 28
#define EVE_MIDI_F1 29
#define EVE_MIDI_F_1 30
#define EVE_MIDI_G1 31
#define EVE_MIDI_G_1 32
#define EVE_MIDI_A1 33
#define EVE_MIDI_A_1 34
#define EVE_MIDI_B1 35
#define EVE_MIDI_C2 36
#define EVE_MIDI_C_2 37
#define EVE_MIDI_D2 38
#define EVE_MIDI_D_2 39
#define EVE_MIDI_E2 40
#define EVE_MIDI_F2 41
#define EVE_MIDI_F_2 42
#define EVE_MIDI_G2 43
#define EVE_MIDI_G_2 44
#define EVE_MIDI_A2 45
#define EVE_MIDI_A_2 46
#define EVE_MIDI_B2 47
#define EVE_MIDI_C3 48
#define EVE_MIDI_C_3 49
#define EVE_MIDI_D3 50
#define EVE_MIDI_D_3 51
#define EVE_MIDI_E3 52
#define EVE_MIDI_F3 53
#define EVE_MIDI_F_3 54
#define EVE_MIDI_G3 55
#define EVE_MIDI_G_3 56
#define EVE_MIDI_A3 57
#define EVE_MIDI_A_3 58
#define EVE_MIDI_B3 59
#define EVE_MIDI_C4 60
#define EVE_MIDI_C_4 61
#define EVE_MIDI_D4 62
#define EVE_MIDI_D_4 63
#define EVE_MIDI_E4 64
#define EVE_MIDI_F4 65
#define EVE_MIDI_F_4 66
#define EVE_MIDI_G4 67
#define EVE_MIDI_G_4 68
#define EVE_MIDI_A4 69
#define EVE_MIDI_A_4 70
#define EVE_MIDI_B4 71
#define EVE_MIDI_C5 72
#define EVE_MIDI_C_5 73
#define EVE_MIDI_D5 74
#define EVE_MIDI_D_5 75
#define EVE_MIDI_E5 76
#define EVE_MIDI_F5 77
#define EVE_MIDI_F_5 78
#define EVE_MIDI_G5 79
#define EVE_MIDI_G_5 80
#define EVE_MIDI_A5 81
#define EVE_MIDI_A_5 82
#define EVE_MIDI_B5 83
#define EVE_MIDI_C6 84
#define EVE_MIDI_C_6 85
#define EVE_MIDI_D6 86
#define EVE_MIDI_D_6 87
#define EVE_MIDI_E6 88
#define EVE_MIDI_F6 89
#define EVE_MIDI_F_6 90
#define EVE_MIDI_G6 91
#define EVE_MIDI_G_6 92
#define EVE_MIDI_A6 93
#define EVE_MIDI_A_6 94
#define EVE_MIDI_B6 95
#define EVE_MIDI_C7 96
#define EVE_MIDI_C_7 97
#define EVE_MIDI_D7 98
#define EVE_MIDI_D_7 99
#define EVE_MIDI_E7 100
#define EVE_MIDI_F7 101
#define EVE_MIDI_F_7 102
#define EVE_MIDI_G7 103
#define EVE_MIDI_G_7 104
#define EVE_MIDI_A7 105
#define EVE_MIDI_A_7 106
#define EVE_MIDI_B7 107
#define EVE_MIDI_C8 108
/* GPIO bits */
#define EVE_GPIO0 0
#define EVE_GPIO1 1 /* default gpio pin for audio shutdown, 1 - enable, 0 - disable */
#define EVE_GPIO7 7 /* default gpio pin for display enable, 1 - enable, 0 - disable */
/* Display rotation */
#define EVE_DISPLAY_0 0 /* 0 degrees rotation */
#define EVE_DISPLAY_180 1 /* 180 degrees rotation */
/* commands common to EVE/EVE2/EVE3 */
#define CMD_APPEND 0xFFFFFF1E
#define CMD_BGCOLOR 0xFFFFFF09
#define CMD_BUTTON 0xFFFFFF0D
#define CMD_CALIBRATE 0xFFFFFF15
#define CMD_CLOCK 0xFFFFFF14
#define CMD_COLDSTART 0xFFFFFF32
#define CMD_DIAL 0xFFFFFF2D
#define CMD_DLSTART 0xFFFFFF00
#define CMD_FGCOLOR 0xFFFFFF0A
#define CMD_GAUGE 0xFFFFFF13
#define CMD_GETMATRIX 0xFFFFFF33
#define CMD_GETPROPS 0xFFFFFF25
#define CMD_GETPTR 0xFFFFFF23
#define CMD_GRADCOLOR 0xFFFFFF34
#define CMD_GRADIENT 0xFFFFFF0B
#define CMD_INFLATE 0xFFFFFF22
#define CMD_INTERRUPT 0xFFFFFF02
#define CMD_KEYS 0xFFFFFF0E
#define CMD_LOADIDENTITY 0xFFFFFF26
#define CMD_LOADIMAGE 0xFFFFFF24
#define CMD_LOGO 0xFFFFFF31
#define CMD_MEMCPY 0xFFFFFF1D
#define CMD_MEMCRC 0xFFFFFF18
#define CMD_MEMSET 0xFFFFFF1B
#define CMD_MEMWRITE 0xFFFFFF1A
#define CMD_MEMZERO 0xFFFFFF1C
#define CMD_NUMBER 0xFFFFFF2E
#define CMD_PROGRESS 0xFFFFFF0F
#define CMD_REGREAD 0xFFFFFF19
#define CMD_ROTATE 0xFFFFFF29
#define CMD_SCALE 0xFFFFFF28
#define CMD_SCREENSAVER 0xFFFFFF2F
#define CMD_SCROLLBAR 0xFFFFFF11
#define CMD_SETFONT 0xFFFFFF2B
#define CMD_SETMATRIX 0xFFFFFF2A
#define CMD_SKETCH 0xFFFFFF30
#define CMD_SLIDER 0xFFFFFF10
#define CMD_SNAPSHOT 0xFFFFFF1F
#define CMD_SPINNER 0xFFFFFF16
#define CMD_STOP 0xFFFFFF17
#define CMD_SWAP 0xFFFFFF01
#define CMD_TEXT 0xFFFFFF0C
#define CMD_TOGGLE 0xFFFFFF12
#define CMD_TRACK 0xFFFFFF2C
#define CMD_TRANSLATE 0xFFFFFF27
/* the following are undocumented commands that therefore should not be used */
#if 0
#define CMD_CRC 0xFFFFFF03
#define CMD_HAMMERAUX 0xFFFFFF04
#define CMD_MARCH 0xFFFFFF05
#define CMD_IDCT 0xFFFFFF06
#define CMD_EXECUTE 0xFFFFFF07
#define CMD_GETPOINT 0xFFFFFF08
#define CMD_TOUCH_TRANSFORM 0xFFFFFF20
#endif
/* FT8xx graphics engine specific macros useful for static display list generation */
#define ALPHA_FUNC(func,ref) ((9UL<<24)|(((func)&7UL)<<8)|(((ref)&255UL)<<0))
#define BEGIN(prim) ((31UL<<24)|(((prim)&15UL)<<0))
#define BITMAP_HANDLE(handle) ((5UL<<24)|(((handle)&31UL)<<0))
#define BITMAP_LAYOUT(format,linestride,height) ((7UL<<24)|(((format)&31UL)<<19)|(((linestride)&1023UL)<<9)|(((height)&511UL)<<0))
#define BITMAP_SIZE(filter,wrapx,wrapy,width,height) ((8UL<<24)|(((filter)&1UL)<<20)|(((wrapx)&1UL)<<19)|(((wrapy)&1UL)<<18)|(((width)&511UL)<<9)|(((height)&511UL)<<0))
#define BITMAP_TRANSFORM_A(a) ((21UL<<24)|(((a)&131071UL)<<0))
#define BITMAP_TRANSFORM_B(b) ((22UL<<24)|(((b)&131071UL)<<0))
#define BITMAP_TRANSFORM_C(c) ((23UL<<24)|(((c)&16777215UL)<<0))
#define BITMAP_TRANSFORM_D(d) ((24UL<<24)|(((d)&131071UL)<<0))
#define BITMAP_TRANSFORM_E(e) ((25UL<<24)|(((e)&131071UL)<<0))
#define BITMAP_TRANSFORM_F(f) ((26UL<<24)|(((f)&16777215UL)<<0))
#define BLEND_FUNC(src,dst) ((11UL<<24)|(((src)&7UL)<<3)|(((dst)&7UL)<<0))
#define CALL(dest) ((29UL<<24)|(((dest)&65535UL)<<0))
#define CELL(cell) ((6UL<<24)|(((cell)&127UL)<<0))
#define CLEAR(c,s,t) ((38UL<<24)|(((c)&1UL)<<2)|(((s)&1UL)<<1)|(((t)&1UL)<<0))
#define CLEAR_COLOR_A(alpha) ((15UL<<24)|(((alpha)&255UL)<<0))
#define CLEAR_COLOR_RGB(red,green,blue) ((2UL<<24)|(((red)&255UL)<<16)|(((green)&255UL)<<8)|(((blue)&255UL)<<0))
#define CLEAR_STENCIL(s) ((17UL<<24)|(((s)&255UL)<<0))
#define CLEAR_TAG(s) ((18UL<<24)|(((s)&255UL)<<0))
#define COLOR_A(alpha) ((16UL<<24)|(((alpha)&255UL)<<0))
#define COLOR_MASK(r,g,b,a) ((32UL<<24)|(((r)&1UL)<<3)|(((g)&1UL)<<2)|(((b)&1UL)<<1)|(((a)&1UL)<<0))
#define COLOR_RGB(red,green,blue) ((4UL<<24)|(((red)&255UL)<<16)|(((green)&255UL)<<8)|(((blue)&255UL)<<0))
/* #define DISPLAY() ((0UL<<24)) */
#define END() ((33UL<<24))
#define JUMP(dest) ((30UL<<24)|(((dest)&65535UL)<<0))
#define LINE_WIDTH(width) ((14UL<<24)|(((width)&4095UL)<<0))
#define MACRO(m) ((37UL<<24)|(((m)&1UL)<<0))
#define POINT_SIZE(size) ((13UL<<24)|(((size)&8191UL)<<0))
#define RESTORE_CONTEXT() ((35UL<<24))
#define RETURN() ((36UL<<24))
#define SAVE_CONTEXT() ((34UL<<24))
#define STENCIL_FUNC(func,ref,mask) ((10UL<<24)|(((func)&7UL)<<16)|(((ref)&255UL)<<8)|(((mask)&255UL)<<0))
#define STENCIL_MASK(mask) ((19UL<<24)|(((mask)&255UL)<<0))
#define STENCIL_OP(sfail,spass) ((12UL<<24)|(((sfail)&7UL)<<3)|(((spass)&7UL)<<0))
#define TAG(s) ((3UL<<24)|(((s)&255UL)<<0))
#define TAG_MASK(mask) ((20UL<<24)|(((mask)&1UL)<<0))
#define VERTEX2F(x,y) ((1UL<<30)|(((x)&32767UL)<<15)|(((y)&32767UL)<<0))
#define VERTEX2II(x,y,handle,cell) ((2UL<<30)|(((x)&511UL)<<21)|(((y)&511UL)<<12)|(((handle)&31UL)<<7)|(((cell)&127UL)<<0))
/* ----------------- BT81x exclusive definitions -----------------*/
#if defined (BT81X_ENABLE)
#define EVE_GLFORMAT 31UL /* used with BITMAP_LAYOUT to indicate bitmap-format is specified by BITMAP_EXT_FORMAT */
#define DL_BITMAP_EXT_FORMAT 0x2E000000 /* requires OR'd arguments */
/* extended Bitmap formats */
#define EVE_COMPRESSED_RGBA_ASTC_4x4_KHR 37808UL
#define EVE_COMPRESSED_RGBA_ASTC_5x4_KHR 37809UL
#define EVE_COMPRESSED_RGBA_ASTC_5x5_KHR 37810UL
#define EVE_COMPRESSED_RGBA_ASTC_6x5_KHR 37811UL
#define EVE_COMPRESSED_RGBA_ASTC_6x6_KHR 37812UL
#define EVE_COMPRESSED_RGBA_ASTC_8x5_KHR 37813UL
#define EVE_COMPRESSED_RGBA_ASTC_8x6_KHR 37814UL
#define EVE_COMPRESSED_RGBA_ASTC_8x8_KHR 37815UL
#define EVE_COMPRESSED_RGBA_ASTC_10x5_KHR 37816UL
#define EVE_COMPRESSED_RGBA_ASTC_10x6_KHR 37817UL
#define EVE_COMPRESSED_RGBA_ASTC_10x8_KHR 37818UL
#define EVE_COMPRESSED_RGBA_ASTC_10x10_KHR 37819UL
#define EVE_COMPRESSED_RGBA_ASTC_12x10_KHR 37820UL
#define EVE_COMPRESSED_RGBA_ASTC_12x12_KHR 37821UL
#define EVE_RAM_ERR_REPORT 0x309800UL /* max 128 bytes null terminated string */
#define EVE_RAM_FLASH 0x800000UL
#define EVE_RAM_FLASH_POSTBLOB 0x801000UL
#define EVE_OPT_FLASH 64UL
#define EVE_OPT_FORMAT 4096UL
#define EVE_OPT_FILL 8192UL
/* additional commands for BT81x */
#define CMD_BITMAP_TRANSFORM 0xFFFFFF21
#define CMD_SYNC 0xFFFFFF42 /* does not need a dedicated function, just use EVE_cmd_dl(CMD_SYNC) */
#define CMD_FLASHERASE 0xFFFFFF44 /* does not need a dedicated function, just use EVE_cmd_dl(CMD_FLASHERASE) */
#define CMD_FLASHWRITE 0xFFFFFF45
#define CMD_FLASHREAD 0xFFFFFF46
#define CMD_FLASHUPDATE 0xFFFFFF47
#define CMD_FLASHDETACH 0xFFFFFF48 /* does not need a dedicated function, just use EVE_cmd_dl(CMD_FLASHDETACH) */
#define CMD_FLASHATTACH 0xFFFFFF49 /* does not need a dedicated function, just use EVE_cmd_dl(CMD_FLASHATTACH) */
#define CMD_FLASHFAST 0xFFFFFF4A
#define CMD_FLASHSPIDESEL 0xFFFFFF4B /* does not need a dedicated function, just use EVE_cmd_dl(CMD_FLASHSPIDESEL) */
#define CMD_FLASHSPITX 0xFFFFFF4C
#define CMD_FLASHSPIRX 0xFFFFFF4D
#define CMD_FLASHSOURCE 0xFFFFFF4E
#define CMD_CLEARCACHE 0xFFFFFF4F /* does not need a dedicated function, just use EVE_cmd_dl(CMD_CLEARCACHE) */
#define CMD_INFLATE2 0xFFFFFF50
#define CMD_ROTATEAROUND 0xFFFFFF51
#define CMD_RESETFONTS 0xFFFFFF52 /* does not need a dedicated function, just use EVE_cmd_dl(CMD_RESETFONTS) */
#define CMD_ANIMSTART 0xFFFFFF53
#define CMD_ANIMSTOP 0xFFFFFF54
#define CMD_ANIMXY 0xFFFFFF55
#define CMD_ANIMDRAW 0xFFFFFF56
#define CMD_GRADIENTA 0xFFFFFF57
#define CMD_FILLWIDTH 0xFFFFFF58
#define CMD_APPENDF 0xFFFFFF59
#define CMD_ANIMFRAME 0xFFFFFF5A
#define CMD_VIDEOSTARTF 0xFFFFFF5F /* does not need a dedicated function, just use EVE_cmd_dl(CMD_VIDEOSTARTF) */
#if 0
/* some undocumented commands for BT81x */
#define CMD_NOP 0xFFFFFF5B
#define CMD_SHA1 0xFFFFFF5C
#define CMD_HMAC 0xFFFFFF5D
#define CMD_LAST_ 0xFFFFFF5E
#endif
/* additional registers for BT81x */
#define REG_ADAPTIVE_FRAMERATE 0x30257cUL
#define REG_PLAYBACK_PAUSE 0x3025ecUL
#define REG_FLASH_STATUS 0x3025f0UL
#define REG_FLASH_SIZE 0x309024UL
#define REG_PLAY_CONTROL 0x30914eUL
#define REG_COPRO_PATCH_DTR 0x309162UL
/* BT81x graphics engine specific macros */
#define BITMAP_EXT_FORMAT(format) ((46UL<<24)|(((format)&65535UL)<<0))
#define BITMAP_SWIZZLE(r,g,b,a) ((47UL<<24)|(((r)&7UL)<<9)|(((g)&7UL)<<6)|(((b)&7UL)<<3)|(((a)&7UL)<<0))
#define BITMAP_SOURCE2(flash_or_ram, addr) ((1UL<<24)|((flash_or_ram) << 23)|(((addr)&8388607UL)<<0))
#define INT_FRR() ((48UL<<24))
#undef BITMAP_TRANSFORM_A
#undef BITMAP_TRANSFORM_B
#undef BITMAP_TRANSFORM_D
#undef BITMAP_TRANSFORM_E
#define BITMAP_TRANSFORM_A_EXT(p,v) ((21UL<<24)|(((p)&1UL)<<17)|(((v)&131071UL)<<0))
#define BITMAP_TRANSFORM_B_EXT(p,v) ((22UL<<24)|(((p)&1UL)<<17)|(((v)&131071UL)<<0))
#define BITMAP_TRANSFORM_D_EXT(p,v) ((24UL<<24)|(((p)&1UL)<<17)|(((v)&131071UL)<<0))
#define BITMAP_TRANSFORM_E_EXT(p,v) ((25UL<<24)|(((p)&1UL)<<17)|(((v)&131071UL)<<0))
#define BITMAP_TRANSFORM_A(a) BITMAP_TRANSFORM_A_EXT(0,a)
#define BITMAP_TRANSFORM_B(b) BITMAP_TRANSFORM_B_EXT(0,b)
#define BITMAP_TRANSFORM_D(d) BITMAP_TRANSFORM_D_EXT(0,d)
#define BITMAP_TRANSFORM_E(e) BITMAP_TRANSFORM_E_EXT(0,e)
#endif
/* ----------------- FT81x / BT81x exclusive definitions -----------------*/
#if defined (FT81X_ENABLE)
/* Host commands */
#define EVE_CLKSEL 0x61 /* configure system clock */
#define EVE_RST_PULSE 0x68 /* reset core - all registers default and processors reset */
#define EVE_PINDRIVE 0x70 /* setup drive strength for various pins */
#define EVE_PIN_PD_STATE 0x71 /* setup how pins behave during power down */
/* Memory definitions */
#define EVE_RAM_G 0x000000UL
#define EVE_ROM_CHIPID 0x0C0000UL
#define EVE_ROM_FONT 0x1E0000UL
#define EVE_ROM_FONT_ADDR 0x2FFFFCUL
#define EVE_RAM_DL 0x300000UL
#define EVE_RAM_REG 0x302000UL
#define EVE_RAM_CMD 0x308000UL
/* Memory buffer sizes */
#define EVE_RAM_G_SIZE 1024*1024L
#define EVE_CMDFIFO_SIZE 4*1024L
#define EVE_RAM_DL_SIZE 8*1024L
/* various additional defines for FT81x */
#define EVE_ADC_DIFFERENTIAL 1UL
#define EVE_ADC_SINGLE_ENDED 0UL
#define EVE_INT_G8 18UL
#define EVE_INT_L8C 12UL
#define EVE_INT_VGA 13UL
#define EVE_OPT_MEDIAFIFO 16UL
#define EVE_OPT_FULLSCREEN 8UL
#define EVE_OPT_NOTEAR 4UL
#define EVE_OPT_SOUND 32UL
#define EVE_PALETTED565 14UL
#define EVE_PALETTED4444 15UL
#define EVE_PALETTED8 16UL
#define EVE_L2 17UL
/* additional commands for FT81x */
#define CMD_MEDIAFIFO 0xFFFFFF39
#define CMD_PLAYVIDEO 0xFFFFFF3A
#define CMD_ROMFONT 0xFFFFFF3F
#define CMD_SETBASE 0xFFFFFF38
#define CMD_SETBITMAP 0xFFFFFF43
#define CMD_SETFONT2 0xFFFFFF3B
#define CMD_SETROTATE 0xFFFFFF36
#define CMD_SETSCRATCH 0xFFFFFF3C
#define CMD_SNAPSHOT2 0xFFFFFF37
#define CMD_VIDEOFRAME 0xFFFFFF41
#define CMD_VIDEOSTART 0xFFFFFF40
/* the following are undocumented commands that therefore should not be used */
#if 0
#define CMD_CSKETCH 0xFFFFFF35
#define CMD_INT_RAMSHARED 0xFFFFFF3D
#define CMD_INT_SWLOADIMAGE 0xFFFFFF3E
#endif
/* Register definitions */
#define REG_ANA_COMP 0x302184UL /* only listed in datasheet */
#define REG_BIST_EN 0x302174UL /* only listed in datasheet */
#define REG_CLOCK 0x302008UL
#define REG_CMDB_SPACE 0x302574UL
#define REG_CMDB_WRITE 0x302578UL
#define REG_CMD_DL 0x302100UL
#define REG_CMD_READ 0x3020f8UL
#define REG_CMD_WRITE 0x3020fcUL
#define REG_CPURESET 0x302020UL
#define REG_CSPREAD 0x302068UL
#define REG_CTOUCH_EXTENDED 0x302108UL
#define REG_CTOUCH_TOUCH0_XY 0x302124UL /* only listed in datasheet */
#define REG_CTOUCH_TOUCH4_X 0x30216cUL
#define REG_CTOUCH_TOUCH4_Y 0x302120UL
#define REG_CTOUCH_TOUCH1_XY 0x30211cUL
#define REG_CTOUCH_TOUCH2_XY 0x30218cUL
#define REG_CTOUCH_TOUCH3_XY 0x302190UL
#define REG_TOUCH_CONFIG 0x302168UL
#define REG_DATESTAMP 0x302564UL /* only listed in datasheet */
#define REG_DITHER 0x302060UL
#define REG_DLSWAP 0x302054UL
#define REG_FRAMES 0x302004UL
#define REG_FREQUENCY 0x30200cUL
#define REG_GPIO 0x302094UL
#define REG_GPIOX 0x30209cUL
#define REG_GPIOX_DIR 0x302098UL
#define REG_GPIO_DIR 0x302090UL
#define REG_HCYCLE 0x30202cUL
#define REG_HOFFSET 0x302030UL
#define REG_HSIZE 0x302034UL
#define REG_HSYNC0 0x302038UL
#define REG_HSYNC1 0x30203cUL
#define REG_ID 0x302000UL
#define REG_INT_EN 0x3020acUL
#define REG_INT_FLAGS 0x3020a8UL
#define REG_INT_MASK 0x3020b0UL
#define REG_MACRO_0 0x3020d8UL
#define REG_MACRO_1 0x3020dcUL
#define REG_MEDIAFIFO_READ 0x309014UL /* only listed in programmers guide */
#define REG_MEDIAFIFO_WRITE 0x309018UL /* only listed in programmers guide */
#define REG_OUTBITS 0x30205cUL
#define REG_PCLK 0x302070UL
#define REG_PCLK_POL 0x30206cUL
#define REG_PLAY 0x30208cUL
#define REG_PLAYBACK_FORMAT 0x3020c4UL
#define REG_PLAYBACK_FREQ 0x3020c0UL
#define REG_PLAYBACK_LENGTH 0x3020b8UL
#define REG_PLAYBACK_LOOP 0x3020c8UL
#define REG_PLAYBACK_PLAY 0x3020ccUL
#define REG_PLAYBACK_READPTR 0x3020bcUL
#define REG_PLAYBACK_START 0x3020b4UL
#define REG_PWM_DUTY 0x3020d4UL
#define REG_PWM_HZ 0x3020d0UL
#define REG_RENDERMODE 0x302010UL /* only listed in datasheet */
#define REG_ROTATE 0x302058UL
#define REG_SNAPFORMAT 0x30201cUL /* only listed in datasheet */
#define REG_SNAPSHOT 0x302018UL /* only listed in datasheet */
#define REG_SNAPY 0x302014UL /* only listed in datasheet */
#define REG_SOUND 0x302088UL
#define REG_SPI_WIDTH 0x302188UL /* listed with false offset in programmers guide V1.1 */
#define REG_SWIZZLE 0x302064UL
#define REG_TAG 0x30207cUL
#define REG_TAG_X 0x302074UL
#define REG_TAG_Y 0x302078UL
#define REG_TAP_CRC 0x302024UL /* only listed in datasheet */
#define REG_TAP_MASK 0x302028UL /* only listed in datasheet */
#define REG_TOUCH_ADC_MODE 0x302108UL
#define REG_TOUCH_CHARGE 0x30210cUL
#define REG_TOUCH_DIRECT_XY 0x30218cUL
#define REG_TOUCH_DIRECT_Z1Z2 0x302190UL
#define REG_TOUCH_MODE 0x302104UL
#define REG_TOUCH_OVERSAMPLE 0x302114UL
#define REG_TOUCH_RAW_XY 0x30211cUL
#define REG_TOUCH_RZ 0x302120UL
#define REG_TOUCH_RZTHRESH 0x302118UL
#define REG_TOUCH_SCREEN_XY 0x302124UL
#define REG_TOUCH_SETTLE 0x302110UL
#define REG_TOUCH_TAG 0x30212cUL
#define REG_TOUCH_TAG1 0x302134UL /* only listed in datasheet */
#define REG_TOUCH_TAG1_XY 0x302130UL /* only listed in datasheet */
#define REG_TOUCH_TAG2 0x30213cUL /* only listed in datasheet */
#define REG_TOUCH_TAG2_XY 0x302138UL /* only listed in datasheet */
#define REG_TOUCH_TAG3 0x302144UL /* only listed in datasheet */
#define REG_TOUCH_TAG3_XY 0x302140UL /* only listed in datasheet */
#define REG_TOUCH_TAG4 0x30214cUL /* only listed in datasheet */
#define REG_TOUCH_TAG4_XY 0x302148UL /* only listed in datasheet */
#define REG_TOUCH_TAG_XY 0x302128UL
#define REG_TOUCH_TRANSFORM_A 0x302150UL
#define REG_TOUCH_TRANSFORM_B 0x302154UL
#define REG_TOUCH_TRANSFORM_C 0x302158UL
#define REG_TOUCH_TRANSFORM_D 0x30215cUL
#define REG_TOUCH_TRANSFORM_E 0x302160UL
#define REG_TOUCH_TRANSFORM_F 0x302164UL
#define REG_TRACKER 0x309000UL /* only listed in programmers guide */
#define REG_TRACKER_1 0x309004UL /* only listed in programmers guide */
#define REG_TRACKER_2 0x309008UL /* only listed in programmers guide */
#define REG_TRACKER_3 0x30900cUL /* only listed in programmers guide */
#define REG_TRACKER_4 0x309010UL /* only listed in programmers guide */
#define REG_TRIM 0x302180UL
#define REG_VCYCLE 0x302040UL
#define REG_VOFFSET 0x302044UL
#define REG_VOL_PB 0x302080UL
#define REG_VOL_SOUND 0x302084UL
#define REG_VSIZE 0x302048UL
#define REG_VSYNC0 0x30204cUL
#define REG_VSYNC1 0x302050UL
#if 0
#define REG_BUSYBITS 0x3020e8UL /* only listed as "reserved" in datasheet */
#define REG_CRC 0x302178UL /* only listed as "reserved" in datasheet */
#define REG_SPI_EARLY_TX 0x30217cUL /* only listed as "reserved" in datasheet */
#define REG_ROMSUB_SEL 0x3020f0UL /* only listed as "reserved" in datasheet */
#define REG_TOUCH_FAULT 0x302170UL /* only listed as "reserved" in datasheet */
#endif
/* FT81x graphics engine specific macros useful for static display list generation */
/* beware, these are different to FTDIs implementation as these take the original values as parameters and not only the upper bits */
#define BITMAP_LAYOUT_H(linestride,height) ((40UL<<24)|((((linestride&0xC00)>>10)&3UL)<<2)|((((height&0x600)>>9)&3UL)<<0))
#define BITMAP_SIZE_H(width,height) ((41UL<<24)|((((width&0x600)>>9)&3UL)<<2)|((((height&0x600)>>9)&3UL)<<0))
#define BITMAP_SOURCE(addr) ((1UL<<24)|(((addr)&4194303UL)<<0))
//#define NOP() ((45UL<<24))
#define PALETTE_SOURCE(addr) ((42UL<<24)|(((addr)&4194303UL)<<0))
#define SCISSOR_SIZE(width,height) ((28UL<<24)|(((width)&4095UL)<<12)|(((height)&4095UL)<<0))
#define SCISSOR_XY(x,y) ((27UL<<24)|(((x)&2047UL)<<11)|(((y)&2047UL)<<0))
#define VERTEX_FORMAT(frac) ((39UL<<24)|(((frac)&7UL)<<0))
#define VERTEX_TRANSLATE_X(x) ((43UL<<24)|(((x)&131071UL)<<0))
#define VERTEX_TRANSLATE_Y(y) ((44UL<<24)|(((y)&131071UL)<<0))
/* ----------------- FT80x exclusive definitions -----------------*/
#else
/* Memory definitions */
#define EVE_RAM_G 0x000000UL
#define EVE_ROM_CHIPID 0x0C0000UL
#define EVE_ROM_FONT 0x0BB23CUL
#define EVE_ROM_FONT_ADDR 0x0FFFFCUL
#define EVE_RAM_DL 0x100000UL
#define EVE_RAM_PAL 0x102000UL
#define EVE_RAM_CMD 0x108000UL
#define EVE_RAM_SCREENSHOT 0x1C2000UL
/* Memory buffer sizes */
#define EVE_RAM_G_SIZE 256*1024L
#define EVE_CMDFIFO_SIZE 4*1024L
#define EVE_RAM_DL_SIZE 8*1024L
#define EVE_RAM_PAL_SIZE 1*1024L
/* Register definitions */
#define REG_ID 0x102400UL
#define REG_FRAMES 0x102404UL
#define REG_CLOCK 0x102408UL
#define REG_FREQUENCY 0x10240CUL
#define REG_SCREENSHOT_EN 0x102410UL
#define REG_SCREENSHOT_Y 0x102414UL
#define REG_SCREENSHOT_START 0x102418UL
#define REG_CPURESET 0x10241CUL
#define REG_TAP_CRC 0x102420UL
#define REG_TAP_MASK 0x102424UL
#define REG_HCYCLE 0x102428UL
#define REG_HOFFSET 0x10242CUL
#define REG_HSIZE 0x102430UL
#define REG_HSYNC0 0x102434UL
#define REG_HSYNC1 0x102438UL
#define REG_VCYCLE 0x10243CUL
#define REG_VOFFSET 0x102440UL
#define REG_VSIZE 0x102444UL
#define REG_VSYNC0 0x102448UL
#define REG_VSYNC1 0x10244CUL
#define REG_DLSWAP 0x102450UL
#define REG_ROTATE 0x102454UL
#define REG_OUTBITS 0x102458UL
#define REG_DITHER 0x10245CUL
#define REG_SWIZZLE 0x102460UL
#define REG_CSPREAD 0x102464UL
#define REG_PCLK_POL 0x102468UL
#define REG_PCLK 0x10246CUL
#define REG_TAG_X 0x102470UL
#define REG_TAG_Y 0x102474UL
#define REG_TAG 0x102478UL
#define REG_VOL_PB 0x10247CUL
#define REG_VOL_SOUND 0x102480UL
#define REG_SOUND 0x102484UL
#define REG_PLAY 0x102488UL
#define REG_GPIO_DIR 0x10248CUL
#define REG_GPIO 0x102490UL
#define REG_INT_FLAGS 0x102498UL
#define REG_INT_EN 0x10249CUL
#define REG_INT_MASK 0x1024A0UL
#define REG_PLAYBACK_START 0x1024A4UL
#define REG_PLAYBACK_LENGTH 0x1024A8UL
#define REG_PLAYBACK_READPTR 0x1024ACUL
#define REG_PLAYBACK_FREQ 0x1024B0UL
#define REG_PLAYBACK_FORMAT 0x1024B4UL
#define REG_PLAYBACK_LOOP 0x1024B8UL
#define REG_PLAYBACK_PLAY 0x1024BCUL
#define REG_PWM_HZ 0x1024C0UL
#define REG_PWM_DUTY 0x1024C4UL
#define REG_MACRO_0 0x1024C8UL
#define REG_MACRO_1 0x1024CCUL
#define REG_SCREENSHOT_BUSY 0x1024D8UL
#define REG_CMD_READ 0x1024E4UL
#define REG_CMD_WRITE 0x1024E8UL
#define REG_CMD_DL 0x1024ECUL
#define REG_TOUCH_MODE 0x1024F0UL
#define REG_TOUCH_ADC_MODE 0x1024F4UL
#define REG_TOUCH_CHARGE 0x1024F8UL
#define REG_TOUCH_SETTLE 0x1024FCUL
#define REG_TOUCH_OVERSAMPLE 0x102500UL
#define REG_TOUCH_RZTHRESH 0x102504UL
#define REG_TOUCH_RAW_XY 0x102508UL
#define REG_TOUCH_RZ 0x10250CUL
#define REG_TOUCH_SCREEN_XY 0x102510UL
#define REG_TOUCH_TAG_XY 0x102514UL
#define REG_TOUCH_TAG 0x102518UL
#define REG_TOUCH_TRANSFORM_A 0x10251CUL
#define REG_TOUCH_TRANSFORM_B 0x102520UL
#define REG_TOUCH_TRANSFORM_C 0x102524UL
#define REG_TOUCH_TRANSFORM_D 0x102528UL
#define REG_TOUCH_TRANSFORM_E 0x10252CUL
#define REG_TOUCH_TRANSFORM_F 0x102530UL
#define REG_SCREENSHOT_READ 0x102554UL
#define REG_TRIM 0x10256CUL
#define REG_TOUCH_DIRECT_XY 0x102574UL
#define REG_TOUCH_DIRECT_Z1Z2 0x102578UL
#define REG_TRACKER 0x109000UL
/* FT80x graphics engine specific macros useful for static display list generation */
#define BITMAP_SOURCE(addr) ((1UL<<24)|(((addr)&1048575UL)<<0))
#define SCISSOR_SIZE(width,height) ((28UL<<24)|(((width)&1023UL)<<10)|(((height)&1023UL)<<0))
#define SCISSOR_XY(x,y) ((27UL<<24)|(((x)&511UL)<<9)|(((y)&511UL)<<0))
#endif
#endif /* EVE_H_ */
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/EVE.h | C | apache-2.0 | 31,870 |
/*
@file EVE_commands.c
@brief contains FT8xx / BT8xx functions
@version 4.0
@date 2020-04-13
@author Rudolph Riedel, David Jade
@section info
This file needs to be renamed to EVE_command.cpp for use with Arduino.
At least für ATSAM I had the best result with -O2.
The c-standard is C99.
@section LICENSE
MIT License
Copyright (c) 2016-2020 Rudolph Riedel and David Jade
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@section History
4.1 LvGL edition
- This version is a heavily modified version of the MIT licensed FT81x code from https://github.com/RudolphRiedel/FT800-FT813
This version is based on a fork by David Jade that added native SPI DMA support and stripped out non-ESP32 code.
It has also been trimmed down to suit LvGL's needs. Extra features can be enabled by defining FT81X_FULL
*/
#include <stdio.h>
#include "EVE.h"
#include "EVE_commands.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/gpio.h"
#include "esp_log.h"
#include "soc/soc_memory_layout.h"
#include "esp_log.h"
#include "disp_spi.h"
#include <string.h>
#if defined (BT81X_ENABLE)
#include <stdarg.h>
#endif
#define TAG_LOG "FT81X"
/* data structure for SPI reading that has (optional) space for inserted dummy byte */
typedef struct _spi_read_data {
#if defined(DISP_SPI_FULL_DUPLEX)
uint8_t _dummy_byte;
#endif
union {
uint8_t byte;
uint16_t word;
uint32_t dword;
} __attribute__((packed));
} spi_read_data __attribute__((aligned(4)));
/* Receive data helpers */
#define member_size(type, member) sizeof(((type *)0)->member)
#if defined(DISP_SPI_FULL_DUPLEX)
#define SPI_READ_DUMMY_LEN member_size(spi_read_data, _dummy_byte)
#else
#define SPI_READ_DUMMY_LEN 0
#endif
#define SPI_READ_BYTE_LEN (SPI_READ_DUMMY_LEN + member_size(spi_read_data, byte))
#define SPI_READ_WORD_LEN (SPI_READ_DUMMY_LEN + member_size(spi_read_data, word))
#define SPI_READ_DWORD_LEN (SPI_READ_DUMMY_LEN + member_size(spi_read_data, dword))
// EVE Memory Commands - used with EVE_memWritexx and EVE_memReadxx
#define MEM_WRITE 0x80 // EVE Host Memory Write
#define MEM_READ 0x00 // EVE Host Memory Read
#define MEM_WRITE_24 0x800000 // EVE Host Memory Write (24-bit format)
volatile uint16_t cmdOffset = 0x0000; /* offset for the 4k co-processor FIFO */
volatile uint8_t cmd_burst = 0; /* flag to indicate cmd-burst is active */
// Buffer for SPI transactions
uint8_t SPIBuffer[SPI_BUFFER_SIZE]; // must be in DMA capable memory if DMA is used!
uint16_t SPIBufferIndex = 0;
disp_spi_send_flag_t SPIInherentSendFlags = 0; // additional inherent SPI flags (for DIO/QIO mode switching)
uint8_t SPIDummyReadBits = 0; // Dummy bits for reading in DIO/QIO modes
// Macros to make SPI use explicit and less verbose
// (macros do obscure code a little but they also help code search and readability)
// Buffer a byte
#define BUFFER_SPI_BYTE(byte) SPIBuffer[SPIBufferIndex++] = (byte);
// Buffer a Word - little Endian format
#define BUFFER_SPI_WORD(word) \
BUFFER_SPI_BYTE((uint8_t)(word)) \
BUFFER_SPI_BYTE((uint8_t)((word) >> 8))
// Buffer a DWord - little Endian format
#define BUFFER_SPI_DWORD(dword) \
BUFFER_SPI_BYTE((uint8_t)(dword)) \
BUFFER_SPI_BYTE((uint8_t)((dword) >> 8)) \
BUFFER_SPI_BYTE((uint8_t)((dword) >> 16)) \
BUFFER_SPI_BYTE((uint8_t)((dword) >> 24))
// Buffer a 24-bit SPI Memory Write address - big Endian format
#define BUFFER_SPI_WRITE_ADDRESS(addr) \
BUFFER_SPI_BYTE((uint8_t)((addr) >> 16) | MEM_WRITE) \
BUFFER_SPI_BYTE((uint8_t)((addr) >> 8)) \
BUFFER_SPI_BYTE((uint8_t)(addr))
// Send buffer
#define SEND_SPI_BUFFER() \
disp_spi_transaction(SPIBuffer, SPIBufferIndex, (disp_spi_send_flag_t)(DISP_SPI_SEND_QUEUED | SPIInherentSendFlags), NULL, 0, 0); \
SPIBufferIndex = 0;
// Wait for DMA queued SPI transactions to complete
#define WAIT_SPI() \
disp_wait_for_pending_transactions();
void DELAY_MS(uint16_t ms)
{
vTaskDelay(ms / portTICK_PERIOD_MS);
}
#if EVE_USE_PDN
void EVE_pdn_set(void)
{
gpio_set_level(EVE_PDN, 0); /* Power-Down low */
}
void EVE_pdn_clear(void)
{
gpio_set_level(EVE_PDN, 1); /* Power-Down high */
}
#endif
void spi_acquire()
{
disp_spi_acquire();
}
void spi_release()
{
disp_spi_release();
}
void EVE_cmdWrite(uint8_t command, uint8_t parameter)
{
const uint8_t data[] =
{
command,
parameter,
0x00
};
disp_spi_transaction(data, sizeof(data), (disp_spi_send_flag_t)(DISP_SPI_SEND_POLLING | SPIInherentSendFlags), NULL, 0, 0);
}
uint8_t EVE_memRead8(uint32_t ftAddress)
{
spi_read_data data = {};
disp_spi_send_flag_t readflags = (disp_spi_send_flag_t)(DISP_SPI_RECEIVE | DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags);
#if defined(DISP_SPI_HALF_DUPLEX)
// in half-duplex mode the FT81x requires dummy bits
readflags |= DISP_SPI_VARIABLE_DUMMY;
#endif
disp_spi_transaction(NULL, SPI_READ_BYTE_LEN, readflags, (uint8_t*)&data, ftAddress, SPIDummyReadBits);
return data.byte; /* return byte read */
}
uint16_t EVE_memRead16(uint32_t ftAddress)
{
#if defined(DISP_SPI_HALF_DUPLEX)
// There are esp32 issues when reading in DMA half-duplex mode that prevents reading more than 1 byte at a time so we work around that
uint16_t word = 0;
for(int i = 0; i < sizeof(word); i++)
{
word |= (EVE_memRead8(ftAddress + i) << i * 8);
}
return word;
#endif
spi_read_data data = {};
disp_spi_send_flag_t readflags = (disp_spi_send_flag_t)(DISP_SPI_RECEIVE | DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags);
#if defined(DISP_SPI_HALF_DUPLEX)
// in half-duplex mode the FT81x requires dummy bits
readflags |= DISP_SPI_VARIABLE_DUMMY;
#endif
disp_spi_transaction(NULL, SPI_READ_WORD_LEN, readflags, (uint8_t*)&data, ftAddress, SPIDummyReadBits);
return data.word; /* return integer read */
}
uint32_t EVE_memRead32(uint32_t ftAddress)
{
#if defined(DISP_SPI_HALF_DUPLEX)
// There are esp32 issues when reading in DMA half-duplex mode that prevents reading more than 1 byte at a time so we work around that
uint32_t dword = 0;
for(int i = 0; i < sizeof(dword); i++)
{
dword |= (EVE_memRead8(ftAddress + i) << i * 8);
}
return dword;
#endif
spi_read_data data = {};
disp_spi_send_flag_t readflags = (disp_spi_send_flag_t)(DISP_SPI_RECEIVE | DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags);
#if defined(DISP_SPI_HALF_DUPLEX)
// in half-duplex mode the FT81x requires dummy bits
readflags |= DISP_SPI_VARIABLE_DUMMY;
#endif
disp_spi_transaction(NULL, SPI_READ_DWORD_LEN, readflags, (uint8_t*)&data, ftAddress, SPIDummyReadBits);
return data.dword; /* return integer read */
}
void EVE_memWrite8(uint32_t ftAddress, uint8_t ftData8)
{
disp_spi_transaction(&ftData8, sizeof(ftData8), (disp_spi_send_flag_t)(DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags), NULL, (ftAddress | MEM_WRITE_24), 0);
}
void EVE_memWrite16(uint32_t ftAddress, uint16_t ftData16)
{
disp_spi_transaction((uint8_t*)&ftData16, sizeof(ftData16), (disp_spi_send_flag_t)(DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags), NULL, (ftAddress | MEM_WRITE_24), 0);
}
void EVE_memWrite32(uint32_t ftAddress, uint32_t ftData32)
{
disp_spi_transaction((uint8_t*)&ftData32, sizeof(ftData32), (disp_spi_send_flag_t)(DISP_SPI_SEND_POLLING | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags), NULL, (ftAddress | MEM_WRITE_24), 0);
}
// write to EVE memory via SPI memory-mapped protocol using queued SPI transactions (i.e. DMA)
// Note: data should be in DMA-capable memory!
void EVE_memWrite_buffer(uint32_t ftAddress, const uint8_t *data, uint32_t len, bool LvGL_Flush)
{
// chunk by DMA transfer size (SPI_TRANSER_SIZE)
uint32_t bytes_left = len;
while(bytes_left > 0)
{
uint32_t block_len = (bytes_left > SPI_TRANSER_SIZE ? SPI_TRANSER_SIZE : bytes_left);
// only send flush on last chunk
disp_spi_send_flag_t flush_flag = 0;
if(LvGL_Flush && bytes_left - block_len == 0)
{
flush_flag = DISP_SPI_SIGNAL_FLUSH;
}
disp_spi_transaction(data, block_len, (disp_spi_send_flag_t)(DISP_SPI_SEND_QUEUED | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags | flush_flag), NULL, (ftAddress | MEM_WRITE_24), 0);
data += block_len;
ftAddress += block_len;
bytes_left -= block_len;
}
}
/* Check if the graphics processor completed executing the current command list. */
/* This is the case when REG_CMD_READ matches cmdOffset, indicating that all commands have been executed. */
uint8_t EVE_busy(void)
{
uint16_t cmdBufferRead;
WAIT_SPI(); // can't tell if EVE is busy if SPI is taking place
cmdBufferRead = EVE_memRead16(REG_CMD_READ); /* read the graphics processor read pointer */
if(cmdBufferRead == 0xFFF) /* we have a co-processor fault, make EVE play with us again */
{
#if defined (BT81X_ENABLE)
uint16_t copro_patch_pointer;
copro_patch_pointer = EVE_memRead16(REG_COPRO_PATCH_DTR);
#endif
EVE_memWrite8(REG_CPURESET, 1); /* hold co-processor engine in the reset condition */
EVE_memWrite16(REG_CMD_READ, 0); /* set REG_CMD_READ to 0 */
EVE_memWrite16(REG_CMD_WRITE, 0); /* set REG_CMD_WRITE to 0 */
EVE_memWrite32(REG_CMD_DL, 0); /* reset REG_CMD_DL to 0 as required by the BT81x programming guide, should not hurt FT8xx */
cmdOffset = 0;
EVE_memWrite8(REG_CPURESET, 0); /* set REG_CMD_WRITE to 0 to restart the co-processor engine*/
#if defined (BT81X_ENABLE)
EVE_memWrite16(REG_COPRO_PATCH_DTR, copro_patch_pointer);
DELAY_MS(5); /* just to be safe */
// reset the SPI buffer just to be cautious
SPIBufferIndex = 0;
BUFFER_SPI_WRITE_ADDRESS(EVE_RAM_CMD + cmdOffset)
BUFFER_SPI_DWORD(CMD_FLASHATTACH)
BUFFER_SPI_DWORD(CMD_FLASHFAST)
SEND_SPI_BUFFER()
WAIT_SPI()
cmdOffset += 8;
BUFFER_SPI_BYTE
BUFFER_SPI_BYTE(MEM_WRITE | 0x30); /* send Memory Write plus high address byte of REG_CMD_WRITE for EVE81x */
BUFFER_SPI_BYTE(0x20); /* send middle address byte of REG_CMD_WRITE for EVE81x */
BUFFER_SPI_BYTE(0xfc); /* send low address byte of REG_CMD_WRITE for EVE81x */
BUFFER_SPI_WORD(cmdOffset);
SEND_SPI_BUFFER()
WAIT_SPI()
EVE_memWrite8(REG_PCLK, EVE_PCLK); /* restore REG_PCLK in case it was set to zero by an error */
DELAY_MS(5); /* just to be safe */
#endif
}
if(cmdOffset != cmdBufferRead)
{
return 1;
}
else
{
return 0;
}
}
void EVE_get_cmdoffset(void)
{
cmdOffset = EVE_memRead16(REG_CMD_WRITE);
}
void EVE_inc_cmdoffset(uint16_t increment)
{
cmdOffset += increment;
cmdOffset &= 0x0fff; // circular
}
/* order the command co-processor to start processing its FIFO queue and do not wait for completion */
void EVE_cmd_start(void)
{
WAIT_SPI();
EVE_memWrite16(REG_CMD_WRITE, cmdOffset);
}
/* order the command co-processor to start processing its FIFO queue and wait for completion */
void EVE_cmd_execute(void)
{
EVE_cmd_start();
while (EVE_busy());
}
/* begin a co-processor command, this is used for all non-display-list commands */
void EVE_begin_cmd(uint32_t command)
{
BUFFER_SPI_WRITE_ADDRESS(EVE_RAM_CMD + cmdOffset)
BUFFER_SPI_DWORD(command)
EVE_inc_cmdoffset(4); // only count the command size - not the write address directive
}
/* co-processor commands that are not used in displays lists, these are no to be used with async transfers */
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_memzero(uint32_t ptr, uint32_t num)
{
EVE_begin_cmd(CMD_MEMZERO);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
}
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_memset(uint32_t ptr, uint8_t value, uint32_t num)
{
EVE_begin_cmd(CMD_MEMSET);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(value)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
}
/* this is meant to be called outside display-list building, does not support cmd-burst */
void block_transfer(const uint8_t *data, uint32_t len); // forward ref
void EVE_cmd_memwrite(uint32_t dest, uint32_t num, const uint8_t *data)
{
EVE_begin_cmd(CMD_MEMWRITE);
BUFFER_SPI_DWORD(dest)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
block_transfer(data, num); // block_transfer is immediate - make sure CMD buffer is prepared!
}
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_memcpy(uint32_t dest, uint32_t src, uint32_t num)
{
EVE_begin_cmd(CMD_MEMCPY);
BUFFER_SPI_DWORD(dest)
BUFFER_SPI_DWORD(src)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
}
/* commands for loading image data into FT8xx CMD memory, with DWORD padding: */
/* Note: these are immediate SPI transfers and assume the CMD buffer is prepared to process the data, etc... */
// Note: data should be in DMA-capable memory!
void eve_spi_CMD_write(uint64_t addr, const uint8_t *data, uint16_t len)
{
// we can use a direct transaction because it is already chunked
disp_spi_transaction(data, len, (disp_spi_send_flag_t)(DISP_SPI_SEND_QUEUED | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags), NULL, (addr | MEM_WRITE_24), 0);
uint8_t padding = len & 0x03; /* 0, 1, 2 or 3 */
padding = 4 - padding; /* 4, 3, 2 or 1 */
padding &= 3; /* 3, 2, 1 or 0 */
// padding is another transaction and needs it's own address (this is a DMA requirement)
if(padding)
{
addr += len;
uint8_t padData[4] = {0};
disp_spi_transaction(padData, padding, (disp_spi_send_flag_t)(DISP_SPI_SEND_QUEUED | DISP_SPI_ADDRESS_24 | SPIInherentSendFlags), NULL, (addr | MEM_WRITE_24), 0);
len += padding;
}
EVE_inc_cmdoffset(len);
}
void block_transfer(const uint8_t *data, uint32_t len)
{
WAIT_SPI(); // SPI commands must be in CMD buffer first
uint32_t bytes_left;
bytes_left = len;
while(bytes_left > 0)
{
uint32_t block_len;
block_len = (bytes_left > BLOCK_TRANSFER_SIZE ? BLOCK_TRANSFER_SIZE : bytes_left);
eve_spi_CMD_write(EVE_RAM_CMD + cmdOffset, data, block_len);
data += block_len;
bytes_left -= block_len;
// signal to process data
EVE_cmd_execute();
}
}
#if FT81X_FULL
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
void EVE_cmd_inflate(uint32_t ptr, const uint8_t *data, uint16_t len)
{
EVE_begin_cmd(CMD_INFLATE);
BUFFER_SPI_DWORD(ptr)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
block_transfer(data, len); // block_transfer is immediate - make sure CMD buffer is prepared!
}
#if defined (BT81X_ENABLE)
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
void EVE_cmd_inflate2(uint32_t ptr, uint32_t options, const uint8_t *data, uint16_t len)
{
EVE_begin_cmd(CMD_INFLATE2);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(options)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
if(options == 0) /* direct data, not by Media-FIFO or Flash */
{
block_transfer(data, len); // block_transfer is immediate - make sure CMD buffer is prepared!
}
}
#endif
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
void EVE_cmd_loadimage(uint32_t ptr, uint32_t options, const uint8_t *data, uint16_t len)
{
EVE_begin_cmd(CMD_LOADIMAGE);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(options)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
#if defined (BT81X_ENABLE)
if( ((options & EVE_OPT_MEDIAFIFO) == 0) && ((options & EVE_OPT_FLASH) == 0) )/* direct data, neither by Media-FIFO or from Flash */
#elif defined (FT81X_ENABLE)
if((options & EVE_OPT_MEDIAFIFO) == 0) /* direct data, not by Media-FIFO */
#endif
{
block_transfer(data, len); // block_transfer is immediate - make sure CMD buffer is prepared!
}
}
#if defined (FT81X_ENABLE)
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_mediafifo(uint32_t ptr, uint32_t size)
{
EVE_begin_cmd(CMD_MEDIAFIFO);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(size)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
}
#endif
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_interrupt(uint32_t ms)
{
EVE_begin_cmd(CMD_INTERRUPT);
BUFFER_SPI_DWORD(ms)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
}
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_setfont(uint32_t font, uint32_t ptr)
{
EVE_begin_cmd(CMD_SETFONT);
BUFFER_SPI_DWORD(font)
BUFFER_SPI_DWORD(ptr)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
}
#if defined (FT81X_ENABLE)
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_setfont2(uint32_t font, uint32_t ptr, uint32_t firstchar)
{
EVE_begin_cmd(CMD_SETFONT2);
BUFFER_SPI_DWORD(font)
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(firstchar)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
}
#endif
#if defined (FT81X_ENABLE)
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_setrotate(uint32_t r)
{
EVE_begin_cmd(CMD_SETROTATE);
BUFFER_SPI_DWORD(r)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
}
#endif
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_snapshot(uint32_t ptr)
{
EVE_begin_cmd(CMD_SNAPSHOT);
BUFFER_SPI_DWORD(ptr)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
}
#if defined (FT81X_ENABLE)
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_snapshot2(uint32_t fmt, uint32_t ptr, int16_t x0, int16_t y0, int16_t w0, int16_t h0)
{
EVE_begin_cmd(CMD_SNAPSHOT2);
BUFFER_SPI_DWORD(fmt)
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
EVE_inc_cmdoffset(16);
SEND_SPI_BUFFER()
}
#endif
/* this is meant to be called outside display-list building, does not support cmd-burst */
void EVE_cmd_track(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t tag)
{
EVE_begin_cmd(CMD_TRACK);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(tag)
BUFFER_SPI_WORD(0)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
}
/* commands that return values by writing to the command-fifo */
/* note: yes, these are different than the functions in the Programmers Guide from FTDI,
this is because I have no idea why anyone would want to pass "result" as an actual argument to these functions
when this only marks the offset the command-processor is writing to */
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* crc32 = EVE_cmd_memcrc(my_ptr_to_some_memory_region, some_amount_of_bytes); */
uint32_t EVE_cmd_memcrc(uint32_t ptr, uint32_t num)
{
EVE_begin_cmd(CMD_MEMCRC);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(num)
BUFFER_SPI_DWORD(0)
EVE_inc_cmdoffset(8);
uint16_t offset = cmdOffset;
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
EVE_cmd_execute();
return (EVE_memRead32(EVE_RAM_CMD + offset));
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* address = EVE_cmd_getpr(); */
uint32_t EVE_cmd_getptr(void)
{
EVE_begin_cmd(CMD_GETPTR);
uint16_t offset = cmdOffset;
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
EVE_cmd_execute();
return (EVE_memRead32(EVE_RAM_CMD + offset));
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* regvalue = EVE_cmd_regread(ptr); */
/* this seems to be completely pointless, there is no real use for it outside a display-list since the register could be read directly */
/* and for what purpose would this be implemented to be used in a display list?? */
uint32_t EVE_cmd_regread(uint32_t ptr)
{
uint16_t offset;
EVE_begin_cmd(CMD_REGREAD);
BUFFER_SPI_DWORD(ptr)
EVE_inc_cmdoffset(4);
offset = cmdOffset;
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
EVE_cmd_execute();
return (EVE_memRead32(EVE_RAM_CMD + offset));
}
/*
Get the properties of an image after a CMD_LOADIMAGE operation.
uint32 pointer, width, height;
EVE_LIB_GetProps(&pointer, &width, &height);
uint32 width, height;
EVE_LIB_GetProps(0, &width, &height);
this is meant to be called outside display-list building, it includes executing the command
and waiting for completion, does not support cmd-burst
*/
void EVE_LIB_GetProps(uint32_t *pointer, uint32_t *width, uint32_t *height)
{
EVE_begin_cmd(CMD_GETPROPS);
uint16_t offset = cmdOffset;
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
EVE_cmd_execute();
if(pointer)
{
*pointer = EVE_memRead32(EVE_RAM_CMD + offset);
}
if(width)
{
*width = EVE_memRead32(EVE_RAM_CMD + offset + 4);
}
if(height)
{
*height = EVE_memRead32(EVE_RAM_CMD + offset + 8);
}
}
/* FT811 / FT813 binary-blob from FTDIs AN_336 to patch the touch-engine for Goodix GT911 / GT9271 touch controllers */
#if defined (EVE_HAS_GT911)
#if defined (__AVR__)
#include <avr/pgmspace.h>
#else
#define PROGMEM
#endif
const uint16_t EVE_GT911_len = 1184;
const uint8_t EVE_GT911_data[1184] PROGMEM =
{
26,255,255,255,32,32,48,0,4,0,0,0,2,0,0,0,
34,255,255,255,0,176,48,0,120,218,237,84,221,111,84,69,20,63,51,179,93,160,148,101,111,76,5,44,141,123,111,161,11,219,154,16,9,16,17,229,156,75,26,11,13,21,227,3,16,252,184,179,
45,219,143,45,41,125,144,72,67,100,150,71,189,113,18,36,17,165,100,165,198,16,32,17,149,196,240,128,161,16,164,38,54,240,0,209,72,130,15,38,125,48,66,82,30,76,19,31,172,103,46,
139,24,255,4,227,157,204,156,51,115,102,206,231,239,220,5,170,94,129,137,75,194,216,98,94,103,117,115,121,76,131,177,125,89,125,82,123,60,243,58,142,242,204,185,243,188,118,156,
227,155,203,238,238,195,251,205,229,71,92,28,169,190,184,84,143,113,137,53,244,103,181,237,87,253,113,137,233,48,12,198,165,181,104,139,25,84,253,155,114,74,191,0,54,138,163,
12,62,131,207,129,23,217,34,91,31,128,65,246,163,175,213,8,147,213,107,35,203,94,108,3,111,40,171,83,24,15,165,177,222,116,97,23,188,140,206,150,42,102,181,87,78,86,182,170,134,
215,241,121,26,243,252,2,76,115,217,139,222,206,173,136,132,81,61,35,185,39,113,23,46,199,76,178,54,151,183,224,0,40,189,28,149,182,58,131,79,152,30,76,34,98,234,162,216,133,141,
102,39,170,40,192,101,53,201,146,191,37,77,44,177,209,74,211,5,206,187,5,6,216,47,53,96,123,22,50,103,251,192,84,17,74,227,185,56,106,51,91,161,96,182,163,48,171,141,139,65,152,
66,66,11,102,43,158,75,36,80,147,184,147,139,112,17,235,216,103,111,239,245,92,10,175,194,40,44,58,125,5,59,112,50,103,245,4,78,192,5,156,194,51,60,191,134,75,110,173,237,46,192,
121,156,192,115,184,218,120,67,63,115,46,11,102,10,97,232,50,235,114,182,148,118,178,41,188,12,135,77,202,124,12,96,238,35,161,234,189,129,23,249,212,139,230,25,53,48,205,52,93,
163,117,53,154,170,81,85,163,178,70,69,66,167,241,14,46,241,1,226,136,152,179,197,59,184,148,254,49,132,48,15,176,137,192,76,131,196,105,104,162,86,81,160,165,255,26,173,162,137,
86,145,210,183,192,55,175,194,211,60,91,120,230,184,174,27,41,131,155,40,224,29,87,179,232,16,55,55,7,165,147,81,23,165,49,101,54,224,75,180,81,108,18,29,226,69,225,110,175,224,
42,212,25,47,130,193,110,234,192,215,252,56,74,162,24,46,251,174,54,106,68,245,14,9,155,160,22,120,207,104,240,29,90,178,140,28,24,220,47,166,112,61,251,208,192,111,56,239,238,
93,255,251,62,99,32,193,75,61,190,235,123,229,110,218,194,85,79,225,59,98,20,238,227,235,220,11,221,149,25,180,116,194,159,111,96,192,24,213,59,139,179,156,215,69,230,19,24,35,
135,117,206,171,206,162,67,129,234,61,235,11,104,103,84,64,223,167,254,40,163,101,92,84,43,150,46,249,219,205,7,116,11,91,104,61,57,75,223,8,48,25,28,119,252,222,113,49,86,249,
74,180,211,156,181,61,215,168,157,7,251,199,150,242,250,91,58,132,94,121,7,53,151,139,98,6,165,153,69,214,32,110,211,100,101,31,89,45,81,98,23,205,205,197,209,109,186,198,35,
141,191,249,25,60,132,223,153,251,98,20,239,146,139,20,217,250,41,250,137,58,177,90,57,79,51,108,233,20,253,194,187,49,222,205,114,141,96,48,175,219,107,54,111,138,22,154,103,
108,79,58,252,179,178,79,164,195,2,153,36,39,170,199,201,167,197,85,106,8,59,177,81,46,56,2,230,75,114,17,55,112,188,65,208,137,77,114,10,115,55,58,208,197,173,122,87,6,140,
110,42,208,124,163,70,108,241,104,18,245,98,214,187,134,53,42,221,22,182,133,211,116,148,177,194,209,192,85,90,199,58,55,203,2,229,19,137,187,161,228,154,112,203,145,125,244,
188,220,118,228,41,201,181,41,195,144,215,183,51,80,250,21,217,16,217,200,235,109,227,188,122,218,142,60,170,224,112,240,184,130,229,224,113,5,223,148,163,80,165,183,130,187,
132,116,64,238,161,85,220,115,139,205,98,227,244,29,102,125,7,37,243,123,223,11,26,92,63,243,116,61,191,138,123,244,160,84,186,74,31,5,174,247,119,135,199,248,253,135,242,97,
102,145,190,144,14,85,238,221,231,193,158,48,205,25,120,248,15,220,29,158,9,70,185,30,103,229,33,254,23,237,160,172,62,193,90,222,224,232,14,200,56,90,104,142,227,120,110,6,
21,211,203,65,150,99,151,220,247,87,164,50,159,49,239,234,58,142,0,109,108,123,18,79,227,36,100,248,222,205,96,127,120,26,171,228,69,63,36,17,252,200,17,116,242,187,227,88,143,
247,2,75,191,6,130,59,188,11,55,240,31,243,122,152,226,183,207,154,73,188,39,219,43,105,222,87,41,143,141,140,175,73,112,184,252,61,184,16,90,250,35,168,82,119,176,57,116,94,
200,150,22,190,179,44,104,12,235,84,149,102,252,89,154,193,99,228,106,242,125,248,64,194,255,223,127,242,83,11,255,2,70,214,226,128,0,0
};
#endif
#endif // FT81X_FULL
/* init, has to be executed with the SPI setup to 11 MHz or less as required by FT8xx / BT8xx */
uint8_t EVE_init(void)
{
uint8_t chipid = 0;
uint16_t timeout = 0;
#if EVE_USE_PDN
EVE_pdn_set();
DELAY_MS(6); /* minimum time for power-down is 5ms */
EVE_pdn_clear();
DELAY_MS(21); /* minimum time to allow from rising PD_N to first access is 20ms */
#endif
/* EVE_cmdWrite(EVE_CORERST,0); */ /* reset, only required for warm-start if PowerDown line is not used */
#if defined (EVE_HAS_CRYSTAL)
EVE_cmdWrite(EVE_CLKEXT, 0); /* setup EVE for external clock */
#else
EVE_cmdWrite(EVE_CLKINT, 0); /* setup EVE for internal clock */
#endif
#if defined (BT81X_ENABLE)
EVE_cmdWrite(EVE_CLKSEL ,0x46); /* set clock to 72 MHz */
#endif
EVE_cmdWrite(EVE_ACTIVE, 0); /* start EVE */
/* BRT AN033 BT81X_Series_Programming_Guide V1.2 had a small change to chapter 2.4 "Initialization Sequence during Boot Up" */
/* Send Host command “ACTIVE” and wait for at least 300 milliseconds. */
/* Ensure that there is no SPI access during this time. */
/* I asked Bridgetek for clarification why this has been made stricter. */
/* From observation with quite a few of different displays I do not agree that either the 300ms are necessary or that */
/* *reading* the SPI while EVE inits itself is causing any issues. */
/* But since BT815 at 72MHz need 42ms anyways before they start to answer, here is my compromise, a fixed 40ms delay */
/* to provide at least a short moment of silence for EVE */
DELAY_MS(40);
/* The most reliable DIO/QIO switching point is after EVE start up but before reading the ChipID. */
#if defined(DISP_SPI_TRANS_MODE_DIO)
ESP_LOGI(TAG_LOG, "Switching to DIO mode");
DELAY_MS(20); /* different boards may take a different delay but this generally seems to work */
EVE_memWrite16(REG_SPI_WIDTH, SPI_WIDTH_DIO);
SPIInherentSendFlags = DISP_SPI_MODE_DIO | DISP_SPI_MODE_DIOQIO_ADDR;
SPIDummyReadBits = 4; /* Esp32 DMA SPI transaction dummy_bits works more like clock cycles, so in DIO 4 dummy_bits == 8 total bits */
#elif defined(DISP_SPI_TRANS_MODE_QIO)
ESP_LOGI(TAG_LOG, "Switching to QIO mode");
DELAY_MS(20); /* different boards may take a different delay but this generally seems to work */
EVE_memWrite16(REG_SPI_WIDTH, SPI_WIDTH_QIO);
SPIInherentSendFlags = DISP_SPI_MODE_QIO | DISP_SPI_MODE_DIOQIO_ADDR;
SPIDummyReadBits = 2; /* Esp32 DMA SPI transaction dummy_bits works more like clock cycles, so in QIO 2 dummy_bits == 8 total bits */
#elif defined(DISP_SPI_HALF_DUPLEX)
SPIDummyReadBits = 8; /* SIO half-duplex mode */
#endif
while(chipid != 0x7C) /* if chipid is not 0x7c, continue to read it until it is, EVE needs a moment for it's power on self-test and configuration */
{
DELAY_MS(1);
chipid = EVE_memRead8(REG_ID);
timeout++;
if(timeout > 400)
{
ESP_LOGI(TAG_LOG, "Failed to read ChipID...aborting initialization.");
return 0;
}
}
timeout = 0;
while (0x00 != (EVE_memRead8(REG_CPURESET) & 0x03)) /* check if EVE is in working status */
{
DELAY_MS(1);
timeout++;
if(timeout > 50) /* experimental, 10 was the lowest value to get the BT815 started with, the touch-controller was the last to get out of reset */
{
ESP_LOGI(TAG_LOG, "Failed to read CPU status...aborting initialization.");
return 0;
}
}
/* tell EVE that we changed the frequency from default to 72MHz for BT8xx */
#if defined (BT81X_ENABLE)
EVE_memWrite32(REG_FREQUENCY, 72000000);
#endif
/* we have a display with a Goodix GT911 / GT9271 touch-controller on it, so we patch our FT811 or FT813 according to AN_336 or setup a BT815 accordingly */
#if defined (EVE_HAS_GT911)
#if defined (BT81X_ENABLE)
EVE_memWrite32(REG_TOUCH_CONFIG, 0x000005d1); /* switch to Goodix touch controller */
#else
EVE_get_cmdoffset();
BUFFER_SPI_WRITE_ADDRESS(EVE_RAM_CMD + cmdOffset)
SEND_SPI_BUFFER()
spi_flash_write(EVE_GT911_data, EVE_GT911_len);
EVE_cmd_execute();
EVE_memWrite8(REG_TOUCH_OVERSAMPLE, 0x0f); /* setup oversample to 0x0f as "hidden" in binary-blob for AN_336 */
EVE_memWrite16(REG_TOUCH_CONFIG, 0x05D0); /* write magic cookie as requested by AN_336 */
/* specific to the EVE2 modules from Matrix-Orbital we have to use GPIO3 to reset GT911 */
EVE_memWrite16(REG_GPIOX_DIR, 0x8008); /* Reset-Value is 0x8000, adding 0x08 sets GPIO3 to output, default-value for REG_GPIOX is 0x8000 -> Low output on GPIO3 */
DELAY_MS(1); /* wait more than 100µs */
EVE_memWrite8(REG_CPURESET, 0x00); /* clear all resets */
DELAY_MS(56); /* wait more than 55ms */
EVE_memWrite16(REG_GPIOX_DIR, 0x8000); /* setting GPIO3 back to input */
#endif
#endif
/* EVE_memWrite8(REG_PCLK, 0x00); */ /* set PCLK to zero - don't clock the LCD until later, line disabled because zero is reset-default and we just did a reset */
#if defined (EVE_ADAM101)
EVE_memWrite8(REG_PWM_DUTY, 0x80); /* turn off backlight for Glyn ADAM101 module, it uses inverted values */
#else
EVE_memWrite8(REG_PWM_DUTY, 0); /* turn off backlight for any other module */
#endif
/* Initialize Display */
EVE_memWrite16(REG_HSIZE, EVE_HSIZE); /* active display width */
EVE_memWrite16(REG_HCYCLE, EVE_HCYCLE); /* total number of clocks per line, incl front/back porch */
EVE_memWrite16(REG_HOFFSET, EVE_HOFFSET); /* start of active line */
EVE_memWrite16(REG_HSYNC0, EVE_HSYNC0); /* start of horizontal sync pulse */
EVE_memWrite16(REG_HSYNC1, EVE_HSYNC1); /* end of horizontal sync pulse */
EVE_memWrite16(REG_VSIZE, EVE_VSIZE); /* active display height */
EVE_memWrite16(REG_VCYCLE, EVE_VCYCLE); /* total number of lines per screen, including pre/post */
EVE_memWrite16(REG_VOFFSET, EVE_VOFFSET); /* start of active screen */
EVE_memWrite16(REG_VSYNC0, EVE_VSYNC0); /* start of vertical sync pulse */
EVE_memWrite16(REG_VSYNC1, EVE_VSYNC1); /* end of vertical sync pulse */
EVE_memWrite8(REG_SWIZZLE, EVE_SWIZZLE); /* FT8xx output to LCD - pin order */
EVE_memWrite8(REG_PCLK_POL, EVE_PCLKPOL); /* LCD data is clocked in on this PCLK edge */
EVE_memWrite8(REG_CSPREAD, EVE_CSPREAD); /* helps with noise, when set to 1 fewer signals are changed simultaneously, reset-default: 1 */
/* do not set PCLK yet - wait for just after the first display list */
/* configure Touch */
EVE_memWrite8(REG_TOUCH_MODE, EVE_TMODE_CONTINUOUS); /* enable touch */
EVE_memWrite16(REG_TOUCH_RZTHRESH, EVE_TOUCH_RZTHRESH); /* eliminate any false touches */
/* disable Audio for now */
EVE_memWrite8(REG_VOL_PB, 0x00); /* turn recorded audio volume down */
EVE_memWrite8(REG_VOL_SOUND, 0x00); /* turn synthesizer volume off */
EVE_memWrite16(REG_SOUND, 0x6000); /* set synthesizer to mute */
/* write a basic display-list to get things started */
EVE_memWrite32(EVE_RAM_DL, DL_CLEAR_RGB);
EVE_memWrite32(EVE_RAM_DL + 4, (DL_CLEAR | CLR_COL | CLR_STN | CLR_TAG));
EVE_memWrite32(EVE_RAM_DL + 8, DL_DISPLAY); /* end of display list */
EVE_memWrite32(REG_DLSWAP, EVE_DLSWAP_FRAME);
/* nothing is being displayed yet... the pixel clock is still 0x00 */
EVE_memWrite8(REG_GPIO, 0x80); /* enable the DISP signal to the LCD panel, it is set to output in REG_GPIO_DIR by default */
EVE_memWrite8(REG_PCLK, EVE_PCLK); /* now start clocking data to the LCD panel */
#if defined (EVE_ADAM101)
EVE_memWrite8(REG_PWM_DUTY, 0x60); /* turn on backlight to 25% for Glyn ADAM101 module, it uses inverted values */
#else
EVE_memWrite8(REG_PWM_DUTY, 0x20); /* turn on backlight to 25% for any other module */
#endif
timeout = 0;
while(EVE_busy()) /* just to be safe, should not even enter the loop */
{
DELAY_MS(1);
timeout++;
if(timeout > 4)
{
break; /* something is wrong here, but since we made it this far through the init, just leave the loop */
}
}
EVE_get_cmdoffset(); /* just to be safe */
#if defined (EVE_DMA)
EVE_init_dma(); /* prepare DMA */
#endif
return 1;
}
/*
These eliminate the overhead of transmitting the command-fifo address with every single command, just wrap a sequence of commands
with these and the address is only transmitted once at the start of the block.
Be careful to not use any functions in the sequence that do not address the command-fifo as for example any EVE_mem...() function.
*/
void EVE_start_cmd_burst(void)
{
cmd_burst = 42;
WAIT_SPI() // it is important to wait before writing to the SPI buffer as it might be in a DMA transaction
BUFFER_SPI_WRITE_ADDRESS(EVE_RAM_CMD + cmdOffset)
}
void EVE_end_cmd_burst(void)
{
cmd_burst = 0;
SEND_SPI_BUFFER()
}
/* begin a co-processor command */
void EVE_start_cmd(uint32_t command)
{
if(!cmd_burst)
{
WAIT_SPI() // it is important to wait before writing to the SPI buffer as it might be in a DMA transaction
BUFFER_SPI_WRITE_ADDRESS(EVE_RAM_CMD + cmdOffset)
}
BUFFER_SPI_DWORD(command)
EVE_inc_cmdoffset(4); /* update the command-ram pointer */
}
/* generic function for all commands that have no arguments and all display-list specific control words */
/*
examples:
EVE_cmd_dl(CMD_DLSTART);
EVE_cmd_dl(CMD_SWAP);
EVE_cmd_dl(CMD_SCREENSAVER);
EVE_cmd_dl(LINE_WIDTH(1*16));
EVE_cmd_dl(VERTEX2F(0,0));
EVE_cmd_dl(DL_BEGIN | EVE_RECTS);
*/
void EVE_cmd_dl(uint32_t command)
{
if(cmd_burst)
{
BUFFER_SPI_DWORD(command)
EVE_inc_cmdoffset(4); /* update the command-ram pointer */
}
else
{
EVE_start_cmd(command);
SEND_SPI_BUFFER()
}
}
#if FT81X_FULL
/* write a string to co-processor memory in context of a command: no chip-select, just plain SPI-transfers */
/* note: assumes cmdOffset is already DWORD aligned */
void EVE_write_string(const char *text)
{
uint8_t textindex = 0;
uint8_t padding = 0;
uint8_t *bytes = (uint8_t *) text; /* need to handle the array as bunch of bytes */
while(bytes[textindex] != 0)
{
BUFFER_SPI_BYTE(bytes[textindex]);
textindex++;
if(textindex > 249 || SPIBufferIndex >= SPI_BUFFER_SIZE) /* there appears to be no end for the "string", or no more room in SPI buffer, so leave */
{
break;
}
}
/* we need to transmit at least one 0x00 byte and up to four if the string happens to be 4-byte aligned already */
padding = textindex & 3; /* 0, 1, 2 or 3 */
padding = 4-padding; /* 4, 3, 2 or 1 */
textindex += padding;
while(padding > 0 && SPIBufferIndex < SPI_BUFFER_SIZE)
{
BUFFER_SPI_BYTE(0);
padding--;
}
EVE_inc_cmdoffset(textindex);
}
/* EVE3 FLASH functions */
#if defined (BT81X_ENABLE)
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* write "num" bytes from *data to the external flash on a BT81x board at address ptr */
/* note: ptr must be 256 byte aligned, num must be a multiple of 256 */
/* note: EVE will not do anything if the alignment requirements are not met */
/* note: the address ptr is relative to the flash so the first address is 0x00000000 not 0x800000 */
/* note: on AVR controllers this expects the data to be located in the controllers flash memory */
void EVE_cmd_flashwrite(uint32_t ptr, uint32_t num, const uint8_t *data)
{
EVE_begin_cmd(CMD_FLASHWRITE);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
WAIT_SPI()
block_transfer(data, num);
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* write "num" bytes from src in the external flash on a BT81x board to dest in RAM_G */
/* note: src must be 64-byte aligned, dest must be 4-byte aligned, num must be a multiple of 4 */
/* note: EVE will not do anything if the alignment requirements are not met */
/* note: the src pointer is relative to the flash so the first address is 0x00000000 not 0x800000 */
void EVE_cmd_flashread(uint32_t dest, uint32_t src, uint32_t num)
{
EVE_begin_cmd(CMD_FLASHREAD);
BUFFER_SPI_DWORD(dest)
BUFFER_SPI_DWORD(src)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* write "num" bytes from src in RAM_G to to the external flash on a BT81x board at address dest */
/* note: dest must be 4096-byte aligned, src must be 4-byte aligned, num must be a multiple of 4096 */
/* note: EVE will not do anything if the alignment requirements are not met */
/* note: the address ptr is relative to the flash so the first address is 0x00000000 not 0x800000 */
void EVE_cmd_flashupdate(uint32_t dest, uint32_t src, uint32_t num)
{
EVE_begin_cmd(CMD_FLASHUPDATE);
BUFFER_SPI_DWORD(dest)
BUFFER_SPI_DWORD(src)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(12);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* this is added for conveniance, using EVE_cmd_dl(CMD_FLASHERASE); followed by EVE_cmd_execute(); would work as well */
void EVE_cmd_flasherase(void)
{
EVE_begin_cmd(CMD_FLASHERASE);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* this is added for conveniance, using EVE_cmd_dl(CMD_FLASHATTACH); followed by EVE_cmd_execute(); would work as well */
void EVE_cmd_flashattach(void)
{
EVE_begin_cmd(CMD_FLASHATTACH);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* this is added for conveniance, using EVE_cmd_dl(CMD_FLASHDETACH); followed by EVE_cmd_execute(); would work as well */
void EVE_cmd_flashdetach(void)
{
EVE_begin_cmd(CMD_FLASHDETACH);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* this is added for conveniance, using EVE_cmd_dl(CMD_FLASHSPIDESEL); followed by EVE_cmd_execute(); would work as well */
void EVE_cmd_flashspidesel(void)
{
EVE_begin_cmd(CMD_FLASHSPIDESEL);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
uint32_t EVE_cmd_flashfast(void)
{
uint16_t offset;
EVE_begin_cmd(CMD_FLASHFAST);
BUFFER_SPI_DWORD(0)
offset = cmdOffset;
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
EVE_cmd_execute();
return EVE_memRead32(EVE_RAM_CMD + offset);
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* write "num" bytes from *data to the BT81x SPI interface */
/* note: raw direct access, not really useful for anything */
void EVE_cmd_flashspitx(uint32_t num, const uint8_t *data)
{
EVE_begin_cmd(CMD_FLASHSPITX);
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
WAIT_SPI()
block_transfer(data, num);
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
/* write "num" bytes from the BT81x SPI interface dest in RAM_G */
/* note: raw direct access, not really useful for anything */
void EVE_cmd_flashspirx(uint32_t dest, uint32_t num)
{
EVE_begin_cmd(CMD_FLASHREAD);
BUFFER_SPI_DWORD(dest)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* this is meant to be called outside display-list building, it includes executing the command and waiting for completion, does not support cmd-burst */
void EVE_cmd_flashsource(uint32_t ptr)
{
EVE_begin_cmd(CMD_FLASHSOURCE);
BUFFER_SPI_DWORD(ptr)
EVE_inc_cmdoffset(4);
SEND_SPI_BUFFER()
EVE_cmd_execute();
}
/* switch the FLASH attached to a BT815/BT816 to full-speed mode, returns 0 for failing to do so, does not support cmd-burst */
uint8_t EVE_init_flash(void)
{
uint8_t timeout = 0;
uint8_t status;
status = EVE_memRead8(REG_FLASH_STATUS); /* should be 0x02 - FLASH_STATUS_BASIC, power-up is done and the attached flash is detected */
while(status == 0) /* FLASH_STATUS_INIT - we are somehow still in init, give it a litte more time, this should never happen */
{
status = EVE_memRead8(REG_FLASH_STATUS);
DELAY_MS(1);
timeout++;
if(timeout > 100) /* 100ms and still in init, lets call quits now and exit with an error */
{
return 0;
}
}
if(status == 1) /* FLASH_STATUS_DETACHED - no flash was found during init, no flash present or the detection failed, but have hope and let the BT81x have annother try */
{
EVE_cmd_dl(CMD_FLASHATTACH);
EVE_cmd_execute();
status = EVE_memRead8(REG_FLASH_STATUS);
if(status != 2) /* still not in FLASH_STATUS_BASIC, time to give up */
{
return 0;
}
}
if(status == 2) /* FLASH_STATUS_BASIC - flash detected and ready for action, lets move it up to FLASH_STATUS_FULL */
{
uint32_t result;
result = EVE_cmd_flashfast();
if(result == 0) /* cmd_flashfast was successful */
{
return 1;
}
else /* room for improvement, cmd_flashfast provided an error code but there is no way to return it without returning a value that is FALSE all the same */
{
return 0;
}
}
if(status == 3) /* FLASH_STATUS_FULL - we are already there, why has this function been called? */
{
return 1;
}
return 0;
}
#endif
/* commands to draw graphics objects: */
#if defined (BT81X_ENABLE)
/* as the name implies, "num_args" is the number of arguments passed to this function as variadic arguments */
void EVE_cmd_text_var(int16_t x0, int16_t y0, int16_t font, uint16_t options, const char* text, uint8_t num_args, ...)
{
va_list arguments;
uint8_t counter;
uint32_t data;
va_start(arguments, num_args);
BUFFER_SPI_DWORD(CMD_TEXT)
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(options & EVE_OPT_FORMAT)
{
for(counter = 0; counter < num_args; counter++)
{
data = (uint32_t) va_arg(arguments, int);
BUFFER_SPI_DWORD(data)
EVE_inc_cmdoffset(4);
}
}
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
va_end(arguments);
}
#endif
void EVE_cmd_text(int16_t x0, int16_t y0, int16_t font, uint16_t options, const char* text)
{
EVE_start_cmd(CMD_TEXT);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
EVE_inc_cmdoffset(8);
EVE_write_string(text);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#if defined (BT81X_ENABLE)
/* as the name implies, "num_args" is the number of arguments passed to this function as variadic arguments */
void EVE_cmd_button_var(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text, uint8_t num_args, ...)
{
va_list arguments;
uint8_t counter;
uint32_t data;
va_start(arguments, num_args);
EVE_start_cmd(CMD_BUTTON);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(options & EVE_OPT_FORMAT)
{
for(counter = 0; counter < num_args; counter++)
{
data = (uint32_t) va_arg(arguments, int);
BUFFER_SPI_DWORD(data)
EVE_inc_cmdoffset(4);
}
}
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
va_end(arguments);
}
#endif
void EVE_cmd_button(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text)
{
EVE_start_cmd(CMD_BUTTON);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* draw a clock */
void EVE_cmd_clock(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t hours, uint16_t minutes, uint16_t seconds, uint16_t millisecs)
{
EVE_start_cmd(CMD_CLOCK);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(r0)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(hours)
BUFFER_SPI_WORD(minutes)
BUFFER_SPI_WORD(seconds)
BUFFER_SPI_WORD(millisecs)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_color_rgb(uint8_t red, uint8_t green, uint8_t blue)
{
BUFFER_SPI_BYTE(green) /* low-byte */
BUFFER_SPI_BYTE(blue)
BUFFER_SPI_BYTE(red)
BUFFER_SPI_BYTE(0x04) /* encoding for COLOR_RGB */
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_bgcolor(uint32_t color)
{
EVE_start_cmd(CMD_BGCOLOR);
BUFFER_SPI_DWORD(color & 0x00ffffff)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_fgcolor(uint32_t color)
{
EVE_start_cmd(CMD_FGCOLOR);
BUFFER_SPI_DWORD(color & 0x00ffffff)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_gradcolor(uint32_t color)
{
EVE_start_cmd(CMD_GRADCOLOR);
BUFFER_SPI_DWORD(color & 0x00ffffff)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_gauge(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t major, uint16_t minor, uint16_t val, uint16_t range)
{
EVE_start_cmd(CMD_GAUGE);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(r0)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(major)
BUFFER_SPI_WORD(minor)
BUFFER_SPI_WORD(val)
BUFFER_SPI_WORD(range)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_gradient(int16_t x0, int16_t y0, uint32_t rgb0, int16_t x1, int16_t y1, uint32_t rgb1)
{
EVE_start_cmd(CMD_GRADIENT);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_DWORD(rgb0 & 0x00ffffff)
BUFFER_SPI_WORD(x1)
BUFFER_SPI_WORD(y1)
BUFFER_SPI_DWORD(rgb1 & 0x00ffffff)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_keys(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text)
{
EVE_start_cmd(CMD_KEYS);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_progress(int16_t x0, int16_t y0, int16_t w0, int16_t h0, uint16_t options, uint16_t val, uint16_t range)
{
EVE_start_cmd(CMD_PROGRESS);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(val)
BUFFER_SPI_WORD(range)
BUFFER_SPI_WORD(0) /* dummy word for 4-byte alignment */
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_scrollbar(int16_t x0, int16_t y0, int16_t w0, int16_t h0, uint16_t options, uint16_t val, uint16_t size, uint16_t range)
{
EVE_start_cmd(CMD_SCROLLBAR);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(val)
BUFFER_SPI_WORD(size)
BUFFER_SPI_WORD(range)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_slider(int16_t x1, int16_t y1, int16_t w1, int16_t h1, uint16_t options, uint16_t val, uint16_t range)
{
EVE_start_cmd(CMD_SLIDER);
BUFFER_SPI_WORD(x1)
BUFFER_SPI_WORD(y1)
BUFFER_SPI_WORD(w1)
BUFFER_SPI_WORD(h1)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(val)
BUFFER_SPI_WORD(range)
BUFFER_SPI_WORD(0) /* dummy word for 4-byte alignment */
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_dial(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t val)
{
EVE_start_cmd(CMD_DIAL);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(r0)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(val)
BUFFER_SPI_WORD(0) /* dummy word for 4-byte alignment */
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#if defined (BT81X_ENABLE)
/* as the name implies, "num_args" is the number of arguments passed to this function as variadic arguments */
void EVE_cmd_toggle_var(int16_t x0, int16_t y0, int16_t w0, int16_t font, uint16_t options, uint16_t state, const char* text, uint8_t num_args, ...)
{
va_list arguments;
uint8_t counter;
uint32_t data;
va_start(arguments, num_args);
EVE_start_cmd(CMD_TOGGLE);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(state)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(options & EVE_OPT_FORMAT)
{
for(counter = 0; counter < num_args; counter++)
{
data = (uint32_t) va_arg(arguments, int);
BUFFER_SPI_DWORD(data)
EVE_inc_cmdoffset(4);
}
}
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
va_end(arguments);
}
#endif
void EVE_cmd_toggle(int16_t x0, int16_t y0, int16_t w0, int16_t font, uint16_t options, uint16_t state, const char* text)
{
EVE_start_cmd(CMD_TOGGLE);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
BUFFER_SPI_WORD(state)
EVE_inc_cmdoffset(12);
EVE_write_string(text);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#if defined (FT81X_ENABLE)
void EVE_cmd_setbase(uint32_t base)
{
EVE_start_cmd(CMD_SETBASE);
BUFFER_SPI_DWORD(base);
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
#endif // FT81X_FULL
#if defined (FT81X_ENABLE)
void EVE_cmd_setbitmap(uint32_t addr, uint16_t fmt, uint16_t width, uint16_t height)
{
EVE_start_cmd(CMD_SETBITMAP);
BUFFER_SPI_DWORD(addr)
BUFFER_SPI_WORD(fmt)
BUFFER_SPI_WORD(width)
BUFFER_SPI_WORD(height)
BUFFER_SPI_WORD(0)
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
#if FT81X_FULL
void EVE_cmd_number(int16_t x0, int16_t y0, int16_t font, uint16_t options, int32_t number)
{
EVE_start_cmd(CMD_NUMBER);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(font)
BUFFER_SPI_WORD(options)
BUFFER_SPI_DWORD(number)
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_append(uint32_t ptr, uint32_t num)
{
EVE_start_cmd(CMD_APPEND);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* commands for setting the bitmap transform matrix: */
/*
The description in the programmers guide is strange for this function.
While it is named *get*matrix, parameters 'a' to 'f' are supplied to the function
and described as "output parameter"
Best guess is that this one allows to setup the matrix coefficients manually.
If this assumption is correct it rather should be named cmd_setupmatrix().
*/
void EVE_cmd_getmatrix(int32_t a, int32_t b, int32_t c, int32_t d, int32_t e, int32_t f)
{
EVE_start_cmd(CMD_GETMATRIX);
BUFFER_SPI_DWORD(a)
BUFFER_SPI_DWORD(b)
BUFFER_SPI_DWORD(c)
BUFFER_SPI_DWORD(d)
BUFFER_SPI_DWORD(e)
BUFFER_SPI_DWORD(f)
EVE_inc_cmdoffset(24);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_translate(int32_t tx, int32_t ty)
{
EVE_start_cmd(CMD_TRANSLATE);
BUFFER_SPI_DWORD(tx)
BUFFER_SPI_DWORD(ty)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_scale(int32_t sx, int32_t sy)
{
EVE_start_cmd(CMD_SCALE);
BUFFER_SPI_DWORD(sx)
BUFFER_SPI_DWORD(sy)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_rotate(int32_t ang)
{
EVE_start_cmd(CMD_ROTATE);
BUFFER_SPI_DWORD(ang)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#if defined (BT81X_ENABLE)
void EVE_cmd_rotatearound(int32_t x0, int32_t y0, int32_t angle, int32_t scale)
{
EVE_start_cmd(CMD_ROTATEAROUND);
BUFFER_SPI_DWORD(x0)
BUFFER_SPI_DWORD(y0)
BUFFER_SPI_DWORD(ang)
BUFFER_SPI_DWORD(scale)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
/* other commands: */
void EVE_cmd_calibrate(void)
{
EVE_start_cmd(CMD_CALIBRATE);
BUFFER_SPI_DWORD(0)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#if defined (FT81X_ENABLE)
void EVE_cmd_romfont(uint32_t font, uint32_t romslot)
{
EVE_start_cmd(CMD_ROMFONT);
BUFFER_SPI_DWORD(font & 0x0000ffff)
BUFFER_SPI_DWORD(romslot & 0x0000ffff)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
#if defined (FT81X_ENABLE)
void EVE_cmd_setscratch(uint32_t handle)
{
EVE_start_cmd(CMD_SETSCRATCH);
BUFFER_SPI_DWORD(handle)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
void EVE_cmd_sketch(int16_t x0, int16_t y0, uint16_t w0, uint16_t h0, uint32_t ptr, uint16_t format)
{
EVE_start_cmd(CMD_SKETCH);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(w0)
BUFFER_SPI_WORD(h0)
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_WORD(format)
BUFFER_SPI_WORD(0) /* dummy word for 4-byte alignment */
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_spinner(int16_t x0, int16_t y0, uint16_t style, uint16_t scale)
{
EVE_start_cmd(CMD_SPINNER);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_WORD(style)
BUFFER_SPI_WORD(scale)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* various commands new for EVE3 */
#if defined (BT81X_ENABLE)
void EVE_cmd_animstart(int32_t ch, uint32_t aoptr, uint32_t loop)
{
EVE_start_cmd(CMD_ANIMSTART);
BUFFER_SPI_DWORD(ch)
BUFFER_SPI_DWORD(aoptr)
BUFFER_SPI_DWORD(loop)
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_animstop(int32_t ch)
{
EVE_start_cmd(CMD_ANIMSTOP);
BUFFER_SPI_DWORD(ch)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_animxy(int32_t ch, int16_t x0, int16_t y0)
{
EVE_start_cmd(CMD_ANIMXY);
BUFFER_SPI_DWORD(ch)
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_animdraw(int32_t ch)
{
EVE_start_cmd(CMD_ANIMDRAW);
BUFFER_SPI_DWORD(ch)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_animframe(int16_t x0, int16_t y0, uint32_t aoptr, uint32_t frame)
{
EVE_start_cmd(CMD_ANIMFRAME);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_DWORD(aoptr)
BUFFER_SPI_DWORD(frame)
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_gradienta(int16_t x0, int16_t y0, uint32_t argb0, int16_t x1, int16_t y1, uint32_t argb1)
{
EVE_start_cmd(CMD_GRADIENTA);
BUFFER_SPI_WORD(x0)
BUFFER_SPI_WORD(y0)
BUFFER_SPI_DWORD(argb0)
BUFFER_SPI_WORD(x1)
BUFFER_SPI_WORD(y1)
BUFFER_SPI_DWORD(argb1)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_fillwidth(uint32_t s)
{
EVE_start_cmd(CMD_FILLWIDTH);
BUFFER_SPI_DWORD(s)
EVE_inc_cmdoffset(4);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
void EVE_cmd_appendf(uint32_t ptr, uint32_t num)
{
EVE_start_cmd(CMD_APPENDF);
BUFFER_SPI_DWORD(ptr)
BUFFER_SPI_DWORD(num)
EVE_inc_cmdoffset(8);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
#endif
/* warning! meta-command! this is a sequence of display-list commands to simplify use at the price of some overhead */
void EVE_cmd_point(int16_t x0, int16_t y0, uint16_t size)
{
EVE_start_cmd((DL_BEGIN | EVE_POINTS));
uint32_t calc = POINT_SIZE(size*16);
BUFFER_SPI_DWORD(calc)
calc = VERTEX2F(x0 * 16, y0 * 16);
BUFFER_SPI_DWORD(calc)
BUFFER_SPI_DWORD(DL_END)
EVE_inc_cmdoffset(12);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* warning! meta-command! this is a sequence of display-list commands to simplify use at the price of some overhead */
void EVE_cmd_line(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t width)
{
EVE_start_cmd((DL_BEGIN | EVE_LINES));
uint32_t calc = LINE_WIDTH(width * 16);
BUFFER_SPI_DWORD(calc)
calc = VERTEX2F(x0 * 16, y0 * 16);
BUFFER_SPI_DWORD(calc)
calc = VERTEX2F(x1 * 16, y1 * 16);
BUFFER_SPI_DWORD(calc)
BUFFER_SPI_DWORD(DL_END)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* warning! meta-command! this is a sequence of display-list commands to simplify use at the price of some overhead */
void EVE_cmd_rect(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t corner)
{
EVE_start_cmd((DL_BEGIN | EVE_RECTS));
uint32_t calc = LINE_WIDTH(corner * 16);
BUFFER_SPI_DWORD(calc)
calc = VERTEX2F(x0 * 16, y0 * 16);
BUFFER_SPI_DWORD(calc)
calc = VERTEX2F(x1 * 16, y1 * 16);
BUFFER_SPI_DWORD(calc)
BUFFER_SPI_DWORD(DL_END)
EVE_inc_cmdoffset(16);
if(!cmd_burst)
{
SEND_SPI_BUFFER()
}
}
/* this is meant to be called outside display-list building */
/* this function displays an interactive calibration screen, calculates the calibration values and */
/* writes the new values to the touch matrix registers of EVE */
/* unlike the built-in cmd_calibrate() of EVE this also works with displays that are cut down from larger ones like EVE2-38A / EVE2-38G */
/* the height is needed as parameter as EVE_VSIZE for the EVE2-38 is 272 but the visible size is only 116 */
/* so the call would be EVE_calibrate_manual(116); for the EVE2-38A and EVE2-38G while for most other displays */
/* using EVE_calibrate_manual(EVE_VSIZE) would work - but for normal displays the built-in cmd_calibrate would work as expected anyways */
/* this code was taken from the MatrixOrbital EVE2-Library on Github, adapted and modified */
void EVE_calibrate_manual(uint16_t height)
{
uint32_t displayX[3], displayY[3];
uint32_t touchX[3], touchY[3];
uint32_t touchValue;
int32_t tmp, k;
int32_t TransMatrix[6];
uint8_t count = 0;
char num[2];
uint8_t touch_lock = 1;
/* these values determine where your calibration points will be drawn on your display */
displayX[0] = (EVE_HSIZE * 0.15);
displayY[0] = (height * 0.15);
displayX[1] = (EVE_HSIZE * 0.85);
displayY[1] = (height / 2);
displayX[2] = (EVE_HSIZE / 2);
displayY[2] = (height * 0.85);
while (count < 3)
{
// immediate transfer mode
EVE_cmd_dl(CMD_DLSTART);
EVE_cmd_dl(DL_CLEAR_RGB | 0x000000);
EVE_cmd_dl(DL_CLEAR | CLR_COL | CLR_STN | CLR_TAG);
/* draw Calibration Point on screen */
EVE_cmd_dl(DL_COLOR_RGB | 0x0000ff);
EVE_cmd_dl(POINT_SIZE(20*16));
EVE_cmd_dl((DL_BEGIN | EVE_POINTS));
EVE_cmd_dl(VERTEX2F((uint32_t)(displayX[count]) * 16, (uint32_t)((displayY[count])) * 16));
EVE_cmd_dl(DL_END);
EVE_cmd_dl(DL_COLOR_RGB | 0xffffff);
EVE_cmd_text((EVE_HSIZE/2), 50, 27, EVE_OPT_CENTER, "Please tap on the dot.");
num[0] = count + 0x31; num[1] = 0; /* null terminated string of one character */
EVE_cmd_text(displayX[count], displayY[count], 27, EVE_OPT_CENTER, num);
EVE_cmd_dl(DL_DISPLAY);
EVE_cmd_dl(CMD_SWAP);
EVE_cmd_execute();
while(1)
{
touchValue = EVE_memRead32(REG_TOUCH_DIRECT_XY); /* read for any new touch tag inputs */
if(touch_lock)
{
if(touchValue & 0x80000000) /* check if we have no touch */
{
touch_lock = 0;
}
}
else
{
if (!(touchValue & 0x80000000)) /* check if a touch is detected */
{
touchX[count] = (touchValue>>16) & 0x03FF; /* raw Touchscreen Y coordinate */
touchY[count] = touchValue & 0x03FF; /* raw Touchscreen Y coordinate */
touch_lock = 1;
count++;
break; /* leave while(1) */
}
}
}
}
k = ((touchX[0] - touchX[2])*(touchY[1] - touchY[2])) - ((touchX[1] - touchX[2])*(touchY[0] - touchY[2]));
tmp = (((displayX[0] - displayX[2]) * (touchY[1] - touchY[2])) - ((displayX[1] - displayX[2])*(touchY[0] - touchY[2])));
TransMatrix[0] = ((int64_t)tmp << 16) / k;
tmp = (((touchX[0] - touchX[2]) * (displayX[1] - displayX[2])) - ((displayX[0] - displayX[2])*(touchX[1] - touchX[2])));
TransMatrix[1] = ((int64_t)tmp << 16) / k;
tmp = ((touchY[0] * (((touchX[2] * displayX[1]) - (touchX[1] * displayX[2])))) + (touchY[1] * (((touchX[0] * displayX[2]) - (touchX[2] * displayX[0])))) + (touchY[2] * (((touchX[1] * displayX[0]) - (touchX[0] * displayX[1])))));
TransMatrix[2] = ((int64_t)tmp << 16) / k;
tmp = (((displayY[0] - displayY[2]) * (touchY[1] - touchY[2])) - ((displayY[1] - displayY[2])*(touchY[0] - touchY[2])));
TransMatrix[3] = ((int64_t)tmp << 16) / k;
tmp = (((touchX[0] - touchX[2]) * (displayY[1] - displayY[2])) - ((displayY[0] - displayY[2])*(touchX[1] - touchX[2])));
TransMatrix[4] = ((int64_t)tmp << 16) / k;
tmp = ((touchY[0] * (((touchX[2] * displayY[1]) - (touchX[1] * displayY[2])))) + (touchY[1] * (((touchX[0] * displayY[2]) - (touchX[2] * displayY[0])))) + (touchY[2] * (((touchX[1] * displayY[0]) - (touchX[0] * displayY[1])))));
TransMatrix[5] = ((int64_t)tmp << 16) / k;
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, TransMatrix[0]);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, TransMatrix[1]);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, TransMatrix[2]);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, TransMatrix[3]);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, TransMatrix[4]);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, TransMatrix[5]);
}
#endif // FT81X_FULL
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/EVE_commands.c | C | apache-2.0 | 63,596 |
/*
@file EVE_commands.h
@brief contains FT8xx / BT8xx function prototypes
@version 4.1 LvGL edition
@date 2020-04-13
@author Rudolph Riedel, David Jade
@section LICENSE
MIT License
Copyright (c) 2016-2020 Rudolph Riedel and David Jade
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@section History
4.1 LvGL edition
- This version is a heavily modified version of the MIT licensed FT81x code from https://github.com/RudolphRiedel/FT800-FT813
This version is based on a fork by David Jade that added native SPI DMA support and stripped out non-ESP32 code.
It has also been trimmed down to suit LvGL's needs. Extra features can be enabled by defining FT81X_FULL
*/
#include "EVE.h"
#ifndef EVE_COMMANDS_H_
#define EVE_COMMANDS_H_
#define BLOCK_TRANSFER_SIZE 3840 // block transfer size when write data to CMD buffer
void DELAY_MS(uint16_t ms);
#if EVE_USE_PDN
void EVE_pdn_set(void);
void EVE_pdn_clear(void);
#endif
void spi_acquire();
void spi_release();
void EVE_cmdWrite(uint8_t command, uint8_t parameter);
uint8_t EVE_memRead8(uint32_t ftAddress);
uint16_t EVE_memRead16(uint32_t ftAddress);
uint32_t EVE_memRead32(uint32_t ftAddress);
void EVE_memWrite8(uint32_t ftAddress, uint8_t ftData8);
void EVE_memWrite16(uint32_t ftAddress, uint16_t ftData16);
void EVE_memWrite32(uint32_t ftAddress, uint32_t ftData32);
void EVE_memWrite_buffer(uint32_t ftAddress, const uint8_t *data, uint32_t len, bool LvGL_Flush);
uint8_t EVE_busy(void);
void EVE_get_cmdoffset(void);
/* commands to operate on memory: */
void EVE_cmd_memzero(uint32_t ptr, uint32_t num);
void EVE_cmd_memset(uint32_t ptr, uint8_t value, uint32_t num);
void EVE_cmd_memwrite(uint32_t dest, uint32_t num, const uint8_t *data);
void EVE_cmd_memcpy(uint32_t dest, uint32_t src, uint32_t num);
#if FT81X_FULL
/* commands for loading image data into FT8xx memory: */
void EVE_cmd_inflate(uint32_t ptr, const uint8_t *data, uint16_t len);
void EVE_cmd_loadimage(uint32_t ptr, uint32_t options, const uint8_t *data, uint16_t len);
#if defined (FT81X_ENABLE)
void EVE_cmd_mediafifo(uint32_t ptr, uint32_t size);
#endif
#endif // FT81X_FULL
void EVE_cmd_start(void);
void EVE_cmd_execute(void);
void EVE_start_cmd_burst(void);
void EVE_end_cmd_burst(void);
void EVE_cmd_dl(uint32_t command);
#if FT81X_FULL
/* EVE3 commands */
#if defined (BT81X_ENABLE)
void EVE_cmd_flashwrite(uint32_t ptr, uint32_t num, const uint8_t *data);
void EVE_cmd_flashread(uint32_t dest, uint32_t src, uint32_t num);
void EVE_cmd_flashupdate(uint32_t dest, uint32_t src, uint32_t num);
void EVE_cmd_flasherase(void);
void EVE_cmd_flashattach(void);
void EVE_cmd_flashdetach(void);
void EVE_cmd_flashspidesel(void);
uint32_t EVE_cmd_flashfast(void);
void EVE_cmd_flashspitx(uint32_t num, const uint8_t *data);
void EVE_cmd_flashspirx(uint32_t dest, uint32_t num);
void EVE_cmd_flashsource(uint32_t ptr);
void EVE_cmd_inflate2(uint32_t ptr, uint32_t options, const uint8_t *data, uint16_t len);
void EVE_cmd_rotatearound(int32_t x0, int32_t y0, int32_t angle, int32_t scale);
void EVE_cmd_animstart(int32_t ch, uint32_t aoptr, uint32_t loop);
void EVE_cmd_animstop(int32_t ch);
void EVE_cmd_animxy(int32_t ch, int16_t x0, int16_t y0);
void EVE_cmd_animdraw(int32_t ch);
void EVE_cmd_animframe(int16_t x0, int16_t y0, uint32_t aoptr, uint32_t frame);
void EVE_cmd_gradienta(int16_t x0, int16_t y0, uint32_t argb0, int16_t x1, int16_t y1, uint32_t argb1);
void EVE_cmd_fillwidth(uint32_t s);
void EVE_cmd_appendf(uint32_t ptr, uint32_t num);
uint8_t EVE_init_flash(void);
#endif
/* commands to draw graphics objects: */
#if defined (BT81X_ENABLE)
void EVE_cmd_text_var(int16_t x0, int16_t y0, int16_t font, uint16_t options, const char* text, uint8_t numargs, ...);
void EVE_cmd_button_var(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text, uint8_t num_args, ...);
void EVE_cmd_toggle_var(int16_t x0, int16_t y0, int16_t w0, int16_t font, uint16_t options, uint16_t state, const char* text, uint8_t num_args, ...);
#endif
void EVE_cmd_text(int16_t x0, int16_t y0, int16_t font, uint16_t options, const char* text);
void EVE_cmd_button(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text);
void EVE_cmd_clock(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t hours, uint16_t minutes, uint16_t seconds, uint16_t millisecs);
void EVE_color_rgb(uint8_t red, uint8_t green, uint8_t blue);
void EVE_cmd_bgcolor(uint32_t color);
void EVE_cmd_fgcolor(uint32_t color);
void EVE_cmd_gradcolor(uint32_t color);
void EVE_cmd_gauge(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t major, uint16_t minor, uint16_t val, uint16_t range);
void EVE_cmd_gradient(int16_t x0, int16_t y0, uint32_t rgb0, int16_t x1, int16_t y1, uint32_t rgb1);
void EVE_cmd_keys(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t font, uint16_t options, const char* text);
void EVE_cmd_progress(int16_t x0, int16_t y0, int16_t w0, int16_t h0, uint16_t options, uint16_t val, uint16_t range);
void EVE_cmd_scrollbar(int16_t x0, int16_t y0, int16_t w0, int16_t h0, uint16_t options, uint16_t val, uint16_t size, uint16_t range);
void EVE_cmd_slider(int16_t x1, int16_t y1, int16_t w1, int16_t h1, uint16_t options, uint16_t val, uint16_t range);
void EVE_cmd_dial(int16_t x0, int16_t y0, int16_t r0, uint16_t options, uint16_t val);
void EVE_cmd_toggle(int16_t x0, int16_t y0, int16_t w0, int16_t font, uint16_t options, uint16_t state, const char* text);
void EVE_cmd_number(int16_t x0, int16_t y0, int16_t font, uint16_t options, int32_t number);
#endif // FT81X_FULL
#if defined (FT81X_ENABLE)
#if FT81X_FULL
void EVE_cmd_setbase(uint32_t base);
#endif
void EVE_cmd_setbitmap(uint32_t addr, uint16_t fmt, uint16_t width, uint16_t height);
#endif
#if FT81X_FULL
void EVE_cmd_append(uint32_t ptr, uint32_t num);
/* commands for setting the bitmap transform matrix: */
void EVE_cmd_getmatrix(int32_t a, int32_t b, int32_t c, int32_t d, int32_t e, int32_t f);
void EVE_cmd_translate(int32_t tx, int32_t ty);
void EVE_cmd_scale(int32_t sx, int32_t sy);
void EVE_cmd_rotate(int32_t ang);
/* other commands: */
void EVE_cmd_calibrate(void);
void EVE_cmd_interrupt(uint32_t ms);
void EVE_cmd_setfont(uint32_t font, uint32_t ptr);
#if defined (FT81X_ENABLE)
void EVE_cmd_romfont(uint32_t font, uint32_t romslot);
void EVE_cmd_setfont2(uint32_t font, uint32_t ptr, uint32_t firstchar);
void EVE_cmd_setrotate(uint32_t r);
void EVE_cmd_setscratch(uint32_t handle);
#endif
void EVE_cmd_sketch(int16_t x0, int16_t y0, uint16_t w0, uint16_t h0, uint32_t ptr, uint16_t format);
void EVE_cmd_snapshot(uint32_t ptr);
#if defined (FT81X_ENABLE)
void EVE_cmd_snapshot2(uint32_t fmt, uint32_t ptr, int16_t x0, int16_t y0, int16_t w0, int16_t h0);
#endif
void EVE_cmd_spinner(int16_t x0, int16_t y0, uint16_t style, uint16_t scale);
void EVE_cmd_track(int16_t x0, int16_t y0, int16_t w0, int16_t h0, int16_t tag);
/* commands that return values by writing to the command-fifo */
uint32_t EVE_cmd_memcrc(uint32_t ptr, uint32_t num);
uint32_t EVE_cmd_getptr(void);
uint32_t EVE_cmd_regread(uint32_t ptr);
void EVE_LIB_GetProps(uint32_t *pointer, uint32_t *width, uint32_t *height);
/* meta-commands, sequences of several display-list entries condensed into simpler to use functions at the price of some overhead */
void EVE_cmd_point(int16_t x0, int16_t y0, uint16_t size);
void EVE_cmd_line(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t w0);
void EVE_cmd_rect(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t corner);
void EVE_calibrate_manual(uint16_t height);
#endif // FT81X_FULL
/* startup FT8xx: */
uint8_t EVE_init(void);
#endif /* EVE_COMMANDS_H_ */
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/EVE_commands.h | C | apache-2.0 | 8,716 |
/*
@file EVE_config.h
@brief configuration information for some TFTs
@version 4.0
@date 2020-02-16
@author Rudolph Riedel, David Jade
@section LICENSE
MIT License
Copyright (c) 2016-2020 Rudolph Riedel amd David Jade
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@section History
4.1 LvGL edition
- This version is a heavily modified version of the MIT licensed FT81x code from https://github.com/RudolphRiedel/FT800-FT813
This version is based on a fork by David Jade that added native SPI DMA support and stripped out non-ESP32 code.
It has also been trimmed down to suit LvGL's needs. Extra features can be enabled by defining FT81X_FULL
*/
#ifndef EVE_CONFIG_H_
#define EVE_CONFIG_H_
#ifdef LV_LVGL_H_INCLUDE_SIMPLE
#include "lvgl.h"
#else
#include "lvgl/lvgl.h"
#endif
#include "../lvgl_spi_conf.h"
#include "FT81x.h"
#define EVE_CLK DISP_SPI_CLK // orange
#define EVE_MISO DISP_SPI_MISO // yellow
#define EVE_MOSI DISP_SPI_MOSI // green
#define EVE_CS DISP_SPI_CS // blue
#define EVE_PDN CONFIG_LV_DISP_PIN_RST // grey
#define EVE_USE_PDN CONFIG_LV_DISP_USE_RST
#define SPI_TRANSER_SIZE (DISP_BUF_SIZE * (LV_COLOR_DEPTH / 8))
#define BYTES_PER_PIXEL (LV_COLOR_DEPTH / 8) // bytes per pixel for (16 for RGB565)
#define BYTES_PER_LINE (EVE_HSIZE * BYTES_PER_PIXEL)
#define SCREEN_BUFFER_SIZE (EVE_HSIZE * EVE_VSIZE * BYTES_PER_PIXEL)
#define SPI_BUFFER_SIZE 256 // size in bytes (multiples of 4) of SPI transaction buffer for streaming commands
/* select the settings for the TFT attached */
#if 0
#define EVE_VM800B35A
#define EVE_VM800B43A
#define EVE_VM800B50A
#define EVE_VM810C
#define EVE_ME812A
#define EVE_ME813A
#define EVE_FT810CB_HY50HD
#define EVE_FT811CB_HY50HD
#define EVE_ET07
#define EVE_RVT28
#define EVE_RVT35
#define EVE_RVT43
#define EVE_RVT50
#define EVE_RVT70
#define EVE_RiTFT43
#define EVE_RiTFT50
#define EVE_RiTFT70
#define EVE_EVE2_29
#define EVE_EVE2_35
#define EVE_EVE2_35G
#define EVE_EVE2_38
#define EVE_EVE2_38G
#define EVE_EVE2_43
#define EVE_EVE2_43G
#define EVE_EVE2_50
#define EVE_EVE2_50G
#define EVE_EVE2_70
#define EVE_EVE2_70G
#define EVE_EVE3_35
#define EVE_EVE3_35G
#define EVE_EVE3_43
#define EVE_EVE3_43G
#define EVE_EVE3_50
#define EVE_EVE3_50G
#define EVE_EVE3_70
#define EVE_EVE3_70G
#define EVE_NHD_35
#define EVE_NHD_43
#define EVE_NHD_50
#define EVE_NHD_70
#define EVE_ADAM101
#define EVE_CFAF240400C1_030SC
#define EVE_CFAF320240F_035T
#define EVE_CFAF480128A0_039TC
#define EVE_CFAF800480E0_050SC
#define EVE_PAF90
#define EVE_SUNFLOWER
#define EVE_CONNECTEVE
#endif
#if defined(CONFIG_LV_FT81X_CONFIG_EVE_VM800B35A)
#define EVE_VM800B35A
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_VM800B43A)
#define EVE_VM800B43A
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_VM800B50A)
#define EVE_VM800B50A
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_VM810C)
#define EVE_VM810C
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_ME812A)
#define EVE_ME812A
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_ME813A)
#define EVE_ME813A
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_FT810CB_HY50HD)
#define EVE_FT810CB_HY50HD
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_FT811CB_HY50HD)
#define EVE_FT811CB_HY50HD
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_ET07)
#define EVE_ET07
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RVT28)
#define EVE_RVT28
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RVT35)
#define EVE_RVT35
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RVT43)
#define EVE_RVT43
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RVT50)
#define EVE_RVT50
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RVT70)
#define EVE_RVT70
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RiTFT43)
#define EVE_RiTFT43
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RiTFT50)
#define EVE_RiTFT50
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_RiTFT70)
#define EVE_RiTFT70
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_29)
#define EVE_EVE2_29
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_35)
#define EVE_EVE2_35
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_35G)
#define EVE_EVE2_35G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_38)
#define EVE_EVE2_38
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_38G)
#define EVE_EVE2_38G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_43)
#define EVE_EVE2_43
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_43G)
#define EVE_EVE2_43G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_50)
#define EVE_EVE2_50
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_50G)
#define EVE_EVE2_50G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_70)
#define EVE_EVE2_70
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE2_70G)
#define EVE_EVE2_70G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_35)
#define EVE_EVE3_35
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_35G)
#define EVE_EVE3_35G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_43)
#define EVE_EVE3_43
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_43G)
#define EVE_EVE3_43G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_50)
#define EVE_EVE3_50
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_50G)
#define EVE_EVE3_50G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_70)
#define EVE_EVE3_70
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_EVE3_70G)
#define EVE_EVE3_70G
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_NHD_35)
#define EVE_NHD_35
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_NHD_43)
#define EVE_NHD_43
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_NHD_50)
#define EVE_NHD_50
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_NHD_70)
#define EVE_NHD_70
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_ADAM101)
#define EVE_ADAM101
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_CFAF240400C1_030SC)
#define EVE_CFAF240400C1_030SC
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_CFAF320240F_035T)
#define EVE_CFAF320240F_035T
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_CFAF480128A0_039TC)
#define EVE_CFAF480128A0_039TC
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_CFAF800480E0_050SC)
#define EVE_CFAF800480E0_050SC
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_PAF90)
#define EVE_PAF90
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_SUNFLOWER)
#define EVE_SUNFLOWER
#elif defined(CONFIG_LV_FT81X_CONFIG_EVE_CONNECTEVE)
#define EVE_CONNECTEVE
#endif
/* display timing parameters below */
/* untested */
#if defined (EVE_EVE3_35)
#define EVE_EVE2_35
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_EVE3_35G)
#define EVE_EVE2_35G
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_EVE3_43)
#define EVE_EVE2_43
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
#if defined (EVE_EVE3_43G)
#define EVE_EVE2_43G
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_EVE3_50)
#define EVE_EVE2_50
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
#if defined (EVE_EVE3_50G)
#define EVE_EVE2_50G
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_EVE3_70)
#define EVE_EVE2_70
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_EVE3_70G)
#define EVE_EVE2_70G
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
#if defined (EVE_RiTFT43)
#define EVE_RVT43
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_RiTFT50)
#define EVE_RVT70
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* untested */
#if defined (EVE_RiTFT70)
#define EVE_RVT70
#define EVE_HAS_CRYSTAL
#define BT81X_ENABLE
#endif
/* some test setup */
#if defined (EVE_800x480x)
#define EVE_HSIZE (800L) /* Thd Length of visible part of line (in PCLKs) - display width */
#define EVE_VSIZE (480L) /* Tvd Number of visible lines (in lines) - display height */
#define EVE_VSYNC0 (0L) /* Tvf Vertical Front Porch */
#define EVE_VSYNC1 (10L) /* Tvf + Tvp Vertical Front Porch plus Vsync Pulse width */
#define EVE_VOFFSET (35L) /* Tvf + Tvp + Tvb Number of non-visible lines (in lines) */
#define EVE_VCYCLE (516L) /* Tv Total number of lines (visible and non-visible) (in lines) */
#define EVE_HSYNC0 (0L) /* (40L) // Thf Horizontal Front Porch */
#define EVE_HSYNC1 (88L) /* Thf + Thp Horizontal Front Porch plus Hsync Pulse width */
#define EVE_HOFFSET (169L) /* Thf + Thp + Thb Length of non-visible part of line (in PCLK cycles) */
#define EVE_HCYCLE (969L) /* Th Total length of line (visible and non-visible) (in PCLKs) */
#define EVE_PCLKPOL (1L) /* PCLK polarity (0 = rising edge, 1 = falling edge) */
#define EVE_SWIZZLE (0L) /* Defines the arrangement of the RGB pins of the FT800 */
#define EVE_PCLK (2L) /* 60MHz / REG_PCLK = PCLK frequency 30 MHz */
#define EVE_CSPREAD (1L) /* helps with noise, when set to 1 fewer signals are changed simultaneously, reset-default: 1 */
#define EVE_TOUCH_RZTHRESH (1200L) /* touch-sensitivity */
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* VM800B35A: FT800 320x240 3.5" FTDI FT800 */
#if defined (EVE_VM800B35A)
#define EVE_HSIZE (320L) /* Thd Length of visible part of line (in PCLKs) - display width */
#define EVE_VSIZE (240L) /* Tvd Number of visible lines (in lines) - display height */
#define EVE_VSYNC0 (0L) /* Tvf Vertical Front Porch */
#define EVE_VSYNC1 (2L) /* Tvf + Tvp Vertical Front Porch plus Vsync Pulse width */
#define EVE_VOFFSET (13L) /* Tvf + Tvp + Tvb Number of non-visible lines (in lines) */
#define EVE_VCYCLE (263L) /* Tv Total number of lines (visible and non-visible) (in lines) */
#define EVE_HSYNC0 (0L) /* Thf Horizontal Front Porch */
#define EVE_HSYNC1 (10L) /* Thf + Thp Horizontal Front Porch plus Hsync Pulse width */
#define EVE_HOFFSET (70L) /* Thf + Thp + Thb Length of non-visible part of line (in PCLK cycles) */
#define EVE_HCYCLE (408L) /* Th Total length of line (visible and non-visible) (in PCLKs) */
#define EVE_PCLKPOL (0L) /* PCLK polarity (0 = rising edge, 1 = falling edge) */
#define EVE_SWIZZLE (2L) /* Defines the arrangement of the RGB pins of the FT800 */
#define EVE_PCLK (8L) /* 48MHz / REG_PCLK = PCLK frequency */
#define EVE_CSPREAD (1L) /* helps with noise, when set to 1 fewer signals are changed simultaneously, reset-default: 1 */
#define EVE_TOUCH_RZTHRESH (1200L) /* touch-sensitivity */
#define EVE_HAS_CRYSTAL /* use external crystal or internal oscillator? */
#endif
/* FTDI/BRT EVE modules VM800B43A and VM800B50A FT800 480x272 4.3" and 5.0" */
#if defined (EVE_VM800B43A) || defined (EVE_VM800B50A)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#endif
/* untested */
/* FTDI/BRT EVE2 modules VM810C50A-D, ME812A-WH50R and ME813A-WH50C, 800x480 5.0" */
#if defined (EVE_VM810C) || defined (EVE_ME812A) || defined (EVE_ME813A)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* FT810CB-HY50HD: FT810 800x480 5.0" HAOYU */
#if defined (EVE_FT810CB_HY50HD)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (13L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (20L)
#define EVE_HOFFSET (64L)
#define EVE_HCYCLE (952L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (2000L) /* touch-sensitivity */
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* FT811CB-HY50HD: FT811 800x480 5.0" HAOYU */
#if defined (EVE_FT811CB_HY50HD)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (13L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (20L)
#define EVE_HOFFSET (64L)
#define EVE_HCYCLE (952L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L) /* touch-sensitivity */
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* untested */
/* G-ET0700G0DM6 800x480 7.0" Glyn */
#if defined (EVE_ET07)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (35L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (128L)
#define EVE_HOFFSET (203L)
#define EVE_HCYCLE (1056L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* untested */
/* RVT28 240x320 2.8" Riverdi, various options, FT800/FT801 */
#if defined (EVE_RVT28)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (2L)
#define EVE_VCYCLE (326L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (20L)
#define EVE_HCYCLE (270L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (4L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#endif
/* untested */
/* RVT3.5 320x240 3.5" Riverdi, various options, FT800/FT801 */
#if defined (EVE_RVT35)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (13L)
#define EVE_VCYCLE (263L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (2L)
#define EVE_PCLK (6L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#endif
/* untested */
/* RVT43 / RVT4.3 480x272 4.3" Riverdi, various options, FT800/FT801 */
#if defined (EVE_RVT43)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#endif
/* untested */
/* RVT50xQFxxxxx 800x480 5.0" Riverdi, various options, FT812/FT813 */
#if defined (EVE_RVT50)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* RVT70xQFxxxxx 800x480 7.0" Riverdi, various options, FT812/FT813, tested with RVT70UQFNWC0x */
#if defined (EVE_RVT70)
#define EVE_HSIZE (800L) /* Thd Length of visible part of line (in PCLKs) - display width */
#define EVE_VSIZE (480L) /* Tvd Number of visible lines (in lines) - display height */
#define EVE_VSYNC0 (0L) /* Tvf Vertical Front Porch */
#define EVE_VSYNC1 (10L) /* Tvf + Tvp Vertical Front Porch plus Vsync Pulse width */
#define EVE_VOFFSET (23L) /* Tvf + Tvp + Tvb Number of non-visible lines (in lines) */
#define EVE_VCYCLE (525L) /* Tv Total number of lines (visible and non-visible) (in lines) */
#define EVE_HSYNC0 (0L) /* Thf Horizontal Front Porch */
#define EVE_HSYNC1 (10L) /* Thf + Thp Horizontal Front Porch plus Hsync Pulse width */
#define EVE_HOFFSET (46L) /* Thf + Thp + Thb Length of non-visible part of line (in PCLK cycles) */
#define EVE_HCYCLE (1056L) /* Th Total length of line (visible and non-visible) (in PCLKs) */
#define EVE_PCLKPOL (1L) /* PCLK polarity (0 = rising edge, 1 = falling edge) */
#define EVE_SWIZZLE (0L) /* Defines the arrangement of the RGB pins of the FT800 */
#define EVE_PCLK (2L) /* 60MHz / REG_PCLK = PCLK frequency 30 MHz */
#define EVE_CSPREAD (1L) /* helps with noise, when set to 1 fewer signals are changed simultaneously, reset-default: 1 */
#define EVE_TOUCH_RZTHRESH (1800L) /* touch-sensitivity */
#define FT81X_ENABLE
#endif
/* untested */
/* EVE2-29A 320x102 2.9" 1U Matrix Orbital, non-touch, FT812 */
#if defined (EVE_EVE2_29)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (102L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (156L)
#define EVE_VCYCLE (262L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (8L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* EVE2-35A 320x240 3.5" Matrix Orbital, resistive, or non-touch, FT812 */
#if defined (EVE_EVE2_35)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (18L)
#define EVE_VCYCLE (262L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (8L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* EVE2-35G 320x240 3.5" Matrix Orbital, capacitive touch, FT813 */
#if defined (EVE_EVE2_35G)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (18L)
#define EVE_VCYCLE (262L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (8L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_GT911 /* special treatment required for out-of-spec touch-controller */
#define FT81X_ENABLE
#endif
/* EVE2-38A 480x116 3.8" 1U Matrix Orbital, resistive touch, FT812 */
#if defined (EVE_EVE2_38)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (152L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* EVE2-38G 480x116 3.8" 1U Matrix Orbital, capacitive touch, FT813 */
#if defined (EVE_EVE2_38G)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (152L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_GT911 /* special treatment required for out-of-spec touch-controller */
#define FT81X_ENABLE
#endif
/* untested */
/* EVE2-43A 480x272 4.3" Matrix Orbital, resistive or no touch, FT812 */
#if defined (EVE_EVE2_43)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* EVE2-43G 480x272 4.3" Matrix Orbital, capacitive touch, FT813 */
#if defined (EVE_EVE2_43G)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_GT911 /* special treatment required for out-of-spec touch-controller */
#define FT81X_ENABLE
#endif
/* untested */
/* Matrix Orbital EVE2 modules EVE2-50A, EVE2-70A : 800x480 5.0" and 7.0" resistive, or no touch, FT812 */
#if defined (EVE_EVE2_50) || defined (EVE_EVE2_70)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* Matrix Orbital EVE2 modules EVE2-50G, EVE2-70G : 800x480 5.0" and 7.0" capacitive touch, FT813 */
#if defined (EVE_EVE2_50G) || defined (EVE_EVE2_70G)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_GT911 /* special treatment required for out-of-spec touch-controller */
#define FT81X_ENABLE
#endif
/* NHD-3.5-320240FT-CxXx-xxx 320x240 3.5" Newhaven, resistive or capacitive, FT81x */
#if defined (EVE_NHD_35)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (13L)
#define EVE_VCYCLE (263L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (2L)
#define EVE_PCLK (6L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* untested */
/* NHD-4.3-480272FT-CxXx-xxx 480x272 4.3" Newhaven, resistive or capacitive, FT81x */
#if defined (EVE_NHD_43)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (292L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (548L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* untested */
/* NHD-5.0-800480FT-CxXx-xxx 800x480 5.0" Newhaven, resistive or capacitive, FT81x */
#if defined (EVE_NHD_50)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* untested */
/* NHD-7.0-800480FT-CxXx-xxx 800x480 7.0" Newhaven, resistive or capacitive, FT81x */
#if defined (EVE_NHD_70)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (3L)
#define EVE_VOFFSET (32L)
#define EVE_VCYCLE (525L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (48L)
#define EVE_HOFFSET (88L)
#define EVE_HCYCLE (928L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* ADAM101-LCP-SWVGA-NEW 1024x600 10.1" Glyn, capacitive, FT813 */
#if defined (EVE_ADAM101)
#define EVE_HSIZE (1024L)
#define EVE_VSIZE (600L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (1L)
#define EVE_VOFFSET (1L)
#define EVE_VCYCLE (720L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (1L)
#define EVE_HOFFSET (1L)
#define EVE_HCYCLE (1100L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (1L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* Crystalfonts CFAF240400C1-030SC 240x400 3.0" , FT811 capacitive touch */
#if defined (EVE_CFAF240400C1_030SC)
#define EVE_HSIZE (240L)
#define EVE_VSIZE (400L)
#define EVE_VSYNC0 (4L)
#define EVE_VSYNC1 (6L)
#define EVE_VOFFSET (8L)
#define EVE_VCYCLE (409L)
#define EVE_HSYNC0 (10L)
#define EVE_HSYNC1 (20L)
#define EVE_HOFFSET (40L)
#define EVE_HCYCLE (489L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (2L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* Crystalfonts CFAF320240F-035T 320x240 3.5" , FT810 resistive touch */
#if defined (EVE_CFAF320240F_035T)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (1L)
#define EVE_VSYNC1 (4L)
#define EVE_VOFFSET (4L)
#define EVE_VCYCLE (245L)
#define EVE_HSYNC0 (10L)
#define EVE_HSYNC1 (20L)
#define EVE_HOFFSET (40L)
#define EVE_HCYCLE (510L)
#define EVE_PCLKPOL (0L)
#define EVE_SWIZZLE (2L)
#define EVE_PCLK (8L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* Crystalfonts CFAF480128A0-039TC 480x128 3.9" , FT811 capacitive touch */
#if defined (EVE_CFAF480128A0_039TC)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (128L)
#define EVE_VSYNC0 (4L)
#define EVE_VSYNC1 (5L)
#define EVE_VOFFSET (8L)
#define EVE_VCYCLE (137L)
#define EVE_HSYNC0 (24L)
#define EVE_HSYNC1 (35L)
#define EVE_HOFFSET (41L)
#define EVE_HCYCLE (1042L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (7L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define FT81X_ENABLE
#endif
/* Crystalfonts CFAF800480E0-050SC 800x480 5.0" , FT813 capacitive touch */
#if defined (EVE_CFAF800480E0_050SC)
#define EVE_HSIZE (800L)
#define EVE_VSIZE (480L)
#define EVE_VSYNC0 (7L)
#define EVE_VSYNC1 (8L)
#define EVE_VOFFSET (30L)
#define EVE_VCYCLE (511L)
#define EVE_HSYNC0 (16L)
#define EVE_HSYNC1 (17L)
#define EVE_HOFFSET (62L)
#define EVE_HCYCLE (978L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (2L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_GT911
#define FT81X_ENABLE
#endif
/* PAF90B5WFNWC01 800x480 9.0" Panasys, BT815 */
#if defined (EVE_PAF90)
#define EVE_HSIZE (800L) /* Thd Length of visible part of line (in PCLKs) - display width */
#define EVE_VSIZE (480L) /* Tvd Number of visible lines (in lines) - display height */
#define EVE_VSYNC0 (0L) /* Tvf Vertical Front Porch */
#define EVE_VSYNC1 (10L) /* Tvf + Tvp Vertical Front Porch plus Vsync Pulse width */
#define EVE_VOFFSET (23L) /* Tvf + Tvp + Tvb Number of non-visible lines (in lines) */
#define EVE_VCYCLE (525L) /* Tv Total number of lines (visible and non-visible) (in lines) */
#define EVE_HSYNC0 (0L) /* Thf Horizontal Front Porch */
#define EVE_HSYNC1 (10L) /* Thf + Thp Horizontal Front Porch plus Hsync Pulse width */
#define EVE_HOFFSET (46L) /* Thf + Thp + Thb Length of non-visible part of line (in PCLK cycles) */
#define EVE_HCYCLE (1056L) /* Th Total length of line (visible and non-visible) (in PCLKs) */
#define EVE_PCLKPOL (1L) /* PCLK polarity (0 = rising edge, 1 = falling edge) */
#define EVE_SWIZZLE (0L) /* Defines the arrangement of the RGB pins of the FT800 */
#define EVE_PCLK (2L) /* 60MHz / REG_PCLK = PCLK frequency 30 MHz */
#define EVE_CSPREAD (1L) /* helps with noise, when set to 1 fewer signals are changed simultaneously, reset-default: 1 */
#define EVE_TOUCH_RZTHRESH (1200L) /* touch-sensitivity */
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#define BT81X_ENABLE
#endif
/* untested */
/* Sunflower Arduino Shield, 320x240 3.5" from Cowfish, FT813, https://github.com/Cowfish-Studios/Cowfish_Sunflower_Shield_PCB */
/* set EVE_CS to 6 and EVE_PDN to 5 in the Arduino block in EVE_target.h */
#if defined (EVE_SUNFLOWER)
#define EVE_HSIZE (320L)
#define EVE_VSIZE (240L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (2L)
#define EVE_VOFFSET (13L)
#define EVE_VCYCLE (263L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (10L)
#define EVE_HOFFSET (70L)
#define EVE_HCYCLE (408L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (2L)
#define EVE_PCLK (6L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (1200L)
#define EVE_HAS_CRYSTAL
#define FT81X_ENABLE
#endif
/* untested */
/* MikroElektronika ConnectEVE, FT800 480x272 4.3" */
#if defined (EVE_CONNECTEVE)
#define EVE_HSIZE (480L)
#define EVE_VSIZE (272L)
#define EVE_VSYNC0 (0L)
#define EVE_VSYNC1 (10L)
#define EVE_VOFFSET (12L)
#define EVE_VCYCLE (286L)
#define EVE_HSYNC0 (0L)
#define EVE_HSYNC1 (41L)
#define EVE_HOFFSET (43L)
#define EVE_HCYCLE (525L)
#define EVE_PCLKPOL (1L)
#define EVE_SWIZZLE (0L)
#define EVE_PCLK (5L)
#define EVE_CSPREAD (0L)
#define EVE_TOUCH_RZTHRESH (2000L)
#define EVE_HAS_CRYSTAL
#endif
#endif /* EVE_CONFIG_H */
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/EVE_config.h | C | apache-2.0 | 30,006 |
#include <stdio.h>
#include "driver/gpio.h"
#include "FT81x.h"
#include "EVE.h"
#include "EVE_commands.h"
/* some pre-definded colors */
#define RED 0xff0000UL
#define ORANGE 0xffa500UL
#define GREEN 0x00ff00UL
#define BLUE 0x0000ffUL
#define BLUE_1 0x5dade2L
#define YELLOW 0xffff00UL
#define PINK 0xff00ffUL
#define PURPLE 0x800080UL
#define WHITE 0xffffffUL
#define BLACK 0x000000UL
/* memory-map defines */
#define SCREEN_BITMAP_ADDR 0x00000000 // full screen buffer (0x00000000 - 0x000BBE40)
uint8_t tft_active = 0;
void touch_calibrate(void)
{
/* send pre-recorded touch calibration values, depending on the display the code is compiled for */
#if defined (EVE_CFAF240400C1_030SC)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x0000ed11);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x00001139);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff76809);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x00000000);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00010690);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xfffadf2e);
#endif
#if defined (EVE_CFAF320240F_035T)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x00005614);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x0000009e);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff43422);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x0000001d);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0xffffbda4);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x00f8f2ef);
#endif
#if defined (EVE_CFAF480128A0_039TC)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x00010485);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x0000017f);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfffb0bd3);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x00000073);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0000e293);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x00069904);
#endif
#if defined (EVE_CFAF800480E0_050SC)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000107f9);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0xffffff8c);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff451ae);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x000000d2);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0000feac);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xfffcfaaf);
#endif
#if defined (EVE_PAF90)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x00000159);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x0001019c);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff93625);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x00010157);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00000000);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x0000c101);
#endif
#if defined (EVE_RiTFT43)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000062cd);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0xfffffe45);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff45e0a);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x000001a3);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00005b33);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xFFFbb870);
#endif
#if defined (EVE_EVE2_38)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x00007bed);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x000001b0);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfff60aa5);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x00000095);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0xffffdcda);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x00829c08);
#endif
#if defined (EVE_EVE2_35G)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000109E4);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x000007A6);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xFFEC1EBA);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x0000072C);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0001096A);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xFFF469CF);
#endif
#if defined (EVE_EVE2_43G)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x0000a1ff);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x00000680);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xffe54cc2);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0xffffff53);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0000912c);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xfffe628d);
#endif
#if defined (EVE_EVE2_50G)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000109E4);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x000007A6);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xFFEC1EBA);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x0000072C);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0001096A);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xFFF469CF);
#endif
#if defined (EVE_EVE2_70G)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000105BC);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0xFFFFFA8A);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0x00004670);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0xFFFFFF75);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00010074);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xFFFF14C8);
#endif
#if defined (EVE_NHD_35)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x0000f78b);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x00000427);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfffcedf8);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0xfffffba4);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x0000f756);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x0009279e);
#endif
#if defined (EVE_RVT70)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000074df);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x000000e6);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xfffd5474);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0x000001af);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00007e79);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0xffe9a63c);
#endif
#if defined (EVE_FT811CB_HY50HD)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 66353);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 712);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 4293876677);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 4294966157);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 67516);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 418276);
#endif
#if defined (EVE_ADAM101)
EVE_memWrite32(REG_TOUCH_TRANSFORM_A, 0x000101E3);
EVE_memWrite32(REG_TOUCH_TRANSFORM_B, 0x00000114);
EVE_memWrite32(REG_TOUCH_TRANSFORM_C, 0xFFF5EEBA);
EVE_memWrite32(REG_TOUCH_TRANSFORM_D, 0xFFFFFF5E);
EVE_memWrite32(REG_TOUCH_TRANSFORM_E, 0x00010226);
EVE_memWrite32(REG_TOUCH_TRANSFORM_F, 0x0000C783);
#endif
/* activate this if you are using a module for the first time or if you need to re-calibrate it */
/* write down the numbers on the screen and either place them in one of the pre-defined blocks above or make a new block */
// Note: requires FT81x_FULL to be defined
#if 0
/* calibrate touch and displays values to screen */
EVE_cmd_dl(CMD_DLSTART);
EVE_cmd_dl(DL_CLEAR_RGB | BLACK);
EVE_cmd_dl(DL_CLEAR | CLR_COL | CLR_STN | CLR_TAG);
EVE_cmd_text((EVE_HSIZE/2), 50, 26, EVE_OPT_CENTER, "Please tap on the dot.");
EVE_cmd_calibrate();
EVE_cmd_dl(DL_DISPLAY);
EVE_cmd_dl(CMD_SWAP);
EVE_cmd_execute();
uint32_t touch_a, touch_b, touch_c, touch_d, touch_e, touch_f;
touch_a = EVE_memRead32(REG_TOUCH_TRANSFORM_A);
touch_b = EVE_memRead32(REG_TOUCH_TRANSFORM_B);
touch_c = EVE_memRead32(REG_TOUCH_TRANSFORM_C);
touch_d = EVE_memRead32(REG_TOUCH_TRANSFORM_D);
touch_e = EVE_memRead32(REG_TOUCH_TRANSFORM_E);
touch_f = EVE_memRead32(REG_TOUCH_TRANSFORM_F);
EVE_cmd_dl(CMD_DLSTART);
EVE_cmd_dl(DL_CLEAR_RGB | BLACK);
EVE_cmd_dl(DL_CLEAR | CLR_COL | CLR_STN | CLR_TAG);
EVE_cmd_dl(TAG(0));
EVE_cmd_text(5, 15, 26, 0, "TOUCH_TRANSFORM_A:");
EVE_cmd_text(5, 30, 26, 0, "TOUCH_TRANSFORM_B:");
EVE_cmd_text(5, 45, 26, 0, "TOUCH_TRANSFORM_C:");
EVE_cmd_text(5, 60, 26, 0, "TOUCH_TRANSFORM_D:");
EVE_cmd_text(5, 75, 26, 0, "TOUCH_TRANSFORM_E:");
EVE_cmd_text(5, 90, 26, 0, "TOUCH_TRANSFORM_F:");
#if defined (FT81X_ENABLE)
EVE_cmd_setbase(16L); /* FT81x only */
EVE_cmd_number(310, 15, 26, EVE_OPT_RIGHTX|8, touch_a);
EVE_cmd_number(310, 30, 26, EVE_OPT_RIGHTX|8, touch_b);
EVE_cmd_number(310, 45, 26, EVE_OPT_RIGHTX|8, touch_c);
EVE_cmd_number(310, 60, 26, EVE_OPT_RIGHTX|8, touch_d);
EVE_cmd_number(310, 75, 26, EVE_OPT_RIGHTX|8, touch_e);
EVE_cmd_number(310, 90, 26, EVE_OPT_RIGHTX|8, touch_f);
#else
EVE_cmd_number(310, 15, 26, EVE_OPT_RIGHTX, touch_a);
EVE_cmd_number(310, 30, 26, EVE_OPT_RIGHTX, touch_b);
EVE_cmd_number(310, 45, 26, EVE_OPT_RIGHTX, touch_c);
EVE_cmd_number(310, 60, 26, EVE_OPT_RIGHTX, touch_d);
EVE_cmd_number(310, 75, 26, EVE_OPT_RIGHTX, touch_e);
EVE_cmd_number(310, 90, 26, EVE_OPT_RIGHTX, touch_f);
#endif
EVE_cmd_dl(DL_DISPLAY); /* instruct the graphics processor to show the list */
EVE_cmd_dl(CMD_SWAP); /* make this list active */
EVE_cmd_execute();
while(1);
#endif
}
// set up a display list for a fullscreen writable bitmap
void TFT_bitmap_display(void)
{
if(tft_active != 0)
{
EVE_start_cmd_burst(); /* start writing to the cmd-fifo as one stream of bytes, only sending the address once */
EVE_cmd_dl(CMD_DLSTART); /* start the display list */
EVE_cmd_dl(DL_CLEAR_RGB | BLACK); /* set the default clear color to black */
EVE_cmd_dl(DL_CLEAR | CLR_COL | CLR_STN | CLR_TAG); /* clear the screen - this and the previous prevent artifacts between lists, Attributes are the color, stencil and tag buffers */
EVE_cmd_dl(TAG(0));
// fullscreen bitmap for memory-mapped direct access
EVE_cmd_dl(TAG(20));
EVE_cmd_setbitmap(SCREEN_BITMAP_ADDR, EVE_RGB565, EVE_HSIZE, EVE_VSIZE);
EVE_cmd_dl(DL_BEGIN | EVE_BITMAPS);
EVE_cmd_dl(VERTEX2F(0, 0));
EVE_cmd_dl(DL_END);
EVE_cmd_dl(TAG(0));
EVE_cmd_dl(DL_DISPLAY); /* instruct the graphics processor to show the list */
EVE_cmd_dl(CMD_SWAP); /* make this list active */
EVE_end_cmd_burst(); /* stop writing to the cmd-fifo */
EVE_cmd_start(); /* order the command co-processor to start processing its FIFO queue but do not wait for completion */
}
}
void FT81x_init(void)
{
#if EVE_USE_PDN
gpio_pad_select_gpio(EVE_PDN);
#endif
gpio_set_level(EVE_CS, 1);
#if EVE_USE_PDN
gpio_set_direction(EVE_PDN, GPIO_MODE_OUTPUT);
#endif
spi_acquire();
if(EVE_init())
{
tft_active = 1;
EVE_memWrite8(REG_PWM_DUTY, 0x30); /* setup backlight, range is from 0 = off to 0x80 = max */
touch_calibrate();
EVE_cmd_memset(SCREEN_BITMAP_ADDR, BLACK, SCREEN_BUFFER_SIZE); // clear screen buffer
EVE_cmd_execute();
TFT_bitmap_display(); // set DL for fullscreen bitmap display
}
spi_release();
}
// write fullscreen bitmap directly
void TFT_WriteScreen(uint8_t* Bitmap)
{
EVE_memWrite_buffer(SCREEN_BITMAP_ADDR, Bitmap, SCREEN_BUFFER_SIZE, false);
}
// write bitmap directly, line-by-line
void TFT_WriteBitmap(uint8_t* Bitmap, uint16_t X, uint16_t Y, uint16_t Width, uint16_t Height)
{
// calc base address
uint32_t addr = SCREEN_BITMAP_ADDR + (Y * BYTES_PER_LINE) + (X * BYTES_PER_PIXEL);
// can we do a fast full width block transfer?
if(X == 0 && Width == EVE_HSIZE)
{
EVE_memWrite_buffer(addr, Bitmap, (Height * BYTES_PER_LINE), true);
}
else
{
// line by line mode
uint32_t bpl = Width * BYTES_PER_PIXEL;
for (uint16_t i = 0; i < Height; i++)
{
EVE_memWrite_buffer(addr, Bitmap + (i * bpl), bpl, (i == Height - 1));
addr += BYTES_PER_LINE;
}
}
}
// LittlevGL flush callback
void FT81x_flush(lv_disp_drv_t * drv, const lv_area_t * area, lv_color_t * color_map)
{
TFT_WriteBitmap((uint8_t*)color_map, area->x1, area->y1, lv_area_get_width(area), lv_area_get_height(area));
}
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/FT81x.c | C | apache-2.0 | 10,960 |
#ifndef FT81X_H_
#define FT81X_H_
#include <stdint.h>
#ifdef LV_LVGL_H_INCLUDE_SIMPLE
#include "lvgl.h"
#else
#include "lvgl/lvgl.h"
#endif
#include "../lvgl_helpers.h"
void FT81x_init(void);
void FT81x_flush(lv_disp_drv_t * drv, const lv_area_t * area, lv_color_t * color_map);
#endif /* FT81X_H_ */
| YifuLiu/AliOS-Things | components/little_ui/driver/lvgl_esp32_drivers/lvgl_tft/FT81x.h | C | apache-2.0 | 306 |