xref: /openbmc/linux/drivers/gpu/drm/msm/msm_kms.h (revision 8730046c)
1 /*
2  * Copyright (C) 2013 Red Hat
3  * Author: Rob Clark <robdclark@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __MSM_KMS_H__
19 #define __MSM_KMS_H__
20 
21 #include <linux/clk.h>
22 #include <linux/regulator/consumer.h>
23 
24 #include "msm_drv.h"
25 
26 #define MAX_PLANE	4
27 
28 /* As there are different display controller blocks depending on the
29  * snapdragon version, the kms support is split out and the appropriate
30  * implementation is loaded at runtime.  The kms module is responsible
31  * for constructing the appropriate planes/crtcs/encoders/connectors.
32  */
33 struct msm_kms_funcs {
34 	/* hw initialization: */
35 	int (*hw_init)(struct msm_kms *kms);
36 	/* irq handling: */
37 	void (*irq_preinstall)(struct msm_kms *kms);
38 	int (*irq_postinstall)(struct msm_kms *kms);
39 	void (*irq_uninstall)(struct msm_kms *kms);
40 	irqreturn_t (*irq)(struct msm_kms *kms);
41 	int (*enable_vblank)(struct msm_kms *kms, struct drm_crtc *crtc);
42 	void (*disable_vblank)(struct msm_kms *kms, struct drm_crtc *crtc);
43 	/* swap global atomic state: */
44 	void (*swap_state)(struct msm_kms *kms, struct drm_atomic_state *state);
45 	/* modeset, bracketing atomic_commit(): */
46 	void (*prepare_commit)(struct msm_kms *kms, struct drm_atomic_state *state);
47 	void (*complete_commit)(struct msm_kms *kms, struct drm_atomic_state *state);
48 	/* functions to wait for atomic commit completed on each CRTC */
49 	void (*wait_for_crtc_commit_done)(struct msm_kms *kms,
50 					struct drm_crtc *crtc);
51 	/* misc: */
52 	const struct msm_format *(*get_format)(struct msm_kms *kms, uint32_t format);
53 	long (*round_pixclk)(struct msm_kms *kms, unsigned long rate,
54 			struct drm_encoder *encoder);
55 	int (*set_split_display)(struct msm_kms *kms,
56 			struct drm_encoder *encoder,
57 			struct drm_encoder *slave_encoder,
58 			bool is_cmd_mode);
59 	/* cleanup: */
60 	void (*destroy)(struct msm_kms *kms);
61 #ifdef CONFIG_DEBUG_FS
62 	/* debugfs: */
63 	int (*debugfs_init)(struct msm_kms *kms, struct drm_minor *minor);
64 	void (*debugfs_cleanup)(struct msm_kms *kms, struct drm_minor *minor);
65 #endif
66 };
67 
68 struct msm_kms {
69 	const struct msm_kms_funcs *funcs;
70 
71 	/* irq number to be passed on to drm_irq_install */
72 	int irq;
73 };
74 
75 /**
76  * Subclass of drm_atomic_state, to allow kms backend to have driver
77  * private global state.  The kms backend can do whatever it wants
78  * with the ->state ptr.  On ->atomic_state_clear() the ->state ptr
79  * is kfree'd and set back to NULL.
80  */
81 struct msm_kms_state {
82 	struct drm_atomic_state base;
83 	void *state;
84 };
85 #define to_kms_state(x) container_of(x, struct msm_kms_state, base)
86 
87 static inline void msm_kms_init(struct msm_kms *kms,
88 		const struct msm_kms_funcs *funcs)
89 {
90 	kms->funcs = funcs;
91 }
92 
93 struct msm_kms *mdp4_kms_init(struct drm_device *dev);
94 struct msm_kms *mdp5_kms_init(struct drm_device *dev);
95 int msm_mdss_init(struct drm_device *dev);
96 void msm_mdss_destroy(struct drm_device *dev);
97 
98 #endif /* __MSM_KMS_H__ */
99