firmware/backlight.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Linus Nielsen Feltzing
  11  * Additional work by Martin Ritter (2007) and Thomas Martitz (2008)
  12  *                  for backlight thread fading
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  20  * KIND, either express or implied.
  21  *
  22  ****************************************************************************/
  23 #include "config.h"
  24 #include <stdlib.h>
  25 #include "cpu.h"
  26 #include "kernel.h"
  27 #include "thread.h"
  28 #include "i2c.h"
  29 #include "debug.h"
  30 #include "rtc.h"
  31 #include "usb.h"
  32 #include "power.h"
  33 #include "system.h"
  34 #include "button.h"
  35 #include "timer.h"
  36 #include "backlight.h"
  37 #include "lcd.h"
  38 #include "screendump.h"
  39
  40 #ifdef HAVE_REMOTE_LCD
  41 #include "lcd-remote.h"
  42 #endif
  43 #ifndef SIMULATOR
  44 #include "backlight-target.h"
  45 #endif
  46
  47 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
  48     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
  49 #include "backlight-sw-fading.h"
  50 #endif
  51 #ifdef SIMULATOR
  52
  53 static inline void _backlight_on(void)
  54 {
  55     sim_backlight(100);
  56 }
  57
  58 static inline void _backlight_off(void)
  59 {
  60     sim_backlight(0);
  61 }
  62
  63 static inline void _backlight_set_brightness(int val)
  64 {
  65     (void)val;
  66 }
  67
  68 static inline void _buttonlight_on(void)
  69 {
  70 }
  71
  72 static inline void _buttonlight_off(void)
  73 {
  74 }
  75
  76 static inline void _buttonlight_set_brightness(int val)
  77 {
  78     (void)val;
  79 }
  80 #ifdef HAVE_REMOTE_LCD
  81 static inline void _remote_backlight_on(void)
  82 {
  83     sim_remote_backlight(100);
  84 }
  85
  86 static inline void _remote_backlight_off(void)
  87 {
  88     sim_remote_backlight(0);
  89 }
  90 #endif /* HAVE_REMOTE_LCD */
  91
  92 #endif /* SIMULATOR */
  93
  94 #if defined(HAVE_BACKLIGHT) && defined(BACKLIGHT_FULL_INIT)
  95
  96 #define BACKLIGHT_THREAD_TIMEOUT HZ
  97
  98 enum {
  99     BACKLIGHT_ON,
 100     BACKLIGHT_OFF,
 101     BACKLIGHT_TMO_CHANGED,
 102 #ifdef HAVE_REMOTE_LCD
 103     REMOTE_BACKLIGHT_ON,
 104     REMOTE_BACKLIGHT_OFF,
 105     REMOTE_BACKLIGHT_TMO_CHANGED,
 106 #endif
 107 #if defined(_BACKLIGHT_FADE_BOOST) || defined(_BACKLIGHT_FADE_ENABLE)
 108     BACKLIGHT_FADE_FINISH,
 109 #endif
 110 #ifdef HAVE_LCD_SLEEP
 111     LCD_SLEEP,
 112 #endif
 113 #ifdef HAVE_BUTTON_LIGHT
 114     BUTTON_LIGHT_ON,
 115     BUTTON_LIGHT_OFF,
 116     BUTTON_LIGHT_TMO_CHANGED,
 117 #endif
 118 #ifdef BACKLIGHT_DRIVER_CLOSE
 119     BACKLIGHT_QUIT,
 120 #endif
 121 };
 122
 123 static void backlight_thread(void);
 124 static long backlight_stack[DEFAULT_STACK_SIZE/sizeof(long)];
 125 static const char backlight_thread_name[] = "backlight";
 126 static struct event_queue backlight_queue;
 127 #ifdef BACKLIGHT_DRIVER_CLOSE
 128 static unsigned int backlight_thread_id = 0;
 129 #endif
 130
 131 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
 132 int backlight_brightness = DEFAULT_BRIGHTNESS_SETTING;
 133 #endif
 134 static int backlight_timer SHAREDBSS_ATTR;
 135 static int backlight_timeout_normal = 5*HZ;
 136 #if CONFIG_CHARGING
 137 static int backlight_timeout_plugged = 5*HZ;
 138 #endif
 139 #ifdef HAS_BUTTON_HOLD
 140 static int backlight_on_button_hold = 0;
 141 #endif
 142 static void backlight_timeout_handler(void);
 143
 144 #ifdef HAVE_BUTTON_LIGHT
 145 static int buttonlight_timer;
 146 static int buttonlight_timeout = 5*HZ;
 147
 148 /* Update state of buttonlight according to timeout setting */
 149 static void buttonlight_update_state(void)
 150 {
 151     buttonlight_timer = buttonlight_timeout;
 152
 153     /* Buttonlight == OFF in the setting? */
 154     if (buttonlight_timer < 0)
 155     {
 156         buttonlight_timer = 0; /* Disable the timeout */
 157         _buttonlight_off();
 158     }
 159     else
 160         _buttonlight_on();
 161 }
 162
 163 /* external interface */
 164 void buttonlight_on(void)
 165 {
 166     queue_remove_from_head(&backlight_queue, BUTTON_LIGHT_ON);
 167     queue_post(&backlight_queue, BUTTON_LIGHT_ON, 0);
 168 }
 169
 170 void buttonlight_off(void)
 171 {
 172     queue_post(&backlight_queue, BUTTON_LIGHT_OFF, 0);
 173 }
 174
 175 void buttonlight_set_timeout(int value)
 176 {
 177     buttonlight_timeout = HZ * value;
 178     queue_post(&backlight_queue, BUTTON_LIGHT_TMO_CHANGED, 0);
 179 }
 180
 181 int buttonlight_get_current_timeout(void)
 182 {
 183     return buttonlight_timeout;
 184 }
 185
 186 #endif /* HAVE_BUTTON_LIGHT */
 187
 188 #ifdef HAVE_REMOTE_LCD
 189 static int remote_backlight_timer;
 190 static int remote_backlight_timeout_normal = 5*HZ;
 191 #if CONFIG_CHARGING
 192 static int remote_backlight_timeout_plugged = 5*HZ;
 193 #endif
 194 #ifdef HAS_REMOTE_BUTTON_HOLD
 195 static int remote_backlight_on_button_hold = 0;
 196 #endif
 197 #endif /* HAVE_REMOTE_LCD */
 198
 199 #ifdef HAVE_LCD_SLEEP
 200 #ifdef HAVE_LCD_SLEEP_SETTING
 201 const signed char lcd_sleep_timeout_value[10] =
 202 {
 203     -1, 0, 5, 10, 15, 20, 30, 45, 60, 90
 204 };
 205 static int lcd_sleep_timeout = 10*HZ;
 206 #else
 207 /* Target defines needed value */
 208 #define lcd_sleep_timeout LCD_SLEEP_TIMEOUT
 209 #endif
 210
 211 static int lcd_sleep_timer SHAREDDATA_ATTR = 0;
 212
 213 static void backlight_lcd_sleep_countdown(bool start)
 214 {
 215     if (!start)
 216     {
 217         /* Cancel the LCD sleep countdown */
 218         lcd_sleep_timer = 0;
 219         return;
 220     }
 221
 222     /* Start LCD sleep countdown */
 223     if (lcd_sleep_timeout < 0)
 224     {
 225         lcd_sleep_timer = 0; /* Setting == Always */
 226         /* Ensure lcd_sleep() is called from backlight_thread() */
 227 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_PWM)
 228         queue_post(&backlight_queue, LCD_SLEEP, 0);
 229 #else
 230         lcd_sleep();
 231 #endif
 232     }
 233     else
 234     {
 235         lcd_sleep_timer = lcd_sleep_timeout;
 236     }
 237 }
 238 #endif /* HAVE_LCD_SLEEP */
 239
 240 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 241     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 242 static int backlight_fading_type = (FADING_UP|FADING_DOWN);
 243 static int backlight_fading_state = NOT_FADING;
 244 #endif
 245
 246
 247 /* backlight fading */
 248 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_PWM)
 249 #define BL_PWM_INTERVAL 5  /* Cycle interval in ms */
 250 #define BL_PWM_BITS     8
 251 #define BL_PWM_COUNT    (1<<BL_PWM_BITS)
 252
 253 /* s15.16 fixed point variables */
 254 static int32_t bl_fade_in_step  = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16)/300;
 255 static int32_t bl_fade_out_step = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16)/2000;
 256 static int32_t bl_dim_fraction  = 0;
 257
 258 static int bl_dim_target  = 0;
 259 static int bl_dim_current = 0;
 260 static enum {DIM_STATE_START, DIM_STATE_MAIN} bl_dim_state = DIM_STATE_START;
 261 static bool bl_timer_active = false;
 262
 263 static void backlight_isr(void)
 264 {
 265     int timer_period = (TIMER_FREQ*BL_PWM_INTERVAL/1000);
 266     bool idle = false;
 267
 268     switch (bl_dim_state)
 269     {
 270       /* New cycle */
 271       case DIM_STATE_START:
 272         bl_dim_current = bl_dim_fraction >> 16;
 273
 274         if (bl_dim_current > 0 && bl_dim_current < BL_PWM_COUNT)
 275         {
 276             _backlight_on_isr();
 277             timer_period = (timer_period * bl_dim_current) >> BL_PWM_BITS;
 278             bl_dim_state = DIM_STATE_MAIN;
 279         }
 280         else
 281         {
 282             if (bl_dim_current)
 283                 _backlight_on_isr();
 284             else
 285                 _backlight_off_isr();
 286             if (bl_dim_current == bl_dim_target)
 287                 idle = true;
 288         }
 289         if (bl_dim_current < bl_dim_target)
 290         {
 291             bl_dim_fraction = MIN(bl_dim_fraction + bl_fade_in_step,
 292                                   (BL_PWM_COUNT<<16));
 293         }
 294         else if (bl_dim_current > bl_dim_target)
 295         {
 296             bl_dim_fraction = MAX(bl_dim_fraction - bl_fade_out_step, 0);
 297         }
 298         break;
 299
 300       /* Dim main screen */
 301       case DIM_STATE_MAIN:
 302         _backlight_off_isr();
 303         timer_period = (timer_period * (BL_PWM_COUNT - bl_dim_current))
 304                      >> BL_PWM_BITS;
 305         bl_dim_state = DIM_STATE_START;
 306         break ;
 307     }
 308     if (idle)
 309     {
 310 #if defined(_BACKLIGHT_FADE_BOOST) || defined(_BACKLIGHT_FADE_ENABLE)
 311         queue_post(&backlight_queue, BACKLIGHT_FADE_FINISH, 0);
 312 #endif
 313         timer_unregister();
 314         bl_timer_active = false;
 315
 316 #ifdef HAVE_LCD_SLEEP
 317         if (bl_dim_current == 0)
 318             backlight_lcd_sleep_countdown(true);
 319 #endif
 320     }
 321     else
 322         timer_set_period(timer_period);
 323 }
 324
 325 static void backlight_switch(void)
 326 {
 327     if (bl_dim_target > (BL_PWM_COUNT/2))
 328     {
 329         _backlight_on_normal();
 330         bl_dim_fraction = (BL_PWM_COUNT<<16);
 331     }
 332     else
 333     {
 334         _backlight_off_normal();
 335         bl_dim_fraction = 0;
 336
 337 #ifdef HAVE_LCD_SLEEP
 338         backlight_lcd_sleep_countdown(true);
 339 #endif
 340     }
 341 }
 342
 343 static void backlight_release_timer(void)
 344 {
 345 #ifdef _BACKLIGHT_FADE_BOOST
 346     cpu_boost(false);
 347 #endif
 348     timer_unregister();
 349     bl_timer_active = false;
 350     backlight_switch();
 351 }
 352
 353 static void backlight_dim(int value)
 354 {
 355     /* protect from extraneous calls with the same target value */
 356     if (value == bl_dim_target)
 357         return;
 358
 359     bl_dim_target = value;
 360
 361     if (bl_timer_active)
 362         return ;
 363
 364     if (timer_register(0, backlight_release_timer, 2, 0, backlight_isr
 365                        IF_COP(, CPU)))
 366     {
 367 #ifdef _BACKLIGHT_FADE_BOOST
 368         /* Prevent cpu frequency changes while dimming. */
 369         cpu_boost(true);
 370 #endif
 371         bl_timer_active = true;
 372     }
 373     else
 374         backlight_switch();
 375 }
 376
 377 static void _backlight_on(void)
 378 {
 379     if (bl_fade_in_step > 0)
 380     {
 381 #ifdef _BACKLIGHT_FADE_ENABLE
 382         _backlight_hw_enable(true);
 383 #endif
 384         backlight_dim(BL_PWM_COUNT);
 385     }
 386     else
 387     {
 388         bl_dim_target = BL_PWM_COUNT;
 389         bl_dim_fraction = (BL_PWM_COUNT<<16);
 390         _backlight_on_normal();
 391     }
 392 }
 393
 394 static void _backlight_off(void)
 395 {
 396     if (bl_fade_out_step > 0)
 397     {
 398         backlight_dim(0);
 399     }
 400     else
 401     {
 402         bl_dim_target = bl_dim_fraction = 0;
 403         _backlight_off_normal();
 404     }
 405 }
 406
 407 void backlight_set_fade_in(int value)
 408 {
 409     if (value > 0)
 410         bl_fade_in_step = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16) / value;
 411     else
 412         bl_fade_in_step = 0;
 413 }
 414
 415 void backlight_set_fade_out(int value)
 416 {
 417     if (value > 0)
 418         bl_fade_out_step = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16) / value;
 419     else
 420         bl_fade_out_step = 0;
 421 }
 422
 423 #elif  (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 424     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 425
 426 void backlight_set_fade_out(bool value)
 427 {
 428     if(value) /* on */
 429         backlight_fading_type |= FADING_DOWN;
 430     else
 431         backlight_fading_type &= FADING_UP;
 432 }
 433
 434 void backlight_set_fade_in(bool value)
 435 {
 436     if(value) /* on */
 437         backlight_fading_type |= FADING_UP;
 438     else
 439         backlight_fading_type &= FADING_DOWN;
 440 }
 441
 442 static void backlight_setup_fade_up(void)
 443 {
 444     if (backlight_fading_type & FADING_UP)
 445     {
 446         if (backlight_fading_state == NOT_FADING)
 447         {
 448             /* make sure the backlight is at lowest level */
 449             _backlight_on();
 450         }
 451         backlight_fading_state = FADING_UP;
 452     }
 453     else
 454     {
 455         backlight_fading_state = NOT_FADING;
 456         _backlight_fade_update_state(backlight_brightness);
 457         _backlight_on();
 458         _backlight_set_brightness(backlight_brightness);
 459     }
 460 }
 461
 462 static void backlight_setup_fade_down(void)
 463 {
 464     if (backlight_fading_type & FADING_DOWN)
 465     {
 466         backlight_fading_state = FADING_DOWN;
 467     }
 468     else
 469     {
 470         backlight_fading_state = NOT_FADING;
 471         _backlight_fade_update_state(MIN_BRIGHTNESS_SETTING-1);
 472         _backlight_off();
 473 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 474         /* write the lowest brightness level to the hardware so that
 475          * fading up is glitch free */
 476         _backlight_set_brightness(MIN_BRIGHTNESS_SETTING);
 477 #endif
 478     }
 479 }
 480 #endif /* CONFIG_BACKLIGHT_FADING */
 481
 482 /* Update state of backlight according to timeout setting */
 483 static void backlight_update_state(void)
 484 {
 485
 486     int timeout = backlight_get_current_timeout();
 487
 488     /* Backlight == OFF in the setting? */
 489     if (UNLIKELY(timeout < 0))
 490     {
 491         backlight_timer = 0; /* Disable the timeout */
 492 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 493     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 494         backlight_setup_fade_down();
 495         /* necessary step to issue fading down when the setting is selected */
 496         queue_post(&backlight_queue, SYS_TIMEOUT, 0);
 497 #else
 498         _backlight_off();
 499 #ifdef HAVE_LCD_SLEEP
 500         backlight_lcd_sleep_countdown(true); /* start sleep countdown */
 501 #endif
 502 #endif
 503     }
 504     else
 505     {
 506         backlight_timer = timeout;
 507
 508 #ifdef HAVE_LCD_SLEEP
 509         backlight_lcd_sleep_countdown(false); /* wake up lcd */
 510 #endif
 511
 512 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 513     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 514         backlight_setup_fade_up();
 515 #else
 516         _backlight_on();
 517 #endif
 518     }
 519 }
 520
 521 #ifdef HAVE_REMOTE_LCD
 522 /* Update state of remote backlight according to timeout setting */
 523 static void remote_backlight_update_state(void)
 524 {
 525     int timeout = remote_backlight_get_current_timeout();
 526     /* Backlight == OFF in the setting? */
 527     if (timeout < 0)
 528     {
 529         remote_backlight_timer = 0; /* Disable the timeout */
 530         _remote_backlight_off();
 531     }
 532     else
 533     {
 534         remote_backlight_timer = timeout;
 535         _remote_backlight_on();
 536     }
 537 }
 538 #endif /* HAVE_REMOTE_LCD */
 539 static inline void do_backlight_off(void)
 540 {
 541     backlight_timer = 0;
 542 #if  (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 543     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 544     backlight_setup_fade_down();
 545 #else
 546     _backlight_off();
 547 #endif /* CONFIG_BACKLIGHT_FADING */
 548 }
 549
 550 void backlight_thread(void)
 551 {
 552     struct queue_event ev;
 553     bool locked = false;
 554
 555     while(1)
 556     {
 557 #if  (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 558     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 559         if (backlight_fading_state != NOT_FADING)
 560             queue_wait_w_tmo(&backlight_queue, &ev, FADE_DELAY);
 561         else
 562 #endif
 563             queue_wait_w_tmo(&backlight_queue, &ev, BACKLIGHT_THREAD_TIMEOUT);
 564         switch(ev.id)
 565         {   /* These events must always be processed */
 566 #ifdef _BACKLIGHT_FADE_BOOST
 567             case BACKLIGHT_FADE_FINISH:
 568                 cpu_boost(false);
 569                 break;
 570 #endif
 571 #ifdef _BACKLIGHT_FADE_ENABLE
 572             case BACKLIGHT_FADE_FINISH:
 573                 _backlight_hw_enable((bl_dim_current|bl_dim_target) != 0);
 574                 break;
 575 #endif
 576
 577 #ifndef SIMULATOR
 578             /* Here for now or else the aggressive init messes up scrolling */
 579 #ifdef HAVE_REMOTE_LCD
 580             case SYS_REMOTE_PLUGGED:
 581                 lcd_remote_on();
 582                 lcd_remote_update();
 583                 break;
 584
 585             case SYS_REMOTE_UNPLUGGED:
 586                 lcd_remote_off();
 587                 break;
 588 #elif defined HAVE_REMOTE_LCD_AS_MAIN
 589             case SYS_REMOTE_PLUGGED:
 590                 lcd_on();
 591                 lcd_update();
 592                 break;
 593
 594             case SYS_REMOTE_UNPLUGGED:
 595                 lcd_off();
 596                 break;
 597 #endif /* HAVE_REMOTE_LCD/ HAVE_REMOTE_LCD_AS_MAIN */
 598 #endif /* !SIMULATOR */
 599             case SYS_USB_CONNECTED:
 600                 usb_acknowledge(SYS_USB_CONNECTED_ACK);
 601                 break;
 602
 603             case SYS_USB_DISCONNECTED:
 604                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 605                 break;
 606
 607 #ifdef BACKLIGHT_DRIVER_CLOSE
 608             /* Get out of here */
 609             case BACKLIGHT_QUIT:
 610                 return;
 611 #endif
 612         }
 613         if (locked)
 614             continue;
 615
 616         switch(ev.id)
 617         {   /* These events are only processed if backlight isn't locked */
 618 #ifdef HAVE_REMOTE_LCD
 619             case REMOTE_BACKLIGHT_TMO_CHANGED:
 620             case REMOTE_BACKLIGHT_ON:
 621                 remote_backlight_update_state();
 622                 break;
 623
 624             case REMOTE_BACKLIGHT_OFF:
 625                 remote_backlight_timer = 0; /* Disable the timeout */
 626                 _remote_backlight_off();
 627                 break;
 628 #endif /* HAVE_REMOTE_LCD */
 629
 630             case BACKLIGHT_TMO_CHANGED:
 631             case BACKLIGHT_ON:
 632                 backlight_update_state();
 633                 break;
 634
 635             case BACKLIGHT_OFF:
 636                 do_backlight_off();
 637                 break;
 638 #ifdef HAVE_LCD_SLEEP
 639             case LCD_SLEEP:
 640                 lcd_sleep();
 641                 break;
 642 #endif
 643 #ifdef HAVE_BUTTON_LIGHT
 644             case BUTTON_LIGHT_TMO_CHANGED:
 645             case BUTTON_LIGHT_ON:
 646                 buttonlight_update_state();
 647                 break;
 648
 649             case BUTTON_LIGHT_OFF:
 650                 buttonlight_timer = 0;
 651                 _buttonlight_off();
 652                 break;
 653 #endif
 654
 655             case SYS_POWEROFF:  /* Lock backlight on poweroff so it doesn't */
 656                 locked = true;      /* go off before power is actually cut. */
 657                 /* fall through */
 658 #if CONFIG_CHARGING
 659             case SYS_CHARGER_CONNECTED:
 660             case SYS_CHARGER_DISCONNECTED:
 661 #endif
 662                 backlight_update_state();
 663 #ifdef HAVE_REMOTE_LCD
 664                 remote_backlight_update_state();
 665 #endif
 666                 break;
 667             case SYS_TIMEOUT:
 668 #if  (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 669     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 670                 if (backlight_fading_state != NOT_FADING)
 671                 {
 672                     if ((_backlight_fade_step(backlight_fading_state)))
 673                     {   /* finished fading */
 674 #ifdef HAVE_LCD_SLEEP
 675                         if (backlight_fading_state == FADING_DOWN)
 676                         {   /* start sleep countdown */
 677                              backlight_lcd_sleep_countdown(true);
 678                         }
 679 #endif
 680                         backlight_fading_state = NOT_FADING;
 681                     }
 682                 }
 683                 else
 684 #endif /* CONFIG_BACKLIGHT_FADING */
 685                     backlight_timeout_handler();
 686                 break;
 687         }
 688     } /* end while */
 689 }
 690
 691 static void backlight_timeout_handler(void)
 692 {
 693     if(backlight_timer > 0)
 694     {
 695         backlight_timer -= BACKLIGHT_THREAD_TIMEOUT;
 696         if(backlight_timer <= 0)
 697         {
 698             do_backlight_off();
 699         }
 700     }
 701 #ifdef HAVE_LCD_SLEEP
 702     else if(lcd_sleep_timer > 0)
 703     {
 704         lcd_sleep_timer -= BACKLIGHT_THREAD_TIMEOUT;
 705         if(lcd_sleep_timer <= 0)
 706         {
 707             lcd_sleep();
 708         }
 709     }
 710 #endif /* HAVE_LCD_SLEEP */
 711 #ifdef HAVE_REMOTE_LCD
 712     if(remote_backlight_timer > 0)
 713     {
 714         remote_backlight_timer -= BACKLIGHT_THREAD_TIMEOUT;
 715         if(remote_backlight_timer <= 0)
 716         {
 717             _remote_backlight_off();
 718         }
 719     }
 720 #endif /* HAVE_REMOVE_LCD */
 721 #ifdef HAVE_BUTTON_LIGHT
 722     if (buttonlight_timer > 0)
 723     {
 724         buttonlight_timer -= BACKLIGHT_THREAD_TIMEOUT;
 725         if (buttonlight_timer <= 0)
 726         {
 727             _buttonlight_off();
 728         }
 729     }
 730 #endif /* HAVE_BUTTON_LIGHT */
 731 }
 732
 733 void backlight_init(void)
 734 {
 735     queue_init(&backlight_queue, true);
 736
 737 #ifndef SIMULATOR
 738     if (_backlight_init())
 739     {
 740 #if (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_PWM)
 741         /* If backlight is already on, don't fade in. */
 742         bl_dim_target = BL_PWM_COUNT;
 743         bl_dim_fraction = (BL_PWM_COUNT<<16);
 744 #endif
 745     }
 746 #endif
 747     /* Leave all lights as set by the bootloader here. The settings load will
 748      * call the appropriate backlight_set_*() functions, only changing light
 749      * status if necessary. */
 750 #ifdef BACKLIGHT_DRIVER_CLOSE
 751     backlight_thread_id =
 752 #endif
 753     create_thread(backlight_thread, backlight_stack,
 754                   sizeof(backlight_stack), 0, backlight_thread_name
 755                   IF_PRIO(, PRIORITY_USER_INTERFACE)
 756                   IF_COP(, CPU));
 757 }
 758
 759 #ifdef BACKLIGHT_DRIVER_CLOSE
 760 void backlight_close(void)
 761 {
 762     unsigned int thread = backlight_thread_id;
 763
 764     /* Wait for thread to exit */
 765     if (thread == 0)
 766         return;
 767
 768     backlight_thread_id = 0;
 769
 770     queue_post(&backlight_queue, BACKLIGHT_QUIT, 0);
 771     thread_wait(thread);
 772 }
 773 #endif /* BACKLIGHT_DRIVER_CLOSE */
 774
 775 void backlight_on(void)
 776 {
 777     queue_remove_from_head(&backlight_queue, BACKLIGHT_ON);
 778     queue_post(&backlight_queue, BACKLIGHT_ON, 0);
 779 }
 780
 781 void backlight_off(void)
 782 {
 783     queue_post(&backlight_queue, BACKLIGHT_OFF, 0);
 784 }
 785
 786 /* returns true when the backlight is on,
 787  * and optionally when it's set to always off. */
 788 bool is_backlight_on(bool ignore_always_off)
 789 {
 790     int timeout = backlight_get_current_timeout();
 791     return (backlight_timer > 0)   /* countdown */
 792         || (timeout == 0) /* always on */
 793         || ((timeout < 0) && !ignore_always_off);
 794 }
 795
 796 /* return value in ticks; 0 means always on, <0 means always off */
 797 int backlight_get_current_timeout(void)
 798 {
 799 #ifdef HAS_BUTTON_HOLD
 800     if ((backlight_on_button_hold != 0)
 801 #ifdef HAVE_REMOTE_LCD_AS_MAIN
 802         && remote_button_hold()
 803 #else
 804         && button_hold()
 805 #endif
 806         )
 807         return (backlight_on_button_hold == 2) ? 0 : -1;
 808         /* always on or always off */
 809     else
 810 #endif
 811 #if CONFIG_CHARGING
 812         if (power_input_present())
 813             return backlight_timeout_plugged;
 814         else
 815 #endif
 816             return backlight_timeout_normal;
 817 }
 818
 819 void backlight_set_timeout(int value)
 820 {
 821     backlight_timeout_normal = HZ * value;
 822     queue_post(&backlight_queue, BACKLIGHT_TMO_CHANGED, 0);
 823 }
 824
 825 #if CONFIG_CHARGING
 826 void backlight_set_timeout_plugged(int value)
 827 {
 828     backlight_timeout_plugged = HZ * value;
 829     queue_post(&backlight_queue, BACKLIGHT_TMO_CHANGED, 0);
 830 }
 831 #endif /* CONFIG_CHARGING */
 832
 833 #ifdef HAS_BUTTON_HOLD
 834 /* Hold button change event handler. */
 835 void backlight_hold_changed(bool hold_button)
 836 {
 837     if (!hold_button || (backlight_on_button_hold > 0))
 838         /* if unlocked or override in effect */
 839         backlight_on();
 840 }
 841
 842 void backlight_set_on_button_hold(int index)
 843 {
 844     if ((unsigned)index >= 3)
 845         /* if given a weird value, use default */
 846         index = 0;
 847
 848     backlight_on_button_hold = index;
 849     queue_post(&backlight_queue, BACKLIGHT_TMO_CHANGED, 0);
 850 }
 851 #endif /* HAS_BUTTON_HOLD */
 852
 853 #ifdef HAVE_LCD_SLEEP_SETTING
 854 void lcd_set_sleep_after_backlight_off(int index)
 855 {
 856     if ((unsigned)index >= sizeof(lcd_sleep_timeout_value))
 857         /* if given a weird value, use default */
 858         index = 3;
 859
 860     lcd_sleep_timeout = HZ * lcd_sleep_timeout_value[index];
 861
 862     if (is_backlight_on(true))
 863         /* Timer will be set when bl turns off or bl set to on. */
 864         return;
 865
 866     /* Backlight is Off */
 867     if (lcd_sleep_timeout < 0)
 868         lcd_sleep_timer = 1; /* Always - sleep next tick */
 869     else
 870         lcd_sleep_timer = lcd_sleep_timeout; /* Never, other */
 871 }
 872 #endif /* HAVE_LCD_SLEEP_SETTING */
 873
 874 #ifdef HAVE_REMOTE_LCD
 875 void remote_backlight_on(void)
 876 {
 877     queue_post(&backlight_queue, REMOTE_BACKLIGHT_ON, 0);
 878 }
 879
 880 void remote_backlight_off(void)
 881 {
 882     queue_post(&backlight_queue, REMOTE_BACKLIGHT_OFF, 0);
 883 }
 884
 885 void remote_backlight_set_timeout(int value)
 886 {
 887     remote_backlight_timeout_normal = HZ * value;
 888     queue_post(&backlight_queue, REMOTE_BACKLIGHT_TMO_CHANGED, 0);
 889 }
 890
 891 #if CONFIG_CHARGING
 892 void remote_backlight_set_timeout_plugged(int value)
 893 {
 894     remote_backlight_timeout_plugged = HZ * value;
 895     queue_post(&backlight_queue, REMOTE_BACKLIGHT_TMO_CHANGED, 0);
 896 }
 897 #endif /* CONFIG_CHARGING */
 898
 899 #ifdef HAS_REMOTE_BUTTON_HOLD
 900 /* Remote hold button change event handler. */
 901 void remote_backlight_hold_changed(bool rc_hold_button)
 902 {
 903     if (!rc_hold_button || (remote_backlight_on_button_hold > 0))
 904         /* if unlocked or override */
 905         remote_backlight_on();
 906 }
 907
 908 void remote_backlight_set_on_button_hold(int index)
 909 {
 910     if ((unsigned)index >= 3)
 911         /* if given a weird value, use default */
 912         index = 0;
 913
 914     remote_backlight_on_button_hold = index;
 915     queue_post(&backlight_queue, REMOTE_BACKLIGHT_TMO_CHANGED, 0);
 916 }
 917 #endif /* HAS_REMOTE_BUTTON_HOLD */
 918
 919 /* return value in ticks; 0 means always on, <0 means always off */
 920 int remote_backlight_get_current_timeout(void)
 921 {
 922 #ifdef HAS_REMOTE_BUTTON_HOLD
 923     if (remote_button_hold() && (remote_backlight_on_button_hold != 0))
 924         return (remote_backlight_on_button_hold == 2)
 925                                  ? 0 : -1;  /* always on or always off */
 926     else
 927 #endif
 928 #if CONFIG_CHARGING
 929         if (power_input_present())
 930             return remote_backlight_timeout_plugged;
 931         else
 932 #endif
 933             return remote_backlight_timeout_normal;
 934 }
 935
 936 /* returns true when the backlight is on, and
 937  * optionally  when it's set to always off */
 938 bool is_remote_backlight_on(bool ignore_always_off)
 939 {
 940     int timeout = remote_backlight_get_current_timeout();
 941     return (remote_backlight_timer > 0)   /* countdown */
 942         || (timeout == 0) /* always on */
 943         || ((timeout < 0) && !ignore_always_off);
 944 }
 945
 946 #endif /* HAVE_REMOTE_LCD */
 947
 948 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
 949 void backlight_set_brightness(int val)
 950 {
 951     if (val < MIN_BRIGHTNESS_SETTING)
 952         val = MIN_BRIGHTNESS_SETTING;
 953     else if (val > MAX_BRIGHTNESS_SETTING)
 954         val = MAX_BRIGHTNESS_SETTING;
 955
 956     backlight_brightness = val;
 957     _backlight_set_brightness(val);
 958 #if  (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_SETTING) \
 959     || (CONFIG_BACKLIGHT_FADING == BACKLIGHT_FADING_SW_HW_REG)
 960     /* receive backlight brightness */
 961     _backlight_fade_update_state(val);
 962 #endif
 963 }
 964 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
 965
 966 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
 967 void buttonlight_set_brightness(int val)
 968 {
 969     if (val < MIN_BRIGHTNESS_SETTING)
 970         val = MIN_BRIGHTNESS_SETTING;
 971     else if (val > MAX_BRIGHTNESS_SETTING)
 972         val = MAX_BRIGHTNESS_SETTING;
 973
 974     _buttonlight_set_brightness(val);
 975 }
 976 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
 977
 978 #else /* !defined(HAVE_BACKLIGHT) || !defined(BACKLIGHT_FULL_INIT)
 979     -- no backlight, empty dummy functions */
 980
 981 #if defined(HAVE_BACKLIGHT) && !defined(BACKLIGHT_FULL_INIT)
 982 void backlight_init(void)
 983 {
 984     (void)_backlight_init();
 985     _backlight_on();
 986 }
 987 #endif
 988
 989 void backlight_on(void) {}
 990 void backlight_off(void) {}
 991 void buttonlight_on(void) {}
 992 void backlight_set_timeout(int value) {(void)value;}
 993
 994 bool is_backlight_on(bool ignore_always_off)
 995 {
 996     (void)ignore_always_off;
 997     return true;
 998 }
 999 #ifdef HAVE_REMOTE_LCD
1000 void remote_backlight_on(void) {}
1001 void remote_backlight_off(void) {}
1002 void remote_backlight_set_timeout(int value) {(void)value;}
1003
1004 bool is_remote_backlight_on(bool ignore_always_off)
1005 {
1006     (void)ignore_always_off;
1007     return true;
1008 }
1009 #endif /* HAVE_REMOTE_LCD */
1010 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
1011 void backlight_set_brightness(int val) { (void)val; }
1012 #endif
1013 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
1014 void buttonlight_set_brightness(int val) { (void)val; }
1015 #endif
1016 #endif /* defined(HAVE_BACKLIGHT) && defined(BACKLIGHT_FULL_INIT) */