summaryrefslogtreecommitdiff
path: root/lib/libarch/amd64/amd64_iopl.2
blob: 22e69e375e2bc9b1515023c349e718ea7e87cbe4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.\"	$OpenBSD: amd64_iopl.2,v 1.8 2015/09/10 17:55:21 schwarze Exp $
.\"	$NetBSD: amd64_iopl.2,v 1.3 1996/02/27 22:57:25 jtc Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by John T. Kohl and Charles M. Hannum.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: September 10 2015 $
.Dt AMD64_IOPL 2 amd64
.Os
.Sh NAME
.Nm amd64_iopl
.Nd change the amd64 I/O privilege level
.Sh SYNOPSIS
.In sys/types.h
.In machine/sysarch.h
.Ft int
.Fn amd64_iopl "int iopl"
.Sh DESCRIPTION
.Fn amd64_iopl
sets the amd64 I/O privilege level to the value specified by
.Ar iopl .
.Pp
This call may only be made by the superuser.
Additionally, it is only permitted when the
.Xr securelevel 7
is less than or equal to 0 or the
.Va machdep.allowaperture
sysctl has been set to a non-zero value.
.Pp
.Sy Note:
Code using the
.Fn amd64_iopl
function must be compiled using
.Cm -lamd64 .
.Sh RETURN VALUES
Upon successful completion,
.Fn amd64_iopl
returns 0.
Otherwise, a value of \-1 is returned and the global
variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn amd64_iopl
will fail if:
.Bl -tag -width [EINVAL]
.It Bq Er EPERM
The caller was not the superuser, or the securelevel is greater than zero and
.Va machdep.allowaperture
has not been set to a non-zero value.
.El
.Sh SEE ALSO
.Xr securelevel 7
.Sh REFERENCES
.Rs
.%A Intel
.%T AMD64 Microprocessor Programmer's Reference Manual
.Re
.Sh WARNING
You can really hose your machine if you enable user-level I/O and
write to hardware ports without care.