116216333SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2f7018c21STomi Valkeinen /*
3f7018c21STomi Valkeinen * Cobalt/SEAD3 LCD frame buffer driver.
4f7018c21STomi Valkeinen *
5f7018c21STomi Valkeinen * Copyright (C) 2008 Yoichi Yuasa <yuasa@linux-mips.org>
6f7018c21STomi Valkeinen * Copyright (C) 2012 MIPS Technologies, Inc.
7f7018c21STomi Valkeinen */
8f7018c21STomi Valkeinen #include <linux/delay.h>
9f7018c21STomi Valkeinen #include <linux/fb.h>
10f7018c21STomi Valkeinen #include <linux/init.h>
11f7018c21STomi Valkeinen #include <linux/io.h>
12f7018c21STomi Valkeinen #include <linux/ioport.h>
13f7018c21STomi Valkeinen #include <linux/uaccess.h>
14f7018c21STomi Valkeinen #include <linux/platform_device.h>
15f7018c21STomi Valkeinen #include <linux/module.h>
16174cd4b1SIngo Molnar #include <linux/sched/signal.h>
17f7018c21STomi Valkeinen
18f7018c21STomi Valkeinen /*
19f7018c21STomi Valkeinen * Cursor position address
20f7018c21STomi Valkeinen * \X 0 1 2 ... 14 15
21f7018c21STomi Valkeinen * Y+----+----+----+---+----+----+
22f7018c21STomi Valkeinen * 0|0x00|0x01|0x02|...|0x0e|0x0f|
23f7018c21STomi Valkeinen * +----+----+----+---+----+----+
24f7018c21STomi Valkeinen * 1|0x40|0x41|0x42|...|0x4e|0x4f|
25f7018c21STomi Valkeinen * +----+----+----+---+----+----+
26f7018c21STomi Valkeinen */
27f7018c21STomi Valkeinen #define LCD_DATA_REG_OFFSET 0x10
28f7018c21STomi Valkeinen #define LCD_XRES_MAX 16
29f7018c21STomi Valkeinen #define LCD_YRES_MAX 2
30f7018c21STomi Valkeinen #define LCD_CHARS_MAX 32
31f7018c21STomi Valkeinen
32f7018c21STomi Valkeinen #define LCD_CLEAR 0x01
33f7018c21STomi Valkeinen #define LCD_CURSOR_MOVE_HOME 0x02
34f7018c21STomi Valkeinen #define LCD_RESET 0x06
35f7018c21STomi Valkeinen #define LCD_OFF 0x08
36f7018c21STomi Valkeinen #define LCD_CURSOR_OFF 0x0c
37f7018c21STomi Valkeinen #define LCD_CURSOR_BLINK_OFF 0x0e
38f7018c21STomi Valkeinen #define LCD_CURSOR_ON 0x0f
39f7018c21STomi Valkeinen #define LCD_ON LCD_CURSOR_ON
40f7018c21STomi Valkeinen #define LCD_CURSOR_MOVE_LEFT 0x10
41f7018c21STomi Valkeinen #define LCD_CURSOR_MOVE_RIGHT 0x14
42f7018c21STomi Valkeinen #define LCD_DISPLAY_LEFT 0x18
43f7018c21STomi Valkeinen #define LCD_DISPLAY_RIGHT 0x1c
44f7018c21STomi Valkeinen #define LCD_PRERESET 0x3f /* execute 4 times continuously */
45f7018c21STomi Valkeinen #define LCD_BUSY 0x80
46f7018c21STomi Valkeinen
47f7018c21STomi Valkeinen #define LCD_GRAPHIC_MODE 0x40
48f7018c21STomi Valkeinen #define LCD_TEXT_MODE 0x80
49f7018c21STomi Valkeinen #define LCD_CUR_POS_MASK 0x7f
50f7018c21STomi Valkeinen
51f7018c21STomi Valkeinen #define LCD_CUR_POS(x) ((x) & LCD_CUR_POS_MASK)
52f7018c21STomi Valkeinen #define LCD_TEXT_POS(x) ((x) | LCD_TEXT_MODE)
53f7018c21STomi Valkeinen
lcd_write_control(struct fb_info * info,u8 control)54f7018c21STomi Valkeinen static inline void lcd_write_control(struct fb_info *info, u8 control)
55f7018c21STomi Valkeinen {
56f7018c21STomi Valkeinen writel((u32)control << 24, info->screen_base);
57f7018c21STomi Valkeinen }
58f7018c21STomi Valkeinen
lcd_read_control(struct fb_info * info)59f7018c21STomi Valkeinen static inline u8 lcd_read_control(struct fb_info *info)
60f7018c21STomi Valkeinen {
61f7018c21STomi Valkeinen return readl(info->screen_base) >> 24;
62f7018c21STomi Valkeinen }
63f7018c21STomi Valkeinen
lcd_write_data(struct fb_info * info,u8 data)64f7018c21STomi Valkeinen static inline void lcd_write_data(struct fb_info *info, u8 data)
65f7018c21STomi Valkeinen {
66f7018c21STomi Valkeinen writel((u32)data << 24, info->screen_base + LCD_DATA_REG_OFFSET);
67f7018c21STomi Valkeinen }
68f7018c21STomi Valkeinen
lcd_read_data(struct fb_info * info)69f7018c21STomi Valkeinen static inline u8 lcd_read_data(struct fb_info *info)
70f7018c21STomi Valkeinen {
71f7018c21STomi Valkeinen return readl(info->screen_base + LCD_DATA_REG_OFFSET) >> 24;
72f7018c21STomi Valkeinen }
73f7018c21STomi Valkeinen
lcd_busy_wait(struct fb_info * info)74f7018c21STomi Valkeinen static int lcd_busy_wait(struct fb_info *info)
75f7018c21STomi Valkeinen {
76f7018c21STomi Valkeinen u8 val = 0;
77f7018c21STomi Valkeinen int timeout = 10, retval = 0;
78f7018c21STomi Valkeinen
79f7018c21STomi Valkeinen do {
80f7018c21STomi Valkeinen val = lcd_read_control(info);
81f7018c21STomi Valkeinen val &= LCD_BUSY;
82f7018c21STomi Valkeinen if (val != LCD_BUSY)
83f7018c21STomi Valkeinen break;
84f7018c21STomi Valkeinen
85f7018c21STomi Valkeinen if (msleep_interruptible(1))
86f7018c21STomi Valkeinen return -EINTR;
87f7018c21STomi Valkeinen
88f7018c21STomi Valkeinen timeout--;
89f7018c21STomi Valkeinen } while (timeout);
90f7018c21STomi Valkeinen
91f7018c21STomi Valkeinen if (val == LCD_BUSY)
92f7018c21STomi Valkeinen retval = -EBUSY;
93f7018c21STomi Valkeinen
94f7018c21STomi Valkeinen return retval;
95f7018c21STomi Valkeinen }
96f7018c21STomi Valkeinen
lcd_clear(struct fb_info * info)97f7018c21STomi Valkeinen static void lcd_clear(struct fb_info *info)
98f7018c21STomi Valkeinen {
99f7018c21STomi Valkeinen int i;
100f7018c21STomi Valkeinen
101f7018c21STomi Valkeinen for (i = 0; i < 4; i++) {
102f7018c21STomi Valkeinen udelay(150);
103f7018c21STomi Valkeinen
104f7018c21STomi Valkeinen lcd_write_control(info, LCD_PRERESET);
105f7018c21STomi Valkeinen }
106f7018c21STomi Valkeinen
107f7018c21STomi Valkeinen udelay(150);
108f7018c21STomi Valkeinen
109f7018c21STomi Valkeinen lcd_write_control(info, LCD_CLEAR);
110f7018c21STomi Valkeinen
111f7018c21STomi Valkeinen udelay(150);
112f7018c21STomi Valkeinen
113f7018c21STomi Valkeinen lcd_write_control(info, LCD_RESET);
114f7018c21STomi Valkeinen }
115f7018c21STomi Valkeinen
116c9742729SGustavo A. R. Silva static const struct fb_fix_screeninfo cobalt_lcdfb_fix = {
117f7018c21STomi Valkeinen .id = "cobalt-lcd",
118f7018c21STomi Valkeinen .type = FB_TYPE_TEXT,
119f7018c21STomi Valkeinen .type_aux = FB_AUX_TEXT_MDA,
120f7018c21STomi Valkeinen .visual = FB_VISUAL_MONO01,
121f7018c21STomi Valkeinen .line_length = LCD_XRES_MAX,
122f7018c21STomi Valkeinen .accel = FB_ACCEL_NONE,
123f7018c21STomi Valkeinen };
124f7018c21STomi Valkeinen
cobalt_lcdfb_read(struct fb_info * info,char __user * buf,size_t count,loff_t * ppos)125f7018c21STomi Valkeinen static ssize_t cobalt_lcdfb_read(struct fb_info *info, char __user *buf,
126f7018c21STomi Valkeinen size_t count, loff_t *ppos)
127f7018c21STomi Valkeinen {
128f7018c21STomi Valkeinen char src[LCD_CHARS_MAX];
129f7018c21STomi Valkeinen unsigned long pos;
130f7018c21STomi Valkeinen int len, retval = 0;
131f7018c21STomi Valkeinen
132*3f8974f6SThomas Zimmermann if (!info->screen_base)
133*3f8974f6SThomas Zimmermann return -ENODEV;
134*3f8974f6SThomas Zimmermann
135f7018c21STomi Valkeinen pos = *ppos;
136f7018c21STomi Valkeinen if (pos >= LCD_CHARS_MAX || count == 0)
137f7018c21STomi Valkeinen return 0;
138f7018c21STomi Valkeinen
139f7018c21STomi Valkeinen if (count > LCD_CHARS_MAX)
140f7018c21STomi Valkeinen count = LCD_CHARS_MAX;
141f7018c21STomi Valkeinen
142f7018c21STomi Valkeinen if (pos + count > LCD_CHARS_MAX)
143f7018c21STomi Valkeinen count = LCD_CHARS_MAX - pos;
144f7018c21STomi Valkeinen
145f7018c21STomi Valkeinen for (len = 0; len < count; len++) {
146f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
147f7018c21STomi Valkeinen if (retval < 0)
148f7018c21STomi Valkeinen break;
149f7018c21STomi Valkeinen
150f7018c21STomi Valkeinen lcd_write_control(info, LCD_TEXT_POS(pos));
151f7018c21STomi Valkeinen
152f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
153f7018c21STomi Valkeinen if (retval < 0)
154f7018c21STomi Valkeinen break;
155f7018c21STomi Valkeinen
156f7018c21STomi Valkeinen src[len] = lcd_read_data(info);
157f7018c21STomi Valkeinen if (pos == 0x0f)
158f7018c21STomi Valkeinen pos = 0x40;
159f7018c21STomi Valkeinen else
160f7018c21STomi Valkeinen pos++;
161f7018c21STomi Valkeinen }
162f7018c21STomi Valkeinen
163f7018c21STomi Valkeinen if (retval < 0 && signal_pending(current))
164f7018c21STomi Valkeinen return -ERESTARTSYS;
165f7018c21STomi Valkeinen
166f7018c21STomi Valkeinen if (copy_to_user(buf, src, len))
167f7018c21STomi Valkeinen return -EFAULT;
168f7018c21STomi Valkeinen
169f7018c21STomi Valkeinen *ppos += len;
170f7018c21STomi Valkeinen
171f7018c21STomi Valkeinen return len;
172f7018c21STomi Valkeinen }
173f7018c21STomi Valkeinen
cobalt_lcdfb_write(struct fb_info * info,const char __user * buf,size_t count,loff_t * ppos)174f7018c21STomi Valkeinen static ssize_t cobalt_lcdfb_write(struct fb_info *info, const char __user *buf,
175f7018c21STomi Valkeinen size_t count, loff_t *ppos)
176f7018c21STomi Valkeinen {
177f7018c21STomi Valkeinen char dst[LCD_CHARS_MAX];
178f7018c21STomi Valkeinen unsigned long pos;
179f7018c21STomi Valkeinen int len, retval = 0;
180f7018c21STomi Valkeinen
181*3f8974f6SThomas Zimmermann if (!info->screen_base)
182*3f8974f6SThomas Zimmermann return -ENODEV;
183*3f8974f6SThomas Zimmermann
184f7018c21STomi Valkeinen pos = *ppos;
185f7018c21STomi Valkeinen if (pos >= LCD_CHARS_MAX || count == 0)
186f7018c21STomi Valkeinen return 0;
187f7018c21STomi Valkeinen
188f7018c21STomi Valkeinen if (count > LCD_CHARS_MAX)
189f7018c21STomi Valkeinen count = LCD_CHARS_MAX;
190f7018c21STomi Valkeinen
191f7018c21STomi Valkeinen if (pos + count > LCD_CHARS_MAX)
192f7018c21STomi Valkeinen count = LCD_CHARS_MAX - pos;
193f7018c21STomi Valkeinen
194f7018c21STomi Valkeinen if (copy_from_user(dst, buf, count))
195f7018c21STomi Valkeinen return -EFAULT;
196f7018c21STomi Valkeinen
197f7018c21STomi Valkeinen for (len = 0; len < count; len++) {
198f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
199f7018c21STomi Valkeinen if (retval < 0)
200f7018c21STomi Valkeinen break;
201f7018c21STomi Valkeinen
202f7018c21STomi Valkeinen lcd_write_control(info, LCD_TEXT_POS(pos));
203f7018c21STomi Valkeinen
204f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
205f7018c21STomi Valkeinen if (retval < 0)
206f7018c21STomi Valkeinen break;
207f7018c21STomi Valkeinen
208f7018c21STomi Valkeinen lcd_write_data(info, dst[len]);
209f7018c21STomi Valkeinen if (pos == 0x0f)
210f7018c21STomi Valkeinen pos = 0x40;
211f7018c21STomi Valkeinen else
212f7018c21STomi Valkeinen pos++;
213f7018c21STomi Valkeinen }
214f7018c21STomi Valkeinen
215f7018c21STomi Valkeinen if (retval < 0 && signal_pending(current))
216f7018c21STomi Valkeinen return -ERESTARTSYS;
217f7018c21STomi Valkeinen
218f7018c21STomi Valkeinen *ppos += len;
219f7018c21STomi Valkeinen
220f7018c21STomi Valkeinen return len;
221f7018c21STomi Valkeinen }
222f7018c21STomi Valkeinen
cobalt_lcdfb_blank(int blank_mode,struct fb_info * info)223f7018c21STomi Valkeinen static int cobalt_lcdfb_blank(int blank_mode, struct fb_info *info)
224f7018c21STomi Valkeinen {
225f7018c21STomi Valkeinen int retval;
226f7018c21STomi Valkeinen
227f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
228f7018c21STomi Valkeinen if (retval < 0)
229f7018c21STomi Valkeinen return retval;
230f7018c21STomi Valkeinen
231f7018c21STomi Valkeinen switch (blank_mode) {
232f7018c21STomi Valkeinen case FB_BLANK_UNBLANK:
233f7018c21STomi Valkeinen lcd_write_control(info, LCD_ON);
234f7018c21STomi Valkeinen break;
235f7018c21STomi Valkeinen default:
236f7018c21STomi Valkeinen lcd_write_control(info, LCD_OFF);
237f7018c21STomi Valkeinen break;
238f7018c21STomi Valkeinen }
239f7018c21STomi Valkeinen
240f7018c21STomi Valkeinen return 0;
241f7018c21STomi Valkeinen }
242f7018c21STomi Valkeinen
cobalt_lcdfb_cursor(struct fb_info * info,struct fb_cursor * cursor)243f7018c21STomi Valkeinen static int cobalt_lcdfb_cursor(struct fb_info *info, struct fb_cursor *cursor)
244f7018c21STomi Valkeinen {
245f7018c21STomi Valkeinen u32 x, y;
246f7018c21STomi Valkeinen int retval;
247f7018c21STomi Valkeinen
248f7018c21STomi Valkeinen switch (cursor->set) {
249f7018c21STomi Valkeinen case FB_CUR_SETPOS:
250f7018c21STomi Valkeinen x = cursor->image.dx;
251f7018c21STomi Valkeinen y = cursor->image.dy;
252f7018c21STomi Valkeinen if (x >= LCD_XRES_MAX || y >= LCD_YRES_MAX)
253f7018c21STomi Valkeinen return -EINVAL;
254f7018c21STomi Valkeinen
255f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
256f7018c21STomi Valkeinen if (retval < 0)
257f7018c21STomi Valkeinen return retval;
258f7018c21STomi Valkeinen
259f7018c21STomi Valkeinen lcd_write_control(info,
260f7018c21STomi Valkeinen LCD_TEXT_POS(info->fix.line_length * y + x));
261f7018c21STomi Valkeinen break;
262f7018c21STomi Valkeinen default:
263f7018c21STomi Valkeinen return -EINVAL;
264f7018c21STomi Valkeinen }
265f7018c21STomi Valkeinen
266f7018c21STomi Valkeinen retval = lcd_busy_wait(info);
267f7018c21STomi Valkeinen if (retval < 0)
268f7018c21STomi Valkeinen return retval;
269f7018c21STomi Valkeinen
270f7018c21STomi Valkeinen if (cursor->enable)
271f7018c21STomi Valkeinen lcd_write_control(info, LCD_CURSOR_ON);
272f7018c21STomi Valkeinen else
273f7018c21STomi Valkeinen lcd_write_control(info, LCD_CURSOR_OFF);
274f7018c21STomi Valkeinen
275f7018c21STomi Valkeinen return 0;
276f7018c21STomi Valkeinen }
277f7018c21STomi Valkeinen
2788a48ac33SJani Nikula static const struct fb_ops cobalt_lcd_fbops = {
279f7018c21STomi Valkeinen .owner = THIS_MODULE,
280f7018c21STomi Valkeinen .fb_read = cobalt_lcdfb_read,
281f7018c21STomi Valkeinen .fb_write = cobalt_lcdfb_write,
282f7018c21STomi Valkeinen .fb_blank = cobalt_lcdfb_blank,
283f7018c21STomi Valkeinen .fb_cursor = cobalt_lcdfb_cursor,
284f7018c21STomi Valkeinen };
285f7018c21STomi Valkeinen
cobalt_lcdfb_probe(struct platform_device * dev)286f7018c21STomi Valkeinen static int cobalt_lcdfb_probe(struct platform_device *dev)
287f7018c21STomi Valkeinen {
288f7018c21STomi Valkeinen struct fb_info *info;
289f7018c21STomi Valkeinen struct resource *res;
290f7018c21STomi Valkeinen int retval;
291f7018c21STomi Valkeinen
292f7018c21STomi Valkeinen info = framebuffer_alloc(0, &dev->dev);
293f7018c21STomi Valkeinen if (!info)
294f7018c21STomi Valkeinen return -ENOMEM;
295f7018c21STomi Valkeinen
296f7018c21STomi Valkeinen res = platform_get_resource(dev, IORESOURCE_MEM, 0);
297f7018c21STomi Valkeinen if (!res) {
298f7018c21STomi Valkeinen framebuffer_release(info);
299f7018c21STomi Valkeinen return -EBUSY;
300f7018c21STomi Valkeinen }
301f7018c21STomi Valkeinen
302f7018c21STomi Valkeinen info->screen_size = resource_size(res);
303f7018c21STomi Valkeinen info->screen_base = devm_ioremap(&dev->dev, res->start,
304f7018c21STomi Valkeinen info->screen_size);
3054dcd19bfSArvind Yadav if (!info->screen_base) {
3064dcd19bfSArvind Yadav framebuffer_release(info);
3074dcd19bfSArvind Yadav return -ENOMEM;
3084dcd19bfSArvind Yadav }
3094dcd19bfSArvind Yadav
310f7018c21STomi Valkeinen info->fbops = &cobalt_lcd_fbops;
311f7018c21STomi Valkeinen info->fix = cobalt_lcdfb_fix;
312f7018c21STomi Valkeinen info->fix.smem_start = res->start;
313f7018c21STomi Valkeinen info->fix.smem_len = info->screen_size;
314f7018c21STomi Valkeinen info->pseudo_palette = NULL;
315f7018c21STomi Valkeinen info->par = NULL;
316f7018c21STomi Valkeinen
317f7018c21STomi Valkeinen retval = register_framebuffer(info);
318f7018c21STomi Valkeinen if (retval < 0) {
319f7018c21STomi Valkeinen framebuffer_release(info);
320f7018c21STomi Valkeinen return retval;
321f7018c21STomi Valkeinen }
322f7018c21STomi Valkeinen
323f7018c21STomi Valkeinen platform_set_drvdata(dev, info);
324f7018c21STomi Valkeinen
325f7018c21STomi Valkeinen lcd_clear(info);
326f7018c21STomi Valkeinen
327f7018c21STomi Valkeinen fb_info(info, "Cobalt server LCD frame buffer device\n");
328f7018c21STomi Valkeinen
329f7018c21STomi Valkeinen return 0;
330f7018c21STomi Valkeinen }
331f7018c21STomi Valkeinen
cobalt_lcdfb_remove(struct platform_device * dev)332ac40ac6cSUwe Kleine-König static void cobalt_lcdfb_remove(struct platform_device *dev)
333f7018c21STomi Valkeinen {
334f7018c21STomi Valkeinen struct fb_info *info;
335f7018c21STomi Valkeinen
336f7018c21STomi Valkeinen info = platform_get_drvdata(dev);
337f7018c21STomi Valkeinen if (info) {
338f7018c21STomi Valkeinen unregister_framebuffer(info);
339f7018c21STomi Valkeinen framebuffer_release(info);
340f7018c21STomi Valkeinen }
341f7018c21STomi Valkeinen }
342f7018c21STomi Valkeinen
343f7018c21STomi Valkeinen static struct platform_driver cobalt_lcdfb_driver = {
344f7018c21STomi Valkeinen .probe = cobalt_lcdfb_probe,
345ac40ac6cSUwe Kleine-König .remove_new = cobalt_lcdfb_remove,
346f7018c21STomi Valkeinen .driver = {
347f7018c21STomi Valkeinen .name = "cobalt-lcd",
348f7018c21STomi Valkeinen },
349f7018c21STomi Valkeinen };
350f7018c21STomi Valkeinen module_platform_driver(cobalt_lcdfb_driver);
351f7018c21STomi Valkeinen
352f7018c21STomi Valkeinen MODULE_LICENSE("GPL v2");
353f7018c21STomi Valkeinen MODULE_AUTHOR("Yoichi Yuasa");
354f7018c21STomi Valkeinen MODULE_DESCRIPTION("Cobalt server LCD frame buffer driver");
355