xref: /openbmc/linux/drivers/gpu/drm/vc4/vc4_hdmi.h (revision ae88357c)
1 #ifndef _VC4_HDMI_H_
2 #define _VC4_HDMI_H_
3 
4 #include <drm/drm_connector.h>
5 #include <media/cec.h>
6 #include <sound/dmaengine_pcm.h>
7 #include <sound/soc.h>
8 
9 #include "vc4_drv.h"
10 
11 /* VC4 HDMI encoder KMS struct */
12 struct vc4_hdmi_encoder {
13 	struct vc4_encoder base;
14 	bool hdmi_monitor;
15 	bool limited_rgb_range;
16 };
17 
18 static inline struct vc4_hdmi_encoder *
19 to_vc4_hdmi_encoder(struct drm_encoder *encoder)
20 {
21 	return container_of(encoder, struct vc4_hdmi_encoder, base.base);
22 }
23 
24 struct vc4_hdmi;
25 struct vc4_hdmi_register;
26 struct vc4_hdmi_connector_state;
27 
28 enum vc4_hdmi_phy_channel {
29 	PHY_LANE_0 = 0,
30 	PHY_LANE_1,
31 	PHY_LANE_2,
32 	PHY_LANE_CK,
33 };
34 
35 struct vc4_hdmi_variant {
36 	/* Encoder Type for that controller */
37 	enum vc4_encoder_type encoder_type;
38 
39 	/* ALSA card name */
40 	const char *card_name;
41 
42 	/* Filename to expose the registers in debugfs */
43 	const char *debugfs_name;
44 
45 	/* Maximum pixel clock supported by the controller (in Hz) */
46 	unsigned long long max_pixel_clock;
47 
48 	/* List of the registers available on that variant */
49 	const struct vc4_hdmi_register *registers;
50 
51 	/* Number of registers on that variant */
52 	unsigned int num_registers;
53 
54 	/* BCM2711 Only.
55 	 * The variants don't map the lane in the same order in the
56 	 * PHY, so this is an array mapping the HDMI channel (index)
57 	 * to the PHY lane (value).
58 	 */
59 	enum vc4_hdmi_phy_channel phy_lane_mapping[4];
60 
61 	/* The BCM2711 cannot deal with odd horizontal pixel timings */
62 	bool unsupported_odd_h_timings;
63 
64 	/*
65 	 * The BCM2711 CEC/hotplug IRQ controller is shared between the
66 	 * two HDMI controllers, and we have a proper irqchip driver for
67 	 * it.
68 	 */
69 	bool external_irq_controller;
70 
71 	/* Callback to get the resources (memory region, interrupts,
72 	 * clocks, etc) for that variant.
73 	 */
74 	int (*init_resources)(struct vc4_hdmi *vc4_hdmi);
75 
76 	/* Callback to reset the HDMI block */
77 	void (*reset)(struct vc4_hdmi *vc4_hdmi);
78 
79 	/* Callback to enable / disable the CSC */
80 	void (*csc_setup)(struct vc4_hdmi *vc4_hdmi, bool enable);
81 
82 	/* Callback to configure the video timings in the HDMI block */
83 	void (*set_timings)(struct vc4_hdmi *vc4_hdmi,
84 			    struct drm_connector_state *state,
85 			    struct drm_display_mode *mode);
86 
87 	/* Callback to initialize the PHY according to the connector state */
88 	void (*phy_init)(struct vc4_hdmi *vc4_hdmi,
89 			 struct vc4_hdmi_connector_state *vc4_conn_state);
90 
91 	/* Callback to disable the PHY */
92 	void (*phy_disable)(struct vc4_hdmi *vc4_hdmi);
93 
94 	/* Callback to enable the RNG in the PHY */
95 	void (*phy_rng_enable)(struct vc4_hdmi *vc4_hdmi);
96 
97 	/* Callback to disable the RNG in the PHY */
98 	void (*phy_rng_disable)(struct vc4_hdmi *vc4_hdmi);
99 
100 	/* Callback to get channel map */
101 	u32 (*channel_map)(struct vc4_hdmi *vc4_hdmi, u32 channel_mask);
102 
103 	/* Enables HDR metadata */
104 	bool supports_hdr;
105 };
106 
107 /* HDMI audio information */
108 struct vc4_hdmi_audio {
109 	struct snd_soc_card card;
110 	struct snd_soc_dai_link link;
111 	struct snd_soc_dai_link_component cpu;
112 	struct snd_soc_dai_link_component codec;
113 	struct snd_soc_dai_link_component platform;
114 	int samplerate;
115 	int channels;
116 	struct snd_dmaengine_dai_dma_data dma_data;
117 	struct snd_pcm_substream *substream;
118 
119 	bool streaming;
120 };
121 
122 /* General HDMI hardware state. */
123 struct vc4_hdmi {
124 	struct vc4_hdmi_audio audio;
125 
126 	struct platform_device *pdev;
127 	const struct vc4_hdmi_variant *variant;
128 
129 	struct vc4_hdmi_encoder encoder;
130 	struct drm_connector connector;
131 
132 	struct delayed_work scrambling_work;
133 
134 	struct i2c_adapter *ddc;
135 	void __iomem *hdmicore_regs;
136 	void __iomem *hd_regs;
137 
138 	/* VC5 Only */
139 	void __iomem *cec_regs;
140 	/* VC5 Only */
141 	void __iomem *csc_regs;
142 	/* VC5 Only */
143 	void __iomem *dvp_regs;
144 	/* VC5 Only */
145 	void __iomem *phy_regs;
146 	/* VC5 Only */
147 	void __iomem *ram_regs;
148 	/* VC5 Only */
149 	void __iomem *rm_regs;
150 
151 	int hpd_gpio;
152 	bool hpd_active_low;
153 
154 	/*
155 	 * On some systems (like the RPi4), some modes are in the same
156 	 * frequency range than the WiFi channels (1440p@60Hz for
157 	 * example). Should we take evasive actions because that system
158 	 * has a wifi adapter?
159 	 */
160 	bool disable_wifi_frequencies;
161 
162 	/*
163 	 * Even if HDMI0 on the RPi4 can output modes requiring a pixel
164 	 * rate higher than 297MHz, it needs some adjustments in the
165 	 * config.txt file to be able to do so and thus won't always be
166 	 * available.
167 	 */
168 	bool disable_4kp60;
169 
170 	struct cec_adapter *cec_adap;
171 	struct cec_msg cec_rx_msg;
172 	bool cec_tx_ok;
173 	bool cec_irq_was_rx;
174 
175 	struct clk *cec_clock;
176 	struct clk *pixel_clock;
177 	struct clk *hsm_clock;
178 	struct clk *audio_clock;
179 	struct clk *pixel_bvb_clock;
180 
181 	struct reset_control *reset;
182 
183 	struct debugfs_regset32 hdmi_regset;
184 	struct debugfs_regset32 hd_regset;
185 };
186 
187 static inline struct vc4_hdmi *
188 connector_to_vc4_hdmi(struct drm_connector *connector)
189 {
190 	return container_of(connector, struct vc4_hdmi, connector);
191 }
192 
193 static inline struct vc4_hdmi *
194 encoder_to_vc4_hdmi(struct drm_encoder *encoder)
195 {
196 	struct vc4_hdmi_encoder *_encoder = to_vc4_hdmi_encoder(encoder);
197 
198 	return container_of(_encoder, struct vc4_hdmi, encoder);
199 }
200 
201 struct vc4_hdmi_connector_state {
202 	struct drm_connector_state	base;
203 	unsigned long long		pixel_rate;
204 };
205 
206 static inline struct vc4_hdmi_connector_state *
207 conn_state_to_vc4_hdmi_conn_state(struct drm_connector_state *conn_state)
208 {
209 	return container_of(conn_state, struct vc4_hdmi_connector_state, base);
210 }
211 
212 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
213 		       struct vc4_hdmi_connector_state *vc4_conn_state);
214 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
215 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
216 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
217 
218 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
219 		       struct vc4_hdmi_connector_state *vc4_conn_state);
220 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
221 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
222 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
223 
224 #endif /* _VC4_HDMI_H_ */
225