1 /* $NetBSD: genfbvar.h,v 1.28 2022/07/17 13:10:54 riastradh 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 genfb_private *sc_private; 106 struct vcons_data vd; 107 struct genfb_pmf_callback *sc_pmfcb; 108 void *sc_fbaddr; /* kva */ 109 bus_addr_t sc_fboffset; /* bus address */ 110 int sc_width, sc_height, sc_stride, sc_depth; 111 size_t sc_fbsize; 112 }; 113 114 void genfb_cnattach(void); 115 int genfb_cndetach(void); 116 void genfb_disable(void); 117 int genfb_is_console(void); 118 int genfb_is_enabled(void); 119 void genfb_init(struct genfb_softc *); 120 int genfb_attach(struct genfb_softc *, struct genfb_ops *); 121 int genfb_borrow(bus_addr_t, bus_space_handle_t *); 122 void genfb_restore_palette(struct genfb_softc *); 123 void genfb_enable_polling(device_t); 124 void genfb_disable_polling(device_t); 125 126 #endif /* GENFBVAR_H */ 127