2 * Mainly by David Woodhouse, somewhat modified by Jordan Crouse
4 * Copyright © 2006-2007 Red Hat, Inc.
5 * Copyright © 2006-2007 Advanced Micro Devices, Inc.
6 * Copyright © 2009 VIA Technology, Inc.
7 * Copyright (c) 2010-2011 Andres Salomon <dilinger@queued.net>
9 * This program is free software. You can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General Public
11 * License as published by the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/kernel.h>
18 #include <linux/console.h>
19 #include <linux/i2c.h>
20 #include <linux/platform_device.h>
21 #include <linux/interrupt.h>
22 #include <linux/delay.h>
23 #include <linux/module.h>
24 #include <linux/backlight.h>
25 #include <linux/device.h>
26 #include <linux/uaccess.h>
27 #include <linux/ctype.h>
28 #include <linux/reboot.h>
29 #include <linux/olpc-ec.h>
33 #include "olpc_dcon.h"
35 /* Module definitions */
37 static ushort resumeline = 898;
38 module_param(resumeline, ushort, 0444);
40 static struct dcon_platform_data *pdata;
44 /* Platform devices */
45 static struct platform_device *dcon_device;
47 static unsigned short normal_i2c[] = { 0x0d, I2C_CLIENT_END };
49 static s32 dcon_write(struct dcon_priv *dcon, u8 reg, u16 val)
51 return i2c_smbus_write_word_data(dcon->client, reg, val);
54 static s32 dcon_read(struct dcon_priv *dcon, u8 reg)
56 return i2c_smbus_read_word_data(dcon->client, reg);
59 /* ===== API functions - these are called by a variety of users ==== */
61 static int dcon_hw_init(struct dcon_priv *dcon, int is_init)
66 ver = dcon_read(dcon, DCON_REG_ID);
67 if ((ver >> 8) != 0xDC) {
68 pr_err("DCON ID not 0xDCxx: 0x%04x instead.\n", ver);
74 pr_info("Discovered DCON version %x\n", ver & 0xFF);
75 rc = pdata->init(dcon);
77 pr_err("Unable to init.\n");
83 dev_err(&dcon->client->dev,
84 "DCON v1 is unsupported, giving up..\n");
89 /* SDRAM setup/hold time */
90 dcon_write(dcon, 0x3a, 0xc040);
91 dcon_write(dcon, DCON_REG_MEM_OPT_A, 0x0000); /* clear option bits */
92 dcon_write(dcon, DCON_REG_MEM_OPT_A,
93 MEM_DLL_CLOCK_DELAY | MEM_POWER_DOWN);
94 dcon_write(dcon, DCON_REG_MEM_OPT_B, MEM_SOFT_RESET);
96 /* Colour swizzle, AA, no passthrough, backlight */
98 dcon->disp_mode = MODE_PASSTHRU | MODE_BL_ENABLE |
99 MODE_CSWIZZLE | MODE_COL_AA;
101 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
104 /* Set the scanline to interrupt on during resume */
105 dcon_write(dcon, DCON_REG_SCAN_INT, resumeline);
112 * The smbus doesn't always come back due to what is believed to be
113 * hardware (power rail) bugs. For older models where this is known to
114 * occur, our solution is to attempt to wait for the bus to stabilize;
115 * if it doesn't happen, cut power to the dcon, repower it, and wait
116 * for the bus to stabilize. Rinse, repeat until we have a working
117 * smbus. For newer models, we simply BUG(); we want to know if this
118 * still happens despite the power fixes that have been made!
120 static int dcon_bus_stabilize(struct dcon_priv *dcon, int is_powered_down)
122 unsigned long timeout;
127 if (is_powered_down) {
129 x = olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
131 pr_warn("unable to force dcon to power up: %d!\n", x);
134 usleep_range(10000, 11000); /* we'll be conservative */
137 pdata->bus_stabilize_wiggle();
139 for (x = -1, timeout = 50; timeout && x < 0; timeout--) {
140 usleep_range(1000, 1100);
141 x = dcon_read(dcon, DCON_REG_ID);
144 pr_err("unable to stabilize dcon's smbus, reasserting power and praying.\n");
145 BUG_ON(olpc_board_at_least(olpc_board(0xc2)));
147 olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
150 goto power_up; /* argh, stupid hardware.. */
154 return dcon_hw_init(dcon, 0);
158 static void dcon_set_backlight(struct dcon_priv *dcon, u8 level)
160 dcon->bl_val = level;
161 dcon_write(dcon, DCON_REG_BRIGHT, dcon->bl_val);
163 /* Purposely turn off the backlight when we go to level 0 */
164 if (dcon->bl_val == 0) {
165 dcon->disp_mode &= ~MODE_BL_ENABLE;
166 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
167 } else if (!(dcon->disp_mode & MODE_BL_ENABLE)) {
168 dcon->disp_mode |= MODE_BL_ENABLE;
169 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
173 /* Set the output type to either color or mono */
174 static int dcon_set_mono_mode(struct dcon_priv *dcon, bool enable_mono)
176 if (dcon->mono == enable_mono)
179 dcon->mono = enable_mono;
182 dcon->disp_mode &= ~(MODE_CSWIZZLE | MODE_COL_AA);
183 dcon->disp_mode |= MODE_MONO_LUMA;
185 dcon->disp_mode &= ~(MODE_MONO_LUMA);
186 dcon->disp_mode |= MODE_CSWIZZLE | MODE_COL_AA;
189 dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode);
193 /* For now, this will be really stupid - we need to address how
194 * DCONLOAD works in a sleep and account for it accordingly
197 static void dcon_sleep(struct dcon_priv *dcon, bool sleep)
201 /* Turn off the backlight and put the DCON to sleep */
203 if (dcon->asleep == sleep)
206 if (!olpc_board_at_least(olpc_board(0xc2)))
212 x = olpc_ec_cmd(EC_DCON_POWER_MODE, &pm, 1, NULL, 0);
214 pr_warn("unable to force dcon to power down: %d!\n", x);
216 dcon->asleep = sleep;
218 /* Only re-enable the backlight if the backlight value is set */
219 if (dcon->bl_val != 0)
220 dcon->disp_mode |= MODE_BL_ENABLE;
221 x = dcon_bus_stabilize(dcon, 1);
223 pr_warn("unable to reinit dcon hardware: %d!\n", x);
225 dcon->asleep = sleep;
227 /* Restore backlight */
228 dcon_set_backlight(dcon, dcon->bl_val);
231 /* We should turn off some stuff in the framebuffer - but what? */
234 /* the DCON seems to get confused if we change DCONLOAD too
235 * frequently -- i.e., approximately faster than frame time.
236 * normally we don't change it this fast, so in general we won't
239 static void dcon_load_holdoff(struct dcon_priv *dcon)
241 ktime_t delta_t, now;
245 delta_t = ktime_sub(now, dcon->load_time);
246 if (ktime_to_ns(delta_t) > NSEC_PER_MSEC * 20) {
253 static bool dcon_blank_fb(struct dcon_priv *dcon, bool blank)
258 if (!lock_fb_info(dcon->fbinfo)) {
260 dev_err(&dcon->client->dev, "unable to lock framebuffer\n");
264 dcon->ignore_fb_events = true;
265 err = fb_blank(dcon->fbinfo,
266 blank ? FB_BLANK_POWERDOWN : FB_BLANK_UNBLANK);
267 dcon->ignore_fb_events = false;
268 unlock_fb_info(dcon->fbinfo);
272 dev_err(&dcon->client->dev, "couldn't %sblank framebuffer\n",
279 /* Set the source of the display (CPU or DCON) */
280 static void dcon_source_switch(struct work_struct *work)
282 struct dcon_priv *dcon = container_of(work, struct dcon_priv,
284 int source = dcon->pending_src;
286 if (dcon->curr_src == source)
289 dcon_load_holdoff(dcon);
291 dcon->switched = false;
294 case DCON_SOURCE_CPU:
295 pr_info("dcon_source_switch to CPU\n");
296 /* Enable the scanline interrupt bit */
297 if (dcon_write(dcon, DCON_REG_MODE,
298 dcon->disp_mode | MODE_SCAN_INT))
299 pr_err("couldn't enable scanline interrupt!\n");
301 /* Wait up to one second for the scanline interrupt */
302 wait_event_timeout(dcon->waitq, dcon->switched, HZ);
305 pr_err("Timeout entering CPU mode; expect a screen glitch.\n");
307 /* Turn off the scanline interrupt */
308 if (dcon_write(dcon, DCON_REG_MODE, dcon->disp_mode))
309 pr_err("couldn't disable scanline interrupt!\n");
312 * Ideally we'd like to disable interrupts here so that the
313 * fb unblanking and DCON turn on happen at a known time value;
314 * however, we can't do that right now with fb_blank
315 * messing with semaphores.
317 * For now, we just hope..
319 if (!dcon_blank_fb(dcon, false)) {
320 pr_err("Failed to enter CPU mode\n");
321 dcon->pending_src = DCON_SOURCE_DCON;
325 /* And turn off the DCON */
326 pdata->set_dconload(1);
327 dcon->load_time = ktime_get();
329 pr_info("The CPU has control\n");
331 case DCON_SOURCE_DCON:
335 pr_info("dcon_source_switch to DCON\n");
337 /* Clear DCONLOAD - this implies that the DCON is in control */
338 pdata->set_dconload(0);
339 dcon->load_time = ktime_get();
341 wait_event_timeout(dcon->waitq, dcon->switched, HZ/2);
343 if (!dcon->switched) {
344 pr_err("Timeout entering DCON mode; expect a screen glitch.\n");
346 /* sometimes the DCON doesn't follow its own rules,
347 * and doesn't wait for two vsync pulses before
348 * ack'ing the frame load with an IRQ. the result
349 * is that the display shows the *previously*
350 * loaded frame. we can detect this by looking at
351 * the time between asserting DCONLOAD and the IRQ --
352 * if it's less than 20msec, then the DCON couldn't
353 * have seen two VSYNC pulses. in that case we
354 * deassert and reassert, and hope for the best.
355 * see http://dev.laptop.org/ticket/9664
357 delta_t = ktime_sub(dcon->irq_time, dcon->load_time);
358 if (dcon->switched && ktime_to_ns(delta_t)
359 < NSEC_PER_MSEC * 20) {
360 pr_err("missed loading, retrying\n");
361 pdata->set_dconload(1);
363 pdata->set_dconload(0);
364 dcon->load_time = ktime_get();
369 dcon_blank_fb(dcon, true);
370 pr_info("The DCON has control\n");
377 dcon->curr_src = source;
380 static void dcon_set_source(struct dcon_priv *dcon, int arg)
382 if (dcon->pending_src == arg)
385 dcon->pending_src = arg;
387 if (dcon->curr_src != arg)
388 schedule_work(&dcon->switch_source);
391 static void dcon_set_source_sync(struct dcon_priv *dcon, int arg)
393 dcon_set_source(dcon, arg);
394 flush_scheduled_work();
397 static ssize_t dcon_mode_show(struct device *dev,
398 struct device_attribute *attr, char *buf)
400 struct dcon_priv *dcon = dev_get_drvdata(dev);
402 return sprintf(buf, "%4.4X\n", dcon->disp_mode);
405 static ssize_t dcon_sleep_show(struct device *dev,
406 struct device_attribute *attr, char *buf)
408 struct dcon_priv *dcon = dev_get_drvdata(dev);
410 return sprintf(buf, "%d\n", dcon->asleep);
413 static ssize_t dcon_freeze_show(struct device *dev,
414 struct device_attribute *attr, char *buf)
416 struct dcon_priv *dcon = dev_get_drvdata(dev);
418 return sprintf(buf, "%d\n", dcon->curr_src == DCON_SOURCE_DCON ? 1 : 0);
421 static ssize_t dcon_mono_show(struct device *dev,
422 struct device_attribute *attr, char *buf)
424 struct dcon_priv *dcon = dev_get_drvdata(dev);
426 return sprintf(buf, "%d\n", dcon->mono);
429 static ssize_t dcon_resumeline_show(struct device *dev,
430 struct device_attribute *attr, char *buf)
432 return sprintf(buf, "%d\n", resumeline);
435 static ssize_t dcon_mono_store(struct device *dev,
436 struct device_attribute *attr, const char *buf, size_t count)
438 unsigned long enable_mono;
441 rc = kstrtoul(buf, 10, &enable_mono);
445 dcon_set_mono_mode(dev_get_drvdata(dev), enable_mono ? true : false);
450 static ssize_t dcon_freeze_store(struct device *dev,
451 struct device_attribute *attr, const char *buf, size_t count)
453 struct dcon_priv *dcon = dev_get_drvdata(dev);
454 unsigned long output;
457 ret = kstrtoul(buf, 10, &output);
461 pr_info("dcon_freeze_store: %lu\n", output);
465 dcon_set_source(dcon, DCON_SOURCE_CPU);
468 dcon_set_source_sync(dcon, DCON_SOURCE_DCON);
470 case 2: /* normally unused */
471 dcon_set_source(dcon, DCON_SOURCE_DCON);
480 static ssize_t dcon_resumeline_store(struct device *dev,
481 struct device_attribute *attr, const char *buf, size_t count)
486 rc = kstrtou16(buf, 10, &rl);
491 dcon_write(dev_get_drvdata(dev), DCON_REG_SCAN_INT, resumeline);
496 static ssize_t dcon_sleep_store(struct device *dev,
497 struct device_attribute *attr, const char *buf, size_t count)
499 unsigned long output;
502 ret = kstrtoul(buf, 10, &output);
506 dcon_sleep(dev_get_drvdata(dev), output ? true : false);
510 static struct device_attribute dcon_device_files[] = {
511 __ATTR(mode, 0444, dcon_mode_show, NULL),
512 __ATTR(sleep, 0644, dcon_sleep_show, dcon_sleep_store),
513 __ATTR(freeze, 0644, dcon_freeze_show, dcon_freeze_store),
514 __ATTR(monochrome, 0644, dcon_mono_show, dcon_mono_store),
515 __ATTR(resumeline, 0644, dcon_resumeline_show, dcon_resumeline_store),
518 static int dcon_bl_update(struct backlight_device *dev)
520 struct dcon_priv *dcon = bl_get_data(dev);
521 u8 level = dev->props.brightness & 0x0F;
523 if (dev->props.power != FB_BLANK_UNBLANK)
526 if (level != dcon->bl_val)
527 dcon_set_backlight(dcon, level);
529 /* power down the DCON when the screen is blanked */
530 if (!dcon->ignore_fb_events)
531 dcon_sleep(dcon, !!(dev->props.state & BL_CORE_FBBLANK));
536 static int dcon_bl_get(struct backlight_device *dev)
538 struct dcon_priv *dcon = bl_get_data(dev);
543 static const struct backlight_ops dcon_bl_ops = {
544 .update_status = dcon_bl_update,
545 .get_brightness = dcon_bl_get,
548 static struct backlight_properties dcon_bl_props = {
549 .max_brightness = 15,
550 .type = BACKLIGHT_RAW,
551 .power = FB_BLANK_UNBLANK,
554 static int dcon_reboot_notify(struct notifier_block *nb,
555 unsigned long foo, void *bar)
557 struct dcon_priv *dcon = container_of(nb, struct dcon_priv, reboot_nb);
559 if (!dcon || !dcon->client)
562 /* Turn off the DCON. Entirely. */
563 dcon_write(dcon, DCON_REG_MODE, 0x39);
564 dcon_write(dcon, DCON_REG_MODE, 0x32);
568 static int unfreeze_on_panic(struct notifier_block *nb,
569 unsigned long e, void *p)
571 pdata->set_dconload(1);
575 static struct notifier_block dcon_panic_nb = {
576 .notifier_call = unfreeze_on_panic,
579 static int dcon_detect(struct i2c_client *client, struct i2c_board_info *info)
581 strlcpy(info->type, "olpc_dcon", I2C_NAME_SIZE);
586 static int dcon_probe(struct i2c_client *client, const struct i2c_device_id *id)
588 struct dcon_priv *dcon;
594 dcon = kzalloc(sizeof(*dcon), GFP_KERNEL);
598 dcon->client = client;
599 init_waitqueue_head(&dcon->waitq);
600 INIT_WORK(&dcon->switch_source, dcon_source_switch);
601 dcon->reboot_nb.notifier_call = dcon_reboot_notify;
602 dcon->reboot_nb.priority = -1;
604 i2c_set_clientdata(client, dcon);
606 if (num_registered_fb < 1) {
607 dev_err(&client->dev, "DCON driver requires a registered fb\n");
611 dcon->fbinfo = registered_fb[0];
613 rc = dcon_hw_init(dcon, 1);
617 /* Add the DCON device */
619 dcon_device = platform_device_alloc("dcon", -1);
621 if (dcon_device == NULL) {
622 pr_err("Unable to create the DCON device\n");
626 rc = platform_device_add(dcon_device);
627 platform_set_drvdata(dcon_device, dcon);
630 pr_err("Unable to add the DCON device\n");
634 for (i = 0; i < ARRAY_SIZE(dcon_device_files); i++) {
635 rc = device_create_file(&dcon_device->dev,
636 &dcon_device_files[i]);
638 dev_err(&dcon_device->dev, "Cannot create sysfs file\n");
643 dcon->bl_val = dcon_read(dcon, DCON_REG_BRIGHT) & 0x0F;
645 /* Add the backlight device for the DCON */
646 dcon_bl_props.brightness = dcon->bl_val;
647 dcon->bl_dev = backlight_device_register("dcon-bl", &dcon_device->dev,
648 dcon, &dcon_bl_ops, &dcon_bl_props);
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]);
664 platform_device_unregister(dcon_device);
667 free_irq(DCON_IRQ, dcon);
673 static int dcon_remove(struct i2c_client *client)
675 struct dcon_priv *dcon = i2c_get_clientdata(client);
677 unregister_reboot_notifier(&dcon->reboot_nb);
678 atomic_notifier_chain_unregister(&panic_notifier_list, &dcon_panic_nb);
680 free_irq(DCON_IRQ, dcon);
682 backlight_device_unregister(dcon->bl_dev);
684 if (dcon_device != NULL)
685 platform_device_unregister(dcon_device);
686 cancel_work_sync(&dcon->switch_source);
694 static int dcon_suspend(struct device *dev)
696 struct i2c_client *client = to_i2c_client(dev);
697 struct dcon_priv *dcon = i2c_get_clientdata(client);
700 /* Set up the DCON to have the source */
701 dcon_set_source_sync(dcon, DCON_SOURCE_DCON);
707 static int dcon_resume(struct device *dev)
709 struct i2c_client *client = to_i2c_client(dev);
710 struct dcon_priv *dcon = i2c_get_clientdata(client);
713 dcon_bus_stabilize(dcon, 0);
714 dcon_set_source(dcon, DCON_SOURCE_CPU);
722 #define dcon_suspend NULL
723 #define dcon_resume NULL
725 #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)
795 #ifdef CONFIG_FB_OLPC_DCON_1_5
797 if (olpc_board_at_least(olpc_board(0xd0)))
798 pdata = &dcon_pdata_xo_1_5;
800 #ifdef CONFIG_FB_OLPC_DCON_1
802 pdata = &dcon_pdata_xo_1;
805 return i2c_add_driver(&dcon_driver);
808 static void __exit olpc_dcon_exit(void)
810 i2c_del_driver(&dcon_driver);
813 module_init(olpc_dcon_init);
814 module_exit(olpc_dcon_exit);
816 MODULE_LICENSE("GPL");