xref: /openbmc/linux/drivers/gpu/drm/vc4/vc4_hdmi.h (revision 7e60e389)
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 	/* Set to true when the CEC support is available */
46 	bool cec_available;
47 
48 	/* Maximum pixel clock supported by the controller (in Hz) */
49 	unsigned long long max_pixel_clock;
50 
51 	/* List of the registers available on that variant */
52 	const struct vc4_hdmi_register *registers;
53 
54 	/* Number of registers on that variant */
55 	unsigned int num_registers;
56 
57 	/* BCM2711 Only.
58 	 * The variants don't map the lane in the same order in the
59 	 * PHY, so this is an array mapping the HDMI channel (index)
60 	 * to the PHY lane (value).
61 	 */
62 	enum vc4_hdmi_phy_channel phy_lane_mapping[4];
63 
64 	/* The BCM2711 cannot deal with odd horizontal pixel timings */
65 	bool unsupported_odd_h_timings;
66 
67 	/* Callback to get the resources (memory region, interrupts,
68 	 * clocks, etc) for that variant.
69 	 */
70 	int (*init_resources)(struct vc4_hdmi *vc4_hdmi);
71 
72 	/* Callback to reset the HDMI block */
73 	void (*reset)(struct vc4_hdmi *vc4_hdmi);
74 
75 	/* Callback to enable / disable the CSC */
76 	void (*csc_setup)(struct vc4_hdmi *vc4_hdmi, bool enable);
77 
78 	/* Callback to configure the video timings in the HDMI block */
79 	void (*set_timings)(struct vc4_hdmi *vc4_hdmi,
80 			    struct drm_connector_state *state,
81 			    struct drm_display_mode *mode);
82 
83 	/* Callback to initialize the PHY according to the connector state */
84 	void (*phy_init)(struct vc4_hdmi *vc4_hdmi,
85 			 struct vc4_hdmi_connector_state *vc4_conn_state);
86 
87 	/* Callback to disable the PHY */
88 	void (*phy_disable)(struct vc4_hdmi *vc4_hdmi);
89 
90 	/* Callback to enable the RNG in the PHY */
91 	void (*phy_rng_enable)(struct vc4_hdmi *vc4_hdmi);
92 
93 	/* Callback to disable the RNG in the PHY */
94 	void (*phy_rng_disable)(struct vc4_hdmi *vc4_hdmi);
95 
96 	/* Callback to get channel map */
97 	u32 (*channel_map)(struct vc4_hdmi *vc4_hdmi, u32 channel_mask);
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 	int samplerate;
108 	int channels;
109 	struct snd_dmaengine_dai_dma_data dma_data;
110 	struct snd_pcm_substream *substream;
111 
112 	bool streaming;
113 };
114 
115 /* General HDMI hardware state. */
116 struct vc4_hdmi {
117 	struct vc4_hdmi_audio audio;
118 
119 	struct platform_device *pdev;
120 	const struct vc4_hdmi_variant *variant;
121 
122 	struct vc4_hdmi_encoder encoder;
123 	struct drm_connector connector;
124 
125 	struct i2c_adapter *ddc;
126 	void __iomem *hdmicore_regs;
127 	void __iomem *hd_regs;
128 
129 	/* VC5 Only */
130 	void __iomem *cec_regs;
131 	/* VC5 Only */
132 	void __iomem *csc_regs;
133 	/* VC5 Only */
134 	void __iomem *dvp_regs;
135 	/* VC5 Only */
136 	void __iomem *phy_regs;
137 	/* VC5 Only */
138 	void __iomem *ram_regs;
139 	/* VC5 Only */
140 	void __iomem *rm_regs;
141 
142 	int hpd_gpio;
143 	bool hpd_active_low;
144 
145 	/*
146 	 * On some systems (like the RPi4), some modes are in the same
147 	 * frequency range than the WiFi channels (1440p@60Hz for
148 	 * example). Should we take evasive actions because that system
149 	 * has a wifi adapter?
150 	 */
151 	bool disable_wifi_frequencies;
152 
153 	struct cec_adapter *cec_adap;
154 	struct cec_msg cec_rx_msg;
155 	bool cec_tx_ok;
156 	bool cec_irq_was_rx;
157 
158 	struct clk *pixel_clock;
159 	struct clk *hsm_clock;
160 	struct clk *audio_clock;
161 	struct clk *pixel_bvb_clock;
162 
163 	struct reset_control *reset;
164 
165 	struct debugfs_regset32 hdmi_regset;
166 	struct debugfs_regset32 hd_regset;
167 };
168 
169 static inline struct vc4_hdmi *
170 connector_to_vc4_hdmi(struct drm_connector *connector)
171 {
172 	return container_of(connector, struct vc4_hdmi, connector);
173 }
174 
175 static inline struct vc4_hdmi *
176 encoder_to_vc4_hdmi(struct drm_encoder *encoder)
177 {
178 	struct vc4_hdmi_encoder *_encoder = to_vc4_hdmi_encoder(encoder);
179 
180 	return container_of(_encoder, struct vc4_hdmi, encoder);
181 }
182 
183 struct vc4_hdmi_connector_state {
184 	struct drm_connector_state	base;
185 	unsigned long long		pixel_rate;
186 };
187 
188 static inline struct vc4_hdmi_connector_state *
189 conn_state_to_vc4_hdmi_conn_state(struct drm_connector_state *conn_state)
190 {
191 	return container_of(conn_state, struct vc4_hdmi_connector_state, base);
192 }
193 
194 void vc4_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
195 		       struct vc4_hdmi_connector_state *vc4_conn_state);
196 void vc4_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
197 void vc4_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
198 void vc4_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
199 
200 void vc5_hdmi_phy_init(struct vc4_hdmi *vc4_hdmi,
201 		       struct vc4_hdmi_connector_state *vc4_conn_state);
202 void vc5_hdmi_phy_disable(struct vc4_hdmi *vc4_hdmi);
203 void vc5_hdmi_phy_rng_enable(struct vc4_hdmi *vc4_hdmi);
204 void vc5_hdmi_phy_rng_disable(struct vc4_hdmi *vc4_hdmi);
205 
206 #endif /* _VC4_HDMI_H_ */
207