1 /* $NetBSD: wsdisplay_vconsvar.h,v 1.34 2023/02/14 08:22:02 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 #include <sys/atomic.h> 38 39 struct vcons_data; 40 41 struct vcons_screen { 42 struct rasops_info scr_ri; 43 LIST_ENTRY(vcons_screen) next; 44 void *scr_cookie; 45 struct vcons_data *scr_vd; 46 struct vcons_data *scr_origvd; 47 struct wsscreen_descr *scr_type; 48 uint32_t *scr_chars; 49 long *scr_attrs; 50 void (*putchar)(void *, int, int, u_int, long); 51 long scr_defattr; 52 /* static flags set by the driver */ 53 uint32_t scr_flags; 54 #define VCONS_NO_REDRAW 1 /* don't readraw in switch_screen */ 55 #define VCONS_SCREEN_IS_STATIC 2 /* don't free() this vcons_screen */ 56 #define VCONS_SWITCH_NEEDS_POLLING 4 /* rasops can overlap so we need to 57 * poll the busy flag when switching 58 * - for drivers that use software 59 * drawing */ 60 #define VCONS_DONT_DRAW 8 /* don't draw on this screen at all */ 61 /* 62 * the following flags are for drivers which either can't accelerate (all) copy 63 * operations or where drawing characters is faster than the blitter 64 * for example, Sun's Creator boards can't accelerate copycols() 65 */ 66 #define VCONS_NO_COPYCOLS 0x10 /* use putchar() based copycols() */ 67 #define VCONS_NO_COPYROWS 0x20 /* use putchar() based copyrows() */ 68 #define VCONS_DONT_READ (VCONS_NO_COPYCOLS|VCONS_NO_COPYROWS|VCONS_NO_CURSOR) 69 /* avoid framebuffer reads */ 70 #define VCONS_LOADFONT 0x40 /* driver can load_font() */ 71 #define VCONS_NO_CURSOR 0x80 /* use putchar() based cursor(), to 72 * avoid fb reads */ 73 #define VCONS_FONT_BITS_R2L 0x100 /* request right-to-left bitorder in 74 * wsfont_find() */ 75 #define VCONS_FONT_BYTES_R2L 0x200 /* request right-to-left byteorder in 76 * wsfont_find() */ 77 78 /* status flags used by vcons */ 79 uint32_t scr_status; 80 #define VCONS_IS_VISIBLE 1 /* this screen is currently visible */ 81 /* non zero when some rasops operation is in progress */ 82 int scr_busy; 83 #ifdef WSDISPLAY_SCROLLSUPPORT 84 int scr_lines_in_buffer; 85 int scr_current_line; 86 int scr_line_wanted; 87 int scr_offset_to_zero; 88 int scr_current_offset; 89 #endif 90 #ifdef VCONS_DRAW_INTR 91 unsigned int scr_dirty; 92 #endif 93 }; 94 95 #define SCREEN_IS_VISIBLE(scr) (((scr)->scr_status & VCONS_IS_VISIBLE) != 0) 96 #define SCREEN_IS_BUSY(scr) (membar_consumer(), (scr)->scr_busy != 0) 97 #define SCREEN_CAN_DRAW(scr) (((scr)->scr_flags & VCONS_DONT_DRAW) == 0) 98 #define SCREEN_BUSY(scr) ((scr)->scr_busy = 1, membar_producer()) 99 #define SCREEN_IDLE(scr) ((scr)->scr_busy = 0, membar_producer()) 100 #define SCREEN_VISIBLE(scr) ((scr)->scr_status |= VCONS_IS_VISIBLE) 101 #define SCREEN_INVISIBLE(scr) ((scr)->scr_status &= ~VCONS_IS_VISIBLE) 102 #define SCREEN_DISABLE_DRAWING(scr) ((scr)->scr_flags |= VCONS_DONT_DRAW) 103 #define SCREEN_ENABLE_DRAWING(scr) ((scr)->scr_flags &= ~VCONS_DONT_DRAW) 104 105 #define DEFATTR ((WS_DEFAULT_FG << 24) || (WS_DEFAULT_BG << 16)) 106 107 struct vcons_data { 108 /* usually the drivers softc */ 109 void *cookie; 110 111 /* 112 * setup the rasops part of the passed vcons_screen, like 113 * geometry, framebuffer address, font, characters, acceleration. 114 * we pass the cookie as 1st parameter 115 */ 116 void (*init_screen)(void *, struct vcons_screen *, int, 117 long *); 118 119 /* called before vcons_redraw_screen */ 120 void *show_screen_cookie; 121 void (*show_screen_cb)(struct vcons_screen *, void *); 122 123 struct vcons_screen *active; 124 struct vcons_data_private *private; 125 }; 126 127 int vcons_init(struct vcons_data *, void *, struct wsscreen_descr *, 128 struct wsdisplay_accessops *); 129 int vcons_earlyinit(struct vcons_data *, void *, struct wsscreen_descr *, 130 struct wsdisplay_accessops *); 131 132 int vcons_init_screen(struct vcons_data *, struct vcons_screen *, int, 133 long *); 134 135 /* completely redraw the screen, clear it if RI_FULLCLEAR is set */ 136 void vcons_redraw_screen(struct vcons_screen *); 137 138 void vcons_update_screen(struct vcons_screen *); 139 140 void vcons_replay_msgbuf(struct vcons_screen *); 141 142 void vcons_enable_polling(struct vcons_data *); 143 void vcons_disable_polling(struct vcons_data *); 144 void vcons_hard_switch(struct vcons_screen *); 145 146 int vcons_offset_to_zero(const struct vcons_screen *); 147 148 #endif /* _WSDISPLAY_VCONS_H_ */ 149