modem_slm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef MODEM_SLM_H_
#define MODEM_SLM_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdbool.h>
#include <zephyr/types.h>
#include <zephyr/kernel.h>
#include <zephyr/sys/util_macro.h>
#include <zephyr/toolchain.h>
 
#define SLM_AT_CMD_RESPONSE_MAX_LEN 2100
 
enum at_cmd_state {
        AT_CMD_OK,
        AT_CMD_ERROR,
        AT_CMD_ERROR_CMS,
        AT_CMD_ERROR_CME,
        AT_CMD_PENDING
};
 
typedef void (*slm_data_handler_t)(const uint8_t *data, size_t datalen);
 
typedef void (*slm_ind_handler_t)(void);
 
int modem_slm_init(slm_data_handler_t handler);
 
int modem_slm_uninit(void);
 
int modem_slm_register_ind(slm_ind_handler_t handler, bool wakeup);
 
int modem_slm_wake_up(void);
 
void modem_slm_reset_uart(void);
 
int modem_slm_send_cmd(const char *const command, uint32_t timeout);
 
int modem_slm_send_data(const uint8_t *const data, size_t datalen);
 
typedef void (*slm_monitor_handler_t)(const char *notif);
 
struct slm_monitor_entry {
        const char *filter;
        const slm_monitor_handler_t handler;
        uint8_t paused;
};
 
#define MON_ANY NULL
#define MON_PAUSED 1
#define MON_ACTIVE 0
 
#define SLM_MONITOR(name, _filter, _handler, ...)                                                  \
        static void _handler(const char *);                                                        \
        static STRUCT_SECTION_ITERABLE(slm_monitor_entry, name) = {                                \
                .filter = _filter,                                                                 \
                .handler = _handler,                                                               \
                COND_CODE_1(__VA_ARGS__, (.paused = __VA_ARGS__,), ())                             \
        }
 
static inline void slm_monitor_pause(struct slm_monitor_entry *mon)
{
        mon->paused = MON_PAUSED;
}
 
static inline void slm_monitor_resume(struct slm_monitor_entry *mon)
{
        mon->paused = MON_ACTIVE;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* MODEM_SLM_H_ */