pl111_drv.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
  4 *
  5 * Parts of this file were based on sources as follows:
  6 *
  7 * Copyright (c) 2006-2008 Intel Corporation
  8 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
  9 * Copyright (C) 2011 Texas Instruments
 10 */
 11
 12/**
 13 * DOC: ARM PrimeCell PL110 and PL111 CLCD Driver
 14 *
 15 * The PL110/PL111 is a simple LCD controller that can support TFT
 16 * and STN displays. This driver exposes a standard KMS interface
 17 * for them.
 18 *
 19 * The driver currently doesn't expose the cursor.  The DRM API for
 20 * cursors requires support for 64x64 ARGB8888 cursor images, while
 21 * the hardware can only support 64x64 monochrome with masking
 22 * cursors.  While one could imagine trying to hack something together
 23 * to look at the ARGB8888 and program reasonable in monochrome, we
 24 * just don't expose the cursor at all instead, and leave cursor
 25 * support to the application software cursor layer.
 26 *
 27 * TODO:
 28 *
 29 * - Fix race between setting plane base address and getting IRQ for
 30 *   vsync firing the pageflip completion.
 31 *
 32 * - Read back hardware state at boot to skip reprogramming the
 33 *   hardware when doing a no-op modeset.
 34 *
 35 * - Use the CLKSEL bit to support switching between the two external
 36 *   clock parents.
 37 */
 38
 39#include <linux/amba/bus.h>
 40#include <linux/dma-buf.h>
 41#include <linux/module.h>
 42#include <linux/of.h>
 43#include <linux/of_graph.h>
 44#include <linux/of_reserved_mem.h>
 45#include <linux/shmem_fs.h>
 46#include <linux/slab.h>
 47
 48#include <drm/clients/drm_client_setup.h>
 49#include <drm/drm_atomic_helper.h>
 50#include <drm/drm_bridge.h>
 51#include <drm/drm_drv.h>
 52#include <drm/drm_fbdev_dma.h>
 53#include <drm/drm_fourcc.h>
 54#include <drm/drm_gem_dma_helper.h>
 55#include <drm/drm_gem_framebuffer_helper.h>
 56#include <drm/drm_of.h>
 57#include <drm/drm_panel.h>
 58#include <drm/drm_probe_helper.h>
 59#include <drm/drm_vblank.h>
 60
 61#include "pl111_drm.h"
 62#include "pl111_versatile.h"
 63#include "pl111_nomadik.h"
 64
 65#define DRIVER_DESC      "DRM module for PL111"
 66
 67static const struct drm_mode_config_funcs mode_config_funcs = {
 68	.fb_create = drm_gem_fb_create,
 69	.atomic_check = drm_atomic_helper_check,
 70	.atomic_commit = drm_atomic_helper_commit,
 71};
 72
 73static int pl111_modeset_init(struct drm_device *dev)
 74{
 75	struct drm_mode_config *mode_config;
 76	struct pl111_drm_dev_private *priv = dev->dev_private;
 77	struct device_node *np = dev->dev->of_node;
 78	struct device_node *remote;
 79	struct drm_panel *panel = NULL;
 80	struct drm_bridge *bridge = NULL;
 81	bool defer = false;
 82	int ret;
 83	int i;
 84
 85	ret = drmm_mode_config_init(dev);
 86	if (ret)
 87		return ret;
 88
 89	mode_config = &dev->mode_config;
 90	mode_config->funcs = &mode_config_funcs;
 91	mode_config->min_width = 1;
 92	mode_config->max_width = 1024;
 93	mode_config->min_height = 1;
 94	mode_config->max_height = 768;
 95
 96	i = 0;
 97	for_each_endpoint_of_node(np, remote) {
 98		struct drm_panel *tmp_panel;
 99		struct drm_bridge *tmp_bridge;
100
101		dev_dbg(dev->dev, "checking endpoint %d\n", i);
102
103		ret = drm_of_find_panel_or_bridge(dev->dev->of_node,
104						  0, i,
105						  &tmp_panel,
106						  &tmp_bridge);
107		if (ret) {
108			if (ret == -EPROBE_DEFER) {
109				/*
110				 * Something deferred, but that is often just
111				 * another way of saying -ENODEV, but let's
112				 * cast a vote for later deferral.
113				 */
114				defer = true;
115			} else if (ret != -ENODEV) {
116				/* Continue, maybe something else is working */
117				dev_err(dev->dev,
118					"endpoint %d returns %d\n", i, ret);
119			}
120		}
121
122		if (tmp_panel) {
123			dev_info(dev->dev,
124				 "found panel on endpoint %d\n", i);
125			panel = tmp_panel;
126		}
127		if (tmp_bridge) {
128			dev_info(dev->dev,
129				 "found bridge on endpoint %d\n", i);
130			bridge = tmp_bridge;
131		}
132
133		i++;
134	}
135
136	/*
137	 * If we can't find neither panel nor bridge on any of the
138	 * endpoints, and any of them retured -EPROBE_DEFER, then
139	 * let's defer this driver too.
140	 */
141	if ((!panel && !bridge) && defer)
142		return -EPROBE_DEFER;
143
144	if (panel) {
145		bridge = drm_panel_bridge_add_typed(panel,
146						    DRM_MODE_CONNECTOR_Unknown);
147		if (IS_ERR(bridge)) {
148			ret = PTR_ERR(bridge);
149			goto finish;
150		}
151	} else if (bridge) {
152		dev_info(dev->dev, "Using non-panel bridge\n");
153	} else {
154		dev_err(dev->dev, "No bridge, exiting\n");
155		return -ENODEV;
156	}
157
158	priv->bridge = bridge;
159	if (panel) {
160		priv->panel = panel;
161		priv->connector = drm_panel_bridge_connector(bridge);
162	}
163
164	ret = pl111_display_init(dev);
165	if (ret != 0) {
166		dev_err(dev->dev, "Failed to init display\n");
167		goto out_bridge;
168	}
169
170	ret = drm_simple_display_pipe_attach_bridge(&priv->pipe,
171						    bridge);
172	if (ret)
173		return ret;
174
175	if (!priv->variant->broken_vblank) {
176		ret = drm_vblank_init(dev, 1);
177		if (ret != 0) {
178			dev_err(dev->dev, "Failed to init vblank\n");
179			goto out_bridge;
180		}
181	}
182
183	drm_mode_config_reset(dev);
184
185	drm_kms_helper_poll_init(dev);
186
187	goto finish;
188
189out_bridge:
190	if (panel)
191		drm_panel_bridge_remove(bridge);
192finish:
193	return ret;
194}
195
196static struct drm_gem_object *
197pl111_gem_import_sg_table(struct drm_device *dev,
198			  struct dma_buf_attachment *attach,
199			  struct sg_table *sgt)
200{
201	struct pl111_drm_dev_private *priv = dev->dev_private;
202
203	/*
204	 * When using device-specific reserved memory we can't import
205	 * DMA buffers: those are passed by reference in any global
206	 * memory and we can only handle a specific range of memory.
207	 */
208	if (priv->use_device_memory)
209		return ERR_PTR(-EINVAL);
210
211	return drm_gem_dma_prime_import_sg_table(dev, attach, sgt);
212}
213
214DEFINE_DRM_GEM_DMA_FOPS(drm_fops);
215
216static const struct drm_driver pl111_drm_driver = {
217	.driver_features =
218		DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
219	.ioctls = NULL,
220	.fops = &drm_fops,
221	.name = "pl111",
222	.desc = DRIVER_DESC,
223	.major = 1,
224	.minor = 0,
225	.patchlevel = 0,
226	.dumb_create = drm_gem_dma_dumb_create,
227	.gem_prime_import_sg_table = pl111_gem_import_sg_table,
228	DRM_FBDEV_DMA_DRIVER_OPS,
229
230#if defined(CONFIG_DEBUG_FS)
231	.debugfs_init = pl111_debugfs_init,
232#endif
233};
234
235static int pl111_amba_probe(struct amba_device *amba_dev,
236			    const struct amba_id *id)
237{
238	struct device *dev = &amba_dev->dev;
239	struct pl111_drm_dev_private *priv;
240	const struct pl111_variant_data *variant = id->data;
241	struct drm_device *drm;
242	int ret;
243
244	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
245	if (!priv)
246		return -ENOMEM;
247
248	drm = drm_dev_alloc(&pl111_drm_driver, dev);
249	if (IS_ERR(drm))
250		return PTR_ERR(drm);
251	amba_set_drvdata(amba_dev, drm);
252	priv->drm = drm;
253	drm->dev_private = priv;
254	priv->variant = variant;
255
256	ret = of_reserved_mem_device_init(dev);
257	if (!ret) {
258		dev_info(dev, "using device-specific reserved memory\n");
259		priv->use_device_memory = true;
260	}
261
262	if (of_property_read_u32(dev->of_node, "max-memory-bandwidth",
263				 &priv->memory_bw)) {
264		dev_info(dev, "no max memory bandwidth specified, assume unlimited\n");
265		priv->memory_bw = 0;
266	}
267
268	/* The two main variants swap this register */
269	if (variant->is_pl110 || variant->is_lcdc) {
270		priv->ienb = CLCD_PL110_IENB;
271		priv->ctrl = CLCD_PL110_CNTL;
272	} else {
273		priv->ienb = CLCD_PL111_IENB;
274		priv->ctrl = CLCD_PL111_CNTL;
275	}
276
277	priv->regs = devm_ioremap_resource(dev, &amba_dev->res);
278	if (IS_ERR(priv->regs)) {
279		dev_err(dev, "%s failed mmio\n", __func__);
280		ret = PTR_ERR(priv->regs);
281		goto dev_put;
282	}
283
284	/* This may override some variant settings */
285	ret = pl111_versatile_init(dev, priv);
286	if (ret)
287		goto dev_put;
288
289	pl111_nomadik_init(dev);
290
291	/* turn off interrupts before requesting the irq */
292	writel(0, priv->regs + priv->ienb);
293
294	ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0,
295			       variant->name, priv);
296	if (ret != 0) {
297		dev_err(dev, "%s failed irq %d\n", __func__, ret);
298		goto dev_put;
299	}
300
301	ret = pl111_modeset_init(drm);
302	if (ret != 0)
303		goto dev_put;
304
305	ret = drm_dev_register(drm, 0);
306	if (ret < 0)
307		goto dev_put;
308
309	drm_client_setup_with_color_mode(drm, priv->variant->fb_depth);
310
311	return 0;
312
313dev_put:
314	drm_dev_put(drm);
315	of_reserved_mem_device_release(dev);
316
317	return ret;
318}
319
320static void pl111_amba_remove(struct amba_device *amba_dev)
321{
322	struct device *dev = &amba_dev->dev;
323	struct drm_device *drm = amba_get_drvdata(amba_dev);
324	struct pl111_drm_dev_private *priv = drm->dev_private;
325
326	drm_dev_unregister(drm);
327	drm_atomic_helper_shutdown(drm);
328	if (priv->panel)
329		drm_panel_bridge_remove(priv->bridge);
330	drm_dev_put(drm);
331	of_reserved_mem_device_release(dev);
332}
333
334static void pl111_amba_shutdown(struct amba_device *amba_dev)
335{
336	drm_atomic_helper_shutdown(amba_get_drvdata(amba_dev));
337}
338
339/*
340 * This early variant lacks the 565 and 444 pixel formats.
341 */
342static const u32 pl110_pixel_formats[] = {
343	DRM_FORMAT_ABGR8888,
344	DRM_FORMAT_XBGR8888,
345	DRM_FORMAT_ARGB8888,
346	DRM_FORMAT_XRGB8888,
347	DRM_FORMAT_ABGR1555,
348	DRM_FORMAT_XBGR1555,
349	DRM_FORMAT_ARGB1555,
350	DRM_FORMAT_XRGB1555,
351};
352
353static const struct pl111_variant_data pl110_variant = {
354	.name = "PL110",
355	.is_pl110 = true,
356	.formats = pl110_pixel_formats,
357	.nformats = ARRAY_SIZE(pl110_pixel_formats),
358	.fb_depth = 16,
359};
360
361/* RealView, Versatile Express etc use this modern variant */
362static const u32 pl111_pixel_formats[] = {
363	DRM_FORMAT_ABGR8888,
364	DRM_FORMAT_XBGR8888,
365	DRM_FORMAT_ARGB8888,
366	DRM_FORMAT_XRGB8888,
367	DRM_FORMAT_BGR565,
368	DRM_FORMAT_RGB565,
369	DRM_FORMAT_ABGR1555,
370	DRM_FORMAT_XBGR1555,
371	DRM_FORMAT_ARGB1555,
372	DRM_FORMAT_XRGB1555,
373	DRM_FORMAT_ABGR4444,
374	DRM_FORMAT_XBGR4444,
375	DRM_FORMAT_ARGB4444,
376	DRM_FORMAT_XRGB4444,
377};
378
379static const struct pl111_variant_data pl111_variant = {
380	.name = "PL111",
381	.formats = pl111_pixel_formats,
382	.nformats = ARRAY_SIZE(pl111_pixel_formats),
383	.fb_depth = 32,
384};
385
386static const u32 pl110_nomadik_pixel_formats[] = {
387	DRM_FORMAT_RGB888,
388	DRM_FORMAT_BGR888,
389	DRM_FORMAT_ABGR8888,
390	DRM_FORMAT_XBGR8888,
391	DRM_FORMAT_ARGB8888,
392	DRM_FORMAT_XRGB8888,
393	DRM_FORMAT_BGR565,
394	DRM_FORMAT_RGB565,
395	DRM_FORMAT_ABGR1555,
396	DRM_FORMAT_XBGR1555,
397	DRM_FORMAT_ARGB1555,
398	DRM_FORMAT_XRGB1555,
399	DRM_FORMAT_ABGR4444,
400	DRM_FORMAT_XBGR4444,
401	DRM_FORMAT_ARGB4444,
402	DRM_FORMAT_XRGB4444,
403};
404
405static const struct pl111_variant_data pl110_nomadik_variant = {
406	.name = "LCDC (PL110 Nomadik)",
407	.formats = pl110_nomadik_pixel_formats,
408	.nformats = ARRAY_SIZE(pl110_nomadik_pixel_formats),
409	.is_lcdc = true,
410	.st_bitmux_control = true,
411	.broken_vblank = true,
412	.fb_depth = 16,
413};
414
415static const struct amba_id pl111_id_table[] = {
416	{
417		.id = 0x00041110,
418		.mask = 0x000fffff,
419		.data = (void *)&pl110_variant,
420	},
421	{
422		.id = 0x00180110,
423		.mask = 0x00fffffe,
424		.data = (void *)&pl110_nomadik_variant,
425	},
426	{
427		.id = 0x00041111,
428		.mask = 0x000fffff,
429		.data = (void *)&pl111_variant,
430	},
431	{0, 0},
432};
433MODULE_DEVICE_TABLE(amba, pl111_id_table);
434
435static struct amba_driver pl111_amba_driver __maybe_unused = {
436	.drv = {
437		.name = "drm-clcd-pl111",
438	},
439	.probe = pl111_amba_probe,
440	.remove = pl111_amba_remove,
441	.shutdown = pl111_amba_shutdown,
442	.id_table = pl111_id_table,
443};
444
445#ifdef CONFIG_ARM_AMBA
446module_amba_driver(pl111_amba_driver);
447#endif
448
449MODULE_DESCRIPTION(DRIVER_DESC);
450MODULE_AUTHOR("ARM Ltd.");
451MODULE_LICENSE("GPL");