Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / lib / libcr / 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 .\" $DragonFly: src/lib/libcr/i386/sys/Attic/i386_get_ioperm.2,v 1.2 2003/06/17 04:26:43 dillon Exp $
27 .\"
28 .Dd July 27, 1998
29 .Os
30 .Dt I386_GET_IOPERM 2
31 .Sh NAME
32 .Nm i386_get_ioperm ,
33 .Nm i386_set_ioperm
34 .Nd manage per-process access to the i386 I/O port space
35 .Sh LIBRARY
36 .Lb libc
37 .Sh SYNOPSIS
38 .In machine/sysarch.h
39 .Ft int
40 .Fn i386_get_ioperm "unsigned int start" "unsigned int *length" "int *enable"
41 .Ft int
42 .Fn i386_set_ioperm "unsigned int start" "unsigned int length" "int enable"
43 .Sh DESCRIPTION
44 .Fn i386_get_ioperm
45 will return the permission for the process' I/O port space in the
46 .Fa *enable
47 argument.  The port range starts at
48 .Fa start
49 and the number of contiguous entries will be returned in
50 .Fa *length .
51 .Pp
52 .Fn i386_set_ioperm
53 will set access to a range of I/O ports described by the
54 .Fa start
55 and
56 .Fa length
57 arguments to the state specified by the
58 .Fa enable
59 argument.
60 .Sh RETURN VALUES
61 .Rv -std
62 .Sh ERRORS
63 .Fn i386_get_ioperm
64 and
65 .Fn i386_set_ioperm
66 will fail if:
67 .Bl -tag -width Er
68 .It Bq Er EINVAL
69 An invalid range was specified by the
70 .Fa start
71 or
72 .Fa length
73 arguments.
74 .It Bq Er EPERM
75 The caller of i386_set_ioperm was not the superuser.
76 .El
77 .Sh SEE ALSO
78 .Xr io 4
79 .Sh AUTHORS
80 This man page was written by
81 .An Jonathan Lemon .