usr/src/man/man2/ioctl.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH IOCTL 2 "Feb 15, 1996"
  11 .SH NAME
  12 ioctl \- control device
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <unistd.h>
  17 #include <stropts.h>
  18
  19 \fBint\fR \fBioctl\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIrequest\fR, \fB/*\fR \fIarg\fR */ ...);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBioctl()\fR function performs a variety of control functions on devices
  26 and streams. For non-streams files, the functions performed by this call are
  27 device-specific control functions.  The \fIrequest\fR argument and an optional
  28 third argument with varying type are passed to the file designated by
  29 \fIfildes\fR and are interpreted by the device driver.
  30 .sp
  31 .LP
  32 For streams files, specific functions are performed by the \fBioctl()\fR
  33 function as described in \fBstreamio\fR(7I).
  34 .sp
  35 .LP
  36 The \fIfildes\fR argument is an open file descriptor that refers to a device.
  37 The \fIrequest\fR argument selects the control function to be performed and
  38 depends on the device being addressed.  The \fIarg\fR argument represents a
  39 third argument that has additional information that is needed by this specific
  40 device to perform the requested function. The data type of \fIarg\fR depends
  41 upon the particular control request, but it is either an \fBint\fR or a pointer
  42 to a device-specific data structure.
  43 .sp
  44 .LP
  45 In addition to device-specific and streams functions, generic functions are
  46 provided by more than one device driver (for example, the general terminal
  47 interface.)  See \fBtermio\fR(7I)).
  48 .SH RETURN VALUES
  49 .sp
  50 .LP
  51 Upon successful completion, the value returned depends upon the device control
  52 function, but must be a non-negative integer.  Otherwise, \fB\(mi1\fR is
  53 returned and \fBerrno\fR is set to indicate the error.
  54 .SH ERRORS
  55 .sp
  56 .LP
  57 The \fBioctl()\fR function will fail for any type of file if:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBEBADF\fR\fR
  62 .ad
  63 .RS 10n
  64 The \fIfildes\fR argument is not a valid open file descriptor.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBEINTR\fR\fR
  71 .ad
  72 .RS 10n
  73 A signal was caught during the execution of the \fBioctl()\fR function.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBEINVAL\fR\fR
  80 .ad
  81 .RS 10n
  82 The stream or multiplexer referenced by \fIfildes\fR is linked (directly or
  83 indirectly) downstream from a multiplexer.
  84 .RE
  85
  86 .sp
  87 .LP
  88 The \fBioctl()\fR function will also fail if the device driver detects an
  89 error.  In this case, the error is passed through \fBioctl()\fR without change
  90 to the caller. A particular driver might not have all of the following error
  91 cases. Under the following conditions, requests to device drivers may fail and
  92 set \fBerrno\fR to indicate the error
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEFAULT\fR\fR
  97 .ad
  98 .RS 11n
  99 The \fIrequest\fR argument requires a data transfer to or from a buffer pointed
 100 to by \fIarg\fR, but \fIarg\fR points to an illegal address.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBEINVAL\fR\fR
 107 .ad
 108 .RS 11n
 109 The \fIrequest\fR or \fIarg\fR argument is not valid for this device.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBEIO\fR\fR
 116 .ad
 117 .RS 11n
 118 Some physical I/O error has occurred.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBENOLINK\fR\fR
 125 .ad
 126 .RS 11n
 127 The \fIfildes\fR argument is on a remote machine and the link to that machine
 128 is no longer active.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBENOTTY\fR\fR
 135 .ad
 136 .RS 11n
 137 The \fIfildes\fR argument is not associated with a streams device that accepts
 138 control functions.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBENXIO\fR\fR
 145 .ad
 146 .RS 11n
 147 The \fIrequest\fR and \fIarg\fR arguments are valid for this device driver, but
 148 the service requested can not be performed on this particular subdevice.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBENODEV\fR\fR
 155 .ad
 156 .RS 11n
 157 The \fIfildes\fR argument refers to a valid streams device, but the
 158 corresponding device driver does not support the \fBioctl()\fR function.
 159 .RE
 160
 161 .sp
 162 .LP
 163 Streams errors are described in \fBstreamio\fR(7I).
 164 .SH ATTRIBUTES
 165 .sp
 166 .LP
 167 See \fBattributes\fR(5) for descriptions of the following attributes:
 168 .sp
 169
 170 .sp
 171 .TS
 172 box;
 173 c | c
 174 l | l .
 175 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 176 _
 177 Interface Stability     Standard
 178 .TE
 179
 180 .SH SEE ALSO
 181 .sp
 182 .LP
 183 \fBattributes\fR(5), \fBstandards\fR(5), \fBstreamio\fR(7I), \fBtermio\fR(7I)