root/sys/sys/termios.h
/*      $OpenBSD: termios.h,v 1.14 2022/12/30 23:41:45 millert Exp $    */
/*      $NetBSD: termios.h,v 1.14 1996/04/09 20:55:41 cgd Exp $ */

/*
 * 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
 */

#ifndef _SYS_TERMIOS_H_
#define _SYS_TERMIOS_H_

#include <sys/cdefs.h>

/*
 * Special Control Characters
 *
 * Index into c_cc[] character array.
 *
 *      Name         Subscript  Enabled by
 */
#define VEOF            0       /* ICANON */
#define VEOL            1       /* ICANON */
#if __BSD_VISIBLE
#define VEOL2           2       /* ICANON */
#endif
#define VERASE          3       /* ICANON */
#if __BSD_VISIBLE
#define VWERASE         4       /* ICANON */
#endif
#define VKILL           5       /* ICANON */
#if __BSD_VISIBLE
#define VREPRINT        6       /* ICANON */
#endif
/*                      7          spare 1 */
#define VINTR           8       /* ISIG */
#define VQUIT           9       /* ISIG */
#define VSUSP           10      /* ISIG */
#if __BSD_VISIBLE
#define VDSUSP          11      /* ISIG */
#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 */
/*                      19         spare 2 */
#endif
#define NCCS            20

#define _POSIX_VDISABLE (0377)

#if __BSD_VISIBLE
#define CCEQ(val, c)    (c == val ? val != _POSIX_VDISABLE : 0)
#endif

/*
 * Input flags - software input processing
 */
#define IGNBRK          0x00000001      /* ignore BREAK condition */
#define BRKINT          0x00000002      /* map BREAK to SIGINT */
#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 */
#if __BSD_VISIBLE
#define IXANY           0x00000800      /* any char will restart after stop */
#define IUCLC           0x00001000      /* translate upper to lower case */
#define IMAXBEL         0x00002000      /* ring bell on input queue full */
#endif /* __BSD_VISIBLE */

/*
 * Output flags - software output processing
 */
#define OPOST           0x00000001      /* enable following output processing */
#if __XPG_VISIBLE
#define ONLCR           0x00000002      /* map NL to CR-NL (ala CRMOD) */
#endif
#if __BSD_VISIBLE || __XPG_VISIBLE
#define TABDLY          0x00000004      /* horizontal tab delay mask */
#define TAB0            0x00000000      /* no tab delay or expansion */
#define TAB3            0x00000004      /* expand tabs to spaces */
#if __BSD_VISIBLE
#define OXTABS          TAB3            /* BSD name for TAB3 */
#define ONOEOT          0x00000008      /* discard EOT's (^D) on output */
#endif
#endif
#if __XPG_VISIBLE
#define OCRNL           0x00000010      /* map CR to NL */
#define OLCUC           0x00000020      /* translate lower case to upper case */
#define ONOCR           0x00000040      /* No CR output at column 0 */
#define ONLRET          0x00000080      /* NL performs the CR function */
#endif /* __XPG_VISIBLE */

/*
 * Control flags - hardware control of terminal
 */
#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 CRTSCTS         0x00010000      /* RTS/CTS full-duplex flow control */
#define CRTS_IFLOW      CRTSCTS         /* XXX compat */
#define CCTS_OFLOW      CRTSCTS         /* XXX compat */
#define MDMBUF          0x00100000      /* DTR/DCD hardware flow control */
#define CHWFLOW         (MDMBUF|CRTSCTS) /* all types of hw flow control */
#endif /* __BSD_VISIBLE */

/*
 * "Local" flags - dumping ground for other state
 *
 * 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 XCASE           0x01000000      /* canonical upper/lower case */
#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 */

typedef unsigned int    tcflag_t;
typedef unsigned char   cc_t;
typedef unsigned int    speed_t;

struct termios {
        tcflag_t        c_iflag;        /* input flags */
        tcflag_t        c_oflag;        /* output flags */
        tcflag_t        c_cflag;        /* control flags */
        tcflag_t        c_lflag;        /* local flags */
        cc_t            c_cc[NCCS];     /* control chars */
        int             c_ispeed;       /* input speed */
        int             c_ospeed;       /* output speed */
};

/*
 * Commands passed to tcsetattr() for setting the termios structure.
 */
#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

/*
 * Standard speeds
 */
#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 EXTA    19200
#define EXTB    38400
#endif /* __BSD_VISIBLE */

#ifndef _KERNEL

#define TCIFLUSH        1
#define TCOFLUSH        2
#define TCIOFLUSH       3
#define TCOOFF          1
#define TCOON           2
#define TCIOFF          3
#define TCION           4

#include <sys/_types.h>

#if __XPG_VISIBLE >= 420 || __POSIX_VISIBLE >= 200809
#ifndef _PID_T_DEFINED_
#define _PID_T_DEFINED_
typedef __pid_t         pid_t;
#endif
#endif

__BEGIN_DECLS
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     tcgetattr(int, struct termios *);
int     tcsetattr(int, int, const struct termios *);
int     tcdrain(int);
int     tcflow(int, int);
int     tcflush(int, int);
int     tcsendbreak(int, int);

#if __XPG_VISIBLE >= 420 || __POSIX_VISIBLE >= 200809
pid_t   tcgetsid(int);
#endif

#if __BSD_VISIBLE
void    cfmakeraw(struct termios *);
int     cfsetspeed(struct termios *, speed_t);
#endif /* __BSD_VISIBLE */
__END_DECLS

#endif /* !_KERNEL */

#if __BSD_VISIBLE
/*
 * Include tty ioctl's that aren't just for backwards compatibility
 * with the old tty driver.  These ioctl definitions were previously
 * in <sys/ioctl.h>.
 */
#include <sys/ttycom.h>
#endif

/*
 * END OF PROTECTED INCLUDE.
 */
#endif /* !_SYS_TERMIOS_H_ */

#if __BSD_VISIBLE
#include <sys/ttydefaults.h>
#endif