Home | History | Annotate | Line # | Download | only in wsfb
genfbvar.h revision 1.27 
      1 /*	$NetBSD: genfbvar.h,v 1.27 2022/03/28 11:21:40 mlelstv Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2007 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 GENFBVAR_H
     30 #define GENFBVAR_H
     31 
     32 #ifdef _KERNEL_OPT
     33 #include "opt_splash.h"
     34 #endif
     35 
     36 #include <sys/param.h>
     37 #include <sys/buf.h>
     38 #include <sys/conf.h>
     39 #include <sys/device.h>
     40 
     41 #include <sys/bus.h>
     42 
     43 #include <dev/wscons/wsconsio.h>
     44 #include <dev/wscons/wsdisplayvar.h>
     45 #include <dev/rasops/rasops.h>
     46 
     47 #include <dev/wscons/wsdisplay_vconsvar.h>
     48 #ifdef _KERNEL_OPT
     49 #include "opt_genfb.h"
     50 #endif
     51 
     52 #ifdef SPLASHSCREEN
     53 #define GENFB_DISABLE_TEXT
     54 #include <dev/splash/splash.h>
     55 #endif
     56 
     57 #if GENFB_GLYPHCACHE > 0
     58 #include <dev/wscons/wsdisplay_glyphcachevar.h>
     59 #endif
     60 
     61 struct genfb_softc;
     62 
     63 struct genfb_ops {
     64 	int (*genfb_ioctl)(void *, void *, u_long, void *, int, struct lwp *);
     65 	paddr_t	(*genfb_mmap)(void *, void *, off_t, int);
     66 	int (*genfb_borrow)(void *, bus_addr_t, bus_space_handle_t *);
     67 	int (*genfb_enable_polling)(void *);
     68 	int (*genfb_disable_polling)(void *);
     69 };
     70 
     71 struct genfb_colormap_callback {
     72 	void *gcc_cookie;
     73 	void (*gcc_set_mapreg)(void *, int, int, int, int);
     74 };
     75 
     76 /*
     77  * Integer parameter provider.  Each callback shall return 0 on success,
     78  * and an error(2) number on failure.  The gpc_upd_parameter callback is
     79  * optional (i.e. it can be NULL).
     80  *
     81  * This structure is used for backlight and brightness control.  The
     82  * expected parameter range is:
     83  *
     84  *	[0, 1]		for backlight
     85  *	[0, 255]	for brightness
     86  */
     87 struct genfb_parameter_callback {
     88 	void *gpc_cookie;
     89 	int (*gpc_get_parameter)(void *, int *);
     90 	int (*gpc_set_parameter)(void *, int);
     91 	int (*gpc_upd_parameter)(void *, int);
     92 };
     93 
     94 struct genfb_pmf_callback {
     95 	bool (*gpc_suspend)(device_t, const pmf_qual_t *);
     96 	bool (*gpc_resume)(device_t, const pmf_qual_t *);
     97 };
     98 
     99 struct genfb_mode_callback {
    100 	bool (*gmc_setmode)(struct genfb_softc *, int);
    101 };
    102 
    103 struct genfb_softc {
    104 	device_t sc_dev;
    105 	struct vcons_data vd;
    106 	struct genfb_ops sc_ops;
    107 	struct vcons_screen sc_console_screen;
    108 	struct wsscreen_descr sc_defaultscreen_descr;
    109 	const struct wsscreen_descr *sc_screens[1];
    110 	struct wsscreen_list sc_screenlist;
    111 	struct genfb_colormap_callback *sc_cmcb;
    112 	struct genfb_pmf_callback *sc_pmfcb;
    113 	struct genfb_parameter_callback *sc_backlight;
    114 	struct genfb_parameter_callback *sc_brightness;
    115 	struct genfb_mode_callback *sc_modecb;
    116 	int sc_backlight_level, sc_backlight_on;
    117 	void *sc_fbaddr;	/* kva */
    118 	void *sc_shadowfb;
    119 	bool sc_enable_shadowfb;
    120 	bus_addr_t sc_fboffset;	/* bus address */
    121 	int sc_width, sc_height, sc_stride, sc_depth;
    122 	size_t sc_fbsize;
    123 	int sc_mode;
    124 	u_char sc_cmap_red[256];
    125 	u_char sc_cmap_green[256];
    126 	u_char sc_cmap_blue[256];
    127 	bool sc_want_clear;
    128 #ifdef SPLASHSCREEN
    129 	struct splash_info sc_splash;
    130 #endif
    131 	struct wsdisplay_accessops sc_accessops;
    132 #if GENFB_GLYPHCACHE > 0
    133 	/*
    134 	 * The generic glyphcache code makes a bunch of assumptions that are
    135 	 * true for most graphics hardware with a directly supported blitter.
    136 	 * For example it assume that
    137 	 * - VRAM access from the host is expensive
    138 	 * - copying data around in VRAM is cheap and can happen in parallel
    139 	 *   to the host CPU
    140 	 * -> therefore we draw glyphs normally if we have to, so the ( assumed
    141 	 *    to be hardware assisted ) driver supplied putchar() method doesn't
    142 	 *    need to be glyphcache aware, then copy them away for later use
    143 	 * for genfb things are a bit different. On most hardware:
    144 	 * - VRAM access from the host is still expensive
    145 	 * - copying data around in VRAM is also expensive since we don't have
    146 	 *   a blitter and VRAM is mapped uncached
    147 	 * - VRAM reads are usually slower than writes ( write combining and
    148 	 *   such help writes but not reads, and VRAM might be behind an
    149 	 *   asymmetric bus like AGP ) and must be avoided, both are much
    150 	 *   slower than main memory
    151 	 * -> therefore we cache glyphs in main memory, no reason to map it
    152 	 *    uncached, we draw into the cache first and then copy the glyph
    153 	 *    into video memory to avoid framebuffer reads and to allow more
    154 	 *    efficient write accesses than putchar() would offer
    155 	 * Because of this we can't use the generic code but we can recycle a
    156 	 * few data structures.
    157 	 */
    158 	uint8_t *sc_cache;
    159 	struct rasops_info sc_cache_ri;
    160 	void (*sc_putchar)(void *, int, int, u_int, long);
    161 	int sc_cache_cells;
    162 	int sc_nbuckets;	/* buckets allocated */
    163 	gc_bucket *sc_buckets;	/* we allocate as many as we can get into ram */
    164 	int sc_attrmap[256];	/* mapping a colour attribute to a bucket */
    165 #endif
    166 
    167 };
    168 
    169 void	genfb_cnattach(void);
    170 int	genfb_cndetach(void);
    171 void	genfb_disable(void);
    172 int	genfb_is_console(void);
    173 int	genfb_is_enabled(void);
    174 void	genfb_init(struct genfb_softc *);
    175 int	genfb_attach(struct genfb_softc *, struct genfb_ops *);
    176 int	genfb_borrow(bus_addr_t, bus_space_handle_t *);
    177 void	genfb_restore_palette(struct genfb_softc *);
    178 void	genfb_enable_polling(device_t);
    179 void	genfb_disable_polling(device_t);
    180 
    181 #endif /* GENFBVAR_H */
    182