zephyr/include/drivers/console/telnet_console.h

38 lines
966 B
C

/*
* Copyright (c) 2017 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __TELNET_CONSOLE_H__
#define __TELNET_CONSOLE_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <kernel.h>
/** @brief Register telnet input processing
*
* Input processing is started when string is received in telnet server.
* Carriage return is translated to NULL making string always NULL
* terminated. Application before calling register function need to
* initialize two fifo queues mentioned below.
*
* @param avail k_fifo queue keeping available input slots
* @param lines k_fifo queue of entered lines which to be processed
* in the application code.
* @param completion callback for tab completion of entered commands
*
* @return N/A
*/
void telnet_register_input(struct k_fifo *avail, struct k_fifo *lines,
uint8_t (*completion)(char *str, uint8_t len));
#ifdef __cplusplus
}
#endif
#endif /* __TELNET_CONSOLE_H__ */