[src/trunk]: src/share/man/man4 Add agp(4) man page.

[gmcgarry <gmcgarry%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/a3862281d76b
branches:  trunk
changeset: 514800:a3862281d76b
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Mon Sep 10 21:12:30 2001 +0000

description:
Add agp(4) man page.

diffstat:

 share/man/man4/Makefile |    5 +-
 share/man/man4/agp.4    |  145 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 148 insertions(+), 2 deletions(-)

diffs (163 lines):

diff -r 37acba124317 -r a3862281d76b share/man/man4/Makefile
--- a/share/man/man4/Makefile   Mon Sep 10 20:36:43 2001 +0000
+++ b/share/man/man4/Makefile   Mon Sep 10 21:12:30 2001 +0000
@@ -1,7 +1,8 @@
-#      $NetBSD: Makefile,v 1.223 2001/08/27 19:51:29 thorpej Exp $
+#      $NetBSD: Makefile,v 1.224 2001/09/10 21:12:30 gmcgarry Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
-MAN=   acphy.4 adv.4 adw.4 ahb.4 ahc.4 amhphy.4 an.4 aria.4 atalk.4 audio.4 \
+MAN=   acphy.4 adv.4 adw.4 agp.4 ahb.4 ahc.4 amhphy.4 an.4 aria.4 \
+       atalk.4 audio.4 \
        auich.4 auvia.4 awi.4 bba.4 bha.4 bktr.4 bpf.4 bmtphy.4 brgphy.4 \
        bridge.4 cac.4 cardbus.4 ccd.4 cd.4 ch.4 clcs.4 clct.4 clnp.4 cltp.4 \
        cmpci.4 cms.4 cnw.4 com.4 ddb.4 de.4 dmphy.4 dpt.4 drum.4 eap.4 edc.4 \
diff -r 37acba124317 -r a3862281d76b share/man/man4/agp.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/agp.4      Mon Sep 10 21:12:30 2001 +0000
@@ -0,0 +1,145 @@
+.\"     $NetBSD: agp.4,v 1.1 2001/09/10 21:12:30 gmcgarry Exp $
+.\"
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Gregory McGarry.
+.\"
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" 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 FOUNDATION 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 September 11, 2001
+.Dt AGP 4
+.Os
+.Sh NAME
+.Nm agp
+.Nd accelerated graphics port driver
+.Sh SYNOPSIS
+.Cd "agp* at pchb?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides machine-independent support for the accelerated
+graphics port found on many PC-based and PCI systems.  The AGP
+specification was designed by Intel.
+.Pp
+The AGP chipset is positioned between the PCI-Host bridge and the
+graphics accelerator to provide a high-performance dedicated graphics
+bus.  It currently supports a peak bandwidth of 528 MB/s.
+.Pp
+The
+.Nm
+driver also provides an interfrace to user processes for use by X
+servers.  A user process communicates to the device initially by means
+of
+.Xr ioctl 2
+calls.  The calls supported are:
+.Bl -tag -width indent
+.It Dv AGPIOC_INFO
+Get AGP information, setting the members in the
+.Em agp_info
+structure as defined in <sys/agpio.h>:
+.Bd -literal
+typedef struct _agp_info {
+        agp_version version;    /* version of the driver        */
+        u_int32_t bridge_id;    /* bridge vendor/device         */
+        u_int32_t agp_mode;     /* mode info of bridge          */
+        off_t aper_base;        /* base of aperture             */
+        size_t aper_size;       /* size of aperture             */
+        size_t pg_total;        /* max pages (swap + system)    */
+        size_t pg_system;       /* max pages (system)           */
+        size_t pg_used;         /* current pages used           */
+} agp_info;
+.Ed
+.It Dv AGPIOC_ACQUIRE
+Acquire AGP.
+.It Dv AGPIOC_RELEASE
+Release AGP.
+.It Dv AGPIOC_SETUP
+Setup AGP, using the members in the
+.Em agp_setup
+structure as defined in <sys/agpio.h>:
+.Bd -literal
+typedef struct _agp_setup {
+        u_int32_t agp_mode;     /* mode info of bridge          */
+} agp_setup;
+.Ed
+.It Dv AGPIOC_ALLOCATE
+Allocate AGP space, using and setting the members in the
+.Em agp_allocate
+structure as defined in <sys/agpio.h>:
+.Bd -literal
+typedef struct _agp_allocate {
+        int key;                /* tag of allocation            */
+        size_t pg_count;        /* number of pages              */
+        u_int32_t type;         /* 0 == normal, other devspec   */
+        paddr_t physical;       /* device specific (some devices  
+                                 * need a phys address of the     
+                                 * actual page behind the gatt    
+                                 * table)                       */
+} agp_allocate;
+.Ed
+.It Dv AGPIOC_DEALLOCATE
+Deallocate AGP space.
+.It Dv AGPIOC_BIND
+Bind AGP, using the members in the
+.Em agp_bind
+structure as defined in <sys/agpio.h>:
+.Bd -literal
+typedef struct _agp_bind {
+        int key;                /* tag of allocation            */
+        off_t pg_start;         /* starting page to populate    */
+} agp_bind;
+.Ed
+.It Dv AGPIOC_UNBIND
+Unbind AGP, using the members in the
+.Em agp_unbind
+structure as defined in <sys/agpio.h>:
+.Bd -literal
+typedef struct _agp_unbind {
+        int key;                /* tag of allocation            */
+        u_int32_t priority;     /* priority for paging out      */
+} agp_unbind;
+.Ed
+.El
+.Sh FILES
+.Bl -tag -width /dev/agp? -compact
+.It Pa /dev/agp?
+device special file
+.El
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr pci 4
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx .
+It was introduced in
+.Nx 1.6 .