osfmk/ppc/screen_switch.h

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