1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (C) 2018 Jernej Skrabec <jernej.skrabec@siol.net>
4  */
5 
6 #ifndef _SUN8I_DW_HDMI_H_
7 #define _SUN8I_DW_HDMI_H_
8 
9 #include <drm/bridge/dw_hdmi.h>
10 #include <drm/drm_encoder.h>
11 #include <linux/clk.h>
12 #include <linux/regmap.h>
13 #include <linux/regulator/consumer.h>
14 #include <linux/reset.h>
15 
16 #define SUN8I_HDMI_PHY_DBG_CTRL_REG	0x0000
17 #define SUN8I_HDMI_PHY_DBG_CTRL_PX_LOCK		BIT(0)
18 #define SUN8I_HDMI_PHY_DBG_CTRL_POL_MASK	GENMASK(15, 8)
19 #define SUN8I_HDMI_PHY_DBG_CTRL_POL_NHSYNC	BIT(8)
20 #define SUN8I_HDMI_PHY_DBG_CTRL_POL_NVSYNC	BIT(9)
21 #define SUN8I_HDMI_PHY_DBG_CTRL_ADDR_MASK	GENMASK(23, 16)
22 #define SUN8I_HDMI_PHY_DBG_CTRL_ADDR(addr)	(addr << 16)
23 
24 #define SUN8I_HDMI_PHY_REXT_CTRL_REG	0x0004
25 #define SUN8I_HDMI_PHY_REXT_CTRL_REXT_EN	BIT(31)
26 
27 #define SUN8I_HDMI_PHY_READ_EN_REG	0x0010
28 #define SUN8I_HDMI_PHY_READ_EN_MAGIC		0x54524545
29 
30 #define SUN8I_HDMI_PHY_UNSCRAMBLE_REG	0x0014
31 #define SUN8I_HDMI_PHY_UNSCRAMBLE_MAGIC		0x42494E47
32 
33 #define SUN8I_HDMI_PHY_ANA_CFG1_REG	0x0020
34 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_SWI		BIT(31)
35 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_PWEND	BIT(30)
36 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_PWENC	BIT(29)
37 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_CALSW	BIT(28)
38 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_SVRCAL(x)	((x) << 26)
39 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_SVBH(x)	((x) << 24)
40 #define SUN8I_HDMI_PHY_ANA_CFG1_AMP_OPT		BIT(23)
41 #define SUN8I_HDMI_PHY_ANA_CFG1_EMP_OPT		BIT(22)
42 #define SUN8I_HDMI_PHY_ANA_CFG1_AMPCK_OPT	BIT(21)
43 #define SUN8I_HDMI_PHY_ANA_CFG1_EMPCK_OPT	BIT(20)
44 #define SUN8I_HDMI_PHY_ANA_CFG1_ENRCAL		BIT(19)
45 #define SUN8I_HDMI_PHY_ANA_CFG1_ENCALOG		BIT(18)
46 #define SUN8I_HDMI_PHY_ANA_CFG1_REG_SCKTMDS	BIT(17)
47 #define SUN8I_HDMI_PHY_ANA_CFG1_TMDSCLK_EN	BIT(16)
48 #define SUN8I_HDMI_PHY_ANA_CFG1_TXEN_MASK	GENMASK(15, 12)
49 #define SUN8I_HDMI_PHY_ANA_CFG1_TXEN_ALL	(0xf << 12)
50 #define SUN8I_HDMI_PHY_ANA_CFG1_BIASEN_TMDSCLK	BIT(11)
51 #define SUN8I_HDMI_PHY_ANA_CFG1_BIASEN_TMDS2	BIT(10)
52 #define SUN8I_HDMI_PHY_ANA_CFG1_BIASEN_TMDS1	BIT(9)
53 #define SUN8I_HDMI_PHY_ANA_CFG1_BIASEN_TMDS0	BIT(8)
54 #define SUN8I_HDMI_PHY_ANA_CFG1_ENP2S_TMDSCLK	BIT(7)
55 #define SUN8I_HDMI_PHY_ANA_CFG1_ENP2S_TMDS2	BIT(6)
56 #define SUN8I_HDMI_PHY_ANA_CFG1_ENP2S_TMDS1	BIT(5)
57 #define SUN8I_HDMI_PHY_ANA_CFG1_ENP2S_TMDS0	BIT(4)
58 #define SUN8I_HDMI_PHY_ANA_CFG1_CKEN		BIT(3)
59 #define SUN8I_HDMI_PHY_ANA_CFG1_LDOEN		BIT(2)
60 #define SUN8I_HDMI_PHY_ANA_CFG1_ENVBS		BIT(1)
61 #define SUN8I_HDMI_PHY_ANA_CFG1_ENBI		BIT(0)
62 
63 #define SUN8I_HDMI_PHY_ANA_CFG2_REG	0x0024
64 #define SUN8I_HDMI_PHY_ANA_CFG2_M_EN		BIT(31)
65 #define SUN8I_HDMI_PHY_ANA_CFG2_PLLDBEN		BIT(30)
66 #define SUN8I_HDMI_PHY_ANA_CFG2_SEN		BIT(29)
67 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_HPDPD	BIT(28)
68 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_HPDEN	BIT(27)
69 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_PLRCK	BIT(26)
70 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_PLR(x)	((x) << 23)
71 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_DENCK	BIT(22)
72 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_DEN		BIT(21)
73 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_CD(x)	((x) << 19)
74 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_CKSS(x)	((x) << 17)
75 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_BIGSWCK	BIT(16)
76 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_BIGSW	BIT(15)
77 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_CSMPS(x)	((x) << 13)
78 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_SLV(x)	((x) << 10)
79 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_BOOSTCK(x)	((x) << 8)
80 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_BOOST(x)	((x) << 6)
81 #define SUN8I_HDMI_PHY_ANA_CFG2_REG_RESDI(x)	((x) << 0)
82 
83 #define SUN8I_HDMI_PHY_ANA_CFG3_REG	0x0028
84 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_SLOWCK(x)	((x) << 30)
85 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_SLOW(x)	((x) << 28)
86 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_WIRE(x)	((x) << 18)
87 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_AMPCK(x)	((x) << 14)
88 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_EMPCK(x)	((x) << 11)
89 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_AMP(x)	((x) << 7)
90 #define SUN8I_HDMI_PHY_ANA_CFG3_REG_EMP(x)	((x) << 4)
91 #define SUN8I_HDMI_PHY_ANA_CFG3_SDAPD		BIT(3)
92 #define SUN8I_HDMI_PHY_ANA_CFG3_SDAEN		BIT(2)
93 #define SUN8I_HDMI_PHY_ANA_CFG3_SCLPD		BIT(1)
94 #define SUN8I_HDMI_PHY_ANA_CFG3_SCLEN		BIT(0)
95 
96 #define SUN8I_HDMI_PHY_PLL_CFG1_REG	0x002c
97 #define SUN8I_HDMI_PHY_PLL_CFG1_REG_OD1		BIT(31)
98 #define SUN8I_HDMI_PHY_PLL_CFG1_REG_OD		BIT(30)
99 #define SUN8I_HDMI_PHY_PLL_CFG1_LDO2_EN		BIT(29)
100 #define SUN8I_HDMI_PHY_PLL_CFG1_LDO1_EN		BIT(28)
101 #define SUN8I_HDMI_PHY_PLL_CFG1_HV_IS_33	BIT(27)
102 #define SUN8I_HDMI_PHY_PLL_CFG1_CKIN_SEL_MSK	BIT(26)
103 #define SUN8I_HDMI_PHY_PLL_CFG1_CKIN_SEL_SHIFT	26
104 #define SUN8I_HDMI_PHY_PLL_CFG1_PLLEN		BIT(25)
105 #define SUN8I_HDMI_PHY_PLL_CFG1_LDO_VSET(x)	((x) << 22)
106 #define SUN8I_HDMI_PHY_PLL_CFG1_UNKNOWN(x)	((x) << 20)
107 #define SUN8I_HDMI_PHY_PLL_CFG1_PLLDBEN		BIT(19)
108 #define SUN8I_HDMI_PHY_PLL_CFG1_CS		BIT(18)
109 #define SUN8I_HDMI_PHY_PLL_CFG1_CP_S(x)		((x) << 13)
110 #define SUN8I_HDMI_PHY_PLL_CFG1_CNT_INT(x)	((x) << 7)
111 #define SUN8I_HDMI_PHY_PLL_CFG1_BWS		BIT(6)
112 #define SUN8I_HDMI_PHY_PLL_CFG1_B_IN_MSK	GENMASK(5, 0)
113 #define SUN8I_HDMI_PHY_PLL_CFG1_B_IN_SHIFT	0
114 
115 #define SUN8I_HDMI_PHY_PLL_CFG2_REG	0x0030
116 #define SUN8I_HDMI_PHY_PLL_CFG2_SV_H		BIT(31)
117 #define SUN8I_HDMI_PHY_PLL_CFG2_PDCLKSEL(x)	((x) << 29)
118 #define SUN8I_HDMI_PHY_PLL_CFG2_CLKSTEP(x)	((x) << 27)
119 #define SUN8I_HDMI_PHY_PLL_CFG2_PSET(x)		((x) << 24)
120 #define SUN8I_HDMI_PHY_PLL_CFG2_PCLK_SEL	BIT(23)
121 #define SUN8I_HDMI_PHY_PLL_CFG2_AUTOSYNC_DIS	BIT(22)
122 #define SUN8I_HDMI_PHY_PLL_CFG2_VREG2_OUT_EN	BIT(21)
123 #define SUN8I_HDMI_PHY_PLL_CFG2_VREG1_OUT_EN	BIT(20)
124 #define SUN8I_HDMI_PHY_PLL_CFG2_VCOGAIN_EN	BIT(19)
125 #define SUN8I_HDMI_PHY_PLL_CFG2_VCOGAIN(x)	((x) << 16)
126 #define SUN8I_HDMI_PHY_PLL_CFG2_VCO_S(x)	((x) << 12)
127 #define SUN8I_HDMI_PHY_PLL_CFG2_VCO_RST_IN	BIT(11)
128 #define SUN8I_HDMI_PHY_PLL_CFG2_SINT_FRAC	BIT(10)
129 #define SUN8I_HDMI_PHY_PLL_CFG2_SDIV2		BIT(9)
130 #define SUN8I_HDMI_PHY_PLL_CFG2_S(x)		((x) << 6)
131 #define SUN8I_HDMI_PHY_PLL_CFG2_S6P25_7P5	BIT(5)
132 #define SUN8I_HDMI_PHY_PLL_CFG2_S5_7		BIT(4)
133 #define SUN8I_HDMI_PHY_PLL_CFG2_PREDIV_MSK	GENMASK(3, 0)
134 #define SUN8I_HDMI_PHY_PLL_CFG2_PREDIV_SHIFT	0
135 #define SUN8I_HDMI_PHY_PLL_CFG2_PREDIV(x)	(((x) - 1) << 0)
136 
137 #define SUN8I_HDMI_PHY_PLL_CFG3_REG	0x0034
138 #define SUN8I_HDMI_PHY_PLL_CFG3_SOUT_DIV2	BIT(0)
139 
140 #define SUN8I_HDMI_PHY_ANA_STS_REG	0x0038
141 #define SUN8I_HDMI_PHY_ANA_STS_B_OUT_SHIFT	11
142 #define SUN8I_HDMI_PHY_ANA_STS_B_OUT_MSK	GENMASK(16, 11)
143 #define SUN8I_HDMI_PHY_ANA_STS_RCALEND2D	BIT(7)
144 #define SUN8I_HDMI_PHY_ANA_STS_RCAL_MASK	GENMASK(5, 0)
145 
146 #define SUN8I_HDMI_PHY_CEC_REG		0x003c
147 
148 struct sun8i_hdmi_phy;
149 
150 struct sun8i_hdmi_phy_variant {
151 	bool has_phy_clk;
152 	bool has_second_pll;
153 	unsigned int is_custom_phy : 1;
154 	const struct dw_hdmi_curr_ctrl *cur_ctr;
155 	const struct dw_hdmi_mpll_config *mpll_cfg;
156 	const struct dw_hdmi_phy_config *phy_cfg;
157 	void (*phy_init)(struct sun8i_hdmi_phy *phy);
158 	void (*phy_disable)(struct dw_hdmi *hdmi,
159 			    struct sun8i_hdmi_phy *phy);
160 	int  (*phy_config)(struct dw_hdmi *hdmi,
161 			   struct sun8i_hdmi_phy *phy,
162 			   unsigned int clk_rate);
163 };
164 
165 struct sun8i_hdmi_phy {
166 	struct clk			*clk_bus;
167 	struct clk			*clk_mod;
168 	struct clk			*clk_phy;
169 	struct clk			*clk_pll0;
170 	struct clk			*clk_pll1;
171 	unsigned int			rcal;
172 	struct regmap			*regs;
173 	struct reset_control		*rst_phy;
174 	struct sun8i_hdmi_phy_variant	*variant;
175 };
176 
177 struct sun8i_dw_hdmi_quirks {
178 	enum drm_mode_status (*mode_valid)(struct drm_connector *connector,
179 					   const struct drm_display_mode *mode);
180 	unsigned int set_rate : 1;
181 };
182 
183 struct sun8i_dw_hdmi {
184 	struct clk			*clk_tmds;
185 	struct device			*dev;
186 	struct dw_hdmi			*hdmi;
187 	struct drm_encoder		encoder;
188 	struct sun8i_hdmi_phy		*phy;
189 	struct dw_hdmi_plat_data	plat_data;
190 	struct regulator		*regulator;
191 	const struct sun8i_dw_hdmi_quirks *quirks;
192 	struct reset_control		*rst_ctrl;
193 };
194 
195 static inline struct sun8i_dw_hdmi *
196 encoder_to_sun8i_dw_hdmi(struct drm_encoder *encoder)
197 {
198 	return container_of(encoder, struct sun8i_dw_hdmi, encoder);
199 }
200 
201 int sun8i_hdmi_phy_probe(struct sun8i_dw_hdmi *hdmi, struct device_node *node);
202 void sun8i_hdmi_phy_remove(struct sun8i_dw_hdmi *hdmi);
203 
204 void sun8i_hdmi_phy_init(struct sun8i_hdmi_phy *phy);
205 void sun8i_hdmi_phy_set_ops(struct sun8i_hdmi_phy *phy,
206 			    struct dw_hdmi_plat_data *plat_data);
207 
208 int sun8i_phy_clk_create(struct sun8i_hdmi_phy *phy, struct device *dev,
209 			 bool second_parent);
210 
211 #endif /* _SUN8I_DW_HDMI_H_ */
212