projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_3_Net_2 release
[unix-history] / usr / src / share / man / man4 / man4.hp300 / grf.4
diff --git a/usr/src/share/man/man4/man4.hp300/grf.4 b/usr/src/share/man/man4/man4.hp300/grf.4
index 8f766f7..4770711 100644 (file)
--- a/usr/src/share/man/man4/man4.hp300/grf.4
+++ b/usr/src/share/man/man4/man4.hp300/grf.4
@@ -1,34 +1,53 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Systems Programming Group of the University of Utah Computer
 .\" Science Department.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" the Systems Programming Group of the University of Utah Computer
 .\" Science Department.
+.\" 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 University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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.
 .\"
 .\"
-.\"    @(#)grf.4       5.1 (Berkeley) 6/29/90
+.\"     @(#)grf.4      5.3 (Berkeley) 7/31/91
 .\"
 .\"
-.TH GRF 4 "June 29, 1990"
-.UC 7
-.SH NAME
-grf \- HP graphics frame buffer device interface
-.SH DESCRIPTION
+.Dd July 31, 1991
+.Dt GRF 4 hp300
+.Os
+.Sh NAME
+.Nm grf
+.Nd
+.Tn HP
+graphics frame buffer device interface
+.Sh DESCRIPTION
 This is a generic description of the frame buffer device interface.
 The devices to which this applies are the 98544, 98545 and 98547
 This is a generic description of the frame buffer device interface.
 The devices to which this applies are the 98544, 98545 and 98547
-Topcat display cards (also known as HP300H devices),
+Topcat display cards (also known as
+.Tn HP300H
+devices),
 the 98548, 98549 and 98550
 Catseye display cards,
 the 98700
 the 98548, 98549 and 98550
 Catseye display cards,
 the 98700
@@ -37,128 +56,158 @@ the 98720
 Renaissance graphics box,
 and the 98730
 DaVinci graphics box.
 Renaissance graphics box,
 and the 98730
 DaVinci graphics box.
-.PP
+.Pp
 Use of the devices can be effectively approached from two directions.
 Use of the devices can be effectively approached from two directions.
-The first is through HP-UX
-.I Starbase
-routines, the second is by direct control in the BSD environment.
+The first is through
+.Tn HP-UX
+.Em Starbase
+routines, the second is by direct control in the
+.Bx
+environment.
 In order to use the Starbase libraries,
 In order to use the Starbase libraries,
-code must be compiled in an HP-UX environment, either by doing so on an HP-UX
-machine and transferring the binaries to the BSD machine, or by compilation
+code must be compiled in an
+.Tn HP-UX
+environment, either by doing so on an
+.Tn HP-UX
+machine and transferring the binaries to the
+.Bx
+machine, or by compilation
 with the use of the
 with the use of the
-.IR hpux (1)
+.Xr hpux 1
 command.
 Applications using Starbase libraries have been run successfully
 command.
 Applications using Starbase libraries have been run successfully
-on BSD machines using both of these compilation techniques.
-.PP
+on
+.Bx
+machines using both of these compilation techniques.
+.Pp
 Direct compilation,
 such as that used for the X Window System servers, has also been successful.
 Examples of some frame buffer operations can be found in
 the device dependent X Window system sources, for example the
 Direct compilation,
 such as that used for the X Window System servers, has also been successful.
 Examples of some frame buffer operations can be found in
 the device dependent X Window system sources, for example the
-.I /usr/src/new/X/libhp.fb
+.Pa /usr/src/new/X/libhp.fb
 directory.  These files contain examples of device dependent color map
 initialization, frame buffer operations, bit moving routines etc.
 directory.  These files contain examples of device dependent color map
 initialization, frame buffer operations, bit moving routines etc.
-.PP
+.Pp
 The basic programming of the
 The basic programming of the
-.IR grf \?
+.Nm grf Ns ?
 devices involves opening the device
 file, mapping the control registers and frame buffer addresses into user
 space, and then manipulating the device as the application requires.
 The address mapping is controlled by an
 devices involves opening the device
 file, mapping the control registers and frame buffer addresses into user
 space, and then manipulating the device as the application requires.
 The address mapping is controlled by an
-.IR ioctl (2)
+.Xr ioctl 2
 call to map the device into user space, and an unmap call when finished.
 call to map the device into user space, and an unmap call when finished.
-The ioctls supported by BSD are:
-.TP
-GRFIOCGINFO
+The ioctls supported by
+.Bx
+are:
+.Bl -tag -width indent
+.It Dv GRFIOCGINFO
 Get Graphics Info
 Get Graphics Info
-.sp
+.Pp
 Get info about device, setting the entries in the
 Get info about device, setting the entries in the
-.I grfinfo
+.Em grfinfo
 structure, as defined in <hpdev/grfioctl.h>:
 structure, as defined in <hpdev/grfioctl.h>:
-.DS
+.Bd -literal
 struct grfinfo {
 struct grfinfo {
-       int             gd_id;                  /* HPUX identifier */
-       caddr_t gd_regaddr;             /* control registers physaddr */
-       int             gd_regsize;             /* control registers size */
-       caddr_t gd_fbaddr;              /* frame buffer physaddr */
-       int             gd_fbsize;              /* frame buffer size */
-       short   gd_colors;              /* number of colors */
-       short   gd_planes;              /* number of planes */
+       int     gd_id;          /* HPUX identifier */
+       caddr_t gd_regaddr;     /* control registers physaddr */
+       int     gd_regsize;     /* control registers size */
+       caddr_t gd_fbaddr;      /* frame buffer physaddr */
+       int     gd_fbsize;      /* frame buffer size */
+       short   gd_colors;      /* number of colors */
+       short   gd_planes;      /* number of planes */
 /* new stuff */
 /* new stuff */
-       int             gd_fbwidth;             /* frame buffer width */
-       int             gd_fbheight;            /* frame buffer height */
-       int             gd_dwidth;              /* displayed part width */
-       int             gd_dheight;             /* displayed part height */
-       int             gd_pad[6];              /* for future expansion */
+       int     gd_fbwidth;     /* frame buffer width */
+       int     gd_fbheight;    /* frame buffer height */
+       int     gd_dwidth;      /* displayed part width */
+       int     gd_dheight;     /* displayed part height */
+       int     gd_pad[6];      /* for future expansion */
 };
 };
-.DE
-.TP
-GRFIOCON
+.Ed
+.It Dv GRFIOCON
 Graphics On
 Graphics On
-.sp
-Turn graphics on by enabling CRT output.  The screen will come on, displaying
+.Pp
+Turn graphics on by enabling
+.Tn CRT
+output.  The screen will come on, displaying
 whatever is in the frame buffer, using whatever colormap is in place.
 whatever is in the frame buffer, using whatever colormap is in place.
-.TP
-GRFIOCOFF
+.It Dv GRFIOCOFF
 Graphics Off
 Graphics Off
-.sp
-Turn graphics off by disabling output to the CRT.  The frame buffer contents
+.Pp
+Turn graphics off by disabling output to the
+.Tn CRT .
+The frame buffer contents
 are not affected.
 are not affected.
-.TP
-GRFIOCMAP
+.It Dv GRFIOCMAP
 Map Device to user space
 Map Device to user space
-.sp
+.Pp
 Map in control registers and framebuffer space. Once the device file is
 mapped, the frame buffer structure is accessible.
 Map in control registers and framebuffer space. Once the device file is
 mapped, the frame buffer structure is accessible.
-.TP
-GRFIOCUNMAP
+.It Dv GRFIOCUNMAP
 Unmap Device
 Unmap Device
-.sp
+.Pp
 Unmap control registers and framebuffer space.
 Unmap control registers and framebuffer space.
-.PP
+.El
+.Pp
 For further information about the use of ioctl see the man page.
 For further information about the use of ioctl see the man page.
-.SH EXAMPLE
+.Sh EXAMPLE
 This short code fragment is an example of opening some graphics device and
 mapping in the control and frame buffer space:
 This short code fragment is an example of opening some graphics device and
 mapping in the control and frame buffer space:
-.DS
+.Bd -literal
 #define GRF_DEV <some_graphics_device>  /* /dev/grfN */
 {
 #define GRF_DEV <some_graphics_device>  /* /dev/grfN */
 {
-    struct fbstruct *regs;  /*  fbstruct = gboxfb, rboxfb, etc. */
-    u_char *Addr, frame_buffer;
-    struct grfinfo gi;
-    int disp_fd;
+       struct fbstruct *regs;  /*  fbstruct = gboxfb, rboxfb, etc. */
+       u_char *Addr, frame_buffer;
+       struct grfinfo gi;
+       int disp_fd;
 
 
-      disp_fd = open(GRF_DEV,1);
-      if (ioctl (disp_fd, GRFIOCGINFO, &gi) < 0) return -1;
-      (void) ioctl (disp_fd, GRFIOCON, 0);
+       disp_fd = open(GRF_DEV,1);
+       if (ioctl (disp_fd, GRFIOCGINFO, &gi) < 0) return -1;
+       (void) ioctl (disp_fd, GRFIOCON, 0);
 
 
-      Addr = (u_char *) 0;
-      if (ioctl (disp_fd, GRFIOCMAP, &Addr) < 0) {
-           (void) ioctl (disp_fd, GRFIOCOFF, 0);
-           return -1;
-      }
-      regs = (fbstruct *) Addr;                       /* Control Registers   */
-      frame_buffer = (u_char *) Addr + gi.gd_regsize; /* Frame buffer memory */
+       Addr = (u_char *) 0;
+       if (ioctl (disp_fd, GRFIOCMAP, &Addr) < 0) {
+               (void) ioctl (disp_fd, GRFIOCOFF, 0);
+               return -1;
+       }
+       regs = (fbstruct *) Addr;               /* Control Registers   */
+       frame_buffer = (u_char *) Addr + gi.gd_regsize; /* Frame buffer mem */
 }
 }
-.DE
-.SH SEE ALSO
-ioctl(2), dv(4), gb(4), rb(4), tc(4), hil(4)
-.SH FILES
-.ta \w'/dev/*crt*  'u
-/dev/grf?      BSD interface special files
-.br
-/dev/*crt*     HP-UX \fIstarbase\fP interface special files
-.SH ERRORS
-.TP 15
-[ENODEV]
+.Ed
+.Sh FILES
+.Bl -tag -width /dev/*crt*? -compact
+.It Pa /dev/grf?
+.Bx
+interface special files
+.It Pa /dev/*crt*
+.Tn HP-UX
+.Em starbase
+interface special files
+.El
+.Sh DIAGNOSTICS
+None under
+.Bx .
+.Tn HP-UX
+The
+.Tn CE.utilities/Crtadjust
+programs must be used for each specific device.
+.Sh ERRORS
+.Bl -tag -width [EINVAL]
+.It Bq Er ENODEV
 no such device.
 no such device.
-.TP 15
-[EBUSY]
+.It Bq Er EBUSY
 Another process has the device open.
 Another process has the device open.
-.TP 15
-[EINVAL]
+.It Bq Er EINVAL
 Invalid ioctl specification.
 Invalid ioctl specification.
-.SH DIAGNOSTICS
-None under BSD.
-.br
-HP-UX CE.utilities/Crtadjust programs must be used for each specific device.
+.El
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr dv 4 ,
+.Xr gb 4 ,
+.Xr rb 4 ,
+.Xr tc 4 ,
+.Xr hil 4
+.Sh HISTORY
+The
+.Nm
+driver
+.Ud
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.