manual/LDP_man-pages/original/man2/ioperm.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1993 Michael Haardt
   4 .\" (michael@moria.de)
   5 .\" Fri Apr  2 11:32:09 MET DST 1993
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  25 .\" USA.
  26 .\"
  27 .\" Modified Sat Jul 24 15:12:05 1993 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified Tue Aug  1 16:27    1995 by Jochen Karrer
  29 .\"                              <cip307@cip.physik.uni-wuerzburg.de>
  30 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  31 .\" Modified Mon Feb 15 17:28:41 CET 1999 by Andries E. Brouwer <aeb@cwi.nl>
  32 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"     Added notes on capability requirements
  34 .\"
  35 .TH IOPERM 2 2007-06-15 "Linux" "Linux Programmer's Manual"
  36 .SH NAME
  37 ioperm \- set port input/output permissions
  38 .SH SYNOPSIS
  39 .B #include <unistd.h>
  40 /* for libc5 */
  41 .br
  42 .B #include <sys/io.h>
  43 /* for glibc */
  44 .sp
  45 .BI "int ioperm(unsigned long " from ", unsigned long " num ", int " turn_on );
  46 .SH DESCRIPTION
  47 .BR ioperm ()
  48 sets the port access permission bits for the calling process for
  49 \fInum\fP bytes starting from port address \fIfrom\fP to the value
  50 \fIturn_on\fP.
  51 If \fIturn_on\fP is nonzero, the calling process must be privileged
  52 .RB ( CAP_SYS_RAWIO ).
  53
  54 .\" FIXME is the following ("Only the first 0x3ff I/O ports can be
  55 .\" specified in this manner") still true?  Looking at changes in
  56 .\" include/asm-i386/processor.h between 2.4 and 2.6 suggests
  57 .\" that the limit is different in 2.6.
  58 Only the first 0x3ff I/O ports can be specified in this manner.
  59 For more ports, the
  60 .BR iopl (2)
  61 system call must be used.
  62
  63 Permissions are not inherited by the child created by
  64 .BR fork (2).
  65 Permissions are preserved across
  66 .BR execve (2);
  67 this is useful for giving port access permissions to unprivileged
  68 programs.
  69
  70 This call is mostly for the i386 architecture.
  71 On many other architectures it does not exist or will always
  72 return an error.
  73 .SH "RETURN VALUE"
  74 On success, zero is returned.
  75 On error, \-1 is returned, and
  76 .I errno
  77 is set appropriately.
  78 .SH ERRORS
  79 .TP
  80 .B EINVAL
  81 Invalid values for
  82 .I from
  83 or
  84 .IR num .
  85 .TP
  86 .B EIO
  87 (on PowerPC) This call is not supported.
  88 .TP
  89 .B ENOMEM
  90 .\" Could not allocate I/O bitmap.
  91 Out of memory.
  92 .TP
  93 .B EPERM
  94 The calling process has insufficient privilege.
  95 .SH "CONFORMING TO"
  96 .BR ioperm ()
  97 is Linux-specific and should not be used in programs
  98 intended to be portable.
  99 .SH NOTES
 100 Libc5 treats it as a system call and has a prototype in
 101 .IR <unistd.h> .
 102 Glibc1 does not have a prototype.
 103 Glibc2 has a prototype both in
 104 .I <sys/io.h>
 105 and in
 106 .IR <sys/perm.h> .
 107 Avoid the latter, it is available on i386 only.
 108 .SH "SEE ALSO"
 109 .BR iopl (2),
 110 .BR capabilities (7)