cli_parser.h

Go to the documentation of this file.

/*
 * ether2ser - Ethernet <-> synchronous V.24 (RS-232/V.28) bridge
 *
 * File:    src/system/cli_parser.h
 * Purpose: CLI parsing API and pin metadata types.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2026 Florian <f.leuze@outlook.de>
 */
 
#ifndef CLI_PARSER_H
#define CLI_PARSER_H
 
// Related headers
 
// Standard library headers
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
// Project Headers
#include "drivers/gpio_driver.h"
#include "drivers/v24_config.h"
#include "system/error.h"
 
// Generated headers
 
typedef struct
{
    const char* name;
    uint8_t gpio_num;
    bool is_output;
} pin_info_t;
 
size_t get_num_pins(void);
 
e2s_error_t cli_parse(const char* line, char* cmd, size_t cmd_cap, char* args, size_t args_cap);
e2s_error_t parse_get_args(const char* args, char* pin_name, const pin_info_t** pin);
 
const pin_info_t* find_pin(const char* name);
 
const pin_info_t* get_pin_table(void);
 
e2s_error_t parse_set_ip_args(const char* args, uint8_t ip_addr[4], uint8_t netmask[4]);
 
e2s_error_t parse_set_gpio_args(const char* args, char* pin_name, int* value,
                                const pin_info_t** pin);
 
e2s_error_t parse_set_net_ip_args(const char* args, uint8_t ip_addr[4], uint8_t netmask[4]);
 
e2s_error_t parse_set_ip_remote_args(const char* args, uint8_t ip_addr[4]);
 
e2s_error_t parse_set_gateway_args(const char* args, uint8_t ip_addr[4]);
 
e2s_error_t parse_set_udp_port_local_args(const char* args, uint16_t* port);
 
e2s_error_t parse_set_udp_port_remote_args(const char* args, uint16_t* port);
 
e2s_error_t parse_set_v24_polarities(const char* args, V24_POLARITIES_T* polarities);
 
e2s_error_t parse_set_v24_baudrate(const char* args, V24_BAUDRATE_T* baudrate);
 
e2s_error_t parse_set_v24_clockmode(const char* args, bool* clockmode);
 
#endif /* CLI_PARSER_H */