shell_telnet.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SHELL_TELNET_H_
#define ZEPHYR_INCLUDE_SHELL_TELNET_H_
 
#include <zephyr/net/socket.h>
#include <zephyr/shell/shell.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern const struct shell_transport_api shell_telnet_transport_api;
 
#define SHELL_TELNET_POLLFD_COUNT 3
#define SHELL_TELNET_MAX_CMD_SIZE 3
 
struct shell_telnet_line_buf {
        char buf[CONFIG_SHELL_TELNET_LINE_BUF_SIZE];
 
        uint16_t len;
};
 
struct shell_telnet {
        shell_transport_handler_t shell_handler;
 
        void *shell_context;
 
        struct shell_telnet_line_buf line_out;
 
        struct zsock_pollfd fds[SHELL_TELNET_POLLFD_COUNT];
 
        uint8_t rx_buf[CONFIG_SHELL_CMD_BUFF_SIZE];
 
        size_t rx_len;
 
        struct k_mutex rx_lock;
        uint8_t cmd_buf[SHELL_TELNET_MAX_CMD_SIZE];
        uint8_t cmd_len;
 
        struct k_work_delayable send_work;
        struct k_work_sync work_sync;
 
        bool output_lock;
};
 
#define SHELL_TELNET_DEFINE(_name)                                      \
        static struct shell_telnet _name##_shell_telnet;                \
        struct shell_transport _name = {                                \
                .api = &shell_telnet_transport_api,                     \
                .ctx = (struct shell_telnet *)&_name##_shell_telnet     \
        }
 
const struct shell *shell_backend_telnet_get_ptr(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SHELL_TELNET_H_ */