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 struct vc4_hdmi;
12 struct vc4_hdmi_register;
13 struct vc4_hdmi_connector_state;
14
15 enum vc4_hdmi_phy_channel {
16 PHY_LANE_0 = 0,
17 PHY_LANE_1,
18 PHY_LANE_2,
19 PHY_LANE_CK,
20 };
21
22 struct vc4_hdmi_variant {
23 /* Encoder Type for that controller */
24 enum vc4_encoder_type encoder_type;
25
26 /* ALSA card name */
27 const char *card_name;
28
29 /* Filename to expose the registers in debugfs */
30 const char *debugfs_name;
31
32 /* Maximum pixel clock supported by the controller (in Hz) */
33 unsigned long long max_pixel_clock;
34
35 /* List of the registers available on that variant */
36 const struct vc4_hdmi_register *registers;
37
38 /* Number of registers on that variant */
39 unsigned int num_registers;
40
41 /* BCM2711 Only.
42 * The variants don't map the lane in the same order in the
43 * PHY, so this is an array mapping the HDMI channel (index)
44 * to the PHY lane (value).
45 */
46 enum vc4_hdmi_phy_channel phy_lane_mapping[4];
47
48 /* The BCM2711 cannot deal with odd horizontal pixel timings */
49 bool unsupported_odd_h_timings;
50
51 /*
52 * The BCM2711 CEC/hotplug IRQ controller is shared between the
53 * two HDMI controllers, and we have a proper irqchip driver for
54 * it.
55 */
56 bool external_irq_controller;
57
58 /* Callback to get the resources (memory region, interrupts,
59 * clocks, etc) for that variant.
60 */
61 int (*init_resources)(struct drm_device *drm,
62 struct vc4_hdmi *vc4_hdmi);
63
64 /* Callback to reset the HDMI block */
65 void (*reset)(struct vc4_hdmi *vc4_hdmi);
66
67 /* Callback to enable / disable the CSC */
68 void (*csc_setup)(struct vc4_hdmi *vc4_hdmi,
69 struct drm_connector_state *state,
70 const struct drm_display_mode *mode);
71
72 /* Callback to configure the video timings in the HDMI block */
73 void (*set_timings)(struct vc4_hdmi *vc4_hdmi,
74 struct drm_connector_state *state,
75 const struct drm_display_mode *mode);
76
77 /* Callback to initialize the PHY according to the connector state */
78 void (*phy_init)(struct vc4_hdmi *vc4_hdmi,
79 struct vc4_hdmi_connector_state *vc4_conn_state);
80
81 /* Callback to disable the PHY */
82 void (*phy_disable)(struct vc4_hdmi *vc4_hdmi);
83
84 /* Callback to enable the RNG in the PHY */
85 void (*phy_rng_enable)(struct vc4_hdmi *vc4_hdmi);
86
87 /* Callback to disable the RNG in the PHY */
88 void (*phy_rng_disable)(struct vc4_hdmi *vc4_hdmi);
89
90 /* Callback to get channel map */
91 u32 (*channel_map)(struct vc4_hdmi *vc4_hdmi, u32 channel_mask);
92
93 /* Enables HDR metadata */
94 bool supports_hdr;
95
96 /* Callback for hardware specific hotplug detect */
97 bool (*hp_detect)(struct vc4_hdmi *vc4_hdmi);
98 };
99
100 /* HDMI audio information */
101 struct vc4_hdmi_audio {
102 struct snd_soc_card card;
103 struct snd_soc_dai_link link;
104 struct snd_soc_dai_link_component cpu;
105 struct snd_soc_dai_link_component codec;
106 struct snd_soc_dai_link_component platform;
107 struct snd_dmaengine_dai_dma_data dma_data;
108 struct hdmi_audio_infoframe infoframe;
109 struct platform_device *codec_pdev;
110 bool streaming;
111 };
112
113 enum vc4_hdmi_output_format {
114 VC4_HDMI_OUTPUT_RGB,
115 VC4_HDMI_OUTPUT_YUV422,
116 VC4_HDMI_OUTPUT_YUV444,
117 VC4_HDMI_OUTPUT_YUV420,
118 };
119
120 enum vc4_hdmi_broadcast_rgb {
121 VC4_HDMI_BROADCAST_RGB_AUTO,
122 VC4_HDMI_BROADCAST_RGB_FULL,
123 VC4_HDMI_BROADCAST_RGB_LIMITED,
124 };
125
126 /* General HDMI hardware state. */
127 struct vc4_hdmi {
128 struct vc4_hdmi_audio audio;
129
130 struct platform_device *pdev;
131 const struct vc4_hdmi_variant *variant;
132
133 struct vc4_encoder encoder;
134 struct drm_connector connector;
135
136 struct delayed_work scrambling_work;
137
138 struct drm_property *broadcast_rgb_property;
139
140 struct i2c_adapter *ddc;
141 void __iomem *hdmicore_regs;
142 void __iomem *hd_regs;
143
144 /* VC5 Only */
145 void __iomem *cec_regs;
146 /* VC5 Only */
147 void __iomem *csc_regs;
148 /* VC5 Only */
149 void __iomem *dvp_regs;
150 /* VC5 Only */
151 void __iomem *phy_regs;
152 /* VC5 Only */
153 void __iomem *ram_regs;
154 /* VC5 Only */
155 void __iomem *rm_regs;
156
157 struct gpio_desc *hpd_gpio;
158
159 /*
160 * On some systems (like the RPi4), some modes are in the same
161 * frequency range than the WiFi channels (1440p@60Hz for
162 * example). Should we take evasive actions because that system
163 * has a wifi adapter?
164 */
165 bool disable_wifi_frequencies;
166
167 struct cec_adapter *cec_adap;
168 struct cec_msg cec_rx_msg;
169 bool cec_tx_ok;
170 bool cec_irq_was_rx;
171
172 struct clk *cec_clock;
173 struct clk *pixel_clock;
174 struct clk *hsm_clock;
175 struct clk *audio_clock;
176 struct clk *pixel_bvb_clock;
177
178 struct reset_control *reset;
179
180 struct debugfs_regset32 hdmi_regset;
181 struct debugfs_regset32 hd_regset;
182
183 /* VC5 only */
184 struct debugfs_regset32 cec_regset;
185 struct debugfs_regset32 csc_regset;
186 struct debugfs_regset32 dvp_regset;
187 struct debugfs_regset32 phy_regset;
188 struct debugfs_regset32 ram_regset;
189 struct debugfs_regset32 rm_regset;
190
191 /**
192 * @hw_lock: Spinlock protecting device register access.
193 */
194 spinlock_t hw_lock;
195
196 /**
197 * @mutex: Mutex protecting the driver access across multiple
198 * frameworks (KMS, ALSA, CEC).
199 */
200 struct mutex mutex;
201
202 /**
203 * @saved_adjusted_mode: Copy of @drm_crtc_state.adjusted_mode
204 * for use by ALSA hooks and interrupt handlers. Protected by @mutex.
205 */
206 struct drm_display_mode saved_adjusted_mode;
207
208 /**
209 * @packet_ram_enabled: Is the HDMI controller packet RAM currently
210 * on? Protected by @mutex.
211 */
212 bool packet_ram_enabled;
213
214 /**
215 * @scdc_enabled: Is the HDMI controller currently running with
216 * the scrambler on? Protected by @mutex.
217 */
218 bool scdc_enabled;
219
220 /**
221 * @output_bpc: Copy of @vc4_connector_state.output_bpc for use
222 * outside of KMS hooks. Protected by @mutex.
223 */
224 unsigned int output_bpc;
225
226 /**
227 * @output_format: Copy of @vc4_connector_state.output_format
228 * for use outside of KMS hooks. Protected by @mutex.
229 */
230 enum vc4_hdmi_output_format output_format;
231 };
232
233 #define connector_to_vc4_hdmi(_connector) \
234 container_of_const(_connector, struct vc4_hdmi, connector)
235
236 static inline struct vc4_hdmi *
encoder_to_vc4_hdmi(struct drm_encoder * encoder)237 encoder_to_vc4_hdmi(struct drm_encoder *encoder)
238 {
239 struct vc4_encoder *_encoder = to_vc4_encoder(encoder);
240 return container_of_const(_encoder, struct vc4_hdmi, encoder);
241 }
242
243 struct vc4_hdmi_connector_state {
244 struct drm_connector_state base;
245 unsigned long long tmds_char_rate;
246 unsigned int output_bpc;
247 enum vc4_hdmi_output_format output_format;
248 enum vc4_hdmi_broadcast_rgb broadcast_rgb;
249 };
250
251 #define conn_state_to_vc4_hdmi_conn_state(_state) \
252 container_of_const(_state, struct vc4_hdmi_connector_state, base)
253
254 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
255 struct vc4_hdmi_connector_state *vc4_conn_state);
256 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
257 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
258 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
259
260 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
261 struct vc4_hdmi_connector_state *vc4_conn_state);
262 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
263 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
264 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
265
266 #endif /* _VC4_HDMI_H_ */
267
