bits/termios.h

   1 /* termios type and macro definitions.  4.4 BSD/generic GNU version.
   2    Copyright (C) 1993,94,96,97,99,2001 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _TERMIOS_H
  21 # error "Never include <bits/termios.h> directly; use <termios.h> instead."
  22 #endif
  23
  24 /* These macros are also defined in some <bits/ioctls.h> files (with
  25    numerically identical values), but this serves to shut up cpp's
  26    complaining. */
  27 #if defined __USE_MISC || defined __USE_XOPEN
  28
  29 # ifdef NL0
  30 #  undef NL0
  31 # endif
  32 # ifdef NL1
  33 #  undef NL1
  34 # endif
  35 # ifdef TAB0
  36 #  undef TAB0
  37 # endif
  38 # ifdef TAB1
  39 #  undef TAB1
  40 # endif
  41 # ifdef TAB2
  42 #  undef TAB2
  43 # endif
  44 # ifdef CR0
  45 #  undef CR0
  46 # endif
  47 # ifdef CR1
  48 #  undef CR1
  49 # endif
  50 # ifdef CR2
  51 #  undef CR2
  52 # endif
  53 # ifdef CR3
  54 #  undef CR3
  55 # endif
  56 # ifdef FF0
  57 #  undef FF0
  58 # endif
  59 # ifdef FF1
  60 #  undef FF1
  61 # endif
  62 # ifdef BS0
  63 #  undef BS0
  64 # endif
  65 # ifdef BS1
  66 #  undef BS1
  67 # endif
  68
  69 #endif /* __USE_MISC || __USE_XOPEN */
  70
  71 #ifdef __USE_BSD
  72
  73 # ifdef MDMBUF
  74 #  undef MDMBUF
  75 # endif
  76 # ifdef FLUSHO
  77 #  undef FLUSHO
  78 # endif
  79 # ifdef PENDIN
  80 #  undef PENDIN
  81 # endif
  82
  83 #endif /* __USE_BSD */
  84
  85 #ifdef ECHO
  86 # undef ECHO
  87 #endif
  88 #ifdef TOSTOP
  89 # undef TOSTOP
  90 #endif
  91 #ifdef NOFLSH
  92 # undef NOFLSH
  93 #endif
  94
  95
  96 /* These definitions match those used by the 4.4 BSD kernel.
  97    If the operating system has termios system calls or ioctls that
  98    correctly implement the POSIX.1 behavior, there should be a
  99    system-dependent version of this file that defines `struct termios',
 100    `tcflag_t', `cc_t', `speed_t' and the `TC*' constants appropriately.  */
 101
 102 /* Type of terminal control flag masks.  */
 103 typedef unsigned long int tcflag_t;
 104
 105 /* Type of control characters.  */
 106 typedef unsigned char cc_t;
 107
 108 /* Type of baud rate specifiers.  */
 109 typedef long int speed_t;
 110
 111 /* Terminal control structure.  */
 112 struct termios
 113 {
 114   /* Input modes.  */
 115   tcflag_t c_iflag;
 116 #define IGNBRK  (1 << 0)        /* Ignore break condition.  */
 117 #define BRKINT  (1 << 1)        /* Signal interrupt on break.  */
 118 #define IGNPAR  (1 << 2)        /* Ignore characters with parity errors.  */
 119 #define PARMRK  (1 << 3)        /* Mark parity and framing errors.  */
 120 #define INPCK   (1 << 4)        /* Enable input parity check.  */
 121 #define ISTRIP  (1 << 5)        /* Strip 8th bit off characters.  */
 122 #define INLCR   (1 << 6)        /* Map NL to CR on input.  */
 123 #define IGNCR   (1 << 7)        /* Ignore CR.  */
 124 #define ICRNL   (1 << 8)        /* Map CR to NL on input.  */
 125 #define IXON    (1 << 9)        /* Enable start/stop output control.  */
 126 #define IXOFF   (1 << 10)       /* Enable start/stop input control.  */
 127 #if defined __USE_BSD || defined __USE_UNIX98
 128 # define IXANY  (1 << 11)       /* Any character will restart after stop.  */
 129 #endif
 130 #ifdef  __USE_BSD
 131 # define IMAXBEL (1 << 13)      /* Ring bell when input queue is full.  */
 132 #endif
 133 #ifdef __USE_GNU
 134 # define IUCLC  (1 << 14)       /* Translate upper case input to lower case. */
 135 #endif
 136
 137   /* Output modes.  */
 138   tcflag_t c_oflag;
 139 #define OPOST   (1 << 0)        /* Perform output processing.  */
 140 #if defined __USE_BSD || defined __USE_XOPEN
 141 # define ONLCR  (1 << 1)        /* Map NL to CR-NL on output.  */
 142 #endif
 143 #ifdef  __USE_BSD
 144 # define OXTABS TAB3            /* Expand tabs to spaces.  */
 145 # define ONOEOT (1 << 3)        /* Discard EOT (^D) on output.  */
 146 #endif
 147 #if defined __USE_BSD || defined __USE_XOPEN
 148 # define OCRNL  (1 << 4)        /* Map CR to NL.  */
 149 # define ONOCR  (1 << 5)        /* Discard CR's when on column 0.  */
 150 # define ONLRET (1 << 6)        /* Move to column 0 on NL.  */
 151 #endif
 152 #if defined __USE_MISC || defined __USE_XOPEN
 153 # define NLDLY  (3 << 8)        /* NL delay.  */
 154 # define NL0    (0 << 8)        /* NL type 0.  */
 155 # define NL1    (1 << 8)        /* NL type 1.  */
 156 # define TABDLY (3 << 10)       /* TAB delay.  */
 157 # define TAB0   (0 << 10)       /* TAB delay type 0.  */
 158 # define TAB1   (1 << 10)       /* TAB delay type 1.  */
 159 # define TAB2   (2 << 10)       /* TAB delay type 2.  */
 160 # define TAB3   (1 << 2)        /* Expand tabs to spaces.  */
 161 # define CRDLY  (3 << 12)       /* CR delay.  */
 162 # define CR0    (0 << 12)       /* CR delay type 0.  */
 163 # define CR1    (1 << 12)       /* CR delay type 1.  */
 164 # define CR2    (2 << 12)       /* CR delay type 2.  */
 165 # define CR3    (3 << 12)       /* CR delay type 3.  */
 166 # define FFDLY  (1 << 14)       /* FF delay.  */
 167 # define FF0    (0 << 14)       /* FF delay type 0.  */
 168 # define FF1    (1 << 14)       /* FF delay type 1.  */
 169 # define BSDLY  (1 << 15)       /* BS delay.  */
 170 # define BS0    (0 << 15)       /* BS delay type 0.  */
 171 # define BS1    (1 << 15)       /* BS delay type 1.  */
 172 # define VTDLY  (1 << 16)       /* VT delay.  */
 173 # define VT0    (0 << 16)       /* VT delay type 0.  */
 174 # define VT1    (1 << 16)       /* VT delay type 1.  */
 175 #endif /* __USE_MISC || __USE_XOPEN */
 176 #ifdef __USE_GNU
 177 # define OLCUC  (1 << 17)       /* Translate lower case output to upper case */
 178 #endif
 179 #ifdef __USE_XOPEN
 180 # define OFILL  (1 << 18)       /* Send fill characters for delays.  */
 181 #endif
 182
 183   /* Control modes.  */
 184   tcflag_t c_cflag;
 185 #ifdef  __USE_BSD
 186 # define CIGNORE        (1 << 0)        /* Ignore these control flags.  */
 187 #endif
 188 #define CSIZE   (CS5|CS6|CS7|CS8)       /* Number of bits per byte (mask).  */
 189 #define CS5     0               /* 5 bits per byte.  */
 190 #define CS6     (1 << 8)        /* 6 bits per byte.  */
 191 #define CS7     (1 << 9)        /* 7 bits per byte.  */
 192 #define CS8     (CS6|CS7)       /* 8 bits per byte.  */
 193 #define CSTOPB  (1 << 10)       /* Two stop bits instead of one.  */
 194 #define CREAD   (1 << 11)       /* Enable receiver.  */
 195 #define PARENB  (1 << 12)       /* Parity enable.  */
 196 #define PARODD  (1 << 13)       /* Odd parity instead of even.  */
 197 #define HUPCL   (1 << 14)       /* Hang up on last close.  */
 198 #define CLOCAL  (1 << 15)       /* Ignore modem status lines.  */
 199 #ifdef  __USE_BSD
 200 # define CRTSCTS        (1 << 16)       /* RTS/CTS flow control.  */
 201 # define CRTS_IFLOW     CRTSCTS         /* Compatibility.  */
 202 # define CCTS_OFLOW     CRTSCTS         /* Compatibility.  */
 203 # define CDTRCTS        (1 << 17)       /* DTR/CTS flow control.  */
 204 # define MDMBUF         (1 << 20)       /* DTR/DCD flow control.  */
 205 # define CHWFLOW        (MDMBUF|CRTSCTS|CDTRCTS) /* All types of flow control.  */
 206 #endif
 207
 208   /* Local modes.  */
 209   tcflag_t c_lflag;
 210 #ifdef  __USE_BSD
 211 # define ECHOKE (1 << 0)        /* Visual erase for KILL.  */
 212 #endif
 213 #define _ECHOE  (1 << 1)        /* Visual erase for ERASE.  */
 214 #define ECHOE   _ECHOE
 215 #define _ECHOK  (1 << 2)        /* Echo NL after KILL.  */
 216 #define ECHOK   _ECHOK
 217 #define _ECHO   (1 << 3)        /* Enable echo.  */
 218 #define ECHO    _ECHO
 219 #define _ECHONL (1 << 4)        /* Echo NL even if ECHO is off.  */
 220 #define ECHONL  _ECHONL
 221 #ifdef  __USE_BSD
 222 # define ECHOPRT        (1 << 5)        /* Hardcopy visual erase.  */
 223 # define ECHOCTL        (1 << 6)        /* Echo control characters as ^X.  */
 224 #endif
 225 #define _ISIG   (1 << 7)        /* Enable signals.  */
 226 #define ISIG    _ISIG
 227 #define _ICANON (1 << 8)        /* Do erase and kill processing.  */
 228 #define ICANON  _ICANON
 229 #ifdef  __USE_BSD
 230 # define ALTWERASE (1 << 9)     /* Alternate WERASE algorithm.  */
 231 #endif
 232 #define _IEXTEN (1 << 10)       /* Enable DISCARD and LNEXT.  */
 233 #define IEXTEN  _IEXTEN
 234 #define EXTPROC (1 << 11)       /* External processing.  */
 235 #define _TOSTOP (1 << 22)       /* Send SIGTTOU for background output.  */
 236 #define TOSTOP  _TOSTOP
 237 #ifdef  __USE_BSD
 238 # define FLUSHO (1 << 23)       /* Output being flushed (state).  */
 239 # define NOKERNINFO (1 << 25)   /* Disable VSTATUS.  */
 240 # define PENDIN (1 << 29)       /* Retype pending input (state).  */
 241 #endif
 242 #define _NOFLSH (1 << 31)       /* Disable flush after interrupt.  */
 243 #define NOFLSH  _NOFLSH
 244
 245   /* Control characters.  */
 246 #define VEOF    0               /* End-of-file character [ICANON].  */
 247 #define VEOL    1               /* End-of-line character [ICANON].  */
 248 #ifdef  __USE_BSD
 249 # define VEOL2  2               /* Second EOL character [ICANON].  */
 250 #endif
 251 #define VERASE  3               /* Erase character [ICANON].  */
 252 #ifdef  __USE_BSD
 253 # define VWERASE        4               /* Word-erase character [ICANON].  */
 254 #endif
 255 #define VKILL   5               /* Kill-line character [ICANON].  */
 256 #ifdef  __USE_BSD
 257 # define VREPRINT 6             /* Reprint-line character [ICANON].  */
 258 #endif
 259 #define VINTR   8               /* Interrupt character [ISIG].  */
 260 #define VQUIT   9               /* Quit character [ISIG].  */
 261 #define VSUSP   10              /* Suspend character [ISIG].  */
 262 #ifdef  __USE_BSD
 263 # define VDSUSP 11              /* Delayed suspend character [ISIG].  */
 264 #endif
 265 #define VSTART  12              /* Start (X-ON) character [IXON, IXOFF].  */
 266 #define VSTOP   13              /* Stop (X-OFF) character [IXON, IXOFF].  */
 267 #ifdef  __USE_BSD
 268 # define VLNEXT 14              /* Literal-next character [IEXTEN].  */
 269 # define VDISCARD 15            /* Discard character [IEXTEN].  */
 270 #endif
 271 #define VMIN    16              /* Minimum number of bytes read at once [!ICANON].  */
 272 #define VTIME   17              /* Time-out value (tenths of a second) [!ICANON].  */
 273 #ifdef  __USE_BSD
 274 # define VSTATUS        18              /* Status character [ICANON].  */
 275 #endif
 276 #define NCCS    20              /* Value duplicated in <hurd/tioctl.defs>.  */
 277   cc_t c_cc[NCCS];
 278
 279   /* Input and output baud rates.  */
 280   speed_t __ispeed, __ospeed;
 281 #define B0      0               /* Hang up.  */
 282 #define B50     50              /* 50 baud.  */
 283 #define B75     75              /* 75 baud.  */
 284 #define B110    110             /* 110 baud.  */
 285 #define B134    134             /* 134.5 baud.  */
 286 #define B150    150             /* 150 baud.  */
 287 #define B200    200             /* 200 baud.  */
 288 #define B300    300             /* 300 baud.  */
 289 #define B600    600             /* 600 baud.  */
 290 #define B1200   1200            /* 1200 baud.  */
 291 #define B1800   1800            /* 1800 baud.  */
 292 #define B2400   2400            /* 2400 baud.  */
 293 #define B4800   4800            /* 4800 baud.  */
 294 #define B9600   9600            /* 9600 baud.  */
 295 #define B7200   7200            /* 7200 baud.  */
 296 #define B14400  14400           /* 14400 baud.  */
 297 #define B19200  19200           /* 19200 baud.  */
 298 #define B28800  28800           /* 28800 baud.  */
 299 #define B38400  38400           /* 38400 baud.  */
 300 #ifdef  __USE_MISC
 301 # define EXTA   19200
 302 # define EXTB   38400
 303 #endif
 304 #define B57600  57600
 305 #define B76800  76800
 306 #define B115200 115200
 307 #define B230400 230400
 308 #define B460800 460800
 309 #define B500000 500000
 310 #define B576000 576000
 311 #define B921600 921600
 312 #define B1000000 1000000
 313 #define B1152000 1152000
 314 #define B1500000 1500000
 315 #define B2000000 2000000
 316 #define B2500000 2500000
 317 #define B3000000 3000000
 318 #define B3500000 3500000
 319 #define B4000000 4000000
 320 };
 321
 322 #define _IOT_termios /* Hurd ioctl type field.  */ \
 323   _IOT (_IOTS (tcflag_t), 4, _IOTS (cc_t), NCCS, _IOTS (speed_t), 2)
 324
 325 /* Values for the OPTIONAL_ACTIONS argument to `tcsetattr'.  */
 326 #define TCSANOW         0       /* Change immediately.  */
 327 #define TCSADRAIN       1       /* Change when pending output is written.  */
 328 #define TCSAFLUSH       2       /* Flush pending input before changing.  */
 329 #ifdef  __USE_BSD
 330 # define TCSASOFT       0x10    /* Flag: Don't alter hardware state.  */
 331 #endif
 332
 333 /* Values for the QUEUE_SELECTOR argument to `tcflush'.  */
 334 #define TCIFLUSH        1       /* Discard data received but not yet read.  */
 335 #define TCOFLUSH        2       /* Discard data written but not yet sent.  */
 336 #define TCIOFLUSH       3       /* Discard all pending data.  */
 337
 338 /* Values for the ACTION argument to `tcflow'.  */
 339 #define TCOOFF  1               /* Suspend output.  */
 340 #define TCOON   2               /* Restart suspended output.  */
 341 #define TCIOFF  3               /* Send a STOP character.  */
 342 #define TCION   4               /* Send a START character.  */