original/man2/ioctl.2

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)ioctl.2     6.4 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified 1993-07-23 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 1999-06-25 by Rachael Munns <vashti@dream.org.uk>
  39 .\" Modified 2000-09-21 by Andries Brouwer <aeb@cwi.nl>
  40 .\"
  41 .TH IOCTL 2 2013-11-08 "Linux" "Linux Programmer's Manual"
  42 .SH NAME
  43 ioctl \- control device
  44 .SH SYNOPSIS
  45 .B #include <sys/ioctl.h>
  46 .sp
  47 .BI "int ioctl(int " d ", unsigned long " request ", ...);"
  48 .\" POSIX says 'request' is int, but glibc has the above
  49 .\" See https://bugzilla.kernel.org/show_bug.cgi?id=42705
  50 .SH DESCRIPTION
  51 The
  52 .BR ioctl ()
  53 function manipulates the underlying device parameters of special files.
  54 In particular, many operating characteristics of character special files
  55 (e.g., terminals) may be controlled with
  56 .BR ioctl ()
  57 requests.
  58 The argument
  59 .I d
  60 must be an open file descriptor.
  61 .PP
  62 The second argument is a device-dependent request code.
  63 The third argument is an untyped pointer to memory.
  64 It's traditionally
  65 .BI "char *" argp
  66 (from the days before
  67 .B "void *"
  68 was valid C), and will be so named for this discussion.
  69 .PP
  70 An
  71 .BR ioctl ()
  72 .I request
  73 has encoded in it whether the argument is an
  74 .I in
  75 parameter or
  76 .I out
  77 parameter, and the size of the argument
  78 .I argp
  79 in bytes.
  80 Macros and defines used in specifying an
  81 .BR ioctl ()
  82 .I request
  83 are located in the file
  84 .IR <sys/ioctl.h> .
  85 .SH RETURN VALUE
  86 Usually, on success zero is returned.
  87 A few
  88 .BR ioctl ()
  89 requests use the return value as an output parameter
  90 and return a nonnegative value on success.
  91 On error, \-1 is returned, and
  92 .I errno
  93 is set appropriately.
  94 .SH ERRORS
  95 .TP 0.7i
  96 .B EBADF
  97 .I d
  98 is not a valid descriptor.
  99 .TP
 100 .B EFAULT
 101 .I argp
 102 references an inaccessible memory area.
 103 .TP
 104 .B EINVAL
 105 .I request
 106 or
 107 .I argp
 108 is not valid.
 109 .TP
 110 .B ENOTTY
 111 .I d
 112 is not associated with a character special device.
 113 .TP
 114 .B ENOTTY
 115 The specified request does not apply to the kind of object that the
 116 descriptor
 117 .I d
 118 references.
 119 .SH CONFORMING TO
 120 No single standard.
 121 Arguments, returns, and semantics of
 122 .BR ioctl ()
 123 vary according to the device driver in question (the call is used as a
 124 catch-all for operations that don't cleanly fit the UNIX stream I/O
 125 model).
 126 See
 127 .BR ioctl_list (2)
 128 for a list of many of the known
 129 .BR ioctl ()
 130 calls.
 131 The
 132 .BR ioctl ()
 133 function call appeared in Version 7 AT&T UNIX.
 134 .SH NOTES
 135 In order to use this call, one needs an open file descriptor.
 136 Often the
 137 .BR open (2)
 138 call has unwanted side effects, that can be avoided under Linux
 139 by giving it the
 140 .B O_NONBLOCK
 141 flag.
 142 .SH SEE ALSO
 143 .BR execve (2),
 144 .BR fcntl (2),
 145 .BR ioctl_list (2),
 146 .BR open (2),
 147 .\" .BR mt (4),
 148 .BR sd (4),
 149 .BR tty (4)
 150 .SH COLOPHON
 151 This page is part of release 3.68 of the Linux
 152 .I man-pages
 153 project.
 154 A description of the project,
 155 information about reporting bugs,
 156 and the latest version of this page,
 157 can be found at
 158 \%http://www.kernel.org/doc/man\-pages/.