firmware/drivers/button.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Daniel Stenberg
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 /*
  23  * Rockbox button functions
  24  */
  25
  26 #include <stdlib.h>
  27 #include "config.h"
  28 #include "system.h"
  29 #include "button.h"
  30 #include "kernel.h"
  31 #include "thread.h"
  32 #include "backlight.h"
  33 #include "serial.h"
  34 #include "power.h"
  35 #include "powermgmt.h"
  36 #include "button-target.h"
  37
  38 #ifdef HAVE_REMOTE_LCD
  39 #include "lcd-remote.h"
  40 #endif
  41
  42 #ifndef SIMULATOR
  43 #if 0
  44 /* Older than MAX_EVENT_AGE button events are going to be ignored.
  45  * Used to prevent for example volume going up uncontrollable when events
  46  * are getting queued and UI is lagging too much.
  47  */
  48 #define MAX_EVENT_AGE  HZ
  49 #endif
  50
  51 struct event_queue button_queue;
  52
  53 static long lastbtn;   /* Last valid button status */
  54 static long last_read; /* Last button status, for debouncing/filtering */
  55 static intptr_t button_data; /* data value from last message dequeued */
  56 #ifdef HAVE_LCD_BITMAP
  57 static bool flipped;  /* buttons can be flipped to match the LCD flip */
  58 #endif
  59 #ifdef HAVE_BACKLIGHT
  60 static bool filter_first_keypress;
  61 #ifdef HAVE_REMOTE_LCD
  62 static bool remote_filter_first_keypress;
  63 #endif
  64 #endif /* HAVE_BACKLIGHT */
  65 #ifdef HAVE_HEADPHONE_DETECTION
  66 static bool phones_present = false;
  67 #endif
  68
  69 /* how long until repeat kicks in, in ticks */
  70 #define REPEAT_START      30
  71
  72 /* the speed repeat starts at, in ticks */
  73 #define REPEAT_INTERVAL_START   16
  74
  75 /* speed repeat finishes at, in ticks */
  76 #define REPEAT_INTERVAL_FINISH  5
  77
  78 #ifdef HAVE_BUTTON_DATA
  79 static int button_read(int *data);
  80 #else
  81 static int button_read(void);
  82 #endif
  83
  84 #if defined(HAVE_HEADPHONE_DETECTION)
  85 static struct timeout hp_detect_timeout; /* Debouncer for headphone plug/unplug */
  86 /* This callback can be used for many different functions if needed -
  87    just check to which object tmo points */
  88 static bool btn_detect_callback(struct timeout *tmo)
  89 {
  90     /* Try to post only transistions */
  91     const long id = tmo->data ? SYS_PHONE_PLUGGED : SYS_PHONE_UNPLUGGED;
  92     queue_remove_from_head(&button_queue, id);
  93     queue_post(&button_queue, id, 0);
  94     return false;
  95 }
  96 #endif
  97
  98 static void button_tick(void)
  99 {
 100     static int count = 0;
 101     static int repeat_speed = REPEAT_INTERVAL_START;
 102     static int repeat_count = 0;
 103     static bool repeat = false;
 104     static bool post = false;
 105 #ifdef HAVE_BACKLIGHT
 106     static bool skip_release = false;
 107 #ifdef HAVE_REMOTE_LCD
 108     static bool skip_remote_release = false;
 109 #endif
 110 #endif
 111     int diff;
 112     int btn;
 113 #ifdef HAVE_BUTTON_DATA
 114     int data = 0;
 115 #else
 116     const int data = 0;
 117 #endif
 118
 119 #ifdef HAS_SERIAL_REMOTE
 120     /* Post events for the remote control */
 121     btn = remote_control_rx();
 122     if(btn)
 123     {
 124         queue_post(&button_queue, btn, 0);
 125     }
 126 #endif
 127
 128 #ifdef HAVE_BUTTON_DATA
 129     btn = button_read(&data);
 130 #else
 131     btn = button_read();
 132 #endif
 133
 134 #if defined(HAVE_HEADPHONE_DETECTION)
 135     if (headphones_inserted() != phones_present)
 136     {
 137         /* Use the autoresetting oneshot to debounce the detection signal */
 138         phones_present = !phones_present;
 139         timeout_register(&hp_detect_timeout, btn_detect_callback,
 140                          HZ, phones_present);
 141     }
 142 #endif
 143
 144     /* Find out if a key has been released */
 145     diff = btn ^ lastbtn;
 146     if(diff && (btn & diff) == 0)
 147     {
 148 #ifdef HAVE_BACKLIGHT
 149 #ifdef HAVE_REMOTE_LCD
 150         if(diff & BUTTON_REMOTE)
 151             if(!skip_remote_release)
 152                 queue_post(&button_queue, BUTTON_REL | diff, data);
 153             else
 154                 skip_remote_release = false;
 155         else
 156 #endif
 157             if(!skip_release)
 158                 queue_post(&button_queue, BUTTON_REL | diff, data);
 159             else
 160                 skip_release = false;
 161 #else
 162         queue_post(&button_queue, BUTTON_REL | diff, data);
 163 #endif
 164     }
 165     else
 166     {
 167         if ( btn )
 168         {
 169             /* normal keypress */
 170             if ( btn != lastbtn )
 171             {
 172                 post = true;
 173                 repeat = false;
 174                 repeat_speed = REPEAT_INTERVAL_START;
 175             }
 176             else /* repeat? */
 177             {
 178                 if ( repeat )
 179                 {
 180                     if (!post)
 181                         count--;
 182                     if (count == 0) {
 183                         post = true;
 184                         /* yes we have repeat */
 185                         if (repeat_speed > REPEAT_INTERVAL_FINISH)
 186                             repeat_speed--;
 187                         count = repeat_speed;
 188
 189                         repeat_count++;
 190
 191                         /* Send a SYS_POWEROFF event if we have a device
 192                            which doesn't shut down easily with the OFF
 193                            key */
 194 #ifdef HAVE_SW_POWEROFF
 195                         if ((btn == POWEROFF_BUTTON
 196 #ifdef RC_POWEROFF_BUTTON
 197                                     || btn == RC_POWEROFF_BUTTON
 198 #endif
 199                                     ) &&
 200 #if CONFIG_CHARGING && !defined(HAVE_POWEROFF_WHILE_CHARGING)
 201                                 !charger_inserted() &&
 202 #endif
 203                                 repeat_count > POWEROFF_COUNT)
 204                         {
 205                             /* Tell the main thread that it's time to
 206                                power off */
 207                             sys_poweroff();
 208
 209                             /* Safety net for players without hardware
 210                                poweroff */
 211                             if(repeat_count > POWEROFF_COUNT * 10)
 212                                 power_off();
 213                         }
 214 #endif
 215                     }
 216                 }
 217                 else
 218                 {
 219                     if (count++ > REPEAT_START)
 220                     {
 221                         post = true;
 222                         repeat = true;
 223                         repeat_count = 0;
 224                         /* initial repeat */
 225                         count = REPEAT_INTERVAL_START;
 226                     }
 227                 }
 228             }
 229             if ( post )
 230             {
 231                 if (repeat)
 232                 {
 233                     /* Only post repeat events if the queue is empty,
 234                      * to avoid afterscroll effects. */
 235                     if (queue_empty(&button_queue))
 236                     {
 237                         queue_post(&button_queue, BUTTON_REPEAT | btn, data);
 238 #ifdef HAVE_BACKLIGHT
 239 #ifdef HAVE_REMOTE_LCD
 240                         skip_remote_release = false;
 241 #endif
 242                         skip_release = false;
 243 #endif
 244                         post = false;
 245                     }
 246                 }
 247                 else
 248                 {
 249 #ifdef HAVE_BACKLIGHT
 250 #ifdef HAVE_REMOTE_LCD
 251                     if (btn & BUTTON_REMOTE) {
 252                         if (!remote_filter_first_keypress
 253                             || is_remote_backlight_on(false)
 254 #if defined(IRIVER_H100_SERIES) || defined(IRIVER_H300_SERIES)
 255                             || (remote_type()==REMOTETYPE_H300_NONLCD)
 256 #endif
 257                             )
 258                             queue_post(&button_queue, btn, data);
 259                         else
 260                             skip_remote_release = true;
 261                     }
 262                     else
 263 #endif
 264                         if (!filter_first_keypress || is_backlight_on(false)
 265 #if BUTTON_REMOTE
 266                                 || (btn & BUTTON_REMOTE)
 267 #endif
 268                            )
 269                             queue_post(&button_queue, btn, data);
 270                         else
 271                             skip_release = true;
 272 #else /* no backlight, nothing to skip */
 273                     queue_post(&button_queue, btn, data);
 274 #endif
 275                     post = false;
 276                 }
 277 #ifdef HAVE_REMOTE_LCD
 278                 if(btn & BUTTON_REMOTE)
 279                     remote_backlight_on();
 280                 else
 281 #endif
 282                 {
 283                     backlight_on();
 284 #ifdef HAVE_BUTTON_LIGHT
 285                     buttonlight_on();
 286 #endif
 287                 }
 288
 289                 reset_poweroff_timer();
 290             }
 291         }
 292         else
 293         {
 294             repeat = false;
 295             count = 0;
 296         }
 297     }
 298     lastbtn = btn & ~(BUTTON_REL | BUTTON_REPEAT);
 299 }
 300
 301 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 302 static void button_boost(bool state)
 303 {
 304     static bool boosted = false;
 305
 306     if (state && !boosted)
 307     {
 308         cpu_boost(true);
 309         boosted = true;
 310     }
 311     else if (!state && boosted)
 312     {
 313         cpu_boost(false);
 314         boosted = false;
 315     }
 316 }
 317 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
 318
 319 int button_queue_count( void )
 320 {
 321     return queue_count(&button_queue);
 322 }
 323
 324 long button_get(bool block)
 325 {
 326     struct queue_event ev;
 327     int pending_count = queue_count(&button_queue);
 328
 329 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 330     /* Control the CPU boost trying to keep queue empty. */
 331     if (pending_count == 0)
 332         button_boost(false);
 333     else if (pending_count > 2)
 334         button_boost(true);
 335 #endif
 336
 337     if ( block || pending_count )
 338     {
 339         queue_wait(&button_queue, &ev);
 340
 341 #if 0
 342         /* Ignore if the event was too old and for simplicity, just
 343          * wait for a new button_get() request. */
 344         if (current_tick - ev.tick > MAX_EVENT_AGE)
 345             return BUTTON_NONE;
 346 #endif
 347         button_data = ev.data;
 348         return ev.id;
 349     }
 350
 351     return BUTTON_NONE;
 352 }
 353
 354 long button_get_w_tmo(int ticks)
 355 {
 356     struct queue_event ev;
 357
 358 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 359     /* Be sure to keep boosted state. */
 360     if (!queue_empty(&button_queue))
 361         return button_get(true);
 362
 363     button_boost(false);
 364 #endif
 365
 366     queue_wait_w_tmo(&button_queue, &ev, ticks);
 367     if (ev.id == SYS_TIMEOUT)
 368         ev.id = BUTTON_NONE;
 369     else
 370         button_data = ev.data;
 371
 372     return ev.id;
 373 }
 374
 375 intptr_t button_get_data(void)
 376 {
 377     return button_data;
 378 }
 379
 380 void button_init(void)
 381 {
 382     /* Init used objects first */
 383     queue_init(&button_queue, true);
 384
 385 #ifdef HAVE_BUTTON_DATA
 386     int temp;
 387 #endif
 388     /* hardware inits */
 389     button_init_device();
 390
 391 #ifdef HAVE_BUTTON_DATA
 392     button_read(&temp);
 393     lastbtn = button_read(&temp);
 394 #else
 395     button_read();
 396     lastbtn = button_read();
 397 #endif
 398
 399     reset_poweroff_timer();
 400
 401 #ifdef HAVE_LCD_BITMAP
 402     flipped = false;
 403 #endif
 404 #ifdef HAVE_BACKLIGHT
 405     filter_first_keypress = false;
 406 #ifdef HAVE_REMOTE_LCD
 407     remote_filter_first_keypress = false;
 408 #endif
 409 #endif
 410
 411     /* Start polling last */
 412     tick_add_task(button_tick);
 413 }
 414
 415 #ifdef BUTTON_DRIVER_CLOSE
 416 void button_close(void)
 417 {
 418     tick_remove_task(button_tick);
 419 }
 420 #endif /* BUTTON_DRIVER_CLOSE */
 421
 422 #ifdef HAVE_LCD_BITMAP /* only bitmap displays can be flipped */
 423 /*
 424  * helper function to swap LEFT/RIGHT, UP/DOWN (if present), and F1/F3 (Recorder)
 425  */
 426 static int button_flip(int button)
 427 {
 428     int newbutton;
 429
 430     newbutton = button &
 431         ~(BUTTON_LEFT | BUTTON_RIGHT
 432 #if defined(BUTTON_UP) && defined(BUTTON_DOWN)
 433         | BUTTON_UP | BUTTON_DOWN
 434 #endif
 435 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD)
 436         | BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD
 437 #endif
 438 #if CONFIG_KEYPAD == RECORDER_PAD
 439         | BUTTON_F1 | BUTTON_F3
 440 #endif
 441         );
 442
 443     if (button & BUTTON_LEFT)
 444         newbutton |= BUTTON_RIGHT;
 445     if (button & BUTTON_RIGHT)
 446         newbutton |= BUTTON_LEFT;
 447 #if defined(BUTTON_UP) && defined(BUTTON_DOWN)
 448     if (button & BUTTON_UP)
 449         newbutton |= BUTTON_DOWN;
 450     if (button & BUTTON_DOWN)
 451         newbutton |= BUTTON_UP;
 452 #endif
 453 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD)
 454     if (button & BUTTON_SCROLL_BACK)
 455         newbutton |= BUTTON_SCROLL_FWD;
 456     if (button & BUTTON_SCROLL_FWD)
 457         newbutton |= BUTTON_SCROLL_BACK;
 458 #endif
 459 #if CONFIG_KEYPAD == RECORDER_PAD
 460     if (button & BUTTON_F1)
 461         newbutton |= BUTTON_F3;
 462     if (button & BUTTON_F3)
 463         newbutton |= BUTTON_F1;
 464 #endif
 465
 466     return newbutton;
 467 }
 468
 469 /*
 470  * set the flip attribute
 471  * better only call this when the queue is empty
 472  */
 473 void button_set_flip(bool flip)
 474 {
 475     if (flip != flipped) /* not the current setting */
 476     {
 477         /* avoid race condition with the button_tick() */
 478         int oldlevel = disable_irq_save();
 479         lastbtn = button_flip(lastbtn);
 480         flipped = flip;
 481         restore_irq(oldlevel);
 482     }
 483 }
 484 #endif /* HAVE_LCD_BITMAP */
 485
 486 #ifdef HAVE_BACKLIGHT
 487 void set_backlight_filter_keypress(bool value)
 488 {
 489     filter_first_keypress = value;
 490 }
 491 #ifdef HAVE_REMOTE_LCD
 492 void set_remote_backlight_filter_keypress(bool value)
 493 {
 494     remote_filter_first_keypress = value;
 495 }
 496 #endif
 497 #endif
 498
 499 /*
 500  * Get button pressed from hardware
 501  */
 502 #ifdef HAVE_BUTTON_DATA
 503 static int button_read(int *data)
 504 {
 505     int btn = button_read_device(data);
 506 #else
 507 static int button_read(void)
 508 {
 509     int btn = button_read_device();
 510 #endif
 511     int retval;
 512
 513 #ifdef HAVE_LCD_BITMAP
 514     if (btn && flipped)
 515         btn = button_flip(btn); /* swap upside down */
 516 #endif
 517
 518     /* Filter the button status. It is only accepted if we get the same
 519        status twice in a row. */
 520 #ifndef HAVE_TOUCHPAD
 521     if (btn != last_read)
 522             retval = lastbtn;
 523     else
 524 #endif
 525         retval = btn;
 526     last_read = btn;
 527
 528     return retval;
 529 }
 530
 531
 532 int button_status(void)
 533 {
 534     return lastbtn;
 535 }
 536
 537 void button_clear_queue(void)
 538 {
 539     queue_clear(&button_queue);
 540 }
 541
 542 #endif /* SIMULATOR */
 543
 544 #ifdef HAVE_SCROLLWHEEL
 545 /* WHEEL_ACCEL_FACTOR = 2^16 / WHEEL_ACCEL_START */
 546 #define WHEEL_ACCEL_FACTOR (1<<16)/WHEEL_ACCEL_START
 547 /**
 548  * data:
 549  *    [31] Use acceleration
 550  * [30:24] Message post count (skipped + 1) (1-127)
 551  *  [23:0] Velocity - degree/sec
 552  *
 553  * WHEEL_ACCEL_FACTOR:
 554  * Value in degree/sec -- configurable via settings -- above which
 555  * the accelerated scrolling starts. Factor is internally scaled by
 556  * 1<<16 in respect to the following 32bit integer operations.
 557  */
 558 int button_apply_acceleration(const unsigned int data)
 559 {
 560     int delta = (data >> 24) & 0x7f;
 561
 562     if ((data & (1 << 31)) != 0)
 563     {
 564         /* read driver's velocity from data */
 565         unsigned int v = data & 0xffffff;
 566
 567         /* v = 28.4 fixed point */
 568         v = (WHEEL_ACCEL_FACTOR * v)>>(16-4);
 569
 570         /* Calculate real numbers item to scroll based upon acceleration
 571          * setting, use correct roundoff */
 572 #if   (WHEEL_ACCELERATION == 1)
 573         v = (v*v     + (1<< 7))>> 8;
 574 #elif (WHEEL_ACCELERATION == 2)
 575         v = (v*v*v   + (1<<11))>>12;
 576 #elif (WHEEL_ACCELERATION == 3)
 577         v = (v*v*v*v + (1<<15))>>16;
 578 #endif
 579
 580         if (v > 1)
 581             delta *= v;
 582     }
 583
 584     return delta;
 585 }
 586 #endif /* HAVE_SCROLLWHEEL */