auxdisplay: Move ifwidth to struct hd44780_common
[linux-block.git] / drivers / auxdisplay / hd44780.c
CommitLineData
351f683b 1// SPDX-License-Identifier: GPL-2.0+
d47d8836
GU
2/*
3 * HD44780 Character LCD driver for Linux
4 *
5 * Copyright (C) 2000-2008, Willy Tarreau <w@1wt.eu>
6 * Copyright (C) 2016-2017 Glider bvba
d47d8836
GU
7 */
8
9#include <linux/delay.h>
10#include <linux/gpio/consumer.h>
11#include <linux/module.h>
ac316725 12#include <linux/mod_devicetable.h>
d47d8836
GU
13#include <linux/platform_device.h>
14#include <linux/property.h>
15#include <linux/slab.h>
16
75354284 17#include "charlcd.h"
718e05ed 18#include "hd44780_common.h"
d47d8836
GU
19
20enum hd44780_pin {
21 /* Order does matter due to writing to GPIO array subsets! */
22 PIN_DATA0, /* Optional */
23 PIN_DATA1, /* Optional */
24 PIN_DATA2, /* Optional */
25 PIN_DATA3, /* Optional */
26 PIN_DATA4,
27 PIN_DATA5,
28 PIN_DATA6,
29 PIN_DATA7,
30 PIN_CTRL_RS,
31 PIN_CTRL_RW, /* Optional */
32 PIN_CTRL_E,
33 PIN_CTRL_BL, /* Optional */
34 PIN_NUM
35};
36
37struct hd44780 {
38 struct gpio_desc *pins[PIN_NUM];
39};
40
66ce7d5c 41static void hd44780_backlight(struct charlcd *lcd, enum charlcd_onoff on)
d47d8836 42{
2545c1c9
LP
43 struct hd44780_common *hdc = lcd->drvdata;
44 struct hd44780 *hd = hdc->hd44780;
d47d8836
GU
45
46 if (hd->pins[PIN_CTRL_BL])
47 gpiod_set_value_cansleep(hd->pins[PIN_CTRL_BL], on);
48}
49
50static void hd44780_strobe_gpio(struct hd44780 *hd)
51{
52 /* Maintain the data during 20 us before the strobe */
53 udelay(20);
54
55 gpiod_set_value_cansleep(hd->pins[PIN_CTRL_E], 1);
56
57 /* Maintain the strobe during 40 us */
58 udelay(40);
59
60 gpiod_set_value_cansleep(hd->pins[PIN_CTRL_E], 0);
61}
62
63/* write to an LCD panel register in 8 bit GPIO mode */
64static void hd44780_write_gpio8(struct hd44780 *hd, u8 val, unsigned int rs)
65{
b9762beb
JK
66 DECLARE_BITMAP(values, 10); /* for DATA[0-7], RS, RW */
67 unsigned int n;
68
69 values[0] = val;
70 __assign_bit(8, values, rs);
71 n = hd->pins[PIN_CTRL_RW] ? 10 : 9;
d47d8836
GU
72
73 /* Present the data to the port */
77588c14 74 gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA0], NULL, values);
d47d8836
GU
75
76 hd44780_strobe_gpio(hd);
77}
78
79/* write to an LCD panel register in 4 bit GPIO mode */
80static void hd44780_write_gpio4(struct hd44780 *hd, u8 val, unsigned int rs)
81{
b9762beb
JK
82 DECLARE_BITMAP(values, 6); /* for DATA[4-7], RS, RW */
83 unsigned int n;
d47d8836
GU
84
85 /* High nibble + RS, RW */
b9762beb
JK
86 values[0] = val >> 4;
87 __assign_bit(4, values, rs);
88 n = hd->pins[PIN_CTRL_RW] ? 6 : 5;
d47d8836
GU
89
90 /* Present the data to the port */
77588c14 91 gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);
d47d8836
GU
92
93 hd44780_strobe_gpio(hd);
94
95 /* Low nibble */
b9762beb
JK
96 values[0] &= ~0x0fUL;
97 values[0] |= val & 0x0f;
d47d8836
GU
98
99 /* Present the data to the port */
77588c14 100 gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);
d47d8836
GU
101
102 hd44780_strobe_gpio(hd);
103}
104
105/* Send a command to the LCD panel in 8 bit GPIO mode */
106static void hd44780_write_cmd_gpio8(struct charlcd *lcd, int cmd)
107{
2545c1c9
LP
108 struct hd44780_common *hdc = lcd->drvdata;
109 struct hd44780 *hd = hdc->hd44780;
d47d8836
GU
110
111 hd44780_write_gpio8(hd, cmd, 0);
112
113 /* The shortest command takes at least 120 us */
114 udelay(120);
115}
116
117/* Send data to the LCD panel in 8 bit GPIO mode */
118static void hd44780_write_data_gpio8(struct charlcd *lcd, int data)
119{
2545c1c9
LP
120 struct hd44780_common *hdc = lcd->drvdata;
121 struct hd44780 *hd = hdc->hd44780;
d47d8836
GU
122
123 hd44780_write_gpio8(hd, data, 1);
124
125 /* The shortest data takes at least 45 us */
126 udelay(45);
127}
128
129static const struct charlcd_ops hd44780_ops_gpio8 = {
130 .write_cmd = hd44780_write_cmd_gpio8,
131 .write_data = hd44780_write_data_gpio8,
132 .backlight = hd44780_backlight,
133};
134
135/* Send a command to the LCD panel in 4 bit GPIO mode */
136static void hd44780_write_cmd_gpio4(struct charlcd *lcd, int cmd)
137{
2545c1c9
LP
138 struct hd44780_common *hdc = lcd->drvdata;
139 struct hd44780 *hd = hdc->hd44780;
d47d8836
GU
140
141 hd44780_write_gpio4(hd, cmd, 0);
142
143 /* The shortest command takes at least 120 us */
144 udelay(120);
145}
146
147/* Send 4-bits of a command to the LCD panel in raw 4 bit GPIO mode */
148static void hd44780_write_cmd_raw_gpio4(struct charlcd *lcd, int cmd)
149{
b9762beb 150 DECLARE_BITMAP(values, 6); /* for DATA[4-7], RS, RW */
2545c1c9
LP
151 struct hd44780_common *hdc = lcd->drvdata;
152 struct hd44780 *hd = hdc->hd44780;
b9762beb 153 unsigned int n;
d47d8836
GU
154
155 /* Command nibble + RS, RW */
b9762beb
JK
156 values[0] = cmd & 0x0f;
157 n = hd->pins[PIN_CTRL_RW] ? 6 : 5;
d47d8836
GU
158
159 /* Present the data to the port */
77588c14 160 gpiod_set_array_value_cansleep(n, &hd->pins[PIN_DATA4], NULL, values);
d47d8836
GU
161
162 hd44780_strobe_gpio(hd);
163}
164
165/* Send data to the LCD panel in 4 bit GPIO mode */
166static void hd44780_write_data_gpio4(struct charlcd *lcd, int data)
167{
2545c1c9
LP
168 struct hd44780_common *hdc = lcd->drvdata;
169 struct hd44780 *hd = hdc->hd44780;
d47d8836
GU
170
171 hd44780_write_gpio4(hd, data, 1);
172
173 /* The shortest data takes at least 45 us */
174 udelay(45);
175}
176
177static const struct charlcd_ops hd44780_ops_gpio4 = {
178 .write_cmd = hd44780_write_cmd_gpio4,
179 .write_cmd_raw4 = hd44780_write_cmd_raw_gpio4,
180 .write_data = hd44780_write_data_gpio4,
181 .backlight = hd44780_backlight,
182};
183
184static int hd44780_probe(struct platform_device *pdev)
185{
186 struct device *dev = &pdev->dev;
187 unsigned int i, base;
188 struct charlcd *lcd;
718e05ed 189 struct hd44780_common *hdc;
d47d8836 190 struct hd44780 *hd;
718e05ed 191 int ifwidth, ret = -ENOMEM;
d47d8836
GU
192
193 /* Required pins */
194 ifwidth = gpiod_count(dev, "data");
195 if (ifwidth < 0)
196 return ifwidth;
197
198 switch (ifwidth) {
199 case 4:
200 base = PIN_DATA4;
201 break;
202 case 8:
203 base = PIN_DATA0;
204 break;
205 default:
206 return -EINVAL;
207 }
208
718e05ed
LP
209 hdc = hd44780_common_alloc();
210 if (!hdc)
211 return -ENOMEM;
212
2545c1c9 213 lcd = charlcd_alloc();
d47d8836 214 if (!lcd)
718e05ed 215 goto fail1;
d47d8836 216
718e05ed
LP
217 hd = kzalloc(sizeof(struct hd44780), GFP_KERNEL);
218 if (!hd)
219 goto fail2;
d47d8836 220
718e05ed
LP
221 hdc->hd44780 = hd;
222 lcd->drvdata = hdc;
d47d8836
GU
223 for (i = 0; i < ifwidth; i++) {
224 hd->pins[base + i] = devm_gpiod_get_index(dev, "data", i,
225 GPIOD_OUT_LOW);
226 if (IS_ERR(hd->pins[base + i])) {
227 ret = PTR_ERR(hd->pins[base + i]);
718e05ed 228 goto fail3;
d47d8836
GU
229 }
230 }
231
232 hd->pins[PIN_CTRL_E] = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
233 if (IS_ERR(hd->pins[PIN_CTRL_E])) {
234 ret = PTR_ERR(hd->pins[PIN_CTRL_E]);
718e05ed 235 goto fail3;
d47d8836
GU
236 }
237
238 hd->pins[PIN_CTRL_RS] = devm_gpiod_get(dev, "rs", GPIOD_OUT_HIGH);
239 if (IS_ERR(hd->pins[PIN_CTRL_RS])) {
240 ret = PTR_ERR(hd->pins[PIN_CTRL_RS]);
718e05ed 241 goto fail3;
d47d8836
GU
242 }
243
244 /* Optional pins */
245 hd->pins[PIN_CTRL_RW] = devm_gpiod_get_optional(dev, "rw",
246 GPIOD_OUT_LOW);
247 if (IS_ERR(hd->pins[PIN_CTRL_RW])) {
248 ret = PTR_ERR(hd->pins[PIN_CTRL_RW]);
718e05ed 249 goto fail3;
d47d8836
GU
250 }
251
252 hd->pins[PIN_CTRL_BL] = devm_gpiod_get_optional(dev, "backlight",
253 GPIOD_OUT_LOW);
254 if (IS_ERR(hd->pins[PIN_CTRL_BL])) {
255 ret = PTR_ERR(hd->pins[PIN_CTRL_BL]);
718e05ed 256 goto fail3;
d47d8836
GU
257 }
258
259 /* Required properties */
c7c3f096
GU
260 ret = device_property_read_u32(dev, "display-height-chars",
261 &lcd->height);
d47d8836 262 if (ret)
718e05ed 263 goto fail3;
c7c3f096 264 ret = device_property_read_u32(dev, "display-width-chars", &lcd->width);
d47d8836 265 if (ret)
718e05ed 266 goto fail3;
d47d8836
GU
267
268 /*
269 * On displays with more than two rows, the internal buffer width is
270 * usually equal to the display width
271 */
272 if (lcd->height > 2)
2545c1c9 273 hdc->bwidth = lcd->width;
d47d8836
GU
274
275 /* Optional properties */
2545c1c9 276 device_property_read_u32(dev, "internal-buffer-width", &hdc->bwidth);
d47d8836 277
3fc04dd7 278 hdc->ifwidth = ifwidth;
d47d8836
GU
279 lcd->ops = ifwidth == 8 ? &hd44780_ops_gpio8 : &hd44780_ops_gpio4;
280
281 ret = charlcd_register(lcd);
282 if (ret)
718e05ed 283 goto fail3;
d47d8836
GU
284
285 platform_set_drvdata(pdev, lcd);
286 return 0;
287
718e05ed
LP
288fail3:
289 kfree(hd);
290fail2:
291 kfree(lcd);
292fail1:
293 kfree(hdc);
d47d8836
GU
294 return ret;
295}
296
297static int hd44780_remove(struct platform_device *pdev)
298{
299 struct charlcd *lcd = platform_get_drvdata(pdev);
300
718e05ed 301 kfree(lcd->drvdata);
d47d8836 302 charlcd_unregister(lcd);
41c8d0ad 303
718e05ed 304 kfree(lcd);
d47d8836
GU
305 return 0;
306}
307
308static const struct of_device_id hd44780_of_match[] = {
309 { .compatible = "hit,hd44780" },
310 { /* sentinel */ }
311};
312MODULE_DEVICE_TABLE(of, hd44780_of_match);
313
314static struct platform_driver hd44780_driver = {
315 .probe = hd44780_probe,
316 .remove = hd44780_remove,
317 .driver = {
318 .name = "hd44780",
319 .of_match_table = hd44780_of_match,
320 },
321};
322
323module_platform_driver(hd44780_driver);
324MODULE_DESCRIPTION("HD44780 Character LCD driver");
325MODULE_AUTHOR("Geert Uytterhoeven <geert@linux-m68k.org>");
326MODULE_LICENSE("GPL");