original/man2/ioperm.2

   1 .\" Copyright (c) 1993 Michael Haardt
   2 .\" (michael@moria.de)
   3 .\" Fri Apr  2 11:32:09 MET DST 1993
   4 .\"
   5 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   6 .\" This is free documentation; you can redistribute it and/or
   7 .\" modify it under the terms of the GNU General Public License as
   8 .\" published by the Free Software Foundation; either version 2 of
   9 .\" the License, or (at your option) any later version.
  10 .\"
  11 .\" The GNU General Public License's references to "object code"
  12 .\" and "executables" are to be interpreted as the output of any
  13 .\" document formatting or typesetting system, including
  14 .\" intermediate and printed output.
  15 .\"
  16 .\" This manual is distributed in the hope that it will be useful,
  17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 .\" GNU General Public License for more details.
  20 .\"
  21 .\" You should have received a copy of the GNU General Public
  22 .\" License along with this manual; if not, see
  23 .\" <http://www.gnu.org/licenses/>.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Modified Sat Jul 24 15:12:05 1993 by Rik Faith <faith@cs.unc.edu>
  27 .\" Modified Tue Aug  1 16:27    1995 by Jochen Karrer
  28 .\"                              <cip307@cip.physik.uni-wuerzburg.de>
  29 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  30 .\" Modified Mon Feb 15 17:28:41 CET 1999 by Andries E. Brouwer <aeb@cwi.nl>
  31 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  32 .\"     Added notes on capability requirements
  33 .\"
  34 .TH IOPERM 2 2013-03-12 "Linux" "Linux Programmer's Manual"
  35 .SH NAME
  36 ioperm \- set port input/output permissions
  37 .SH SYNOPSIS
  38 .B #include <unistd.h>
  39 /* for libc5 */
  40 .br
  41 .B #include <sys/io.h>
  42 /* for glibc */
  43 .sp
  44 .BI "int ioperm(unsigned long " from ", unsigned long " num ", int " turn_on );
  45 .SH DESCRIPTION
  46 .BR ioperm ()
  47 sets the port access permission bits for the calling thread for
  48 .I num
  49 bits starting from port address
  50 .IR from .
  51 If
  52 .I turn_on
  53 is nonzero, then permission for the specified bits is enabled;
  54 otherwise it is disabled.
  55 If
  56 .I turn_on
  57 is nonzero, the calling thread must be privileged
  58 .RB ( CAP_SYS_RAWIO ).
  59
  60 Before Linux 2.6.8,
  61 only the first 0x3ff I/O ports could be specified in this manner.
  62 For more ports, the
  63 .BR iopl (2)
  64 system call had to be used (with a
  65 .I level
  66 argument of 3).
  67 Since Linux 2.6.8, 65,536 I/O ports can be specified.
  68
  69 Permissions are not inherited by the child created by
  70 .BR fork (2);
  71 following a
  72 .BR fork (2)
  73 the child must turn on those permissions that it needs.
  74 Permissions are preserved across
  75 .BR execve (2);
  76 this is useful for giving port access permissions to unprivileged
  77 programs.
  78
  79 This call is mostly for the i386 architecture.
  80 On many other architectures it does not exist or will always
  81 return an error.
  82 .SH RETURN VALUE
  83 On success, zero is returned.
  84 On error, \-1 is returned, and
  85 .I errno
  86 is set appropriately.
  87 .SH ERRORS
  88 .TP
  89 .B EINVAL
  90 Invalid values for
  91 .I from
  92 or
  93 .IR num .
  94 .TP
  95 .B EIO
  96 (on PowerPC) This call is not supported.
  97 .TP
  98 .B ENOMEM
  99 .\" Could not allocate I/O bitmap.
 100 Out of memory.
 101 .TP
 102 .B EPERM
 103 The calling thread has insufficient privilege.
 104 .SH CONFORMING TO
 105 .BR ioperm ()
 106 is Linux-specific and should not be used in programs
 107 intended to be portable.
 108 .SH NOTES
 109 The
 110 .I /proc/ioports
 111 file shows the I/O ports that are currently allocated on the system.
 112
 113 Libc5 treats it as a system call and has a prototype in
 114 .IR <unistd.h> .
 115 Glibc1 does not have a prototype.
 116 Glibc2 has a prototype both in
 117 .I <sys/io.h>
 118 and in
 119 .IR <sys/perm.h> .
 120 Avoid the latter, it is available on i386 only.
 121 .SH SEE ALSO
 122 .BR iopl (2),
 123 .BR outb (2),
 124 .BR capabilities (7)
 125 .SH COLOPHON
 126 This page is part of release 3.68 of the Linux
 127 .I man-pages
 128 project.
 129 A description of the project,
 130 information about reporting bugs,
 131 and the latest version of this page,
 132 can be found at
 133 \%http://www.kernel.org/doc/man\-pages/.