xref: /netbsd-src/sys/external/bsd/drm2/include/drm/drmfb.h (revision 2b73d18af7a98bc9907041875c671f63165f1d3e)
1 /*	$NetBSD: drmfb.h,v 1.3 2021/12/19 12:21:30 riastradh Exp $	*/
2 
3 /*-
4  * Copyright (c) 2014 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Taylor R. Campbell.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef	_DRM_DRMFB_H_
33 #define	_DRM_DRMFB_H_
34 
35 #include <sys/device_if.h>
36 
37 #include <dev/wsfb/genfbvar.h>
38 
39 struct drm_device;
40 struct drm_fb_helper;
41 struct drm_fb_helper_surface_sizes;
42 
43 struct drmfb_attach_args;
44 struct drmfb_params;
45 struct drmfb_softc;
46 
47 struct drmfb_params {
48 	/*
49 	 * Framebuffer mmap.
50 	 */
51 	paddr_t		(*dp_mmapfb)(struct drmfb_softc *, off_t, int);
52 
53 	/*
54 	 * Other mmap, e.g. for arbitrary PCI BARs.  Available only to
55 	 * users with privileges for access to unmanaged memory.
56 	 */
57 	paddr_t		(*dp_mmap)(struct drmfb_softc *, off_t, int);
58 
59 	/*
60 	 * Ioctl handler.  Must handle:
61 	 *
62 	 * - WSDISPLAYIO_GET_BUSID
63 	 * - WSDISPLAYIO_GTYPE
64 	 *
65 	 * May add or override anything else.  Return EPASSTHROUGH to
66 	 * defer.
67 	 */
68 	int		(*dp_ioctl)(struct drmfb_softc *, unsigned long,
69 			    void *, int, struct lwp *);
70 	/* XXX Kludge!  */
71 	bool		(*dp_is_vga_console)(struct drm_device *);
72 	void		(*dp_disable_vga)(struct drm_device *);
73 };
74 
75 struct drmfb_attach_args {
76 	device_t			da_dev;
77 	struct drm_fb_helper		*da_fb_helper;
78 	const struct drm_fb_helper_surface_size	*da_fb_sizes;
79 	void				*da_fb_vaddr;
80 	uint32_t			da_fb_linebytes;
81 	const struct drmfb_params	*da_params;
82 };
83 
84 /* Treat as opaque.  Must be first member of device softc.  */
85 struct drmfb_softc {
86 	struct genfb_softc		sc_genfb; /* XXX Must be first. */
87 	struct drmfb_attach_args	sc_da;
88 };
89 
90 int	drmfb_attach(struct drmfb_softc *, const struct drmfb_attach_args *);
91 int	drmfb_detach(struct drmfb_softc *, int);
92 bool	drmfb_shutdown(struct drmfb_softc *, int);
93 
94 #endif	/* _DRM_DRMFB_H_ */
95