Blame man2/iopl.2

Packit 7cfc04
.\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
Packit 7cfc04
.\" Portions extracted from linux/kernel/ioport.c (no copyright notice).
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" Modified Tue Aug  1 16:47    1995 by Jochen Karrer
Packit 7cfc04
.\"                              <cip307@cip.physik.uni-wuerzburg.de>
Packit 7cfc04
.\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
Packit 7cfc04
.\" Modified Fri Nov 27 14:50:36 CET 1998 by Andries Brouwer <aeb@cwi.nl>
Packit 7cfc04
.\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
Packit 7cfc04
.\"     Added notes on capability requirements
Packit 7cfc04
.\"
Packit 7cfc04
.TH IOPL 2 2017-09-15 "Linux" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
iopl \- change I/O privilege level
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.B #include <sys/io.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "int iopl(int " level );
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
.BR iopl ()
Packit 7cfc04
changes the I/O privilege level of the calling process,
Packit 7cfc04
as specified by the two least significant bits in
Packit 7cfc04
.IR level .
Packit 7cfc04
.PP
Packit 7cfc04
This call is necessary to allow 8514-compatible X servers to run under
Packit 7cfc04
Linux.
Packit 7cfc04
Since these X servers require access to all 65536 I/O ports, the
Packit 7cfc04
.BR ioperm (2)
Packit 7cfc04
call is not sufficient.
Packit 7cfc04
.PP
Packit 7cfc04
In addition to granting unrestricted I/O port access, running at a higher
Packit 7cfc04
I/O privilege level also allows the process to disable interrupts.
Packit 7cfc04
This will probably crash the system, and is not recommended.
Packit 7cfc04
.PP
Packit 7cfc04
Permissions are not inherited by the child process created by
Packit 7cfc04
.BR fork (2)
Packit 7cfc04
and are not preserved across
Packit 7cfc04
.BR execve (2)
Packit 7cfc04
(but see NOTES).
Packit 7cfc04
.PP
Packit 7cfc04
The I/O privilege level for a normal process is 0.
Packit 7cfc04
.PP
Packit 7cfc04
This call is mostly for the i386 architecture.
Packit 7cfc04
On many other architectures it does not exist or will always
Packit 7cfc04
return an error.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
On success, zero is returned.
Packit 7cfc04
On error, \-1 is returned, and
Packit 7cfc04
.I errno
Packit 7cfc04
is set appropriately.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EINVAL
Packit 7cfc04
.I level
Packit 7cfc04
is greater than 3.
Packit 7cfc04
.TP
Packit 7cfc04
.B ENOSYS
Packit 7cfc04
This call is unimplemented.
Packit 7cfc04
.TP
Packit 7cfc04
.B EPERM
Packit 7cfc04
The calling process has insufficient privilege to call
Packit 7cfc04
.BR iopl ();
Packit 7cfc04
the
Packit 7cfc04
.B CAP_SYS_RAWIO
Packit 7cfc04
capability is required to raise the I/O privilege level
Packit 7cfc04
above its current value.
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
.BR iopl ()
Packit 7cfc04
is Linux-specific and should not be used in programs that are
Packit 7cfc04
intended to be portable.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
.\" Libc5 treats it as a system call and has a prototype in
Packit 7cfc04
.\" .IR <unistd.h> .
Packit 7cfc04
.\" Glibc1 does not have a prototype.
Packit 7cfc04
Glibc2 has a prototype both in
Packit 7cfc04
.I <sys/io.h>
Packit 7cfc04
and in
Packit 7cfc04
.IR <sys/perm.h> .
Packit 7cfc04
Avoid the latter, it is available on i386 only.
Packit 7cfc04
.PP
Packit 7cfc04
Prior to Linux 3.7,
Packit 7cfc04
on some architectures (such as i386), permissions
Packit 7cfc04
.I were
Packit 7cfc04
inherited by the child produced by
Packit 7cfc04
.BR fork (2)
Packit 7cfc04
and were preserved across
Packit 7cfc04
.BR execve (2).
Packit 7cfc04
This behavior was inadvertently changed in Linux 3.7,
Packit 7cfc04
and won't be reinstated.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR ioperm (2),
Packit 7cfc04
.BR outb (2),
Packit 7cfc04
.BR capabilities (7)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.