1 // SPDX-License-Identifier: GPL-2.0
3 * Mainly by David Woodhouse, somewhat modified by Jordan Crouse
5 * Copyright © 2006-2007 Red Hat, Inc.
6 * Copyright © 2006-2007 Advanced Micro Devices, Inc.
7 * Copyright © 2009 VIA Technology, Inc.
8 * Copyright (c) 2010-2011 Andres Salomon <dilinger@queued.net>
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/kernel.h>
15 #include <linux/console.h>
16 #include <linux/i2c.h>
17 #include <linux/platform_device.h>
18 #include <linux/interrupt.h>
19 #include <linux/delay.h>
20 #include <linux/module.h>
21 #include <linux/backlight.h>
22 #include <linux/device.h>
23 #include <linux/uaccess.h>
24 #include <linux/ctype.h>
25 #include <linux/panic_notifier.h>
26 #include <linux/reboot.h>
27 #include <linux/olpc-ec.h>
31 #include "olpc_dcon.h"
33 /* Module definitions */
35 static ushort resumeline = 898;
36 module_param(resumeline, ushort, 0444);
38 static struct dcon_platform_data *pdata;
42 /* Platform devices */
43 static struct platform_device *dcon_device;
45 static unsigned short normal_i2c[] = { 0x0d, I2C_CLIENT_END };
47 static s32 dcon_write(struct dcon_priv *dcon, u8 reg, u16 val)
49 return i2c_smbus_write_word_data(dcon->client, reg, val);
52 static s32 dcon_read(struct dcon_priv *dcon, u8 reg)
54 return i2c_smbus_read_word_data(dcon->client, reg);
57 /* ===== API functions - these are called by a variety of users ==== */
59 static int dcon_hw_init(struct dcon_priv *dcon, int is_init)
64 ver = dcon_read(dcon, DCON_REG_ID);
65 if ((ver >> 8) != 0xDC) {
66 pr_err("DCON ID not 0xDCxx: 0x%04x instead.\n", ver);
72 pr_info("Discovered DCON version %x\n", ver & 0xFF);
73 rc = pdata->init(dcon);
75 pr_err("Unable to init.\n");
81 dev_err(&dcon->client->dev,
82 "DCON v1 is unsupported, giving up..\n");
87 /* SDRAM setup/hold time */
88 dcon_write(dcon, 0x3a, 0xc040);
89 dcon_write(dcon, DCON_REG_MEM_OPT_A, 0x0000); /* clear option bits */
90 dcon_write(dcon, DCON_REG_MEM_OPT_A,
91 MEM_DLL_CLOCK_DELAY | MEM_POWER_DOWN);
92 dcon_write(dcon, DCON_REG_MEM_OPT_B, MEM_SOFT_RESET);
94 /* Colour swizzle, AA, no passthrough, backlight */
96 dcon->disp_mode = MODE_PASSTHRU | MODE_BL_ENABLE |
97 MODE_CSWIZZLE | MODE_COL_AA;
99 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
101 /* Set the scanline to interrupt on during resume */
102 dcon_write(dcon, DCON_REG_SCAN_INT, resumeline);
109 * The smbus doesn't always come back due to what is believed to be
110 * hardware (power rail) bugs. For older models where this is known to
111 * occur, our solution is to attempt to wait for the bus to stabilize;
112 * if it doesn't happen, cut power to the dcon, repower it, and wait
113 * for the bus to stabilize. Rinse, repeat until we have a working
114 * smbus. For newer models, we simply BUG(); we want to know if this
115 * still happens despite the power fixes that have been made!
117 static int dcon_bus_stabilize(struct dcon_priv *dcon, int is_powered_down)
119 unsigned long timeout;
124 if (is_powered_down) {
126 x = olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
128 pr_warn("unable to force dcon to power up: %d!\n", x);
131 usleep_range(10000, 11000); /* we'll be conservative */
134 pdata->bus_stabilize_wiggle();
136 for (x = -1, timeout = 50; timeout && x < 0; timeout--) {
137 usleep_range(1000, 1100);
138 x = dcon_read(dcon, DCON_REG_ID);
141 pr_err("unable to stabilize dcon's smbus, reasserting power and praying.\n");
142 BUG_ON(olpc_board_at_least(olpc_board(0xc2)));
144 olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
147 goto power_up; /* argh, stupid hardware.. */
151 return dcon_hw_init(dcon, 0);
155 static void dcon_set_backlight(struct dcon_priv *dcon, u8 level)
157 dcon->bl_val = level;
158 dcon_write(dcon, DCON_REG_BRIGHT, dcon->bl_val);
160 /* Purposely turn off the backlight when we go to level 0 */
161 if (dcon->bl_val == 0) {
162 dcon->disp_mode &= ~MODE_BL_ENABLE;
163 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
164 } else if (!(dcon->disp_mode & MODE_BL_ENABLE)) {
165 dcon->disp_mode |= MODE_BL_ENABLE;
166 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
170 /* Set the output type to either color or mono */
171 static int dcon_set_mono_mode(struct dcon_priv *dcon, bool enable_mono)
173 if (dcon->mono == enable_mono)
176 dcon->mono = enable_mono;
179 dcon->disp_mode &= ~(MODE_CSWIZZLE | MODE_COL_AA);
180 dcon->disp_mode |= MODE_MONO_LUMA;
182 dcon->disp_mode &= ~(MODE_MONO_LUMA);
183 dcon->disp_mode |= MODE_CSWIZZLE | MODE_COL_AA;
186 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
190 /* For now, this will be really stupid - we need to address how
191 * DCONLOAD works in a sleep and account for it accordingly
194 static void dcon_sleep(struct dcon_priv *dcon, bool sleep)
198 /* Turn off the backlight and put the DCON to sleep */
200 if (dcon->asleep == sleep)
203 if (!olpc_board_at_least(olpc_board(0xc2)))
209 x = olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
211 pr_warn("unable to force dcon to power down: %d!\n", x);
213 dcon->asleep = sleep;
215 /* Only re-enable the backlight if the backlight value is set */
216 if (dcon->bl_val != 0)
217 dcon->disp_mode |= MODE_BL_ENABLE;
218 x = dcon_bus_stabilize(dcon, 1);
220 pr_warn("unable to reinit dcon hardware: %d!\n", x);
222 dcon->asleep = sleep;
224 /* Restore backlight */
225 dcon_set_backlight(dcon, dcon->bl_val);
228 /* We should turn off some stuff in the framebuffer - but what? */
231 /* the DCON seems to get confused if we change DCONLOAD too
232 * frequently -- i.e., approximately faster than frame time.
233 * normally we don't change it this fast, so in general we won't
236 static void dcon_load_holdoff(struct dcon_priv *dcon)
238 ktime_t delta_t, now;
242 delta_t = ktime_sub(now, dcon->load_time);
243 if (ktime_to_ns(delta_t) > NSEC_PER_MSEC * 20)
249 static bool dcon_blank_fb(struct dcon_priv *dcon, bool blank)
254 lock_fb_info(dcon->fbinfo);
256 dcon->ignore_fb_events = true;
257 err = fb_blank(dcon->fbinfo,
258 blank ? FB_BLANK_POWERDOWN : FB_BLANK_UNBLANK);
259 dcon->ignore_fb_events = false;
260 unlock_fb_info(dcon->fbinfo);
264 dev_err(&dcon->client->dev, "couldn't %sblank framebuffer\n",
271 /* Set the source of the display (CPU or DCON) */
272 static void dcon_source_switch(struct work_struct *work)
274 struct dcon_priv *dcon = container_of(work, struct dcon_priv,
276 int source = dcon->pending_src;
278 if (dcon->curr_src == source)
281 dcon_load_holdoff(dcon);
283 dcon->switched = false;
286 case DCON_SOURCE_CPU:
287 pr_info("%s to CPU\n", __func__);
288 /* Enable the scanline interrupt bit */
289 if (dcon_write(dcon, DCON_REG_MODE,
290 dcon->disp_mode | MODE_SCAN_INT))
291 pr_err("couldn't enable scanline interrupt!\n");
293 /* Wait up to one second for the scanline interrupt */
294 wait_event_timeout(dcon->waitq, dcon->switched, HZ);
297 pr_err("Timeout entering CPU mode; expect a screen glitch.\n");
299 /* Turn off the scanline interrupt */
300 if (dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode))
301 pr_err("couldn't disable scanline interrupt!\n");
304 * Ideally we'd like to disable interrupts here so that the
305 * fb unblanking and DCON turn on happen at a known time value;
306 * however, we can't do that right now with fb_blank
307 * messing with semaphores.
309 * For now, we just hope..
311 if (!dcon_blank_fb(dcon, false)) {
312 pr_err("Failed to enter CPU mode\n");
313 dcon->pending_src = DCON_SOURCE_DCON;
317 /* And turn off the DCON */
318 pdata->set_dconload(1);
319 dcon->load_time = ktime_get();
321 pr_info("The CPU has control\n");
323 case DCON_SOURCE_DCON:
327 pr_info("%s to DCON\n", __func__);
329 /* Clear DCONLOAD - this implies that the DCON is in control */
330 pdata->set_dconload(0);
331 dcon->load_time = ktime_get();
333 wait_event_timeout(dcon->waitq, dcon->switched, HZ / 2);
335 if (!dcon->switched) {
336 pr_err("Timeout entering DCON mode; expect a screen glitch.\n");
338 /* sometimes the DCON doesn't follow its own rules,
339 * and doesn't wait for two vsync pulses before
340 * ack'ing the frame load with an IRQ. the result
341 * is that the display shows the *previously*
342 * loaded frame. we can detect this by looking at
343 * the time between asserting DCONLOAD and the IRQ --
344 * if it's less than 20msec, then the DCON couldn't
345 * have seen two VSYNC pulses. in that case we
346 * deassert and reassert, and hope for the best.
347 * see http://dev.laptop.org/ticket/9664
349 delta_t = ktime_sub(dcon->irq_time, dcon->load_time);
350 if (dcon->switched && ktime_to_ns(delta_t)
351 < NSEC_PER_MSEC * 20) {
352 pr_err("missed loading, retrying\n");
353 pdata->set_dconload(1);
355 pdata->set_dconload(0);
356 dcon->load_time = ktime_get();
361 dcon_blank_fb(dcon, true);
362 pr_info("The DCON has control\n");
369 dcon->curr_src = source;
372 static void dcon_set_source(struct dcon_priv *dcon, int arg)
374 if (dcon->pending_src == arg)
377 dcon->pending_src = arg;
379 if (dcon->curr_src != arg)
380 schedule_work(&dcon->switch_source);
383 static void dcon_set_source_sync(struct dcon_priv *dcon, int arg)
385 dcon_set_source(dcon, arg);
386 flush_scheduled_work();
389 static ssize_t dcon_mode_show(struct device *dev,
390 struct device_attribute *attr,
393 struct dcon_priv *dcon = dev_get_drvdata(dev);
395 return sprintf(buf, "%4.4X\n", dcon->disp_mode);
398 static ssize_t dcon_sleep_show(struct device *dev,
399 struct device_attribute *attr,
402 struct dcon_priv *dcon = dev_get_drvdata(dev);
404 return sprintf(buf, "%d\n", dcon->asleep);
407 static ssize_t dcon_freeze_show(struct device *dev,
408 struct device_attribute *attr,
411 struct dcon_priv *dcon = dev_get_drvdata(dev);
413 return sprintf(buf, "%d\n", dcon->curr_src == DCON_SOURCE_DCON ? 1 : 0);
416 static ssize_t dcon_mono_show(struct device *dev,
417 struct device_attribute *attr,
420 struct dcon_priv *dcon = dev_get_drvdata(dev);
422 return sprintf(buf, "%d\n", dcon->mono);
425 static ssize_t dcon_resumeline_show(struct device *dev,
426 struct device_attribute *attr,
429 return sprintf(buf, "%d\n", resumeline);
432 static ssize_t dcon_mono_store(struct device *dev,
433 struct device_attribute *attr,
434 const char *buf, size_t count)
436 unsigned long enable_mono;
439 rc = kstrtoul(buf, 10, &enable_mono);
443 dcon_set_mono_mode(dev_get_drvdata(dev), enable_mono ? true : false);
448 static ssize_t dcon_freeze_store(struct device *dev,
449 struct device_attribute *attr,
450 const char *buf, size_t count)
452 struct dcon_priv *dcon = dev_get_drvdata(dev);
453 unsigned long output;
456 ret = kstrtoul(buf, 10, &output);
462 dcon_set_source(dcon, DCON_SOURCE_CPU);
465 dcon_set_source_sync(dcon, DCON_SOURCE_DCON);
467 case 2: /* normally unused */
468 dcon_set_source(dcon, DCON_SOURCE_DCON);
477 static ssize_t dcon_resumeline_store(struct device *dev,
478 struct device_attribute *attr,
479 const char *buf, size_t count)
484 rc = kstrtou16(buf, 10, &rl);
489 dcon_write(dev_get_drvdata(dev), DCON_REG_SCAN_INT, resumeline);
494 static ssize_t dcon_sleep_store(struct device *dev,
495 struct device_attribute *attr,
496 const char *buf, size_t count)
498 unsigned long output;
501 ret = kstrtoul(buf, 10, &output);
505 dcon_sleep(dev_get_drvdata(dev), output ? true : false);
509 static struct device_attribute dcon_device_files[] = {
510 __ATTR(mode, 0444, dcon_mode_show, NULL),
511 __ATTR(sleep, 0644, dcon_sleep_show, dcon_sleep_store),
512 __ATTR(freeze, 0644, dcon_freeze_show, dcon_freeze_store),
513 __ATTR(monochrome, 0644, dcon_mono_show, dcon_mono_store),
514 __ATTR(resumeline, 0644, dcon_resumeline_show, dcon_resumeline_store),
517 static int dcon_bl_update(struct backlight_device *dev)
519 struct dcon_priv *dcon = bl_get_data(dev);
520 u8 level = dev->props.brightness & 0x0F;
522 if (dev->props.power != FB_BLANK_UNBLANK)
525 if (level != dcon->bl_val)
526 dcon_set_backlight(dcon, level);
528 /* power down the DCON when the screen is blanked */
529 if (!dcon->ignore_fb_events)
530 dcon_sleep(dcon, !!(dev->props.state & BL_CORE_FBBLANK));
535 static int dcon_bl_get(struct backlight_device *dev)
537 struct dcon_priv *dcon = bl_get_data(dev);
542 static const struct backlight_ops dcon_bl_ops = {
543 .update_status = dcon_bl_update,
544 .get_brightness = dcon_bl_get,
547 static struct backlight_properties dcon_bl_props = {
548 .max_brightness = 15,
549 .type = BACKLIGHT_RAW,
550 .power = FB_BLANK_UNBLANK,
553 static int dcon_reboot_notify(struct notifier_block *nb,
554 unsigned long foo, void *bar)
556 struct dcon_priv *dcon = container_of(nb, struct dcon_priv, reboot_nb);
558 if (!dcon || !dcon->client)
561 /* Turn off the DCON. Entirely. */
562 dcon_write(dcon, DCON_REG_MODE, 0x39);
563 dcon_write(dcon, DCON_REG_MODE, 0x32);
567 static int unfreeze_on_panic(struct notifier_block *nb,
568 unsigned long e, void *p)
570 pdata->set_dconload(1);
574 static struct notifier_block dcon_panic_nb = {
575 .notifier_call = unfreeze_on_panic,
578 static int dcon_detect(struct i2c_client *client, struct i2c_board_info *info)
580 strscpy(info->type, "olpc_dcon", I2C_NAME_SIZE);
585 static int dcon_probe(struct i2c_client *client, const struct i2c_device_id *id)
587 struct dcon_priv *dcon;
593 dcon = kzalloc(sizeof(*dcon), GFP_KERNEL);
597 dcon->client = client;
598 init_waitqueue_head(&dcon->waitq);
599 INIT_WORK(&dcon->switch_source, dcon_source_switch);
600 dcon->reboot_nb.notifier_call = dcon_reboot_notify;
601 dcon->reboot_nb.priority = -1;
603 i2c_set_clientdata(client, dcon);
605 if (num_registered_fb < 1) {
606 dev_err(&client->dev, "DCON driver requires a registered fb\n");
610 dcon->fbinfo = registered_fb[0];
612 rc = dcon_hw_init(dcon, 1);
616 /* Add the DCON device */
618 dcon_device = platform_device_alloc("dcon", -1);
621 pr_err("Unable to create the DCON device\n");
625 rc = platform_device_add(dcon_device);
626 platform_set_drvdata(dcon_device, dcon);
629 pr_err("Unable to add the DCON device\n");
633 for (i = 0; i < ARRAY_SIZE(dcon_device_files); i++) {
634 rc = device_create_file(&dcon_device->dev,
635 &dcon_device_files[i]);
637 dev_err(&dcon_device->dev, "Cannot create sysfs file\n");
642 dcon->bl_val = dcon_read(dcon, DCON_REG_BRIGHT) & 0x0F;
644 /* Add the backlight device for the DCON */
645 dcon_bl_props.brightness = dcon->bl_val;
646 dcon->bl_dev = backlight_device_register("dcon-bl", &dcon_device->dev,
649 if (IS_ERR(dcon->bl_dev)) {
650 dev_err(&client->dev, "cannot register backlight dev (%ld)\n",
651 PTR_ERR(dcon->bl_dev));
655 register_reboot_notifier(&dcon->reboot_nb);
656 atomic_notifier_chain_register(&panic_notifier_list, &dcon_panic_nb);
661 for (j = 0; j < i; j++)
662 device_remove_file(&dcon_device->dev, &dcon_device_files[j]);
663 platform_device_del(dcon_device);
665 platform_device_put(dcon_device);
668 free_irq(DCON_IRQ, dcon);
674 static int dcon_remove(struct i2c_client *client)
676 struct dcon_priv *dcon = i2c_get_clientdata(client);
678 unregister_reboot_notifier(&dcon->reboot_nb);
679 atomic_notifier_chain_unregister(&panic_notifier_list, &dcon_panic_nb);
681 free_irq(DCON_IRQ, dcon);
683 backlight_device_unregister(dcon->bl_dev);
686 platform_device_unregister(dcon_device);
687 cancel_work_sync(&dcon->switch_source);
695 static int dcon_suspend(struct device *dev)
697 struct i2c_client *client = to_i2c_client(dev);
698 struct dcon_priv *dcon = i2c_get_clientdata(client);
701 /* Set up the DCON to have the source */
702 dcon_set_source_sync(dcon, DCON_SOURCE_DCON);
708 static int dcon_resume(struct device *dev)
710 struct i2c_client *client = to_i2c_client(dev);
711 struct dcon_priv *dcon = i2c_get_clientdata(client);
714 dcon_bus_stabilize(dcon, 0);
715 dcon_set_source(dcon, DCON_SOURCE_CPU);
723 #define dcon_suspend NULL
724 #define dcon_resume NULL
726 #endif /* CONFIG_PM */
728 irqreturn_t dcon_interrupt(int irq, void *id)
730 struct dcon_priv *dcon = id;
733 if (pdata->read_status(&status))
736 switch (status & 3) {
738 pr_debug("DCONLOAD_MISSED interrupt\n");
741 case 2: /* switch to DCON mode */
742 case 1: /* switch to CPU mode */
743 dcon->switched = true;
744 dcon->irq_time = ktime_get();
745 wake_up(&dcon->waitq);
749 /* workaround resume case: the DCON (on 1.5) doesn't
750 * ever assert status 0x01 when switching to CPU mode
751 * during resume. this is because DCONLOAD is de-asserted
752 * _immediately_ upon exiting S3, so the actual release
753 * of the DCON happened long before this point.
754 * see http://dev.laptop.org/ticket/9869
756 if (dcon->curr_src != dcon->pending_src && !dcon->switched) {
757 dcon->switched = true;
758 dcon->irq_time = ktime_get();
759 wake_up(&dcon->waitq);
760 pr_debug("switching w/ status 0/0\n");
762 pr_debug("scanline interrupt w/CPU\n");
769 static const struct dev_pm_ops dcon_pm_ops = {
770 .suspend = dcon_suspend,
771 .resume = dcon_resume,
774 static const struct i2c_device_id dcon_idtable[] = {
778 MODULE_DEVICE_TABLE(i2c, dcon_idtable);
780 static struct i2c_driver dcon_driver = {
785 .class = I2C_CLASS_DDC | I2C_CLASS_HWMON,
786 .id_table = dcon_idtable,
788 .remove = dcon_remove,
789 .detect = dcon_detect,
790 .address_list = normal_i2c,
793 static int __init olpc_dcon_init(void)
796 if (olpc_board_at_least(olpc_board(0xd0)))
797 pdata = &dcon_pdata_xo_1_5;
799 pdata = &dcon_pdata_xo_1;
801 return i2c_add_driver(&dcon_driver);
804 static void __exit olpc_dcon_exit(void)
806 i2c_del_driver(&dcon_driver);
809 module_init(olpc_dcon_init);
810 module_exit(olpc_dcon_exit);
812 MODULE_LICENSE("GPL");