slm_at_host.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef SLM_AT_HOST_
#define SLM_AT_HOST_
 
#include <zephyr/types.h>
#include <ctype.h>
#include <nrf_modem_at.h>
#include <modem/at_monitor.h>
#include <modem/at_cmd_custom.h>
#include <modem/at_parser.h>
#include "slm_defines.h"
 
/* This delay is necessary to send AT responses at low baud rates. */
#define SLM_UART_RESPONSE_DELAY K_MSEC(50)
 
#define SLM_DATAMODE_FLAGS_NONE 0
#define SLM_DATAMODE_FLAGS_MORE_DATA (1 << 0)
#define SLM_DATAMODE_FLAGS_EXIT_HANDLER (1 << 1)
 
extern uint8_t slm_data_buf[SLM_MAX_MESSAGE_SIZE];  /* For socket data. */
extern uint8_t slm_at_buf[SLM_AT_MAX_CMD_LEN + 1]; /* AT command buffer. */
 
extern uint16_t slm_datamode_time_limit; /* Send trigger by time in data mode. */
 
enum slm_datamode_operation {
        DATAMODE_SEND,  /* Send data in datamode */
        DATAMODE_EXIT   /* Exit data mode */
};
 
typedef int (*slm_datamode_handler_t)(uint8_t op, const uint8_t *data, int len, uint8_t flags);
 
/* All the AT backend API functions return 0 on success. */
struct slm_at_backend {
        int (*start)(void);
        int (*send)(const uint8_t *data, size_t len);
        int (*stop)(void);
};
int slm_at_set_backend(struct slm_at_backend backend);
 
int slm_at_send(const uint8_t *data, size_t len);
 
int slm_at_send_str(const char *str);
 
void slm_at_receive(const uint8_t *data, size_t len);
 
int slm_at_host_init(void);
 
int slm_at_host_power_off(void);
 
int slm_at_host_power_on(void);
 
void slm_at_host_uninit(void);
 
void rsp_send(const char *fmt, ...);
 
void rsp_send_ok(void);
 
void rsp_send_error(void);
 
void data_send(const uint8_t *data, size_t len);
 
int enter_datamode(slm_datamode_handler_t handler);
 
bool in_datamode(void);
 
bool exit_datamode_handler(int result);
 
typedef int slm_at_callback(enum at_parser_cmd_type cmd_type, struct at_parser *parser,
                            uint32_t param_count);
 
int slm_at_cb_wrapper(char *buf, size_t len, char *at_cmd, slm_at_callback cb);
 
#define SLM_AT_CMD_CUSTOM(entry, _filter, _callback)                                               \
        static int _callback(enum at_parser_cmd_type cmd_type, struct at_parser *parser,           \
                             uint32_t);                                                            \
        static int _callback##_wrapper_##entry(char *buf, size_t len, char *at_cmd)                \
        {                                                                                          \
                return slm_at_cb_wrapper(buf, len, at_cmd, _callback);                             \
        }                                                                                          \
        AT_CMD_CUSTOM(entry, _filter, _callback##_wrapper_##entry);
 
#endif /* SLM_AT_HOST_ */