[mirror_ubuntu-focal-kernel.git] / drivers / video / backlight / l4f00242t03.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * l4f00242t03.c -- support for Epson L4F00242T03 LCD
 *
 * Copyright 2007-2009 Freescale Semiconductor, Inc. All Rights Reserved.
 *
 * Copyright (c) 2009 Alberto Panizzo <maramaopercheseimorto@gmail.com>
 *	Inspired by Marek Vasut work in l4f00242t03.c
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/module.h>
#include <linux/gpio.h>
#include <linux/lcd.h>
#include <linux/slab.h>
#include <linux/regulator/consumer.h>

#include <linux/spi/spi.h>
#include <linux/spi/l4f00242t03.h>

struct l4f00242t03_priv {
	struct spi_device	*spi;
	struct lcd_device	*ld;
	int lcd_state;
	struct regulator *io_reg;
	struct regulator *core_reg;
};

static void l4f00242t03_reset(unsigned int gpio)
{
	pr_debug("l4f00242t03_reset.\n");
	gpio_set_value(gpio, 1);
	mdelay(100);
	gpio_set_value(gpio, 0);
	mdelay(10);	/* tRES >= 100us */
	gpio_set_value(gpio, 1);
	mdelay(20);
}

#define param(x) ((x) | 0x100)

static void l4f00242t03_lcd_init(struct spi_device *spi)
{
	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);
	const u16 cmd[] = { 0x36, param(0), 0x3A, param(0x60) };
	int ret;

	dev_dbg(&spi->dev, "initializing LCD\n");

	ret = regulator_set_voltage(priv->io_reg, 1800000, 1800000);
	if (ret) {
		dev_err(&spi->dev, "failed to set the IO regulator voltage.\n");
		return;
	}
	ret = regulator_enable(priv->io_reg);
	if (ret) {
		dev_err(&spi->dev, "failed to enable the IO regulator.\n");
		return;
	}

	ret = regulator_set_voltage(priv->core_reg, 2800000, 2800000);
	if (ret) {
		dev_err(&spi->dev, "failed to set the core regulator voltage.\n");
		regulator_disable(priv->io_reg);
		return;
	}
	ret = regulator_enable(priv->core_reg);
	if (ret) {
		dev_err(&spi->dev, "failed to enable the core regulator.\n");
		regulator_disable(priv->io_reg);
		return;
	}

	l4f00242t03_reset(pdata->reset_gpio);

	gpio_set_value(pdata->data_enable_gpio, 1);
	msleep(60);
	spi_write(spi, (const u8 *)cmd, ARRAY_SIZE(cmd) * sizeof(u16));
}

static void l4f00242t03_lcd_powerdown(struct spi_device *spi)
{
	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);

	dev_dbg(&spi->dev, "Powering down LCD\n");

	gpio_set_value(pdata->data_enable_gpio, 0);

	regulator_disable(priv->io_reg);
	regulator_disable(priv->core_reg);
}

static int l4f00242t03_lcd_power_get(struct lcd_device *ld)
{
	struct l4f00242t03_priv *priv = lcd_get_data(ld);

	return priv->lcd_state;
}

static int l4f00242t03_lcd_power_set(struct lcd_device *ld, int power)
{
	struct l4f00242t03_priv *priv = lcd_get_data(ld);
	struct spi_device *spi = priv->spi;

	const u16 slpout = 0x11;
	const u16 dison = 0x29;

	const u16 slpin = 0x10;
	const u16 disoff = 0x28;

	if (power <= FB_BLANK_NORMAL) {
		if (priv->lcd_state <= FB_BLANK_NORMAL) {
			/* Do nothing, the LCD is running */
		} else if (priv->lcd_state < FB_BLANK_POWERDOWN) {
			dev_dbg(&spi->dev, "Resuming LCD\n");

			spi_write(spi, (const u8 *)&slpout, sizeof(u16));
			msleep(60);
			spi_write(spi, (const u8 *)&dison, sizeof(u16));
		} else {
			/* priv->lcd_state == FB_BLANK_POWERDOWN */
			l4f00242t03_lcd_init(spi);
			priv->lcd_state = FB_BLANK_VSYNC_SUSPEND;
			l4f00242t03_lcd_power_set(priv->ld, power);
		}
	} else if (power < FB_BLANK_POWERDOWN) {
		if (priv->lcd_state <= FB_BLANK_NORMAL) {
			/* Send the display in standby */
			dev_dbg(&spi->dev, "Standby the LCD\n");

			spi_write(spi, (const u8 *)&disoff, sizeof(u16));
			msleep(60);
			spi_write(spi, (const u8 *)&slpin, sizeof(u16));
		} else if (priv->lcd_state < FB_BLANK_POWERDOWN) {
			/* Do nothing, the LCD is already in standby */
		} else {
			/* priv->lcd_state == FB_BLANK_POWERDOWN */
			l4f00242t03_lcd_init(spi);
			priv->lcd_state = FB_BLANK_UNBLANK;
			l4f00242t03_lcd_power_set(ld, power);
		}
	} else {
		/* power == FB_BLANK_POWERDOWN */
		if (priv->lcd_state != FB_BLANK_POWERDOWN) {
			/* Clear the screen before shutting down */
			spi_write(spi, (const u8 *)&disoff, sizeof(u16));
			msleep(60);
			l4f00242t03_lcd_powerdown(spi);
		}
	}

	priv->lcd_state = power;

	return 0;
}

static struct lcd_ops l4f_ops = {
	.set_power	= l4f00242t03_lcd_power_set,
	.get_power	= l4f00242t03_lcd_power_get,
};

static int l4f00242t03_probe(struct spi_device *spi)
{
	struct l4f00242t03_priv *priv;
	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
	int ret;

	if (pdata == NULL) {
		dev_err(&spi->dev, "Uninitialized platform data.\n");
		return -EINVAL;
	}

	priv = devm_kzalloc(&spi->dev, sizeof(struct l4f00242t03_priv),
				GFP_KERNEL);
	if (priv == NULL)
		return -ENOMEM;

	spi_set_drvdata(spi, priv);
	spi->bits_per_word = 9;
	spi_setup(spi);

	priv->spi = spi;

	ret = devm_gpio_request_one(&spi->dev, pdata->reset_gpio,
			GPIOF_OUT_INIT_HIGH, "lcd l4f00242t03 reset");
	if (ret) {
		dev_err(&spi->dev,
			"Unable to get the lcd l4f00242t03 reset gpio.\n");
		return ret;
	}

	ret = devm_gpio_request_one(&spi->dev, pdata->data_enable_gpio,
			GPIOF_OUT_INIT_LOW, "lcd l4f00242t03 data enable");
	if (ret) {
		dev_err(&spi->dev,
			"Unable to get the lcd l4f00242t03 data en gpio.\n");
		return ret;
	}

	priv->io_reg = devm_regulator_get(&spi->dev, "vdd");
	if (IS_ERR(priv->io_reg)) {
		dev_err(&spi->dev, "%s: Unable to get the IO regulator\n",
		       __func__);
		return PTR_ERR(priv->io_reg);
	}

	priv->core_reg = devm_regulator_get(&spi->dev, "vcore");
	if (IS_ERR(priv->core_reg)) {
		dev_err(&spi->dev, "%s: Unable to get the core regulator\n",
		       __func__);
		return PTR_ERR(priv->core_reg);
	}

	priv->ld = devm_lcd_device_register(&spi->dev, "l4f00242t03", &spi->dev,
					priv, &l4f_ops);
	if (IS_ERR(priv->ld))
		return PTR_ERR(priv->ld);

	/* Init the LCD */
	l4f00242t03_lcd_init(spi);
	priv->lcd_state = FB_BLANK_VSYNC_SUSPEND;
	l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_UNBLANK);

	dev_info(&spi->dev, "Epson l4f00242t03 lcd probed.\n");

	return 0;
}

static int l4f00242t03_remove(struct spi_device *spi)
{
	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);

	l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_POWERDOWN);
	return 0;
}

static void l4f00242t03_shutdown(struct spi_device *spi)
{
	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);

	if (priv)
		l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_POWERDOWN);

}

static struct spi_driver l4f00242t03_driver = {
	.driver = {
		.name	= "l4f00242t03",
	},
	.probe		= l4f00242t03_probe,
	.remove		= l4f00242t03_remove,
	.shutdown	= l4f00242t03_shutdown,
};

module_spi_driver(l4f00242t03_driver);

MODULE_AUTHOR("Alberto Panizzo <maramaopercheseimorto@gmail.com>");
MODULE_DESCRIPTION("EPSON L4F00242T03 LCD");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
e7fb9c4a AP	2	/*
	3	* l4f00242t03.c -- support for Epson L4F00242T03 LCD
	4	*
	5	* Copyright 2007-2009 Freescale Semiconductor, Inc. All Rights Reserved.
	6	*
	7	* Copyright (c) 2009 Alberto Panizzo <maramaopercheseimorto@gmail.com>
e4f8ae70	8	* Inspired by Marek Vasut work in l4f00242t03.c
e7fb9c4a AP	9	*/
e7fb9c4a AP	10
6677110b JH	11	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
6677110b JH	12
e7fb9c4a AP	13	#include <linux/device.h>
	14	#include <linux/kernel.h>
	15	#include <linux/delay.h>
355b200b	16	#include <linux/module.h>
e7fb9c4a AP	17	#include <linux/gpio.h>
e7fb9c4a AP	18	#include <linux/lcd.h>
5a0e3ad6	19	#include <linux/slab.h>
e7fb9c4a AP	20	#include <linux/regulator/consumer.h>
	21
	22	#include <linux/spi/spi.h>
	23	#include <linux/spi/l4f00242t03.h>
	24
	25	struct l4f00242t03_priv {
	26	struct spi_device *spi;
	27	struct lcd_device *ld;
95558ad1	28	int lcd_state;
e7fb9c4a AP	29	struct regulator *io_reg;
	30	struct regulator *core_reg;
	31	};
	32
e7fb9c4a AP	33	static void l4f00242t03_reset(unsigned int gpio)
	34	{
	35	pr_debug("l4f00242t03_reset.\n");
	36	gpio_set_value(gpio, 1);
	37	mdelay(100);
	38	gpio_set_value(gpio, 0);
	39	mdelay(10); /* tRES >= 100us */
	40	gpio_set_value(gpio, 1);
	41	mdelay(20);
	42	}
	43
	44	#define param(x) ((x) \| 0x100)
	45
	46	static void l4f00242t03_lcd_init(struct spi_device *spi)
	47	{
c512794c	48	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
60066078	49	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);
e7fb9c4a	50	const u16 cmd[] = { 0x36, param(0), 0x3A, param(0x60) };
ef73e632	51	int ret;
e7fb9c4a AP	52
	53	dev_dbg(&spi->dev, "initializing LCD\n");
	54
ef73e632 JH	55	ret = regulator_set_voltage(priv->io_reg, 1800000, 1800000);
	56	if (ret) {
	57	dev_err(&spi->dev, "failed to set the IO regulator voltage.\n");
	58	return;
	59	}
	60	ret = regulator_enable(priv->io_reg);
	61	if (ret) {
	62	dev_err(&spi->dev, "failed to enable the IO regulator.\n");
	63	return;
	64	}
	65
	66	ret = regulator_set_voltage(priv->core_reg, 2800000, 2800000);
	67	if (ret) {
	68	dev_err(&spi->dev, "failed to set the core regulator voltage.\n");
	69	regulator_disable(priv->io_reg);
	70	return;
	71	}
	72	ret = regulator_enable(priv->core_reg);
	73	if (ret) {
	74	dev_err(&spi->dev, "failed to enable the core regulator.\n");
	75	regulator_disable(priv->io_reg);
	76	return;
	77	}
e7fb9c4a	78
aff5ce6c AP	79	l4f00242t03_reset(pdata->reset_gpio);
aff5ce6c AP	80
e7fb9c4a AP	81	gpio_set_value(pdata->data_enable_gpio, 1);
	82	msleep(60);
	83	spi_write(spi, (const u8 )cmd, ARRAY_SIZE(cmd) sizeof(u16));
	84	}
	85
95558ad1 AP	86	static void l4f00242t03_lcd_powerdown(struct spi_device *spi)
95558ad1 AP	87	{
c512794c	88	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
60066078	89	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);
95558ad1 AP	90
	91	dev_dbg(&spi->dev, "Powering down LCD\n");
	92
	93	gpio_set_value(pdata->data_enable_gpio, 0);
	94
0556dc34 MB	95	regulator_disable(priv->io_reg);
0556dc34 MB	96	regulator_disable(priv->core_reg);
95558ad1 AP	97	}
	98
	99	static int l4f00242t03_lcd_power_get(struct lcd_device *ld)
	100	{
	101	struct l4f00242t03_priv *priv = lcd_get_data(ld);
	102
	103	return priv->lcd_state;
	104	}
	105
e7fb9c4a AP	106	static int l4f00242t03_lcd_power_set(struct lcd_device *ld, int power)
	107	{
	108	struct l4f00242t03_priv *priv = lcd_get_data(ld);
	109	struct spi_device *spi = priv->spi;
	110
	111	const u16 slpout = 0x11;
	112	const u16 dison = 0x29;
	113
	114	const u16 slpin = 0x10;
	115	const u16 disoff = 0x28;
	116
4dbdf886	117	if (power <= FB_BLANK_NORMAL) {
95558ad1 AP	118	if (priv->lcd_state <= FB_BLANK_NORMAL) {
	119	/* Do nothing, the LCD is running */
	120	} else if (priv->lcd_state < FB_BLANK_POWERDOWN) {
	121	dev_dbg(&spi->dev, "Resuming LCD\n");
	122
	123	spi_write(spi, (const u8 *)&slpout, sizeof(u16));
	124	msleep(60);
	125	spi_write(spi, (const u8 *)&dison, sizeof(u16));
	126	} else {
	127	/* priv->lcd_state == FB_BLANK_POWERDOWN */
	128	l4f00242t03_lcd_init(spi);
	129	priv->lcd_state = FB_BLANK_VSYNC_SUSPEND;
	130	l4f00242t03_lcd_power_set(priv->ld, power);
	131	}
	132	} else if (power < FB_BLANK_POWERDOWN) {
	133	if (priv->lcd_state <= FB_BLANK_NORMAL) {
	134	/* Send the display in standby */
	135	dev_dbg(&spi->dev, "Standby the LCD\n");
	136
	137	spi_write(spi, (const u8 *)&disoff, sizeof(u16));
	138	msleep(60);
	139	spi_write(spi, (const u8 *)&slpin, sizeof(u16));
	140	} else if (priv->lcd_state < FB_BLANK_POWERDOWN) {
	141	/* Do nothing, the LCD is already in standby */
	142	} else {
	143	/* priv->lcd_state == FB_BLANK_POWERDOWN */
	144	l4f00242t03_lcd_init(spi);
	145	priv->lcd_state = FB_BLANK_UNBLANK;
	146	l4f00242t03_lcd_power_set(ld, power);
	147	}
e7fb9c4a	148	} else {
95558ad1	149	/* power == FB_BLANK_POWERDOWN */
26bbabc8 AP	150	if (priv->lcd_state != FB_BLANK_POWERDOWN) {
	151	/* Clear the screen before shutting down */
	152	spi_write(spi, (const u8 *)&disoff, sizeof(u16));
	153	msleep(60);
	154	l4f00242t03_lcd_powerdown(spi);
	155	}
e7fb9c4a AP	156	}
e7fb9c4a AP	157
95558ad1 AP	158	priv->lcd_state = power;
95558ad1 AP	159
e7fb9c4a AP	160	return 0;
	161	}
	162
	163	static struct lcd_ops l4f_ops = {
	164	.set_power = l4f00242t03_lcd_power_set,
95558ad1	165	.get_power = l4f00242t03_lcd_power_get,
e7fb9c4a AP	166	};
e7fb9c4a AP	167
1b9e450d	168	static int l4f00242t03_probe(struct spi_device *spi)
e7fb9c4a AP	169	{
e7fb9c4a AP	170	struct l4f00242t03_priv *priv;
c512794c	171	struct l4f00242t03_pdata *pdata = dev_get_platdata(&spi->dev);
e7fb9c4a AP	172	int ret;
	173
	174	if (pdata == NULL) {
	175	dev_err(&spi->dev, "Uninitialized platform data.\n");
	176	return -EINVAL;
	177	}
	178
ba4a887a JH	179	priv = devm_kzalloc(&spi->dev, sizeof(struct l4f00242t03_priv),
ba4a887a JH	180	GFP_KERNEL);
1bd04820	181	if (priv == NULL)
beb0a43f	182	return -ENOMEM;
e7fb9c4a	183
60066078	184	spi_set_drvdata(spi, priv);
e7fb9c4a AP	185	spi->bits_per_word = 9;
	186	spi_setup(spi);
	187
	188	priv->spi = spi;
	189
62a5c075 JH	190	ret = devm_gpio_request_one(&spi->dev, pdata->reset_gpio,
62a5c075 JH	191	GPIOF_OUT_INIT_HIGH, "lcd l4f00242t03 reset");
e7fb9c4a AP	192	if (ret) {
	193	dev_err(&spi->dev,
	194	"Unable to get the lcd l4f00242t03 reset gpio.\n");
ba4a887a	195	return ret;
e7fb9c4a AP	196	}
e7fb9c4a AP	197
62a5c075 JH	198	ret = devm_gpio_request_one(&spi->dev, pdata->data_enable_gpio,
62a5c075 JH	199	GPIOF_OUT_INIT_LOW, "lcd l4f00242t03 data enable");
e7fb9c4a AP	200	if (ret) {
	201	dev_err(&spi->dev,
	202	"Unable to get the lcd l4f00242t03 data en gpio.\n");
62a5c075	203	return ret;
e7fb9c4a AP	204	}
e7fb9c4a AP	205
610b71a6	206	priv->io_reg = devm_regulator_get(&spi->dev, "vdd");
0556dc34 MB	207	if (IS_ERR(priv->io_reg)) {
	208	dev_err(&spi->dev, "%s: Unable to get the IO regulator\n",
	209	__func__);
62a5c075	210	return PTR_ERR(priv->io_reg);
e7fb9c4a AP	211	}
e7fb9c4a AP	212
610b71a6	213	priv->core_reg = devm_regulator_get(&spi->dev, "vcore");
0556dc34 MB	214	if (IS_ERR(priv->core_reg)) {
	215	dev_err(&spi->dev, "%s: Unable to get the core regulator\n",
	216	__func__);
610b71a6	217	return PTR_ERR(priv->core_reg);
e7fb9c4a AP	218	}
e7fb9c4a AP	219
7dd78077 JH	220	priv->ld = devm_lcd_device_register(&spi->dev, "l4f00242t03", &spi->dev,
7dd78077 JH	221	priv, &l4f_ops);
610b71a6 AL	222	if (IS_ERR(priv->ld))
610b71a6 AL	223	return PTR_ERR(priv->ld);
e7fb9c4a AP	224
e7fb9c4a AP	225	/* Init the LCD */
e7fb9c4a	226	l4f00242t03_lcd_init(spi);
95558ad1 AP	227	priv->lcd_state = FB_BLANK_VSYNC_SUSPEND;
95558ad1 AP	228	l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_UNBLANK);
e7fb9c4a AP	229
	230	dev_info(&spi->dev, "Epson l4f00242t03 lcd probed.\n");
	231
	232	return 0;
e7fb9c4a AP	233	}
e7fb9c4a AP	234
7e4b9d0b	235	static int l4f00242t03_remove(struct spi_device *spi)
e7fb9c4a	236	{
60066078	237	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);
e7fb9c4a	238
95558ad1	239	l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_POWERDOWN);
e7fb9c4a AP	240	return 0;
	241	}
	242
95558ad1 AP	243	static void l4f00242t03_shutdown(struct spi_device *spi)
95558ad1 AP	244	{
60066078	245	struct l4f00242t03_priv *priv = spi_get_drvdata(spi);
95558ad1 AP	246
	247	if (priv)
	248	l4f00242t03_lcd_power_set(priv->ld, FB_BLANK_POWERDOWN);
	249
	250	}
	251
e7fb9c4a AP	252	static struct spi_driver l4f00242t03_driver = {
	253	.driver = {
	254	.name = "l4f00242t03",
e7fb9c4a AP	255	},
e7fb9c4a AP	256	.probe = l4f00242t03_probe,
d1723fa2	257	.remove = l4f00242t03_remove,
95558ad1	258	.shutdown = l4f00242t03_shutdown,
e7fb9c4a AP	259	};
e7fb9c4a AP	260
462dd838	261	module_spi_driver(l4f00242t03_driver);
e7fb9c4a AP	262
	263	MODULE_AUTHOR("Alberto Panizzo <maramaopercheseimorto@gmail.com>");
	264	MODULE_DESCRIPTION("EPSON L4F00242T03 LCD");
c3cf2e44	265	MODULE_LICENSE("GPL v2");