Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / rcons / rcons.h
blob7e88e2db08d9d78097f73125b43b508aac09938c
1 /* $NetBSD: rcons.h,v 1.12.28.5 2005/11/10 14:07:47 skrll Exp $ */
3 /*
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This software was developed by the Computer Systems Engineering group
8 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9 * contributed to Berkeley.
11 * All advertising materials mentioning features or use of this software
12 * must display the following acknowledgement:
13 * This product includes software developed by the University of
14 * California, Lawrence Berkeley Laboratory.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 * 3. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * SUCH DAMAGE.
40 * @(#)fbvar.h 8.1 (Berkeley) 6/11/93
42 #ifndef _RCONS_H_
43 #define _RCONS_H_ 1
45 #include "opt_rcons.h"
47 #include <sys/callout.h>
49 /* Avoid dragging in dev/wscons/wsdisplayvar.h */
50 struct wsdisplay_emulops;
52 struct rconsole {
53 /* This section must be filled in by the framebugger device */
54 u_int rc_maxrow; /* emulator height of screen */
55 u_int rc_maxcol; /* emulator width of screen */
56 void (*rc_bell)(int); /* ring the bell */
57 struct wsdisplay_emulops *rc_ops;/* output ops */
58 void *rc_cookie; /* cookie thereof */
59 u_int rc_width; /* width in pixels */
60 u_int rc_height; /* height in pixels */
61 u_int rc_row; /* emulator row */
62 u_int rc_col; /* emulator column */
64 struct callout rc_belltmr_ch;
66 /* These may be overridden in the kernel config file. */
67 int rc_deffgcolor; /* default fg color */
68 int rc_defbgcolor; /* default bg color */
70 /* Bits maintained by the raster routines */
71 u_int rc_bits; /* see defines below */
72 int rc_ringing; /* bell currently ringing */
73 int rc_belldepth; /* audible bell depth */
74 int rc_scroll; /* stupid sun scroll mode */
75 int rc_p0; /* escape sequence parameter 0 */
76 int rc_p1; /* escape sequence parameter 1 */
77 int rc_fgcolor; /* current fg color */
78 int rc_bgcolor; /* current bg color */
79 long rc_attr; /* current wscons text attribute */
80 long rc_defattr; /* default text attribute */
81 long rc_kern_attr; /* kernel output attribute */
82 u_int rc_wsflg; /* wscons attribute flags */
83 u_int rc_supwsflg; /* supported attribute flags */
84 u_int rc_charmap[256]; /* ASCII->emulator char map */
87 #define FB_INESC 0x001 /* processing an escape sequence */
88 #define FB_VISBELL 0x002 /* visual bell */
89 #define FB_CURSOR 0x004 /* cursor is visible */
90 #define FB_INVERT 0x008 /* framebuffer inverted */
91 #define FB_NO_CURSOR 0x010 /* cursor is disabled */
93 #define FB_P0_DEFAULT 0x100 /* param 0 is defaulted */
94 #define FB_P1_DEFAULT 0x200 /* param 1 is defaulted */
95 #define FB_P0 0x400 /* working on param 0 */
96 #define FB_P1 0x800 /* working on param 1 */
98 /* rcons_kern.c */
99 void rcons_cnputc(int);
100 void rcons_bell(struct rconsole *);
101 void rcons_init(struct rconsole *, int);
102 void rcons_ttyinit(struct tty *);
104 /* rcons_subr.c */
105 void rcons_init_ops(struct rconsole *rc);
106 void rcons_puts(struct rconsole *, const unsigned char *, int);
107 void rcons_pctrl(struct rconsole *, int);
108 void rcons_esc(struct rconsole *, int);
109 void rcons_doesc(struct rconsole *, int);
110 void rcons_sgresc(struct rconsole *, int);
111 void rcons_text(struct rconsole *, const unsigned char *, int);
112 void rcons_cursor(struct rconsole *);
113 void rcons_invert(struct rconsole *, int);
114 void rcons_clear2eop(struct rconsole *);
115 void rcons_clear2eol(struct rconsole *);
116 void rcons_scroll(struct rconsole *, int);
117 void rcons_delchar(struct rconsole *, int);
118 void rcons_delline(struct rconsole *, int);
119 void rcons_insertchar(struct rconsole *, int);
120 void rcons_insertline(struct rconsole *, int);
121 void rcons_setcolor(struct rconsole *, int, int);
123 #endif /* !defined _RCONS_H_ */