GNU Linux-libre 4.14.290-gnu1
[releases.git] / drivers / gpu / drm / msm / msm_kms.h
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         void (*set_encoder_mode)(struct msm_kms *kms,
60                                  struct drm_encoder *encoder,
61                                  bool cmd_mode);
62         /* cleanup: */
63         void (*destroy)(struct msm_kms *kms);
64 #ifdef CONFIG_DEBUG_FS
65         /* debugfs: */
66         int (*debugfs_init)(struct msm_kms *kms, struct drm_minor *minor);
67 #endif
68 };
69
70 struct msm_kms {
71         const struct msm_kms_funcs *funcs;
72
73         /* irq number to be passed on to drm_irq_install */
74         int irq;
75
76         /* mapper-id used to request GEM buffer mapped for scanout: */
77         struct msm_gem_address_space *aspace;
78 };
79
80 /**
81  * Subclass of drm_atomic_state, to allow kms backend to have driver
82  * private global state.  The kms backend can do whatever it wants
83  * with the ->state ptr.  On ->atomic_state_clear() the ->state ptr
84  * is kfree'd and set back to NULL.
85  */
86 struct msm_kms_state {
87         struct drm_atomic_state base;
88         void *state;
89 };
90 #define to_kms_state(x) container_of(x, struct msm_kms_state, base)
91
92 static inline void msm_kms_init(struct msm_kms *kms,
93                 const struct msm_kms_funcs *funcs)
94 {
95         kms->funcs = funcs;
96 }
97
98 struct msm_kms *mdp4_kms_init(struct drm_device *dev);
99 struct msm_kms *mdp5_kms_init(struct drm_device *dev);
100 int msm_mdss_init(struct drm_device *dev);
101 void msm_mdss_destroy(struct drm_device *dev);
102 int msm_mdss_enable(struct msm_mdss *mdss);
103 int msm_mdss_disable(struct msm_mdss *mdss);
104
105 #endif /* __MSM_KMS_H__ */