termios.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2018-2025 Liviu Ionescu. All rights reserved.
 *
 * Copyright (c) 1988, 1989, 1993, 1994
 *  The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *  @(#)termios.h   8.3 (Berkeley) 3/28/94
 * $FreeBSD$
 */
 
#ifndef POSIX_TERMIOS_H_
#define POSIX_TERMIOS_H_
 
// ----------------------------------------------------------------------------
 
#include <unistd.h>
 
#if defined(_POSIX_VERSION)
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wgnu-include-next"
#endif
#include_next <termios.h>
#pragma GCC diagnostic pop
 
#else
 
// Avoid warnings for __BSD* definitions.
#pragma GCC system_header
 
#ifdef __cplusplus
extern "C"
{
#endif
 
// http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/termios.h.html
 
// ----------------------------------------------------------------------------
 
// Special Control Characters
 
// The following subscript names are for the array c_cc.
#define VEOF 0 /* ICANON */
#define VEOL 1 /* ICANON */
#if __BSD_VISIBLE
#define VEOL2 2 /* ICANON together with IEXTEN */
#endif
#define VERASE 3 /* ICANON */
#if __BSD_VISIBLE
#define VWERASE 4 /* ICANON together with IEXTEN */
#endif
#define VKILL 5 /* ICANON */
#if __BSD_VISIBLE
#define VREPRINT 6 /* ICANON together with IEXTEN */
#define VERASE2 7 /* ICANON */
#endif
// 7       ex-spare 1
#define VINTR 8 /* ISIG */
#define VQUIT 9 /* ISIG */
#define VSUSP 10 /* ISIG */
#if __BSD_VISIBLE
#define VDSUSP 11 /* ISIG together with IEXTEN */
#endif
#define VSTART 12 /* IXON, IXOFF */
#define VSTOP 13 /* IXON, IXOFF */
#if __BSD_VISIBLE
#define VLNEXT 14 /* IEXTEN */
#define VDISCARD 15 /* IEXTEN */
#endif
#define VMIN 16 /* !ICANON */
#define VTIME 17 /* !ICANON */
#if __BSD_VISIBLE
#define VSTATUS 18 /* ICANON together with IEXTEN */
// 19      spare 2
#endif
 
// [LNP] Added 2017-08-18
#define VTIME_MS 19 /* !ICANON */
  // [LNP] End added
 
#define NCCS 20
 
#define _POSIX_VDISABLE 0xff
 
// Input Modes
 
// The c_iflag field describes the basic terminal input control:
#define IGNBRK 0x00000001 /* ignore BREAK condition */
#define BRKINT 0x00000002 /* map BREAK to SIGINTR */
#define IGNPAR 0x00000004 /* ignore (discard) parity errors */
#define PARMRK 0x00000008 /* mark parity and framing errors */
#define INPCK 0x00000010 /* enable checking of parity errors */
#define ISTRIP 0x00000020 /* strip 8th bit off chars */
#define INLCR 0x00000040 /* map NL into CR */
#define IGNCR 0x00000080 /* ignore CR */
#define ICRNL 0x00000100 /* map CR to NL (ala CRMOD) */
#define IXON 0x00000200 /* enable output flow control */
#define IXOFF 0x00000400 /* enable input flow control */
#define IXANY 0x00000800 /* any char will restart after stop */
#if __BSD_VISIBLE
#define IMAXBEL 0x00002000 /* ring bell on input queue full */
#endif
 
// Output Modes
 
// The c_oflag field specifies the system treatment of output:
#define OPOST 0x00000001 /* enable following output processing */
#define ONLCR 0x00000002 /* map NL to CR-NL (ala CRMOD) */
#define TABDLY 0x00000004 /* tab delay mask */
#define TAB0 0x00000000 /* no tab delay and expansion */
#define TAB3 0x00000004 /* expand tabs to spaces */
#define ONOEOT 0x00000008 /* discard EOT's (^D) on output) */
#define OCRNL 0x00000010 /* map CR to NL on output */
#define ONOCR 0x00000020 /* no CR output at column 0 */
#define ONLRET 0x00000040 /* NL performs CR function */
 
// TODO: add
// OFILL
// NLDLY
// CRDLY
// TABDLY
// BSDLY
// VTDLY
// FFDLY
 
// Baud Rate Selection
 
// The input and output baud rates are stored in the termios structure.
// These are the valid values for objects of type speed_t. The following
// values shall be defined, but not all baud rates need be supported by
// the underlying hardware.
#define B0 0
#define B50 50
#define B75 75
#define B110 110
#define B134 134
#define B150 150
#define B200 200
#define B300 300
#define B600 600
#define B1200 1200
#define B1800 1800
#define B2400 2400
#define B4800 4800
#define B9600 9600
#define B19200 19200
#define B38400 38400
#if __BSD_VISIBLE
#define B7200 7200
#define B14400 14400
#define B28800 28800
#define B57600 57600
#define B76800 76800
#define B115200 115200
#define B230400 230400
#define B460800 460800
#define B921600 921600
#define EXTA 19200
#define EXTB 38400
#endif
 
// Control Modes
 
// The c_cflag field describes the hardware control of the terminal;
// not all values specified are required to be supported by the
// underlying hardware.
#if __BSD_VISIBLE
#define CIGNORE 0x00000001 /* ignore control flags */
#endif
#define CSIZE 0x00000300 /* character size mask */
#define CS5 0x00000000 /* 5 bits (pseudo) */
#define CS6 0x00000100 /* 6 bits */
#define CS7 0x00000200 /* 7 bits */
#define CS8 0x00000300 /* 8 bits */
#define CSTOPB 0x00000400 /* send 2 stop bits */
#define CREAD 0x00000800 /* enable receiver */
#define PARENB 0x00001000 /* parity enable */
#define PARODD 0x00002000 /* odd parity, else even */
#define HUPCL 0x00004000 /* hang up on last close */
#define CLOCAL 0x00008000 /* ignore modem status lines */
#if __BSD_VISIBLE
#define CCTS_OFLOW 0x00010000 /* CTS flow control of output */
#define CRTSCTS (CCTS_OFLOW | CRTS_IFLOW)
#define CRTS_IFLOW 0x00020000 /* RTS flow control of input */
#define CDTR_IFLOW 0x00040000 /* DTR flow control of input */
#define CDSR_OFLOW 0x00080000 /* DSR flow control of output */
#define CCAR_OFLOW 0x00100000 /* DCD flow control of output */
#endif
 
// Local Modes
 
// The c_lflag field of the argument structure is used to control
// various terminal functions.
// Warning: some flags in this structure begin with the letter "I"
// and look like they belong in the input flag.
#if __BSD_VISIBLE
#define ECHOKE 0x00000001 /* visual erase for line kill */
#endif
#define ECHOE 0x00000002 /* visually erase chars */
#define ECHOK 0x00000004 /* echo NL after line kill */
#define ECHO 0x00000008 /* enable echoing */
#define ECHONL 0x00000010 /* echo NL even if ECHO is off */
#if __BSD_VISIBLE
#define ECHOPRT 0x00000020 /* visual erase mode for hardcopy */
#define ECHOCTL 0x00000040 /* echo control chars as ^(Char) */
#endif
#define ISIG 0x00000080 /* enable signals INTR, QUIT, [D]SUSP */
#define ICANON 0x00000100 /* canonicalize input lines */
#if __BSD_VISIBLE
#define ALTWERASE 0x00000200 /* use alternate WERASE algorithm */
#endif
#define IEXTEN 0x00000400 /* enable DISCARD and LNEXT */
#define EXTPROC 0x00000800 /* external processing */
#define TOSTOP 0x00400000 /* stop background jobs from output */
#if __BSD_VISIBLE
#define FLUSHO 0x00800000 /* output being flushed (state) */
#define NOKERNINFO 0x02000000 /* no kernel output from VSTATUS */
#define PENDIN 0x20000000 /* XXX retype pending input (state) */
#endif
#define NOFLSH 0x80000000 /* don't flush after interrupt */
 
// Attribute Selection
 
// The following symbolic constants are for use with tcsetattr().
#define TCSANOW 0 /* make change immediate */
#define TCSADRAIN 1 /* drain output, then change */
#define TCSAFLUSH 2 /* drain output, flush input */
#if __BSD_VISIBLE
#define TCSASOFT 0x10 /* flag - don't alter h.w. state */
#endif
 
// Line Control
 
// The following symbolic constants are for use with tcflush().
#define TCIFLUSH 1
#define TCOFLUSH 2
#define TCIOFLUSH 3
 
// The following symbolic constants are for use with tcflow().
#define TCOOFF 1
#define TCOON 2
#define TCIOFF 3
#define TCION 4
 
  // --------------------------------------------------------------------------
 
  typedef unsigned int tcflag_t; // Terminal modes.
  typedef unsigned char cc_t; // terminal special characters.
  typedef unsigned int speed_t; // Terminal baud rates.
 
  struct termios
  {
    tcflag_t c_iflag; /* input modes */
    tcflag_t c_oflag; /* output modes */
    tcflag_t c_cflag; /* control modes */
    tcflag_t c_lflag; /* local modes */
    cc_t c_cc[NCCS]; /* control chars */
 
    speed_t c_ispeed; /* input speed */
    speed_t c_ospeed; /* output speed */
  };
 
  // --------------------------------------------------------------------------
 
  // Some functions are not yet implemented in µOS++.
 
  // speed_t cfgetispeed(const struct termios *);
  // speed_t cfgetospeed(const struct termios *);
  // int     cfsetispeed(struct termios *, speed_t);
  // int     cfsetospeed(struct termios *, speed_t);
 
  int
  tcdrain (int fildes);
 
  // int tcflow(int, int);
 
  int
  tcflush (int fildes, int queue_selector);
 
  int
  tcgetattr (int fildes, struct termios* termios_p);
 
  // pid_t tcgetsid(int);
 
  int
  tcsendbreak (int fildes, int duration);
 
  int
  tcsetattr (int fildes, int optional_actions,
             const struct termios* termios_p);
 
  // --------------------------------------------------------------------------
 
#ifdef __cplusplus
}
#endif
 
#endif /* defined(_POSIX_VERSION) */
 
#endif /* POSIX_TERMIOS_H_ */