6024688fdaf33d6439815742967fc9606a1e0d11
[dragonfly.git] / lib / libc / i386 / sys / i386_get_ioperm.2
1 .\" Copyright (c) 1998 Jonathan Lemon
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/lib/libc/i386/sys/i386_get_ioperm.2,v 1.3.2.6 2001/12/14 18:33:54 ru Exp $
26 .\"
27 .Dd July 27, 1998
28 .Dt I386_GET_IOPERM 2
29 .Os
30 .Sh NAME
31 .Nm i386_get_ioperm ,
32 .Nm i386_set_ioperm
33 .Nd manage per-process access to the i386 I/O port space
34 .Sh LIBRARY
35 .Lb libc
36 .Sh SYNOPSIS
37 .In machine/sysarch.h
38 .Ft int
39 .Fn i386_get_ioperm "unsigned int start" "unsigned int *length" "int *enable"
40 .Ft int
41 .Fn i386_set_ioperm "unsigned int start" "unsigned int length" "int enable"
42 .Sh DESCRIPTION
43 .Fn i386_get_ioperm
44 will return the permission for the process' I/O port space in the
45 .Fa *enable
46 argument.  The port range starts at
47 .Fa start
48 and the number of contiguous entries will be returned in
49 .Fa *length .
50 .Pp
51 .Fn i386_set_ioperm
52 will set access to a range of I/O ports described by the
53 .Fa start
54 and
55 .Fa length
56 arguments to the state specified by the
57 .Fa enable
58 argument.
59 .Sh RETURN VALUES
60 .Rv -std
61 .Sh ERRORS
62 .Fn i386_get_ioperm
63 and
64 .Fn i386_set_ioperm
65 will fail if:
66 .Bl -tag -width Er
67 .It Bq Er EINVAL
68 An invalid range was specified by the
69 .Fa start
70 or
71 .Fa length
72 arguments.
73 .It Bq Er EPERM
74 The caller of
75 .Fn i386_set_ioperm
76 was not the superuser.
77 .El
78 .Sh SEE ALSO
79 .Xr io 4
80 .Sh AUTHORS
81 This man page was written by
82 .An Jonathan Lemon .