1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 by Daniel Stenberg
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
23 * Rockbox button functions
32 #include "backlight.h"
35 #include "powermgmt.h"
37 #include "button-sdl.h"
39 #include "button-target.h"
42 #ifdef HAVE_REMOTE_LCD
43 #include "lcd-remote.h"
47 /* Older than MAX_EVENT_AGE button events are going to be ignored.
48 * Used to prevent for example volume going up uncontrollable when events
49 * are getting queued and UI is lagging too much.
51 #define MAX_EVENT_AGE HZ
54 struct event_queue button_queue
;
56 static long lastbtn
; /* Last valid button status */
57 static long last_read
; /* Last button status, for debouncing/filtering */
58 static intptr_t button_data
; /* data value from last message dequeued */
59 #ifdef HAVE_LCD_BITMAP
60 static bool flipped
; /* buttons can be flipped to match the LCD flip */
63 static bool filter_first_keypress
;
64 #ifdef HAVE_REMOTE_LCD
65 static bool remote_filter_first_keypress
;
67 #endif /* HAVE_BACKLIGHT */
68 #ifdef HAVE_HEADPHONE_DETECTION
69 static bool phones_present
= false;
72 /* how long until repeat kicks in, in ticks */
73 #define REPEAT_START 30
75 /* the speed repeat starts at, in ticks */
76 #define REPEAT_INTERVAL_START 16
78 /* speed repeat finishes at, in ticks */
79 #define REPEAT_INTERVAL_FINISH 5
81 #ifdef HAVE_BUTTON_DATA
82 static int button_read(int *data
);
84 static int button_read(void);
87 #ifdef HAVE_TOUCHSCREEN
88 static int last_touchscreen_touch
;
89 static int lastdata
= 0;
91 #if defined(HAVE_HEADPHONE_DETECTION)
92 static struct timeout hp_detect_timeout
; /* Debouncer for headphone plug/unplug */
93 /* This callback can be used for many different functions if needed -
94 just check to which object tmo points */
95 static int btn_detect_callback(struct timeout
*tmo
)
97 /* Try to post only transistions */
98 const long id
= tmo
->data
? SYS_PHONE_PLUGGED
: SYS_PHONE_UNPLUGGED
;
99 queue_remove_from_head(&button_queue
, id
);
100 queue_post(&button_queue
, id
, 0);
105 static void button_tick(void)
107 static int count
= 0;
108 static int repeat_speed
= REPEAT_INTERVAL_START
;
109 static int repeat_count
= 0;
110 static bool repeat
= false;
111 static bool post
= false;
112 #ifdef HAVE_BACKLIGHT
113 static bool skip_release
= false;
114 #ifdef HAVE_REMOTE_LCD
115 static bool skip_remote_release
= false;
120 #ifdef HAVE_BUTTON_DATA
126 #if defined(HAS_SERIAL_REMOTE) && !defined(SIMULATOR)
127 /* Post events for the remote control */
128 btn
= remote_control_rx();
131 queue_post(&button_queue
, btn
, 0);
135 #ifdef HAVE_BUTTON_DATA
136 btn
= button_read(&data
);
141 #if defined(HAVE_HEADPHONE_DETECTION)
142 if (headphones_inserted() != phones_present
)
144 /* Use the autoresetting oneshot to debounce the detection signal */
145 phones_present
= !phones_present
;
146 timeout_register(&hp_detect_timeout
, btn_detect_callback
,
151 /* Find out if a key has been released */
152 diff
= btn
^ lastbtn
;
153 if(diff
&& (btn
& diff
) == 0)
155 #ifdef HAVE_BACKLIGHT
156 #ifdef HAVE_REMOTE_LCD
157 if(diff
& BUTTON_REMOTE
)
158 if(!skip_remote_release
)
159 queue_post(&button_queue
, BUTTON_REL
| diff
, data
);
161 skip_remote_release
= false;
165 queue_post(&button_queue
, BUTTON_REL
| diff
, data
);
167 skip_release
= false;
169 queue_post(&button_queue
, BUTTON_REL
| diff
, data
);
176 /* normal keypress */
177 if ( btn
!= lastbtn
)
181 repeat_speed
= REPEAT_INTERVAL_START
;
191 /* yes we have repeat */
192 if (repeat_speed
> REPEAT_INTERVAL_FINISH
)
194 count
= repeat_speed
;
198 /* Send a SYS_POWEROFF event if we have a device
199 which doesn't shut down easily with the OFF
201 #ifdef HAVE_SW_POWEROFF
202 if ((btn
== POWEROFF_BUTTON
203 #ifdef RC_POWEROFF_BUTTON
204 || btn
== RC_POWEROFF_BUTTON
207 #if CONFIG_CHARGING && !defined(HAVE_POWEROFF_WHILE_CHARGING)
208 #if CONFIG_CHARGING >= CHARGING_MONITOR
211 !charger_inserted() &&
214 repeat_count
> POWEROFF_COUNT
)
216 /* Tell the main thread that it's time to
220 /* Safety net for players without hardware
223 if(repeat_count
> POWEROFF_COUNT
* 10)
232 if (count
++ > REPEAT_START
)
238 count
= REPEAT_INTERVAL_START
;
246 /* Only post repeat events if the queue is empty,
247 * to avoid afterscroll effects. */
248 if (queue_empty(&button_queue
))
250 queue_post(&button_queue
, BUTTON_REPEAT
| btn
, data
);
251 #ifdef HAVE_BACKLIGHT
252 #ifdef HAVE_REMOTE_LCD
253 skip_remote_release
= false;
255 skip_release
= false;
262 #ifdef HAVE_BACKLIGHT
263 #ifdef HAVE_REMOTE_LCD
264 if (btn
& BUTTON_REMOTE
) {
265 if (!remote_filter_first_keypress
266 || is_remote_backlight_on(false)
267 #if defined(IRIVER_H100_SERIES) || defined(IRIVER_H300_SERIES)
268 || (remote_type()==REMOTETYPE_H300_NONLCD
)
271 queue_post(&button_queue
, btn
, data
);
273 skip_remote_release
= true;
277 if (!filter_first_keypress
|| is_backlight_on(false)
279 || (btn
& BUTTON_REMOTE
)
282 queue_post(&button_queue
, btn
, data
);
285 #else /* no backlight, nothing to skip */
286 queue_post(&button_queue
, btn
, data
);
290 #ifdef HAVE_REMOTE_LCD
291 if(btn
& BUTTON_REMOTE
)
292 remote_backlight_on();
297 #ifdef HAVE_BUTTON_LIGHT
302 reset_poweroff_timer();
311 lastbtn
= btn
& ~(BUTTON_REL
| BUTTON_REPEAT
);
312 #ifdef HAVE_BUTTON_DATA
317 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
318 static void button_boost(bool state
)
320 static bool boosted
= false;
322 if (state
&& !boosted
)
327 else if (!state
&& boosted
)
333 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
335 int button_queue_count( void )
337 return queue_count(&button_queue
);
340 long button_get(bool block
)
342 struct queue_event ev
;
343 int pending_count
= queue_count(&button_queue
);
345 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
346 /* Control the CPU boost trying to keep queue empty. */
347 if (pending_count
== 0)
349 else if (pending_count
> 2)
353 if ( block
|| pending_count
)
355 queue_wait(&button_queue
, &ev
);
358 /* Ignore if the event was too old and for simplicity, just
359 * wait for a new button_get() request. */
360 if (current_tick
- ev
.tick
> MAX_EVENT_AGE
)
363 button_data
= ev
.data
;
370 long button_get_w_tmo(int ticks
)
372 struct queue_event ev
;
374 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
375 /* Be sure to keep boosted state. */
376 if (!queue_empty(&button_queue
))
377 return button_get(true);
382 queue_wait_w_tmo(&button_queue
, &ev
, ticks
);
383 if (ev
.id
== SYS_TIMEOUT
)
386 button_data
= ev
.data
;
390 intptr_t button_get_data(void)
395 void button_init(void)
397 /* Init used objects first */
398 queue_init(&button_queue
, true);
400 #ifdef HAVE_BUTTON_DATA
404 button_init_device();
406 #ifdef HAVE_BUTTON_DATA
408 lastbtn
= button_read(&temp
);
411 lastbtn
= button_read();
414 reset_poweroff_timer();
416 #ifdef HAVE_LCD_BITMAP
419 #ifdef HAVE_BACKLIGHT
420 filter_first_keypress
= false;
421 #ifdef HAVE_REMOTE_LCD
422 remote_filter_first_keypress
= false;
425 #ifdef HAVE_TOUCHSCREEN
426 last_touchscreen_touch
= 0xffff;
428 /* Start polling last */
429 tick_add_task(button_tick
);
433 #ifdef BUTTON_DRIVER_CLOSE
434 void button_close(void)
436 tick_remove_task(button_tick
);
438 #endif /* BUTTON_DRIVER_CLOSE */
442 * helper function to swap LEFT/RIGHT, UP/DOWN (if present), and F1/F3 (Recorder)
444 static int button_flip(int button
)
449 ~(BUTTON_LEFT
| BUTTON_RIGHT
450 #if defined(BUTTON_UP) && defined(BUTTON_DOWN)
451 | BUTTON_UP
| BUTTON_DOWN
453 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD)
454 | BUTTON_SCROLL_BACK
| BUTTON_SCROLL_FWD
456 #if CONFIG_KEYPAD == RECORDER_PAD
457 | BUTTON_F1
| BUTTON_F3
459 #if CONFIG_KEYPAD == SANSA_C200_PAD
460 | BUTTON_VOL_UP
| BUTTON_VOL_DOWN
462 #if CONFIG_KEYPAD == PHILIPS_SA9200_PAD
463 | BUTTON_VOL_UP
| BUTTON_VOL_DOWN
464 | BUTTON_NEXT
| BUTTON_PREV
468 if (button
& BUTTON_LEFT
)
469 newbutton
|= BUTTON_RIGHT
;
470 if (button
& BUTTON_RIGHT
)
471 newbutton
|= BUTTON_LEFT
;
472 #if defined(BUTTON_UP) && defined(BUTTON_DOWN)
473 if (button
& BUTTON_UP
)
474 newbutton
|= BUTTON_DOWN
;
475 if (button
& BUTTON_DOWN
)
476 newbutton
|= BUTTON_UP
;
478 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD)
479 if (button
& BUTTON_SCROLL_BACK
)
480 newbutton
|= BUTTON_SCROLL_FWD
;
481 if (button
& BUTTON_SCROLL_FWD
)
482 newbutton
|= BUTTON_SCROLL_BACK
;
484 #if CONFIG_KEYPAD == RECORDER_PAD
485 if (button
& BUTTON_F1
)
486 newbutton
|= BUTTON_F3
;
487 if (button
& BUTTON_F3
)
488 newbutton
|= BUTTON_F1
;
490 #if CONFIG_KEYPAD == SANSA_C200_PAD
491 if (button
& BUTTON_VOL_UP
)
492 newbutton
|= BUTTON_VOL_DOWN
;
493 if (button
& BUTTON_VOL_DOWN
)
494 newbutton
|= BUTTON_VOL_UP
;
496 #if CONFIG_KEYPAD == PHILIPS_SA9200_PAD
497 if (button
& BUTTON_VOL_UP
)
498 newbutton
|= BUTTON_VOL_DOWN
;
499 if (button
& BUTTON_VOL_DOWN
)
500 newbutton
|= BUTTON_VOL_UP
;
501 if (button
& BUTTON_NEXT
)
502 newbutton
|= BUTTON_PREV
;
503 if (button
& BUTTON_PREV
)
504 newbutton
|= BUTTON_NEXT
;
511 * set the flip attribute
512 * better only call this when the queue is empty
514 void button_set_flip(bool flip
)
516 if (flip
!= flipped
) /* not the current setting */
518 /* avoid race condition with the button_tick() */
519 int oldlevel
= disable_irq_save();
520 lastbtn
= button_flip(lastbtn
);
522 restore_irq(oldlevel
);
525 #endif /* HAVE_LCD_FLIP */
526 #endif /* SIMULATOR */
528 #ifdef HAVE_BACKLIGHT
529 void set_backlight_filter_keypress(bool value
)
531 filter_first_keypress
= value
;
533 #ifdef HAVE_REMOTE_LCD
534 void set_remote_backlight_filter_keypress(bool value
)
536 remote_filter_first_keypress
= value
;
542 * Get button pressed from hardware
544 #ifdef HAVE_BUTTON_DATA
545 static int button_read(int *data
)
547 int btn
= button_read_device(data
);
549 static int button_read(void)
551 int btn
= button_read_device();
557 btn
= button_flip(btn
); /* swap upside down */
558 #endif /* HAVE_LCD_FLIP */
560 #ifdef HAVE_TOUCHSCREEN
561 if (btn
& BUTTON_TOUCHSCREEN
)
562 last_touchscreen_touch
= current_tick
;
564 /* Filter the button status. It is only accepted if we get the same
565 status twice in a row. */
566 #ifndef HAVE_TOUCHSCREEN
567 if (btn
!= last_read
)
577 int button_status(void)
582 #ifdef HAVE_BUTTON_DATA
583 int button_status_wdata(int *pdata
)
590 void button_clear_queue(void)
592 queue_clear(&button_queue
);
595 #ifdef HAVE_TOUCHSCREEN
596 int touchscreen_last_touch(void)
598 return last_touchscreen_touch
;
602 #ifdef HAVE_WHEEL_ACCELERATION
603 /* WHEEL_ACCEL_FACTOR = 2^16 / WHEEL_ACCEL_START */
604 #define WHEEL_ACCEL_FACTOR (1<<16)/WHEEL_ACCEL_START
607 * [31] Use acceleration
608 * [30:24] Message post count (skipped + 1) (1-127)
609 * [23:0] Velocity - degree/sec
611 * WHEEL_ACCEL_FACTOR:
612 * Value in degree/sec -- configurable via settings -- above which
613 * the accelerated scrolling starts. Factor is internally scaled by
614 * 1<<16 in respect to the following 32bit integer operations.
616 int button_apply_acceleration(const unsigned int data
)
618 int delta
= (data
>> 24) & 0x7f;
620 if ((data
& (1 << 31)) != 0)
622 /* read driver's velocity from data */
623 unsigned int v
= data
& 0xffffff;
625 /* v = 28.4 fixed point */
626 v
= (WHEEL_ACCEL_FACTOR
* v
)>>(16-4);
628 /* Calculate real numbers item to scroll based upon acceleration
629 * setting, use correct roundoff */
630 #if (WHEEL_ACCELERATION == 1)
631 v
= (v
*v
+ (1<< 7))>> 8;
632 #elif (WHEEL_ACCELERATION == 2)
633 v
= (v
*v
*v
+ (1<<11))>>12;
634 #elif (WHEEL_ACCELERATION == 3)
635 v
= (v
*v
*v
*v
+ (1<<15))>>16;
644 #endif /* HAVE_WHEEL_ACCELERATION */