ioctl_tty(2)

NAME

ioctl_tty – ioctls for terminals and serial lines

SYNOPSIS

#include <termios.h>

int ioctl(int fd, int cmd, …);

DESCRIPTION

The ioctl(2) call for terminals and serial ports accepts many possible command arguments. Most require a third argument, of varying type, here called argp or arg.

Use of ioctl makes for nonportable programs. Use the POSIX interface described in termios(3) whenever possible.

Get and set terminal attributes

TCGETS struct termios *argp: Equivalent to
tcgetattr(fd, argp).
: Get the current serial port settings.
TCSETS const struct termios *argp: Equivalent to
tcsetattr(fd, TCSANOW, argp).
: Set the current serial port settings.
TCSETSW const struct termios *argp: Equivalent to
tcsetattr(fd, TCSADRAIN, argp).
: Allow the output buffer to drain, and set the current serial port settings.
TCSETSF const struct termios *argp: Equivalent to
tcsetattr(fd, TCSAFLUSH, argp).
: Allow the output buffer to drain, discard pending input, and set the current serial port settings.

The following four ioctls are just like TCGETS, TCSETS, TCSETSW, TCSETSF, except that they take a struct termio * instead of a struct termios *.

: TCGETA struct termio *argp
: TCSETA const struct termio *argp
: TCSETAW const struct termio *argp
: TCSETAF const struct termio *argp

Locking the termios structure

The
termios structure of a terminal can be locked. The lock is itself a termios structure, with nonzero bits or fields indicating a locked value.

TIOCGLCKTRMIOS struct termios *argp: Gets the locking status of the
termios structure of the terminal.
TIOCSLCKTRMIOS const struct termios *argp: Sets the locking status of the
termios structure of the terminal. Only a process with the CAP_SYS_ADMIN capability can do this.

Get and set window size

Window sizes are kept in the kernel, but not used by the kernel (except in the case of virtual consoles, where the kernel will update the window size when the size of the virtual console changes, for example, by loading a new font).

The following constants and structure are defined in <sys/ioctl.h>.

TIOCGWINSZ struct winsize *argp: Get window size.
TIOCSWINSZ const struct winsize *argp: Set window size.

The struct used by these ioctls is defined as

struct winsize {
    unsigned short ws_row;
    unsigned short ws_col;
    unsigned short ws_xpixel;   /* unused */
    unsigned short ws_ypixel;   /* unused */ };

When the window size changes, a SIGWINCH signal is sent to the foreground process group.

Sending a break

TCSBRK int arg: Equivalent to
tcsendbreak(fd, arg).
: If the terminal is using asynchronous serial data transmission, and arg is zero, then send a break (a stream of zero bits) for between 0.25 and 0.5 seconds. If the terminal is not using asynchronous serial data transmission, then either a break is sent, or the function returns without doing anything. When arg is nonzero, nobody knows what will happen.
: (SVr4, UnixWare, Solaris, Linux treat tcsendbreak(fd,arg) with nonzero arg like tcdrain(fd). SunOS treats arg as a multiplier, and sends a stream of bits arg times as long as done for zero arg. DG/UX and AIX treat arg (when nonzero) as a time interval measured in milliseconds. HP-UX ignores arg.)
TCSBRKP int arg: So-called "POSIX version" of
TCSBRK. It treats nonzero arg as a time interval measured in deciseconds, and does nothing when the driver does not support breaks.
TIOCSBRK void: Turn break on, that is, start sending zero bits.
TIOCCBRK void: Turn break off, that is, stop sending zero bits.

Software flow control

TCXONC int arg: Equivalent to
tcflow(fd, arg).
: See tcflow(3) for the argument values TCOOFF, TCOON, TCIOFF, TCION.

Buffer count and flushing

FIONREAD int *argp: Get the number of bytes in the input buffer.
TIOCINQ int *argp: Same as
FIONREAD.
TIOCOUTQ int *argp: Get the number of bytes in the output buffer.
TCFLSH int arg: Equivalent to
tcflush(fd, arg).
: See tcflush(3) for the argument values TCIFLUSH, TCOFLUSH, TCIOFLUSH.

Faking input

TIOCSTI const char *argp: Insert the given byte in the input queue.

Redirecting console output

TIOCCONS void: Redirect output that would have gone to
/dev/console or /dev/tty0 to the given terminal. If that was a pseudoterminal master, send it to the slave. In Linux before version 2.6.10, anybody can do this as long as the output was not redirected yet; since version 2.6.10, only a process with the CAP_SYS_ADMIN capability may do this. If output was redirected already, then EBUSY is returned, but redirection can be stopped by using this ioctl with fd pointing at /dev/console or /dev/tty0.

Controlling terminal

TIOCSCTTY int arg: Make the given terminal the controlling terminal of the calling process.
The calling process must be a session leader and not have a controlling terminal already. For this case, arg should be specified as zero.
: If this terminal is already the controlling terminal of a different session group, then the ioctl fails with EPERM, unless the caller has the CAP_SYS_ADMIN capability and arg equals 1, in which case the terminal is stolen, and all processes that had it as controlling terminal lose it.
TIOCNOTTY void: If the given terminal was the controlling terminal of the calling process,
give up this controlling terminal. If the process was session leader, then send SIGHUP and SIGCONT to the foreground process group and all processes in the current session lose their controlling terminal.

Process group and session ID

TIOCGPGRP pid_t *argp: When successful, equivalent to
*argp = tcgetpgrp(fd).
: Get the process group ID of the foreground process group on this terminal.
TIOCSPGRP const pid_t *argp: Equivalent to
tcsetpgrp(fd, *argp).
: Set the foreground process group ID of this terminal.
TIOCGSID pid_t *argp: Get the session ID of the given terminal.
This fails with the error ENOTTY if the terminal is not a master pseudoterminal and not our controlling terminal. Strange.

Exclusive mode

TIOCEXCL void: Put the terminal into exclusive mode.
No further open(2) operations on the terminal are permitted. (They fail with EBUSY, except for a process with the CAP_SYS_ADMIN capability.)
TIOCGEXCL int *argp: (since Linux 3.8)
If the terminal is currently in exclusive mode, place a nonzero value in the location pointed to by argp; otherwise, place zero in *argp.
TIOCNXCL void: Disable exclusive mode.

Line discipline

TIOCGETD int *argp: Get the line discipline of the terminal.
TIOCSETD const int *argp: Set the line discipline of the terminal.

Pseudoterminal ioctls

TIOCPKT const int *argp: Enable (when
*argp is nonzero) or disable packet mode. Can be applied to the master side of a pseudoterminal only (and will return ENOTTY otherwise). In packet mode, each subsequent read(2) will return a packet that either contains a single nonzero control byte, or has a single byte containing zero (‘