1 /* $NetBSD: wsdisplay_vconsvar.h,v 1.24 2016/06/02 21:17:14 macallan Exp $ */ 2 3 /*- 4 * Copyright (c) 2005, 2006 Michael Lorenz 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef _WSDISPLAY_VCONS_H_ 30 #define _WSDISPLAY_VCONS_H_ 31 32 #ifdef _KERNEL_OPT 33 #include "opt_wsdisplay_compat.h" 34 #include "opt_vcons.h" 35 #endif 36 37 struct vcons_data; 38 39 struct vcons_screen { 40 struct rasops_info scr_ri; 41 LIST_ENTRY(vcons_screen) next; 42 void *scr_cookie; 43 struct vcons_data *scr_vd; 44 struct vcons_data *scr_origvd; 45 const struct wsscreen_descr *scr_type; 46 uint32_t *scr_chars; 47 long *scr_attrs; 48 long scr_defattr; 49 /* static flags set by the driver */ 50 uint32_t scr_flags; 51 #define VCONS_NO_REDRAW 1 /* don't readraw in switch_screen */ 52 #define VCONS_SCREEN_IS_STATIC 2 /* don't free() this vcons_screen */ 53 #define VCONS_SWITCH_NEEDS_POLLING 4 /* rasops can overlap so we need to 54 * poll the busy flag when switching 55 * - for drivers that use software 56 * drawing */ 57 #define VCONS_DONT_DRAW 8 /* don't draw on this screen at all */ 58 /* 59 * the following flags are for drivers which either can't accelerate (all) copy 60 * operations or where drawing characters is faster than the blitter 61 * for example, Sun's Creator boards can't accelerate copycols() 62 */ 63 #define VCONS_NO_COPYCOLS 0x10 /* use putchar() based copycols() */ 64 #define VCONS_NO_COPYROWS 0x20 /* use putchar() based copyrows() */ 65 #define VCONS_DONT_READ 0x30 /* avoid framebuffer reads */ 66 /* status flags used by vcons */ 67 uint32_t scr_status; 68 #define VCONS_IS_VISIBLE 1 /* this screen is currently visible */ 69 /* non zero when some rasops operation is in progress */ 70 int scr_busy; 71 #ifdef WSDISPLAY_SCROLLSUPPORT 72 int scr_lines_in_buffer; 73 int scr_current_line; 74 int scr_line_wanted; 75 int scr_offset_to_zero; 76 int scr_current_offset; 77 #endif 78 #ifdef VCONS_DRAW_INTR 79 unsigned int scr_dirty; 80 #endif 81 }; 82 83 #define SCREEN_IS_VISIBLE(scr) (((scr)->scr_status & VCONS_IS_VISIBLE) != 0) 84 #define SCREEN_IS_BUSY(scr) ((scr)->scr_busy != 0) 85 #define SCREEN_CAN_DRAW(scr) (((scr)->scr_flags & VCONS_DONT_DRAW) == 0) 86 #define SCREEN_BUSY(scr) ((scr)->scr_busy = 1) 87 #define SCREEN_IDLE(scr) ((scr)->scr_busy = 0) 88 #define SCREEN_VISIBLE(scr) ((scr)->scr_status |= VCONS_IS_VISIBLE) 89 #define SCREEN_INVISIBLE(scr) ((scr)->scr_status &= ~VCONS_IS_VISIBLE) 90 #define SCREEN_DISABLE_DRAWING(scr) ((scr)->scr_flags |= VCONS_DONT_DRAW) 91 #define SCREEN_ENABLE_DRAWING(scr) ((scr)->scr_flags &= ~VCONS_DONT_DRAW) 92 93 #define DEFATTR ((WS_DEFAULT_FG << 24) || (WS_DEFAULT_BG << 16)) 94 95 struct vcons_data { 96 /* usually the drivers softc */ 97 void *cookie; 98 99 /* 100 * setup the rasops part of the passed vcons_screen, like 101 * geometry, framebuffer address, font, characters, acceleration. 102 * we pass the cookie as 1st parameter 103 */ 104 void (*init_screen)(void *, struct vcons_screen *, int, 105 long *); 106 107 /* accessops */ 108 int (*ioctl)(void *, void *, u_long, void *, int, struct lwp *); 109 110 /* rasops */ 111 void (*copycols)(void *, int, int, int, int); 112 void (*erasecols)(void *, int, int, int, long); 113 void (*copyrows)(void *, int, int, int); 114 void (*eraserows)(void *, int, int, long); 115 void (*putchar)(void *, int, int, u_int, long); 116 void (*cursor)(void *, int, int, int); 117 /* called before vcons_redraw_screen */ 118 void (*show_screen_cb)(struct vcons_screen *); 119 /* virtual screen management stuff */ 120 void (*switch_cb)(void *, int, int); 121 void *switch_cb_arg; 122 struct callout switch_callout; 123 uint32_t switch_pending; 124 LIST_HEAD(, vcons_screen) screens; 125 struct vcons_screen *active, *wanted; 126 const struct wsscreen_descr *currenttype; 127 int switch_poll_count; 128 #ifdef VCONS_DRAW_INTR 129 int cells; 130 long *attrs; 131 uint32_t *chars; 132 int cursor_offset; 133 callout_t intr; 134 int intr_valid; 135 void *intr_softint; 136 int use_intr; /* use intr drawing when non-zero */ 137 #endif 138 }; 139 140 int vcons_init(struct vcons_data *, void *cookie, struct wsscreen_descr *, 141 struct wsdisplay_accessops *); 142 143 int vcons_init_screen(struct vcons_data *, struct vcons_screen *, int, 144 long *); 145 146 /* completely redraw the screen, clear it if RI_FULLCLEAR is set */ 147 void vcons_redraw_screen(struct vcons_screen *); 148 149 #ifdef VCONS_DRAW_INTR 150 /* redraw all dirty character cells */ 151 void vcons_update_screen(struct vcons_screen *); 152 void vcons_invalidate_cache(struct vcons_data *); 153 #else 154 #define vcons_update_screen vcons_redraw_screen 155 #endif 156 157 void vcons_replay_msgbuf(struct vcons_screen *); 158 159 void vcons_enable_polling(struct vcons_data *); 160 void vcons_disable_polling(struct vcons_data *); 161 void vcons_hard_switch(struct vcons_screen *); 162 163 #endif /* _WSDISPLAY_VCONS_H_ */ 164