xref: /netbsd-src/sys/external/bsd/drm2/include/drm/drm_client.h (revision 51a9647c3dc952b32742bb27eb35760bec557de5)
1 /*	$NetBSD: drm_client.h,v 1.2 2021/12/19 12:04:59 riastradh Exp $	*/
2 
3 /*-
4  * Copyright (c) 2020 The NetBSD Foundation, Inc.
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 _DRM_DRM_CLIENT_H_
30 #define	_DRM_DRM_CLIENT_H_
31 
32 #include <linux/mutex.h>
33 
34 struct drm_client_buffer;
35 struct drm_client_dev;
36 struct drm_client_funcs;
37 struct drm_device;
38 struct drm_mode_set;
39 
40 struct drm_client_dev {
41 	struct mutex			modeset_mutex;
42 	struct drm_mode_set		*modesets;
43 	struct drm_framebuffer		*fb;
44 	struct drm_device		*dev;
45 	const struct drm_client_funcs	*funcs;
46 };
47 
48 struct drm_client_funcs {
49 	struct module *owner;
50 	void	(*unregister)(struct drm_client_dev *);
51 	int	(*restore)(struct drm_client_dev *);
52 	int	(*hotplug)(struct drm_client_dev *);
53 };
54 
55 struct drm_client_buffer {
56 	struct drm_framebuffer	*fb;
57 };
58 
59 int	drm_client_init(struct drm_device *, struct drm_client_dev *,
60 	    const char *, const struct drm_client_funcs *);
61 void	drm_client_register(struct drm_client_dev *);
62 void	drm_client_release(struct drm_client_dev *);
63 
64 void	drm_client_dev_hotplug(struct drm_device *);
65 void	drm_client_dev_restore(struct drm_device *);
66 void	drm_client_dev_unregister(struct drm_device *);
67 
68 struct drm_client_buffer *
69 	drm_client_framebuffer_create(struct drm_client_dev *, u32, u32, u32);
70 void	*drm_client_buffer_vmap(struct drm_client_buffer *);
71 void	drm_client_buffer_vunmap(struct drm_client_buffer *);
72 void	drm_client_framebuffer_delete(struct drm_client_buffer *);
73 
74 int	drm_client_modeset_create(struct drm_client_dev *);
75 int	drm_client_modeset_probe(struct drm_client_dev *, unsigned, unsigned);
76 bool	drm_client_rotation(struct drm_mode_set *, unsigned *);
77 int	drm_client_modeset_commit_force(struct drm_client_dev *);
78 int	drm_client_modeset_commit(struct drm_client_dev *);
79 int	drm_client_modeset_dpms(struct drm_client_dev *, int);
80 void	drm_client_modeset_free(struct drm_client_dev *);
81 
82 #define drm_client_for_each_modeset(MODESET, CLIENT)		   \
83 	KASSERT(mutex_is_locked(&(CLIENT)->modeset_mutex));	   \
84 	drm_client_for_each_modeset_unlocked(MODESET, CLIENT)
85 
86 #define drm_client_for_each_modeset_unlocked(MODESET, CLIENT)	   \
87 	for ((MODESET) = (CLIENT)->modesets; (MODESET)->crtc; (MODESET)++)
88 
89 #define drm_client_for_each_connector_iter(CONNECTOR, ITER)		      \
90 	drm_for_each_connector_iter(CONNECTOR, ITER)			      \
91 		if ((CONNECTOR)->connector_type !=			      \
92 		    DRM_MODE_CONNECTOR_WRITEBACK)
93 
94 #endif	/* _DRM_DRM_CLIENT_H_ */
95