Home | History | Annotate | Line # | Download | only in rasops
rasops.h revision 1.24
      1 /* 	$NetBSD: rasops.h,v 1.24 2010/04/17 13:36:22 nonaka Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Andrew Doran.
      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  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _RASOPS_H_
     33 #define _RASOPS_H_ 1
     34 
     35 struct wsdisplay_font;
     36 
     37 /* For rasops_info::ri_flg */
     38 #define RI_FULLCLEAR	0x01	/* eraserows() hack to clear full screen */
     39 #define RI_FORCEMONO	0x02	/* monochrome output even if we can do color */
     40 #define RI_BSWAP	0x04	/* framebuffer endianness doesn't match CPU */
     41 #define RI_CURSOR	0x08	/* cursor is switched on */
     42 #define RI_CLEAR	0x10	/* clear display on startup */
     43 #define RI_CENTER	0x20	/* center onscreen output */
     44 #define RI_CURSORCLIP	0x40	/* cursor is currently clipped */
     45 #define RI_CFGDONE	0x80	/* rasops_reconfig() completed successfully */
     46 #define RI_ROTATE_CW	0x100	/* display is rotated, quarter clockwise */
     47 #define RI_ROTATE_CCW	0x200	/* display is rotated, quarter counter-clockwise */
     48 #define RI_ROTATE_UD	0x400	/* display is rotated, upside-down */
     49 #define RI_ROTATE_MASK	0x700
     50 
     51 struct rasops_info {
     52 	/* These must be filled in by the caller */
     53 	int	ri_depth;	/* depth in bits */
     54 	u_char	*ri_bits;	/* ptr to bits */
     55 	int	ri_width;	/* width (pels) */
     56 	int	ri_height;	/* height (pels) */
     57 	int	ri_stride;	/* stride in bytes */
     58 
     59 	/*
     60 	 * If you want shadow framebuffer support, point ri_hwbits
     61 	 * to the real framebuffer, and ri_bits to the shadow framebuffer
     62 	 */
     63 	u_char	*ri_hwbits;
     64 
     65 	/*
     66 	 * These can optionally be left zeroed out. If you fill ri_font,
     67 	 * but aren't using wsfont, set ri_wsfcookie to -1.
     68 	 */
     69 	struct	wsdisplay_font *ri_font;
     70 	int	ri_wsfcookie;	/* wsfont cookie */
     71 	void	*ri_hw;		/* driver private data; ignored by rasops */
     72 	int	ri_crow;	/* cursor row */
     73 	int	ri_ccol;	/* cursor column */
     74 	int	ri_flg;		/* various operational flags */
     75 
     76 	/*
     77 	 * These are optional and will default if zero. Meaningless
     78 	 * on depths other than 15, 16, 24 and 32 bits per pel. On
     79 	 * 24 bit displays, ri_{r,g,b}num must be 8.
     80 	 */
     81 	u_char	ri_rnum;	/* number of bits for red */
     82 	u_char	ri_gnum;	/* number of bits for green */
     83 	u_char	ri_bnum;	/* number of bits for blue */
     84 	u_char	ri_rpos;	/* which bit red starts at */
     85 	u_char	ri_gpos;	/* which bit green starts at */
     86 	u_char	ri_bpos;	/* which bit blue starts at */
     87 
     88 	/* These are filled in by rasops_init() */
     89 	int	ri_emuwidth;	/* width we actually care about */
     90 	int	ri_emuheight;	/* height we actually care about */
     91 	int	ri_emustride;	/* bytes per row we actually care about */
     92 	int	ri_rows;	/* number of rows (characters, not pels) */
     93 	int	ri_cols;	/* number of columns (characters, not pels) */
     94 	int	ri_delta;	/* row delta in bytes */
     95 	int	ri_pelbytes;	/* bytes per pel (may be zero) */
     96 	int	ri_fontscale;	/* fontheight * fontstride */
     97 	int	ri_xscale;	/* fontwidth * pelbytes */
     98 	int	ri_yscale;	/* fontheight * stride */
     99 	u_char  *ri_origbits;	/* where screen bits actually start */
    100 	u_char  *ri_hworigbits;	/* where hw bits actually start */
    101 	int	ri_xorigin;	/* where ri_bits begins (x) */
    102 	int	ri_yorigin;	/* where ri_bits begins (y) */
    103 	int32_t	ri_devcmap[16]; /* color -> framebuffer data */
    104 
    105 	/* The emulops you need to use, and the screen caps for wscons */
    106 	struct	wsdisplay_emulops ri_ops;
    107 	int	ri_caps;
    108 
    109 	/* Callbacks so we can share some code */
    110 	void	(*ri_do_cursor)(struct rasops_info *);
    111 
    112 #if NRASOPS_ROTATION > 0
    113 	/* Used to intercept putchar to permit display rotation */
    114 	struct	wsdisplay_emulops ri_real_ops;
    115 #endif
    116 };
    117 
    118 #define DELTA(p, d, cast) ((p) = (cast)((char *)(p) + (d)))
    119 
    120 #define CHAR_IN_FONT(c,font) 					\
    121        ((c) >= (font)->firstchar && 				\
    122 	((c) - (font)->firstchar) < (font)->numchars)
    123 
    124 /*
    125  * rasops_init().
    126  *
    127  * Integer parameters are the number of rows and columns we'd *like*.
    128  *
    129  * In terms of optimization, fonts that are a multiple of 8 pixels wide
    130  * work the best.
    131  *
    132  * rasops_init() takes care of rasops_reconfig(). The parameters to both
    133  * are the same. If calling rasops_reconfig() to change the font and
    134  * ri_wsfcookie >= 0, you must call wsfont_unlock() on it, and reset it
    135  * to -1 (or a new, valid cookie).
    136  */
    137 
    138 /*
    139  * Per-depth initialization functions. These should not be called outside
    140  * the rasops code.
    141  */
    142 void	rasops1_init(struct rasops_info *);
    143 void	rasops2_init(struct rasops_info *);
    144 void	rasops4_init(struct rasops_info *);
    145 void	rasops8_init(struct rasops_info *);
    146 void	rasops15_init(struct rasops_info *);
    147 void	rasops24_init(struct rasops_info *);
    148 void	rasops32_init(struct rasops_info *);
    149 
    150 /* rasops.c */
    151 int	rasops_init(struct rasops_info *, int, int);
    152 int	rasops_reconfig(struct rasops_info *, int, int);
    153 void	rasops_unpack_attr(long, int *, int *, int *);
    154 void	rasops_eraserows(void *, int, int, long);
    155 void	rasops_erasecols(void *, int, int, int, long);
    156 void	rasops_copycols(void *, int, int, int, int);
    157 
    158 extern const u_char	rasops_isgray[16];
    159 extern const u_char	rasops_cmap[256*3];
    160 
    161 #endif /* _RASOPS_H_ */
    162