ioctl man page

ioctl — control device

Synopsis

#include <sys/ioctl.h>

int ioctl(int fd, unsigned long request, ...);

Description

The ioctl() function manipulates the underlying device parameters of special files. In particular, many operating characteristics of character special files (e.g., terminals) may be controlled with ioctl() requests. The argument fd must be an open file descriptor.

The second argument is a device-dependent request code. The third argument is an untyped pointer to memory. It's traditionally char *argp (from the days before void * was valid C), and will be so named for this discussion.

An ioctl() request has encoded in it whether the argument is an in parameter or out parameter, and the size of the argument argp in bytes. Macros and defines used in specifying an ioctl() request are located in the file <sys/ioctl.h>.

Return Value

Usually, on success zero is returned. A few ioctl() requests use the return value as an output parameter and return a nonnegative value on success. On error, -1 is returned, and errno is set appropriately.

Errors

EBADF
fd is not a valid file descriptor.
EFAULT
argp references an inaccessible memory area.
EINVAL
request or argp is not valid.
ENOTTY
fd is not associated with a character special device.
ENOTTY
The specified request does not apply to the kind of object that the file descriptor fd references.

Conforming to

No single standard. Arguments, returns, and semantics of ioctl() vary according to the device driver in question (the call is used as a catch-all for operations that don't cleanly fit the UNIX stream I/O model). See ioctl_list(2) for a list of many of the known ioctl() calls. The ioctl() function call appeared in Version 7 AT&T UNIX.

Notes

In order to use this call, one needs an open file descriptor. Often the open(2) call has unwanted side effects, that can be avoided under Linux by giving it the O_NONBLOCK flag.

See Also

execve(2), fcntl(2), ioctl_fat(2), ioctl_ficlonerange(2), ioctl_fideduperange(2), ioctl_list(2), open(2), console_ioctl(4), sd(4), tty(4), tty_ioctl(4)

Colophon

This page is part of release 4.08 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

Referenced By

apple2(6), apropos(1), arp(7), btrfs(5), capabilities(7), collectd.conf(5), console_ioctl(4), cstream(1), drm(7), drm-memory(7), dsp56k(4), errno(3), explain(1), explain(3), explain_ioctl(3), explain_ioctl_or_die(3), explain_lca2010(1), fd(4), getifaddrs(3), getsockopt(2), haveged(8), hwstamp_ctl(8), if_nameindex(3), if_nametoindex(3), inotify(7), ioctl_fat(2), ioctl_ficlonerange(2), ioctl_fideduperange(2), ioctl_list(2), ksh(1), loop(4), lp(4), man(1), mgettydefs(4), ntfsclone(8), open(2), openpty(3), perf_event_open(2), perlfunc(1), phosphor(6), pipe(7), procenv(1), pty(7), random(4), read(2), rmt(1), rtc(4), scrub(1), sd(4), select_tut(2), signal(7), sockatmark(3), socket(2), socket(7), sslsplit(1), st(4), stress-ng(1), swipl(1), syscalls(2), tcgetsid(3), tcp(7), termio(7), timerfd_create(2), tty(4), tty_ioctl(4), udp(7), unix(7), vcs(4), whatis(1), write(2).

2016-07-17 Linux Linux Programmer's Manual