1// SPDX-License-Identifier: GPL-2.0+
  2/*
  3 * shmob_drm_drv.c  --  SH Mobile DRM driver
  4 *
  5 * Copyright (C) 2012 Renesas Electronics Corporation
  6 *
  7 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
  8 */
  9
 10#include <linux/clk.h>
 11#include <linux/io.h>
 12#include <linux/mm.h>
 13#include <linux/module.h>
 14#include <linux/platform_device.h>
 15#include <linux/pm.h>
 16#include <linux/slab.h>
 17
 18#include <drm/drm_crtc_helper.h>
 19#include <drm/drm_drv.h>
 20#include <drm/drm_gem_dma_helper.h>
 21#include <drm/drm_module.h>
 22#include <drm/drm_probe_helper.h>
 23#include <drm/drm_vblank.h>
 24
 25#include "shmob_drm_drv.h"
 26#include "shmob_drm_kms.h"
 27#include "shmob_drm_plane.h"
 28#include "shmob_drm_regs.h"
 29
 30/* -----------------------------------------------------------------------------
 31 * Hardware initialization
 32 */
 33
 34static int shmob_drm_init_interface(struct shmob_drm_device *sdev)
 35{
 36	static const u32 ldmt1r[] = {
 37		[SHMOB_DRM_IFACE_RGB8] = LDMT1R_MIFTYP_RGB8,
 38		[SHMOB_DRM_IFACE_RGB9] = LDMT1R_MIFTYP_RGB9,
 39		[SHMOB_DRM_IFACE_RGB12A] = LDMT1R_MIFTYP_RGB12A,
 40		[SHMOB_DRM_IFACE_RGB12B] = LDMT1R_MIFTYP_RGB12B,
 41		[SHMOB_DRM_IFACE_RGB16] = LDMT1R_MIFTYP_RGB16,
 42		[SHMOB_DRM_IFACE_RGB18] = LDMT1R_MIFTYP_RGB18,
 43		[SHMOB_DRM_IFACE_RGB24] = LDMT1R_MIFTYP_RGB24,
 44		[SHMOB_DRM_IFACE_YUV422] = LDMT1R_MIFTYP_YCBCR,
 45		[SHMOB_DRM_IFACE_SYS8A] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS8A,
 46		[SHMOB_DRM_IFACE_SYS8B] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS8B,
 47		[SHMOB_DRM_IFACE_SYS8C] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS8C,
 48		[SHMOB_DRM_IFACE_SYS8D] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS8D,
 49		[SHMOB_DRM_IFACE_SYS9] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS9,
 50		[SHMOB_DRM_IFACE_SYS12] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS12,
 51		[SHMOB_DRM_IFACE_SYS16A] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS16A,
 52		[SHMOB_DRM_IFACE_SYS16B] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS16B,
 53		[SHMOB_DRM_IFACE_SYS16C] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS16C,
 54		[SHMOB_DRM_IFACE_SYS18] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS18,
 55		[SHMOB_DRM_IFACE_SYS24] = LDMT1R_IFM | LDMT1R_MIFTYP_SYS24,
 56	};
 57
 58	if (sdev->pdata->iface.interface >= ARRAY_SIZE(ldmt1r)) {
 59		dev_err(sdev->dev, "invalid interface type %u\n",
 60			sdev->pdata->iface.interface);
 61		return -EINVAL;
 62	}
 63
 64	sdev->ldmt1r = ldmt1r[sdev->pdata->iface.interface];
 65	return 0;
 66}
 67
 68static int shmob_drm_setup_clocks(struct shmob_drm_device *sdev,
 69					    enum shmob_drm_clk_source clksrc)
 70{
 71	struct clk *clk;
 72	char *clkname;
 73
 74	switch (clksrc) {
 75	case SHMOB_DRM_CLK_BUS:
 76		clkname = "bus_clk";
 77		sdev->lddckr = LDDCKR_ICKSEL_BUS;
 78		break;
 79	case SHMOB_DRM_CLK_PERIPHERAL:
 80		clkname = "peripheral_clk";
 81		sdev->lddckr = LDDCKR_ICKSEL_MIPI;
 82		break;
 83	case SHMOB_DRM_CLK_EXTERNAL:
 84		clkname = NULL;
 85		sdev->lddckr = LDDCKR_ICKSEL_HDMI;
 86		break;
 87	default:
 88		return -EINVAL;
 89	}
 90
 91	clk = devm_clk_get(sdev->dev, clkname);
 92	if (IS_ERR(clk)) {
 93		dev_err(sdev->dev, "cannot get dot clock %s\n", clkname);
 94		return PTR_ERR(clk);
 95	}
 96
 97	sdev->clock = clk;
 98	return 0;
 99}
100
101/* -----------------------------------------------------------------------------
102 * DRM operations
103 */
104
105static irqreturn_t shmob_drm_irq(int irq, void *arg)
106{
107	struct drm_device *dev = arg;
108	struct shmob_drm_device *sdev = dev->dev_private;
109	unsigned long flags;
110	u32 status;
111
112	/* Acknowledge interrupts. Putting interrupt enable and interrupt flag
113	 * bits in the same register is really brain-dead design and requires
114	 * taking a spinlock.
115	 */
116	spin_lock_irqsave(&sdev->irq_lock, flags);
117	status = lcdc_read(sdev, LDINTR);
118	lcdc_write(sdev, LDINTR, status ^ LDINTR_STATUS_MASK);
119	spin_unlock_irqrestore(&sdev->irq_lock, flags);
120
121	if (status & LDINTR_VES) {
122		drm_handle_vblank(dev, 0);
123		shmob_drm_crtc_finish_page_flip(&sdev->crtc);
124	}
125
126	return IRQ_HANDLED;
127}
128
129DEFINE_DRM_GEM_DMA_FOPS(shmob_drm_fops);
130
131static const struct drm_driver shmob_drm_driver = {
132	.driver_features	= DRIVER_GEM | DRIVER_MODESET,
133	DRM_GEM_DMA_DRIVER_OPS,
134	.fops			= &shmob_drm_fops,
135	.name			= "shmob-drm",
136	.desc			= "Renesas SH Mobile DRM",
137	.date			= "20120424",
138	.major			= 1,
139	.minor			= 0,
140};
141
142/* -----------------------------------------------------------------------------
143 * Power management
144 */
145
146#ifdef CONFIG_PM_SLEEP
147static int shmob_drm_pm_suspend(struct device *dev)
148{
149	struct shmob_drm_device *sdev = dev_get_drvdata(dev);
150
151	drm_kms_helper_poll_disable(sdev->ddev);
152	shmob_drm_crtc_suspend(&sdev->crtc);
153
154	return 0;
155}
156
157static int shmob_drm_pm_resume(struct device *dev)
158{
159	struct shmob_drm_device *sdev = dev_get_drvdata(dev);
160
161	drm_modeset_lock_all(sdev->ddev);
162	shmob_drm_crtc_resume(&sdev->crtc);
163	drm_modeset_unlock_all(sdev->ddev);
164
165	drm_kms_helper_poll_enable(sdev->ddev);
166	return 0;
167}
168#endif
169
170static const struct dev_pm_ops shmob_drm_pm_ops = {
171	SET_SYSTEM_SLEEP_PM_OPS(shmob_drm_pm_suspend, shmob_drm_pm_resume)
172};
173
174/* -----------------------------------------------------------------------------
175 * Platform driver
176 */
177
178static int shmob_drm_remove(struct platform_device *pdev)
179{
180	struct shmob_drm_device *sdev = platform_get_drvdata(pdev);
181	struct drm_device *ddev = sdev->ddev;
182
183	drm_dev_unregister(ddev);
184	drm_kms_helper_poll_fini(ddev);
185	free_irq(sdev->irq, ddev);
186	drm_dev_put(ddev);
187
188	return 0;
189}
190
191static int shmob_drm_probe(struct platform_device *pdev)
192{
193	struct shmob_drm_platform_data *pdata = pdev->dev.platform_data;
194	struct shmob_drm_device *sdev;
195	struct drm_device *ddev;
196	unsigned int i;
197	int ret;
198
199	if (pdata == NULL) {
200		dev_err(&pdev->dev, "no platform data\n");
201		return -EINVAL;
202	}
203
204	/*
205	 * Allocate and initialize the driver private data, I/O resources and
206	 * clocks.
207	 */
208	sdev = devm_kzalloc(&pdev->dev, sizeof(*sdev), GFP_KERNEL);
209	if (sdev == NULL)
210		return -ENOMEM;
211
212	sdev->dev = &pdev->dev;
213	sdev->pdata = pdata;
214	spin_lock_init(&sdev->irq_lock);
215
216	platform_set_drvdata(pdev, sdev);
217
218	sdev->mmio = devm_platform_ioremap_resource(pdev, 0);
219	if (IS_ERR(sdev->mmio))
220		return PTR_ERR(sdev->mmio);
221
222	ret = shmob_drm_setup_clocks(sdev, pdata->clk_source);
223	if (ret < 0)
224		return ret;
225
226	ret = shmob_drm_init_interface(sdev);
227	if (ret < 0)
228		return ret;
229
230	/* Allocate and initialize the DRM device. */
231	ddev = drm_dev_alloc(&shmob_drm_driver, &pdev->dev);
232	if (IS_ERR(ddev))
233		return PTR_ERR(ddev);
234
235	sdev->ddev = ddev;
236	ddev->dev_private = sdev;
237
238	ret = shmob_drm_modeset_init(sdev);
239	if (ret < 0) {
240		dev_err(&pdev->dev, "failed to initialize mode setting\n");
241		goto err_free_drm_dev;
242	}
243
244	for (i = 0; i < 4; ++i) {
245		ret = shmob_drm_plane_create(sdev, i);
246		if (ret < 0) {
247			dev_err(&pdev->dev, "failed to create plane %u\n", i);
248			goto err_modeset_cleanup;
249		}
250	}
251
252	ret = drm_vblank_init(ddev, 1);
253	if (ret < 0) {
254		dev_err(&pdev->dev, "failed to initialize vblank\n");
255		goto err_modeset_cleanup;
256	}
257
258	ret = platform_get_irq(pdev, 0);
259	if (ret < 0)
260		goto err_modeset_cleanup;
261	sdev->irq = ret;
262
263	ret = request_irq(sdev->irq, shmob_drm_irq, 0, ddev->driver->name,
264			  ddev);
265	if (ret < 0) {
266		dev_err(&pdev->dev, "failed to install IRQ handler\n");
267		goto err_modeset_cleanup;
268	}
269
270	/*
271	 * Register the DRM device with the core and the connectors with
272	 * sysfs.
273	 */
274	ret = drm_dev_register(ddev, 0);
275	if (ret < 0)
276		goto err_irq_uninstall;
277
278	return 0;
279
280err_irq_uninstall:
281	free_irq(sdev->irq, ddev);
282err_modeset_cleanup:
283	drm_kms_helper_poll_fini(ddev);
284err_free_drm_dev:
285	drm_dev_put(ddev);
286
287	return ret;
288}
289
290static struct platform_driver shmob_drm_platform_driver = {
291	.probe		= shmob_drm_probe,
292	.remove		= shmob_drm_remove,
293	.driver		= {
294		.name	= "shmob-drm",
295		.pm	= &shmob_drm_pm_ops,
296	},
297};
298
299drm_module_platform_driver(shmob_drm_platform_driver);
300
301MODULE_AUTHOR("Laurent Pinchart <laurent.pinchart@ideasonboard.com>");
302MODULE_DESCRIPTION("Renesas SH Mobile DRM Driver");
303MODULE_LICENSE("GPL");