components/x11/libdga/src/cmap_grab.h

   1 /* Copyright (c) 1993, 1996, Oracle and/or its affiliates. All rights reserved.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a
   4  * copy of this software and associated documentation files (the "Software"),
   5  * to deal in the Software without restriction, including without limitation
   6  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7  * and/or sell copies of the Software, and to permit persons to whom the
   8  * Software is furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice (including the next
  11  * paragraph) shall be included in all copies or substantial portions of the
  12  * Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20  * DEALINGS IN THE SOFTWARE.
  21  */
  22
  23
  24 /*
  25  * cmap_grab.h - colormap grabber structures and information
  26  */
  27
  28 #ifndef _CMAP_GRAB_H
  29 #define _CMAP_GRAB_H
  30
  31
  32
  33 /****
  34  *
  35  * Colormap grabber header file.
  36  *
  37  *
  38  *
  39  * Macros defined here:
  40  *
  41  *  sh_cm_lock(infop)
  42  *  sh_cm_unlock(infop)
  43  *      lock and unlock colormap info page.  'infop' is the Grabbedcmap
  44  *      pointer returned by cmapgrab_grab()
  45  *
  46  *  sh_cmapgrab_cookie(infop)
  47  *      returns the colormap info page cookie used to map the info page.
  48  *      this is the value that should be returned to the requesting
  49  *      client.
  50  *
  51  ****/
  52
  53
  54 #include <sys/types.h>
  55 #ifdef MT
  56 #include <synch.h>
  57 #endif
  58
  59 #include "dga.h"
  60 #include "dga_internal.h"
  61
  62
  63 /* method to use to load colormaps */
  64
  65 typedef enum {
  66         SUNWINDOWS_IOCTL=0,     /* use /dev/winxx SunWindows device driver */
  67         HW_DEVICE_IOCTL=1,      /* use graphics hardware device driver */
  68         HW_DEVICE_DIRECT=2      /* access hardware colormap directly */
  69 } cmap_load_method;
  70
  71
  72 #define CMMAGIC 0x434d4150      /* "CMAP" */
  73 #define CMVERS  0
  74
  75 #define MAX_CM_DEVNAME  40      /* better not have long device names */
  76 #define DGA_CM_DEV_INFO_SZ 132
  77
  78         /* device types, from sh_scr_dev.h */
  79
  80 #define SCR_DEV_GENERIC 0       /* generic class implementations */
  81 #define SCR_DEV_MEM1    1       /* depth 1 memory framebuffer */
  82 #define SCR_DEV_MEM8    2       /* depth 8 memory framebuffer */
  83 #define SCR_DEV_MEM32   3       /* depth 32 memory framebuffer */
  84
  85 #define SCR_DEV_CG2     4       /* Sun CG2 framebuffer (depth 8) */
  86 #define SCR_DEV_BW2     5       /* Sun BW2 framebuffer (depth 1) */
  87 #define SCR_DEV_CG4     6       /* Sun CG4 framebuffer (1 or 8) */
  88 #define SCR_DEV_CG6     7       /* Sun CG6 (Lego) */
  89 #define SCR_DEV_CG3     8       /* Sun CG3 (Color RoadRunner) */
  90 #define SCR_DEV_GPFB    9       /* GP1/GP+/GP2 framebuffer (depth 8) */
  91 #define SCR_DEV_GP      10      /* GP1/GP+/GP2 accelerator */
  92 #define SCR_DEV_CG5     11      /* Sun CG5 framebuffer (depth 8) */
  93 #define SCR_DEV_CG8     12      /* Sun CG8 framebuffer (depth 8, 24 bit color)*/
  94 #define SCR_DEV_GT      13      /* Sun GT (Hawk) depth 1, 8, and 24 bit */
  95 #define SCR_DEV_CG12    14      /* Sun CG12 (Egret) depth 1, 8, and 24 bit */
  96 #define SCR_DEV_REC     15      /* Recording device type */
  97 #define SCR_DEV_SMC     16      /* Sun SMC/MDI (SPAM) depth 1, 8, 24-bit */
  98
  99 #define SCR_DEV_LAST    16
 100
 101
 102 /* info in shared memory */
 103
 104 typedef struct _grabbedcmap
 105 {
 106     /* version 0 info starts here */
 107         long    cm_magic ;      /* "CMAP" = 0x434d4150 ("PAMC" on 386i) */
 108         long    cm_version ;    /* 0 */
 109         int     cm_count ;      /* change count */
 110         struct _grabbedcmap *cm_ptr ;   /* self-reference */
 111         u_long  cm_cmap ;       /* X11 colormap ID */
 112
 113         u_long  cm_cookie ;     /* lock-page cookie */
 114
 115         /* server-specific info, not meaningful to client */
 116         int     cm_sinfofd ;
 117         int     cm_sdevfd ;
 118         u_long  *cm_slockp ;
 119         u_long  *cm_sunlockp ;
 120         int     cm_slockcnt ;
 121         int     cm_clientcnt ;
 122         int     cm_filesuffix ;
 123         caddr_t cm_shras ;
 124
 125         char    cm_devname[MAX_CM_DEVNAME] ;
 126         char    cm_lockdevname[MAX_CM_DEVNAME] ;
 127         int     cm_default ;    /* is it the default colormap for this screen */
 128         int     cm_installed ;  /* flag: colormap is installed in HW */
 129         cmap_load_method cm_load_method ;   /* see typedef above */
 130         char    cm_sunwindows_def_devname[MAX_CM_DEVNAME] ; /* device name, */
 131         char    cm_sunwindows_def_cmapname[MAX_CM_DEVNAME] ;/* cmap name, and */
 132         int     cm_sunwindows_def_cmapsize; /* size of server's SunWindows
 133                                                color map "xnews_default" */
 134         char    cm_sunwindows_inst_devname[MAX_CM_DEVNAME] ; /* device name, */
 135         char    cm_sunwindows_inst_cmapname[MAX_CM_DEVNAME];/* cmap name, and */
 136         int     cm_sunwindows_inst_cmapsize; /* size of server's SunWindows
 137                                                color map "xnews_installed" */
 138         int     cm_fbtype ;     /* reserved */
 139         int     cm_reallen ;    /* colormap hardware size */
 140         int     cm_start ;      /* first valid location */
 141         int     cm_len ;        /* number of valid locations */
 142         int     cm_cmapnum ;    /* [0]cmap number - FB's with multiple maps */
 143         int     cm_ioctlbits ;  /* [0]high-order bits for FBIOPUTCMAP */
 144         int     cm_devtype ;    /* device hardware type */
 145         int     cm_reserved[5] ;/* reserved */
 146
 147         long    cm_shadowofs ;  /* byte offset relative to cm_magic of
 148                                    the start of the shadow colormap */
 149
 150     /* version 1 info starts here */
 151         int     cm_scount ;     /* server's last remembered count */
 152         int     cm_locktype ;   /* using /dev/winlock? see below. */
 153
 154     /* version 2 info starts here */
 155         u_int   device_offset;  /* offset to device specific section */
 156
 157         /* Do NOT add any fields below dev_info */
 158         u_char  dev_info[DGA_CM_DEV_INFO_SZ];/* device specific information */
 159 } Grabbedcmap ;
 160
 161
 162         /* followed by three arrays of u_shorts, length cm_len, for
 163            red, green and blue and one array of bytes which are
 164            the change flags for their respective colors:
 165
 166                 rr
 167                 rr
 168                 rr
 169                 :
 170                 gg
 171                 gg
 172                 gg
 173                 :
 174                 bb
 175                 bb
 176                 bb
 177                 :
 178                 f
 179                 f
 180                 f
 181                 :
 182
 183             Clients set a flag to non-zero to indicate that the color
 184             has been changed.  The server clears these when the chagnes
 185             have been seen. */
 186
 187 #define CM_LOCKDEV      0       /* use GRABPAGEALLOC from device */
 188 #define CM_WINLOCK      1       /* use winlock functions */
 189
 190
 191
 192
 193 typedef struct cmap_devlist{
 194         int fd;
 195         int refcnt;
 196         char devname[MAX_CM_DEVNAME];
 197         struct cmap_devlist *next;
 198 } Cmap_Devlist;
 199
 200
 201 #define CM_PAGESZ       (8*1024)
 202 #define CM_LOCK(x)      (*(x)) = 1
 203 #define CM_UNLOCK(x)    (*(x)) = 0
 204
 205
 206 #define wx_cm_lock(infop)               \
 207     do {                                \
 208     if( (infop)->cm_lockcnt++ == 0 )    \
 209         *(infop)->cm_lockp = 1 ;        \
 210     } while (0)
 211
 212 #define wx_cm_unlock(infop)             \
 213     do {                                \
 214     if( --(infop)->cm_lockcnt == 0 )    \
 215         *(infop)->cm_unlockp = 0 ;      \
 216     } while (0)
 217
 218
 219 #define CM_INFOP(clientp) ((Grabbedcmap *) ((clientp)->cm_info))
 220
 221 Dga_cmap        wx_cm_grab() ;
 222
 223 #endif /* _CMAP_GRAB_H */