1 /*
2  * Copyright (C) 2012 Texas Instruments
3  * Author: Rob Clark <robdclark@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #include <linux/pinctrl/pinmux.h>
19 #include <linux/pinctrl/consumer.h>
20 #include <linux/backlight.h>
21 #include <linux/gpio/consumer.h>
22 #include <video/display_timing.h>
23 #include <video/of_display_timing.h>
24 #include <video/videomode.h>
25 #include <drm/drm_atomic_helper.h>
26 
27 #include "tilcdc_drv.h"
28 #include "tilcdc_panel.h"
29 
30 struct panel_module {
31 	struct tilcdc_module base;
32 	struct tilcdc_panel_info *info;
33 	struct display_timings *timings;
34 	struct backlight_device *backlight;
35 	struct gpio_desc *enable_gpio;
36 };
37 #define to_panel_module(x) container_of(x, struct panel_module, base)
38 
39 
40 /*
41  * Encoder:
42  */
43 
44 struct panel_encoder {
45 	struct drm_encoder base;
46 	struct panel_module *mod;
47 };
48 #define to_panel_encoder(x) container_of(x, struct panel_encoder, base)
49 
50 static void panel_encoder_dpms(struct drm_encoder *encoder, int mode)
51 {
52 	struct panel_encoder *panel_encoder = to_panel_encoder(encoder);
53 	struct backlight_device *backlight = panel_encoder->mod->backlight;
54 	struct gpio_desc *gpio = panel_encoder->mod->enable_gpio;
55 
56 	if (backlight) {
57 		backlight->props.power = mode == DRM_MODE_DPMS_ON ?
58 					 FB_BLANK_UNBLANK : FB_BLANK_POWERDOWN;
59 		backlight_update_status(backlight);
60 	}
61 
62 	if (gpio)
63 		gpiod_set_value_cansleep(gpio,
64 					 mode == DRM_MODE_DPMS_ON ? 1 : 0);
65 }
66 
67 static void panel_encoder_prepare(struct drm_encoder *encoder)
68 {
69 	panel_encoder_dpms(encoder, DRM_MODE_DPMS_OFF);
70 }
71 
72 static void panel_encoder_commit(struct drm_encoder *encoder)
73 {
74 	panel_encoder_dpms(encoder, DRM_MODE_DPMS_ON);
75 }
76 
77 static void panel_encoder_mode_set(struct drm_encoder *encoder,
78 		struct drm_display_mode *mode,
79 		struct drm_display_mode *adjusted_mode)
80 {
81 	/* nothing needed */
82 }
83 
84 static const struct drm_encoder_funcs panel_encoder_funcs = {
85 		.destroy        = drm_encoder_cleanup,
86 };
87 
88 static const struct drm_encoder_helper_funcs panel_encoder_helper_funcs = {
89 		.dpms           = panel_encoder_dpms,
90 		.prepare        = panel_encoder_prepare,
91 		.commit         = panel_encoder_commit,
92 		.mode_set       = panel_encoder_mode_set,
93 };
94 
95 static struct drm_encoder *panel_encoder_create(struct drm_device *dev,
96 		struct panel_module *mod)
97 {
98 	struct panel_encoder *panel_encoder;
99 	struct drm_encoder *encoder;
100 	int ret;
101 
102 	panel_encoder = devm_kzalloc(dev->dev, sizeof(*panel_encoder),
103 				     GFP_KERNEL);
104 	if (!panel_encoder) {
105 		dev_err(dev->dev, "allocation failed\n");
106 		return NULL;
107 	}
108 
109 	panel_encoder->mod = mod;
110 
111 	encoder = &panel_encoder->base;
112 	encoder->possible_crtcs = 1;
113 
114 	ret = drm_encoder_init(dev, encoder, &panel_encoder_funcs,
115 			DRM_MODE_ENCODER_LVDS, NULL);
116 	if (ret < 0)
117 		goto fail;
118 
119 	drm_encoder_helper_add(encoder, &panel_encoder_helper_funcs);
120 
121 	return encoder;
122 
123 fail:
124 	drm_encoder_cleanup(encoder);
125 	return NULL;
126 }
127 
128 /*
129  * Connector:
130  */
131 
132 struct panel_connector {
133 	struct drm_connector base;
134 
135 	struct drm_encoder *encoder;  /* our connected encoder */
136 	struct panel_module *mod;
137 };
138 #define to_panel_connector(x) container_of(x, struct panel_connector, base)
139 
140 
141 static void panel_connector_destroy(struct drm_connector *connector)
142 {
143 	drm_connector_unregister(connector);
144 	drm_connector_cleanup(connector);
145 }
146 
147 static enum drm_connector_status panel_connector_detect(
148 		struct drm_connector *connector,
149 		bool force)
150 {
151 	return connector_status_connected;
152 }
153 
154 static int panel_connector_get_modes(struct drm_connector *connector)
155 {
156 	struct drm_device *dev = connector->dev;
157 	struct panel_connector *panel_connector = to_panel_connector(connector);
158 	struct display_timings *timings = panel_connector->mod->timings;
159 	int i;
160 
161 	for (i = 0; i < timings->num_timings; i++) {
162 		struct drm_display_mode *mode = drm_mode_create(dev);
163 		struct videomode vm;
164 
165 		if (videomode_from_timings(timings, &vm, i))
166 			break;
167 
168 		drm_display_mode_from_videomode(&vm, mode);
169 
170 		mode->type = DRM_MODE_TYPE_DRIVER;
171 
172 		if (timings->native_mode == i)
173 			mode->type |= DRM_MODE_TYPE_PREFERRED;
174 
175 		drm_mode_set_name(mode);
176 		drm_mode_probed_add(connector, mode);
177 	}
178 
179 	return i;
180 }
181 
182 static int panel_connector_mode_valid(struct drm_connector *connector,
183 		  struct drm_display_mode *mode)
184 {
185 	struct tilcdc_drm_private *priv = connector->dev->dev_private;
186 	/* our only constraints are what the crtc can generate: */
187 	return tilcdc_crtc_mode_valid(priv->crtc, mode);
188 }
189 
190 static struct drm_encoder *panel_connector_best_encoder(
191 		struct drm_connector *connector)
192 {
193 	struct panel_connector *panel_connector = to_panel_connector(connector);
194 	return panel_connector->encoder;
195 }
196 
197 static const struct drm_connector_funcs panel_connector_funcs = {
198 	.destroy            = panel_connector_destroy,
199 	.dpms               = drm_atomic_helper_connector_dpms,
200 	.detect             = panel_connector_detect,
201 	.fill_modes         = drm_helper_probe_single_connector_modes,
202 	.reset              = drm_atomic_helper_connector_reset,
203 	.atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
204 	.atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
205 };
206 
207 static const struct drm_connector_helper_funcs panel_connector_helper_funcs = {
208 	.get_modes          = panel_connector_get_modes,
209 	.mode_valid         = panel_connector_mode_valid,
210 	.best_encoder       = panel_connector_best_encoder,
211 };
212 
213 static struct drm_connector *panel_connector_create(struct drm_device *dev,
214 		struct panel_module *mod, struct drm_encoder *encoder)
215 {
216 	struct panel_connector *panel_connector;
217 	struct drm_connector *connector;
218 	int ret;
219 
220 	panel_connector = devm_kzalloc(dev->dev, sizeof(*panel_connector),
221 				       GFP_KERNEL);
222 	if (!panel_connector) {
223 		dev_err(dev->dev, "allocation failed\n");
224 		return NULL;
225 	}
226 
227 	panel_connector->encoder = encoder;
228 	panel_connector->mod = mod;
229 
230 	connector = &panel_connector->base;
231 
232 	drm_connector_init(dev, connector, &panel_connector_funcs,
233 			DRM_MODE_CONNECTOR_LVDS);
234 	drm_connector_helper_add(connector, &panel_connector_helper_funcs);
235 
236 	connector->interlace_allowed = 0;
237 	connector->doublescan_allowed = 0;
238 
239 	ret = drm_mode_connector_attach_encoder(connector, encoder);
240 	if (ret)
241 		goto fail;
242 
243 	drm_connector_register(connector);
244 
245 	return connector;
246 
247 fail:
248 	panel_connector_destroy(connector);
249 	return NULL;
250 }
251 
252 /*
253  * Module:
254  */
255 
256 static int panel_modeset_init(struct tilcdc_module *mod, struct drm_device *dev)
257 {
258 	struct panel_module *panel_mod = to_panel_module(mod);
259 	struct tilcdc_drm_private *priv = dev->dev_private;
260 	struct drm_encoder *encoder;
261 	struct drm_connector *connector;
262 
263 	encoder = panel_encoder_create(dev, panel_mod);
264 	if (!encoder)
265 		return -ENOMEM;
266 
267 	connector = panel_connector_create(dev, panel_mod, encoder);
268 	if (!connector)
269 		return -ENOMEM;
270 
271 	priv->encoders[priv->num_encoders++] = encoder;
272 	priv->connectors[priv->num_connectors++] = connector;
273 
274 	tilcdc_crtc_set_panel_info(priv->crtc,
275 				   to_panel_encoder(encoder)->mod->info);
276 
277 	return 0;
278 }
279 
280 static const struct tilcdc_module_ops panel_module_ops = {
281 		.modeset_init = panel_modeset_init,
282 };
283 
284 /*
285  * Device:
286  */
287 
288 /* maybe move this somewhere common if it is needed by other outputs? */
289 static struct tilcdc_panel_info *of_get_panel_info(struct device_node *np)
290 {
291 	struct device_node *info_np;
292 	struct tilcdc_panel_info *info;
293 	int ret = 0;
294 
295 	if (!np) {
296 		pr_err("%s: no devicenode given\n", __func__);
297 		return NULL;
298 	}
299 
300 	info_np = of_get_child_by_name(np, "panel-info");
301 	if (!info_np) {
302 		pr_err("%s: could not find panel-info node\n", __func__);
303 		return NULL;
304 	}
305 
306 	info = kzalloc(sizeof(*info), GFP_KERNEL);
307 	if (!info) {
308 		pr_err("%s: allocation failed\n", __func__);
309 		of_node_put(info_np);
310 		return NULL;
311 	}
312 
313 	ret |= of_property_read_u32(info_np, "ac-bias", &info->ac_bias);
314 	ret |= of_property_read_u32(info_np, "ac-bias-intrpt", &info->ac_bias_intrpt);
315 	ret |= of_property_read_u32(info_np, "dma-burst-sz", &info->dma_burst_sz);
316 	ret |= of_property_read_u32(info_np, "bpp", &info->bpp);
317 	ret |= of_property_read_u32(info_np, "fdd", &info->fdd);
318 	ret |= of_property_read_u32(info_np, "sync-edge", &info->sync_edge);
319 	ret |= of_property_read_u32(info_np, "sync-ctrl", &info->sync_ctrl);
320 	ret |= of_property_read_u32(info_np, "raster-order", &info->raster_order);
321 	ret |= of_property_read_u32(info_np, "fifo-th", &info->fifo_th);
322 
323 	/* optional: */
324 	info->tft_alt_mode      = of_property_read_bool(info_np, "tft-alt-mode");
325 	info->invert_pxl_clk    = of_property_read_bool(info_np, "invert-pxl-clk");
326 
327 	if (ret) {
328 		pr_err("%s: error reading panel-info properties\n", __func__);
329 		kfree(info);
330 		of_node_put(info_np);
331 		return NULL;
332 	}
333 	of_node_put(info_np);
334 
335 	return info;
336 }
337 
338 static int panel_probe(struct platform_device *pdev)
339 {
340 	struct device_node *bl_node, *node = pdev->dev.of_node;
341 	struct panel_module *panel_mod;
342 	struct tilcdc_module *mod;
343 	struct pinctrl *pinctrl;
344 	int ret;
345 
346 	/* bail out early if no DT data: */
347 	if (!node) {
348 		dev_err(&pdev->dev, "device-tree data is missing\n");
349 		return -ENXIO;
350 	}
351 
352 	panel_mod = devm_kzalloc(&pdev->dev, sizeof(*panel_mod), GFP_KERNEL);
353 	if (!panel_mod)
354 		return -ENOMEM;
355 
356 	bl_node = of_parse_phandle(node, "backlight", 0);
357 	if (bl_node) {
358 		panel_mod->backlight = of_find_backlight_by_node(bl_node);
359 		of_node_put(bl_node);
360 
361 		if (!panel_mod->backlight)
362 			return -EPROBE_DEFER;
363 
364 		dev_info(&pdev->dev, "found backlight\n");
365 	}
366 
367 	panel_mod->enable_gpio = devm_gpiod_get_optional(&pdev->dev, "enable",
368 							 GPIOD_OUT_LOW);
369 	if (IS_ERR(panel_mod->enable_gpio)) {
370 		ret = PTR_ERR(panel_mod->enable_gpio);
371 		dev_err(&pdev->dev, "failed to request enable GPIO\n");
372 		goto fail_backlight;
373 	}
374 
375 	if (panel_mod->enable_gpio)
376 		dev_info(&pdev->dev, "found enable GPIO\n");
377 
378 	mod = &panel_mod->base;
379 	pdev->dev.platform_data = mod;
380 
381 	tilcdc_module_init(mod, "panel", &panel_module_ops);
382 
383 	pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
384 	if (IS_ERR(pinctrl))
385 		dev_warn(&pdev->dev, "pins are not configured\n");
386 
387 	panel_mod->timings = of_get_display_timings(node);
388 	if (!panel_mod->timings) {
389 		dev_err(&pdev->dev, "could not get panel timings\n");
390 		ret = -EINVAL;
391 		goto fail_free;
392 	}
393 
394 	panel_mod->info = of_get_panel_info(node);
395 	if (!panel_mod->info) {
396 		dev_err(&pdev->dev, "could not get panel info\n");
397 		ret = -EINVAL;
398 		goto fail_timings;
399 	}
400 
401 	return 0;
402 
403 fail_timings:
404 	display_timings_release(panel_mod->timings);
405 
406 fail_free:
407 	tilcdc_module_cleanup(mod);
408 
409 fail_backlight:
410 	if (panel_mod->backlight)
411 		put_device(&panel_mod->backlight->dev);
412 	return ret;
413 }
414 
415 static int panel_remove(struct platform_device *pdev)
416 {
417 	struct tilcdc_module *mod = dev_get_platdata(&pdev->dev);
418 	struct panel_module *panel_mod = to_panel_module(mod);
419 	struct backlight_device *backlight = panel_mod->backlight;
420 
421 	if (backlight)
422 		put_device(&backlight->dev);
423 
424 	display_timings_release(panel_mod->timings);
425 
426 	tilcdc_module_cleanup(mod);
427 	kfree(panel_mod->info);
428 
429 	return 0;
430 }
431 
432 static struct of_device_id panel_of_match[] = {
433 		{ .compatible = "ti,tilcdc,panel", },
434 		{ },
435 };
436 
437 struct platform_driver panel_driver = {
438 	.probe = panel_probe,
439 	.remove = panel_remove,
440 	.driver = {
441 		.owner = THIS_MODULE,
442 		.name = "panel",
443 		.of_match_table = panel_of_match,
444 	},
445 };
446 
447 int __init tilcdc_panel_init(void)
448 {
449 	return platform_driver_register(&panel_driver);
450 }
451 
452 void __exit tilcdc_panel_fini(void)
453 {
454 	platform_driver_unregister(&panel_driver);
455 }
456