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