share/man/man4/man4.hp300/topcat.4

   1 .\"     $NetBSD: topcat.4,v 1.3 2002/02/13 08:17:58 ross Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the Systems Programming Group of the University of Utah Computer
   8 .\" Science Department.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     from: @(#)tc.4  8.1 (Berkeley) 6/9/93
  35 .\"
  36 .Dd September 10, 2001
  37 .Dt TOPCAT 4 hp300
  38 .Os
  39 .Sh NAME
  40 .Nm topcat
  41 .Nd
  42 .Tn HP98544
  43 98550 ``Topcat'' and ``Catseye'' device interface
  44 .Sh SYNOPSIS
  45 .Cd "topcat* at intio?"
  46 .Cd "topcat* at dio? scode ?"
  47 .Sh DESCRIPTION
  48 This driver is for the
  49 .Tn HP98544 ,
  50 98545 and 98547 ``Topcat''
  51 and
  52 .Tn HP98548 ,
  53 98549, and 98550 ``Catseye'' display cards.
  54 This driver merely checks for the existence of the device
  55 and does minimal set up, as it is expected the applications will initialize
  56 the device to their requirements.
  57 The Topcat and Catseye are nearly identical in common usage and only the
  58 Topcat will be referred to from now on.
  59 .Pp
  60 The Topcat display cards are not user configurable.  If one is present on a
  61 system, it will always have a frame buffer address of 0x200000 and a control
  62 register address of 0x560000.  These are the
  63 .Tn HP
  64 series 300
  65 .Tn ITE
  66 (Internal
  67 Terminal Emulator) defaults.  The device can also be used as a graphics output
  68 device.
  69 .Pp
  70 The
  71 .Xr ioctl 2
  72 calls supported by the
  73 .Bx
  74 system for the Topcat are:
  75 .Bl -tag -width GRFIOCGINFO
  76 .It Dv GRFIOCGINFO
  77 Get Graphics Info
  78 .Pp
  79 Get info about device, setting the entries in the
  80 .Ar grfinfo
  81 structure, as defined in
  82 .Aq Pa hpdev/grfioctl.h .
  83 For the 98544 or 98549,
  84 the number of planes should be 1, as they are monochrome devices.
  85 The number of planes for a 98545 is 4, translating to 15 colors,
  86 excluding black.
  87 The 98547 and 98548 cards have 6 planes, yielding 63 colors and black.
  88 The 98550 has 8 planes, yielding 255 colors and black.
  89 The displayed frame buffer size for the 98549 and 98550 is 2048 x 1024,
  90 for the others it is 1024 x 768.
  91 .It Dv GRFIOCON
  92 Graphics On
  93 .Pp
  94 Turn graphics on by enabling
  95 .Tn CRT
  96 output.  The screen will come on, displaying
  97 whatever is in the frame buffer, using whatever colormap is in place.
  98 .It Dv GRFIOCOFF
  99 Graphics Off
 100 .Pp
 101 Turn graphics off by disabling output to the
 102 .Tn CRT .
 103 The frame buffer contents
 104 are not affected.
 105 .It Dv GRFIOCMAP
 106 Map Device to user space
 107 .Pp
 108 Map in control registers and framebuffer space. Once the device file is
 109 mapped, the frame buffer structure is accessible.  The frame buffer structure
 110 describing Topcat/Catseye devices is defined in
 111 .Aq Pa hpdev/grf_tcreg.h .
 112 .El
 113 .Pp
 114 For further information about the use of
 115 .Xr ioctl 2
 116 see the man page.
 117 .Sh FILES
 118 .Bl -tag -width /dev/MAKEDEV.hpux -compact
 119 .It Pa /dev/grf?
 120 .Bx
 121 special file
 122 .It Pa /dev/crt9837
 123 .It Pa /dev/crt98550
 124 .Tn HP-UX
 125 .Em starbase
 126 special files
 127 .It Pa /dev/MAKEDEV.hpux
 128 script for creating
 129 .Tn HP-UX
 130 special files
 131 .El
 132 .Sh EXAMPLES
 133 A small example of opening, mapping and using the device is given below.
 134 For more examples of the details on the behavior of the device, see the device
 135 dependent source files for the X Window System, in the
 136 .Pa /usr/src/new/X/libhp
 137 directory.
 138 .Bd -literal
 139 struct tcboxfb *tc;
 140 u_char *Addr, frame_buffer;
 141 struct grfinfo gi;
 142 int disp_fd;
 143
 144 disp_fd = open("/dev/grf0",1);
 145
 146 if (ioctl (disp_fd, GRFIOCGINFO, \*[Am]gi) \*[Lt] 0) return -1;
 147
 148 (void) ioctl (disp_fd, GRFIOCON, 0);
 149
 150 Addr = (u_char *) 0;
 151 if (ioctl (disp_fd, GRFIOCMAP, \*[Am]Addr) \*[Lt] 0) {
 152         (void) ioctl (disp_fd, GRFIOCOFF, 0);
 153         return -1;
 154 }
 155 tc = (tcboxfb *) Addr;                          /* Control Registers   */
 156 frame_buffer = (u_char *) Addr + gi.gd_regsize; /* Frame buffer memory */
 157 .Ed
 158 .Sh DIAGNOSTICS
 159 None under
 160 .Bx .
 161 .Tn HP-UX
 162 .Tn /usr/CE.utilities/Crtadjust
 163 programs must be used.
 164 .Sh ERRORS
 165 .Bl -tag -width [EINVAL]
 166 .It Bq Er ENODEV
 167 no such device.
 168 .It Bq Er EBUSY
 169 Another process has the device open.
 170 .It Bq Er EINVAL
 171 Invalid
 172 .Xr ioctl 2
 173 specification.
 174 .El
 175 .Sh SEE ALSO
 176 .Xr ioctl 2 ,
 177 .Xr grf 4 ,
 178 .Xr ite 4