Manpage of IOCTL
IOCTLSection: Linux Programmer's Manual (2)
NAMEioctl - control device
DESCRIPTIONThe 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 fdmust 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() requesthas encoded in it whether the argument is an inparameter or outparameter, and the size of the argument argpin bytes. Macros and defines used in specifying an ioctl() requestare located in the file <sys/ioctl.h>.
RETURN VALUEUsually, 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 errnois set appropriately.
- fdis not a valid file descriptor.
- argpreferences an inaccessible memory area.
- requestor argpis not valid.
- fdis not associated with a character special device.
- The specified request does not apply to the kind of object that the file descriptor fdreferences.
CONFORMING TONo 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.
NOTESIn 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_NONBLOCKflag.
SEE ALSOexecve(2), fcntl(2), ioctl_fat(2), ioctl_ficlonerange(2), ioctl_fideduperange(2), ioctl_iflags(2), ioctl_list(2), ioctl_ns(2), open(2), console_ioctl(4), sd(4), tty(4), tty_ioctl(4)
This document was created by man2html, using the manual pages.
Time: 16:30:09 GMT, March 14, 2017 Click Here!