1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Elida kd35t133 5.5" MIPI-DSI panel driver
4  * Copyright (C) 2020 Theobroma Systems Design und Consulting GmbH
5  *
6  * based on
7  *
8  * Rockteck jh057n00900 5.5" MIPI-DSI panel driver
9  * Copyright (C) Purism SPC 2019
10  */
11 
12 #include <linux/delay.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/media-bus-format.h>
15 #include <linux/module.h>
16 #include <linux/of.h>
17 #include <linux/regulator/consumer.h>
18 
19 #include <video/display_timing.h>
20 #include <video/mipi_display.h>
21 
22 #include <drm/drm_mipi_dsi.h>
23 #include <drm/drm_modes.h>
24 #include <drm/drm_panel.h>
25 
26 /* Manufacturer specific Commands send via DSI */
27 #define KD35T133_CMD_INTERFACEMODECTRL		0xb0
28 #define KD35T133_CMD_FRAMERATECTRL		0xb1
29 #define KD35T133_CMD_DISPLAYINVERSIONCTRL	0xb4
30 #define KD35T133_CMD_DISPLAYFUNCTIONCTRL	0xb6
31 #define KD35T133_CMD_POWERCONTROL1		0xc0
32 #define KD35T133_CMD_POWERCONTROL2		0xc1
33 #define KD35T133_CMD_VCOMCONTROL		0xc5
34 #define KD35T133_CMD_POSITIVEGAMMA		0xe0
35 #define KD35T133_CMD_NEGATIVEGAMMA		0xe1
36 #define KD35T133_CMD_SETIMAGEFUNCTION		0xe9
37 #define KD35T133_CMD_ADJUSTCONTROL3		0xf7
38 
39 struct kd35t133 {
40 	struct device *dev;
41 	struct drm_panel panel;
42 	struct gpio_desc *reset_gpio;
43 	struct regulator *vdd;
44 	struct regulator *iovcc;
45 	enum drm_panel_orientation orientation;
46 	bool prepared;
47 };
48 
49 static inline struct kd35t133 *panel_to_kd35t133(struct drm_panel *panel)
50 {
51 	return container_of(panel, struct kd35t133, panel);
52 }
53 
54 #define dsi_dcs_write_seq(dsi, cmd, seq...) do {			\
55 		static const u8 b[] = { cmd, seq };			\
56 		int ret;						\
57 		ret = mipi_dsi_dcs_write_buffer(dsi, b, ARRAY_SIZE(b));	\
58 		if (ret < 0)						\
59 			return ret;					\
60 	} while (0)
61 
62 static int kd35t133_init_sequence(struct kd35t133 *ctx)
63 {
64 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(ctx->dev);
65 	struct device *dev = ctx->dev;
66 
67 	/*
68 	 * Init sequence was supplied by the panel vendor with minimal
69 	 * documentation.
70 	 */
71 	dsi_dcs_write_seq(dsi, KD35T133_CMD_POSITIVEGAMMA,
72 			  0x00, 0x13, 0x18, 0x04, 0x0f, 0x06, 0x3a, 0x56,
73 			  0x4d, 0x03, 0x0a, 0x06, 0x30, 0x3e, 0x0f);
74 	dsi_dcs_write_seq(dsi, KD35T133_CMD_NEGATIVEGAMMA,
75 			  0x00, 0x13, 0x18, 0x01, 0x11, 0x06, 0x38, 0x34,
76 			  0x4d, 0x06, 0x0d, 0x0b, 0x31, 0x37, 0x0f);
77 	dsi_dcs_write_seq(dsi, KD35T133_CMD_POWERCONTROL1, 0x18, 0x17);
78 	dsi_dcs_write_seq(dsi, KD35T133_CMD_POWERCONTROL2, 0x41);
79 	dsi_dcs_write_seq(dsi, KD35T133_CMD_VCOMCONTROL, 0x00, 0x1a, 0x80);
80 	dsi_dcs_write_seq(dsi, MIPI_DCS_SET_ADDRESS_MODE, 0x48);
81 	dsi_dcs_write_seq(dsi, MIPI_DCS_SET_PIXEL_FORMAT, 0x55);
82 	dsi_dcs_write_seq(dsi, KD35T133_CMD_INTERFACEMODECTRL, 0x00);
83 	dsi_dcs_write_seq(dsi, KD35T133_CMD_FRAMERATECTRL, 0xa0);
84 	dsi_dcs_write_seq(dsi, KD35T133_CMD_DISPLAYINVERSIONCTRL, 0x02);
85 	dsi_dcs_write_seq(dsi, KD35T133_CMD_DISPLAYFUNCTIONCTRL,
86 			  0x20, 0x02);
87 	dsi_dcs_write_seq(dsi, KD35T133_CMD_SETIMAGEFUNCTION, 0x00);
88 	dsi_dcs_write_seq(dsi, KD35T133_CMD_ADJUSTCONTROL3,
89 			  0xa9, 0x51, 0x2c, 0x82);
90 	mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_INVERT_MODE, NULL, 0);
91 
92 	dev_dbg(dev, "Panel init sequence done\n");
93 	return 0;
94 }
95 
96 static int kd35t133_unprepare(struct drm_panel *panel)
97 {
98 	struct kd35t133 *ctx = panel_to_kd35t133(panel);
99 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(ctx->dev);
100 	int ret;
101 
102 	if (!ctx->prepared)
103 		return 0;
104 
105 	ret = mipi_dsi_dcs_set_display_off(dsi);
106 	if (ret < 0)
107 		dev_err(ctx->dev, "failed to set display off: %d\n", ret);
108 
109 	ret = mipi_dsi_dcs_enter_sleep_mode(dsi);
110 	if (ret < 0) {
111 		dev_err(ctx->dev, "failed to enter sleep mode: %d\n", ret);
112 		return ret;
113 	}
114 
115 	regulator_disable(ctx->iovcc);
116 	regulator_disable(ctx->vdd);
117 
118 	ctx->prepared = false;
119 
120 	return 0;
121 }
122 
123 static int kd35t133_prepare(struct drm_panel *panel)
124 {
125 	struct kd35t133 *ctx = panel_to_kd35t133(panel);
126 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(ctx->dev);
127 	int ret;
128 
129 	if (ctx->prepared)
130 		return 0;
131 
132 	dev_dbg(ctx->dev, "Resetting the panel\n");
133 	ret = regulator_enable(ctx->vdd);
134 	if (ret < 0) {
135 		dev_err(ctx->dev, "Failed to enable vdd supply: %d\n", ret);
136 		return ret;
137 	}
138 
139 	ret = regulator_enable(ctx->iovcc);
140 	if (ret < 0) {
141 		dev_err(ctx->dev, "Failed to enable iovcc supply: %d\n", ret);
142 		goto disable_vdd;
143 	}
144 
145 	msleep(20);
146 
147 	gpiod_set_value_cansleep(ctx->reset_gpio, 1);
148 	usleep_range(10, 20);
149 	gpiod_set_value_cansleep(ctx->reset_gpio, 0);
150 
151 	msleep(20);
152 
153 	ret = mipi_dsi_dcs_exit_sleep_mode(dsi);
154 	if (ret < 0) {
155 		dev_err(ctx->dev, "Failed to exit sleep mode: %d\n", ret);
156 		goto disable_iovcc;
157 	}
158 
159 	msleep(250);
160 
161 	ret = kd35t133_init_sequence(ctx);
162 	if (ret < 0) {
163 		dev_err(ctx->dev, "Panel init sequence failed: %d\n", ret);
164 		goto disable_iovcc;
165 	}
166 
167 	ret = mipi_dsi_dcs_set_display_on(dsi);
168 	if (ret < 0) {
169 		dev_err(ctx->dev, "Failed to set display on: %d\n", ret);
170 		goto disable_iovcc;
171 	}
172 
173 	msleep(50);
174 
175 	ctx->prepared = true;
176 
177 	return 0;
178 
179 disable_iovcc:
180 	regulator_disable(ctx->iovcc);
181 disable_vdd:
182 	regulator_disable(ctx->vdd);
183 	return ret;
184 }
185 
186 static const struct drm_display_mode default_mode = {
187 	.hdisplay	= 320,
188 	.hsync_start	= 320 + 130,
189 	.hsync_end	= 320 + 130 + 4,
190 	.htotal		= 320 + 130 + 4 + 130,
191 	.vdisplay	= 480,
192 	.vsync_start	= 480 + 2,
193 	.vsync_end	= 480 + 2 + 1,
194 	.vtotal		= 480 + 2 + 1 + 2,
195 	.clock		= 17000,
196 	.width_mm	= 42,
197 	.height_mm	= 82,
198 };
199 
200 static int kd35t133_get_modes(struct drm_panel *panel,
201 				struct drm_connector *connector)
202 {
203 	struct kd35t133 *ctx = panel_to_kd35t133(panel);
204 	struct drm_display_mode *mode;
205 
206 	mode = drm_mode_duplicate(connector->dev, &default_mode);
207 	if (!mode) {
208 		dev_err(ctx->dev, "Failed to add mode %ux%u@%u\n",
209 			default_mode.hdisplay, default_mode.vdisplay,
210 			drm_mode_vrefresh(&default_mode));
211 		return -ENOMEM;
212 	}
213 
214 	drm_mode_set_name(mode);
215 
216 	mode->type = DRM_MODE_TYPE_DRIVER | DRM_MODE_TYPE_PREFERRED;
217 	connector->display_info.width_mm = mode->width_mm;
218 	connector->display_info.height_mm = mode->height_mm;
219 	drm_mode_probed_add(connector, mode);
220 	/*
221 	 * TODO: Remove once all drm drivers call
222 	 * drm_connector_set_orientation_from_panel()
223 	 */
224 	drm_connector_set_panel_orientation(connector, ctx->orientation);
225 
226 	return 1;
227 }
228 
229 static enum drm_panel_orientation kd35t133_get_orientation(struct drm_panel *panel)
230 {
231 	struct kd35t133 *ctx = panel_to_kd35t133(panel);
232 
233 	return ctx->orientation;
234 }
235 
236 static const struct drm_panel_funcs kd35t133_funcs = {
237 	.unprepare	= kd35t133_unprepare,
238 	.prepare	= kd35t133_prepare,
239 	.get_modes	= kd35t133_get_modes,
240 	.get_orientation = kd35t133_get_orientation,
241 };
242 
243 static int kd35t133_probe(struct mipi_dsi_device *dsi)
244 {
245 	struct device *dev = &dsi->dev;
246 	struct kd35t133 *ctx;
247 	int ret;
248 
249 	ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
250 	if (!ctx)
251 		return -ENOMEM;
252 
253 	ctx->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
254 	if (IS_ERR(ctx->reset_gpio)) {
255 		dev_err(dev, "cannot get reset gpio\n");
256 		return PTR_ERR(ctx->reset_gpio);
257 	}
258 
259 	ctx->vdd = devm_regulator_get(dev, "vdd");
260 	if (IS_ERR(ctx->vdd)) {
261 		ret = PTR_ERR(ctx->vdd);
262 		if (ret != -EPROBE_DEFER)
263 			dev_err(dev, "Failed to request vdd regulator: %d\n", ret);
264 		return ret;
265 	}
266 
267 	ctx->iovcc = devm_regulator_get(dev, "iovcc");
268 	if (IS_ERR(ctx->iovcc)) {
269 		ret = PTR_ERR(ctx->iovcc);
270 		if (ret != -EPROBE_DEFER)
271 			dev_err(dev, "Failed to request iovcc regulator: %d\n", ret);
272 		return ret;
273 	}
274 
275 	ret = of_drm_get_panel_orientation(dev->of_node, &ctx->orientation);
276 	if (ret < 0) {
277 		dev_err(dev, "%pOF: failed to get orientation %d\n", dev->of_node, ret);
278 		return ret;
279 	}
280 
281 	mipi_dsi_set_drvdata(dsi, ctx);
282 
283 	ctx->dev = dev;
284 
285 	dsi->lanes = 1;
286 	dsi->format = MIPI_DSI_FMT_RGB888;
287 	dsi->mode_flags = MIPI_DSI_MODE_VIDEO | MIPI_DSI_MODE_VIDEO_BURST |
288 			  MIPI_DSI_MODE_LPM | MIPI_DSI_MODE_NO_EOT_PACKET |
289 			  MIPI_DSI_CLOCK_NON_CONTINUOUS;
290 
291 	drm_panel_init(&ctx->panel, &dsi->dev, &kd35t133_funcs,
292 		       DRM_MODE_CONNECTOR_DSI);
293 
294 	ret = drm_panel_of_backlight(&ctx->panel);
295 	if (ret)
296 		return ret;
297 
298 	drm_panel_add(&ctx->panel);
299 
300 	ret = mipi_dsi_attach(dsi);
301 	if (ret < 0) {
302 		dev_err(dev, "mipi_dsi_attach failed: %d\n", ret);
303 		drm_panel_remove(&ctx->panel);
304 		return ret;
305 	}
306 
307 	return 0;
308 }
309 
310 static void kd35t133_shutdown(struct mipi_dsi_device *dsi)
311 {
312 	struct kd35t133 *ctx = mipi_dsi_get_drvdata(dsi);
313 	int ret;
314 
315 	ret = drm_panel_unprepare(&ctx->panel);
316 	if (ret < 0)
317 		dev_err(&dsi->dev, "Failed to unprepare panel: %d\n", ret);
318 
319 	ret = drm_panel_disable(&ctx->panel);
320 	if (ret < 0)
321 		dev_err(&dsi->dev, "Failed to disable panel: %d\n", ret);
322 }
323 
324 static int kd35t133_remove(struct mipi_dsi_device *dsi)
325 {
326 	struct kd35t133 *ctx = mipi_dsi_get_drvdata(dsi);
327 	int ret;
328 
329 	kd35t133_shutdown(dsi);
330 
331 	ret = mipi_dsi_detach(dsi);
332 	if (ret < 0)
333 		dev_err(&dsi->dev, "Failed to detach from DSI host: %d\n", ret);
334 
335 	drm_panel_remove(&ctx->panel);
336 
337 	return 0;
338 }
339 
340 static const struct of_device_id kd35t133_of_match[] = {
341 	{ .compatible = "elida,kd35t133" },
342 	{ /* sentinel */ }
343 };
344 MODULE_DEVICE_TABLE(of, kd35t133_of_match);
345 
346 static struct mipi_dsi_driver kd35t133_driver = {
347 	.driver = {
348 		.name = "panel-elida-kd35t133",
349 		.of_match_table = kd35t133_of_match,
350 	},
351 	.probe	= kd35t133_probe,
352 	.remove = kd35t133_remove,
353 	.shutdown = kd35t133_shutdown,
354 };
355 module_mipi_dsi_driver(kd35t133_driver);
356 
357 MODULE_AUTHOR("Heiko Stuebner <heiko.stuebner@theobroma-systems.com>");
358 MODULE_DESCRIPTION("DRM driver for Elida kd35t133 MIPI DSI panel");
359 MODULE_LICENSE("GPL v2");
360