1/*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
49 *  School of Computer Science
50 *  Carnegie Mellon University
51 *  Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 */
58/*
59 *	File: screen_switch.h
60 * 	Author: Alessandro Forin, Carnegie Mellon University
61 *	Date:	10/90
62 *
63 *	Definitions of things that must be tailored to
64 *	specific hardware boards for the Generic Screen Driver.
65 */
66
67#ifndef	SCREEN_SWITCH_H
68#define	SCREEN_SWITCH_H	1
69
70#include <mach/boolean.h>
71
72/*
73 *	List of probe routines, scanned at cold-boot time
74 *	to see which, if any, graphic display is available.
75 *	This is done before autoconf, so that printing on
76 *	the console works early on.  The alloc routine is
77 *	called only on the first device that answers.
78 *	Ditto for the setup routine, called later on.
79 */
80struct screen_probe_vector {
81	int		(*probe)(void);
82	unsigned int	(*alloc)(void);
83	int		(*setup)(int, user_info_t);
84};
85
86/*
87 *	Low-level operations on the graphic device, used
88 *	by the otherwise device-independent interface code
89 */
90
91/* Forward declaration of screen_softc_t */
92typedef struct screen_softc *screen_softc_t;
93
94struct screen_switch {
95	int	(*graphic_open)(void);			/* when X11 opens */
96	int	(*graphic_close)(screen_softc_t);	/* .. or closes */
97	int	(*set_status)(screen_softc_t,
98			      dev_flavor_t,
99			      dev_status_t,
100			      natural_t);		/* dev-specific ops */
101	int	(*get_status)(screen_softc_t,
102			      dev_flavor_t,
103			      dev_status_t,
104			      natural_t*);		/* dev-specific ops */
105	int	(*char_paint)(screen_softc_t,
106			      int,
107			      int,
108			      int);			/* blitc */
109	int	(*pos_cursor)(void*,
110			      int,
111			      int);			/* cursor positioning*/
112	int	(*insert_line)(screen_softc_t,
113			       short);			/* ..and scroll down */
114	int	(*remove_line)(screen_softc_t,
115			       short);			/* ..and scroll up */
116	int	(*clear_bitmap)(screen_softc_t);	/* blank screen */
117	int	(*video_on)(void*,
118			    user_info_t*);		/* screen saver */
119	int	(*video_off)(void*,
120			     user_info_t*);
121	int	(*intr_enable)(void*,
122			       boolean_t);
123	int	(*map_page)(screen_softc_t,
124			    vm_offset_t,
125			    int);			/* user-space mapping*/
126};
127
128/*
129 *	Each graphic device needs page-aligned memory
130 *	to be mapped in user space later (for events
131 *	and such).  Size and content of this memory
132 *	is unfortunately device-dependent, even if
133 *	it did not need to (puns).
134 */
135extern char  *screen_data;
136
137extern struct screen_probe_vector screen_probe_vector[];
138
139extern int screen_noop(void), screen_find(void);
140
141#endif	/* SCREEN_SWITCH_H */
142