serial_options.h

Go to the documentation of this file.

#pragma once
 
/* ************************************************************************** */
/*      ____    _    _____ ____     _    _   _   _____ _  _   ____  ____      */
/*     / ___|  / \  |  ___|  _ \   / \  | \ | | |_   _| || | |  _ \/ ___|     */
/*     \___ \ / _ \ | |_  | |_) | / _ \ |  \| |   | | | || |_| | | \___ \     */
/*      ___) / ___ \|  _| |  _ < / ___ \| |\  |   | | |__   _| |_| |___) |    */
/*     |____/_/   \_|_|   |_| \_/_/   \_|_| \_|   |_|    |_| |____/|____/     */
/*                                                                            */
/* ************************************************************************** */
 
#include <termios.h>
 
#include <stdbool.h>
#include <stdint.h> // uint*_t

struct serial_input_modes
{
    uint32_t ignore_break           :1; 
    uint32_t signal_break           :1; 
    uint32_t discard_invalid_chars  :1; 
    uint32_t mark_errors            :1; 
    uint32_t parity_check           :1; 
    uint32_t strip_8th_bit          :1; 
    uint32_t map_nl_to_cr           :1; 
    uint32_t ignore_cr              :1; 
    uint32_t map_cr_to_nl           :1; 
    uint32_t map_upper_to_lower     :1;
    uint32_t enable_start_stop_out  :1; 
    uint32_t any_can_restart_output :1; 
    uint32_t enable_start_stop_in   :1; 
    uint32_t ring_bell_when_full    :1; 
    uint32_t is_utf8                :1; 
    uint32_t _unused                :16;
    uint32_t _dont_modify_speed     :1; /* Used when setting speed */
};

struct serial_output_modes
{
    uint32_t enable_processing  :1; 
    uint32_t map_lower_to_upper :1;
    uint32_t map_nl_to_crnl     :1; 
    uint32_t map_cr_to_nl       :1; 
    uint32_t no_cr              :1; 
    uint32_t nl_returns         :1; 
    uint32_t use_fill           :1; 
    uint32_t fill_is_del        :1; 
    uint32_t _nl_delay          :1;
    uint32_t _cr_delay          :2;
    uint32_t _tab_delay         :2;
    uint32_t _backspace_delay   :1;
    uint32_t vertical_tab_delay :1;
    uint32_t _formfeed_delay    :1;
};

struct serial_control_modes
{
    uint32_t _speed_4lsb     :4; /* Least significant 4-bits of the line speed */
    uint32_t character_size  :2; 
    uint32_t two_stop_bits   :1; 
    uint32_t read            :1; 
    uint32_t enable_parity   :1;
    uint32_t odd_parity      :1;
    uint32_t hang_up         :1;
    uint32_t is_local        :1; 
    uint32_t _speed_is_extra :1; /* For non-posix baud rates */
};

struct serial_local_modes
{
    uint32_t enable_signals    :1;
    uint32_t canonical         :1; 
    uint32_t _uppercase_only   :1; /* Not supported under Linux */
    uint32_t echo              :1; /* Echo input characters. */
    uint32_t echo_erasure      :1; /* requires canonical mode */
    uint32_t echo_kill         :1; /* requires canonical mode */
    uint32_t echo_nl           :1; /* requires canonical mode */
    uint32_t disable_flush     :1;
    uint32_t tostop            :1;
    uint32_t _echo_control     :1; /* Escape control characters */
    uint32_t _echo_print       :1; /* Print chars when erased, if ICANON and ECHO */
    uint32_t _misc             :4;
    uint32_t enable_processing :1; /* implementation-defined input processing */
};

enum character_size
{
    character_size_5 = 0, 
    character_size_6 = 1, 
    character_size_7 = 2, 
    character_size_8 = 3  
};

union serial_control_characters
{
    uint8_t array[NCCS]; 
 
    struct
    {
        uint8_t interrupt; 
        uint8_t quit;      
        uint8_t erase;
        uint8_t kill;
        uint8_t end_of_file;
        uint8_t timeout;
        uint8_t minimum;
    }; 
};

typedef union serial_options serial_options_t;

union serial_options
{
    struct termios termios; 
 
    struct
    {
        struct serial_input_modes       input;   
        struct serial_output_modes      output;  
        struct serial_control_modes     control; 
        struct serial_local_modes       local;   
        uint8_t                         line_discipline;
        union serial_control_characters control_characters;
        uint32_t                        input_speed;
        uint32_t                        output_speed;
    }; 
};