apps/plugins/battery_bench.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  *
  11  * Copyright (C) 2006 Alexander Spyridakis, Hristo Kovachev
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22
  23 #include "version.h"
  24 #include "plugin.h"
  25 PLUGIN_HEADER
  26
  27 #define BATTERY_LOG "/battery_bench.txt"
  28 #define BUF_SIZE 16000
  29
  30 #define EV_EXIT 1337
  31
  32 /* seems to work with 1300, but who knows... */
  33 #define THREAD_STACK_SIZE DEFAULT_STACK_SIZE + 0x200
  34
  35 #if CONFIG_KEYPAD == RECORDER_PAD
  36
  37 #define BATTERY_ON BUTTON_PLAY
  38 #define BATTERY_OFF BUTTON_OFF
  39 #define BATTERY_ON_TXT  "PLAY - start"
  40 #define BATTERY_OFF_TXT "OFF"
  41
  42 #if BUTTON_REMOTE != 0
  43 #define BATTERY_RC_ON BUTTON_RC_PLAY
  44 #define BATTERY_RC_OFF BUTTON_RC_STOP
  45 #endif
  46
  47 #elif CONFIG_KEYPAD == ONDIO_PAD
  48
  49 #define BATTERY_ON BUTTON_RIGHT
  50 #define BATTERY_OFF BUTTON_OFF
  51 #define BATTERY_ON_TXT  "RIGHT - start"
  52 #define BATTERY_OFF_TXT "OFF"
  53
  54 #elif CONFIG_KEYPAD == PLAYER_PAD
  55
  56 #define BATTERY_ON BUTTON_PLAY
  57 #define BATTERY_OFF BUTTON_STOP
  58 #define BATTERY_ON_TXT  "PLAY - start"
  59 #define BATTERY_OFF_TXT "STOP"
  60
  61 #define BATTERY_RC_ON BUTTON_RC_PLAY
  62 #define BATTERY_RC_OFF BUTTON_RC_STOP
  63
  64 #elif (CONFIG_KEYPAD == IRIVER_H100_PAD) || \
  65       (CONFIG_KEYPAD == IRIVER_H300_PAD)
  66
  67 #define BATTERY_ON BUTTON_ON
  68 #define BATTERY_RC_ON BUTTON_RC_ON
  69
  70 #define BATTERY_OFF BUTTON_OFF
  71 #define BATTERY_RC_OFF BUTTON_RC_STOP
  72
  73 #define BATTERY_ON_TXT  "PLAY - start"
  74 #define BATTERY_OFF_TXT "STOP"
  75
  76 #elif (CONFIG_KEYPAD == IPOD_4G_PAD) || \
  77       (CONFIG_KEYPAD == IPOD_3G_PAD) || \
  78       (CONFIG_KEYPAD == IPOD_1G2G_PAD)
  79
  80 #define BATTERY_ON  BUTTON_PLAY
  81 #define BATTERY_OFF BUTTON_MENU
  82 #define BATTERY_ON_TXT  "PLAY - start"
  83 #define BATTERY_OFF_TXT "MENU"
  84
  85 #elif CONFIG_KEYPAD == IAUDIO_X5M5_PAD
  86
  87 #define BATTERY_ON  BUTTON_SELECT
  88 #define BATTERY_OFF BUTTON_POWER
  89 #define BATTERY_ON_TXT  "SELECT - start"
  90 #define BATTERY_OFF_TXT "POWER"
  91
  92 #elif CONFIG_KEYPAD == IRIVER_IFP7XX_PAD
  93
  94 #define BATTERY_ON  BUTTON_SELECT
  95 #define BATTERY_OFF BUTTON_PLAY
  96 #define BATTERY_ON_TXT  "SELECT - start"
  97 #define BATTERY_OFF_TXT "PLAY"
  98
  99 #elif (CONFIG_KEYPAD == SANSA_E200_PAD) || \
 100       (CONFIG_KEYPAD == SANSA_C200_PAD) || \
 101       (CONFIG_KEYPAD == SANSA_CLIP_PAD) || \
 102       (CONFIG_KEYPAD == SANSA_M200_PAD)
 103 #define BATTERY_ON BUTTON_SELECT
 104 #define BATTERY_OFF BUTTON_POWER
 105 #define BATTERY_ON_TXT  "SELECT - start"
 106 #define BATTERY_OFF_TXT "POWER"
 107
 108 #elif (CONFIG_KEYPAD == SANSA_FUZE_PAD)
 109 #define BATTERY_ON BUTTON_SELECT
 110 #define BATTERY_OFF BUTTON_HOME
 111 #define BATTERY_ON_TXT  "SELECT - start"
 112 #define BATTERY_OFF_TXT "HOME"
 113
 114 #elif CONFIG_KEYPAD == IRIVER_H10_PAD
 115
 116 #define BATTERY_ON  BUTTON_PLAY
 117 #define BATTERY_OFF BUTTON_POWER
 118 #define BATTERY_ON_TXT  "PLAY  - start"
 119 #define BATTERY_OFF_TXT "POWER"
 120
 121 #elif CONFIG_KEYPAD == GIGABEAT_PAD
 122
 123 #define BATTERY_ON  BUTTON_SELECT
 124 #define BATTERY_OFF BUTTON_POWER
 125 #define BATTERY_ON_TXT  "SELECT - start"
 126 #define BATTERY_OFF_TXT "POWER"
 127
 128 #elif CONFIG_KEYPAD == GIGABEAT_S_PAD
 129
 130 #define BATTERY_ON  BUTTON_SELECT
 131 #define BATTERY_OFF BUTTON_BACK
 132 #define BATTERY_ON_TXT  "SELECT - start"
 133 #define BATTERY_OFF_TXT "BACK"
 134
 135 #elif CONFIG_KEYPAD == MROBE500_PAD
 136
 137 #define BATTERY_ON  BUTTON_RC_PLAY
 138 #define BATTERY_OFF BUTTON_POWER
 139 #define BATTERY_ON_TXT  "PLAY - start"
 140 #define BATTERY_OFF_TXT "POWER"
 141
 142 #elif CONFIG_KEYPAD == MROBE100_PAD
 143
 144 #define BATTERY_ON  BUTTON_SELECT
 145 #define BATTERY_OFF BUTTON_POWER
 146 #define BATTERY_ON_TXT  "SELECT - start"
 147 #define BATTERY_OFF_TXT "POWER"
 148
 149 #elif CONFIG_KEYPAD == IAUDIO_M3_PAD
 150
 151 #define BATTERY_ON  BUTTON_PLAY
 152 #define BATTERY_OFF BUTTON_REC
 153 #define BATTERY_RC_ON  BUTTON_RC_PLAY
 154 #define BATTERY_RC_OFF BUTTON_RC_REC
 155 #define BATTERY_ON_TXT  "PLAY - start"
 156 #define BATTERY_OFF_TXT "REC"
 157
 158 #elif CONFIG_KEYPAD == COWON_D2_PAD
 159
 160 #define BATTERY_OFF BUTTON_POWER
 161 #define BATTERY_OFF_TXT "POWER"
 162
 163 #elif CONFIG_KEYPAD == IAUDIO67_PAD
 164
 165 #define BATTERY_OFF BUTTON_POWER
 166 #define BATTERY_OFF_TXT "POWER"
 167 #define BATTERY_ON BUTTON_PLAY
 168 #define BATTERY_ON_TXT  "PLAY - start"
 169
 170 #elif CONFIG_KEYPAD == CREATIVEZVM_PAD
 171 #define BATTERY_ON BUTTON_PLAY
 172 #define BATTERY_ON_TXT  "PLAY - start"
 173 #define BATTERY_OFF BUTTON_BACK
 174 #define BATTERY_OFF_TXT "BACK"
 175
 176 #elif CONFIG_KEYPAD == PHILIPS_HDD1630_PAD
 177
 178 #define BATTERY_ON  BUTTON_MENU
 179 #define BATTERY_OFF BUTTON_POWER
 180 #define BATTERY_ON_TXT  "MENU - start"
 181 #define BATTERY_OFF_TXT "POWER"
 182
 183 #elif CONFIG_KEYPAD == PHILIPS_SA9200_PAD
 184
 185 #define BATTERY_ON  BUTTON_MENU
 186 #define BATTERY_OFF BUTTON_POWER
 187 #define BATTERY_ON_TXT  "MENU - start"
 188 #define BATTERY_OFF_TXT "POWER"
 189
 190 #elif CONFIG_KEYPAD == ONDAVX747_PAD
 191
 192 #define BATTERY_OFF BUTTON_POWER
 193 #define BATTERY_OFF_TXT "POWER"
 194 #elif CONFIG_KEYPAD == ONDAVX777_PAD
 195
 196 #define BATTERY_OFF BUTTON_POWER
 197 #define BATTERY_OFF_TXT "POWER"
 198
 199 #elif CONFIG_KEYPAD == SAMSUNG_YH_PAD
 200
 201 #define BATTERY_ON      BUTTON_LEFT
 202 #define BATTERY_OFF     BUTTON_RIGHT
 203 #define BATTERY_ON_TXT  "LEFT"
 204 #define BATTERY_OFF_TXT "RIGHT"
 205
 206 #elif CONFIG_KEYPAD == PBELL_VIBE500_PAD
 207
 208 #define BATTERY_ON  BUTTON_PLAY
 209 #define BATTERY_OFF BUTTON_REC
 210 #define BATTERY_ON_TXT  "PLAY - start"
 211 #define BATTERY_OFF_TXT "REC"
 212
 213 #elif CONFIG_KEYPAD == MPIO_HD200_PAD
 214 #define BATTERY_ON  BUTTON_PLAY
 215 #define BATTERY_OFF BUTTON_REC
 216 #define BATTERY_ON_TXT  "PLAY - start"
 217 #define BATTERY_OFF_TXT "REC"
 218
 219 #else
 220 #error No keymap defined!
 221 #endif
 222
 223 #ifdef HAVE_TOUCHSCREEN
 224 #ifndef BATTERY_ON
 225 #define BATTERY_ON       BUTTON_CENTER
 226 #endif
 227 #ifndef BATTERY_OFF
 228 #define BATTERY_OFF      BUTTON_TOPLEFT
 229 #endif
 230 #ifndef BATTERY_ON_TXT
 231 #define BATTERY_ON_TXT  "CENTRE - start"
 232 #endif
 233 #ifndef BATTERY_OFF_TXT
 234 #define BATTERY_OFF_TXT "TOPLEFT"
 235 #endif
 236 #endif
 237
 238 /****************************** Plugin Entry Point ****************************/
 239 int main(void);
 240 bool exit_tsr(bool);
 241 void thread(void);
 242
 243
 244 enum plugin_status plugin_start(const void* parameter)
 245 {
 246     (void)parameter;
 247
 248     return main();
 249 }
 250
 251 /* Struct for battery information */
 252 struct batt_info
 253 {
 254     /* the size of the struct elements is optimised to make the struct size
 255      * a power of 2 */
 256     long ticks;
 257     int eta;
 258     unsigned int voltage;
 259     short level;
 260     unsigned short flags;
 261 } bat[BUF_SIZE/sizeof(struct batt_info)];
 262
 263 #define BUF_ELEMENTS    (sizeof(bat)/sizeof(struct batt_info))
 264
 265 static unsigned int thread_id;
 266 static struct event_queue thread_q;
 267 static bool in_usb_mode;
 268 static unsigned int buf_idx;
 269
 270 bool exit_tsr(bool reenter)
 271 {
 272     long button;
 273     (void)reenter;
 274     rb->lcd_clear_display();
 275     rb->lcd_puts_scroll(0, 0, "Batt.Bench is currently running.");
 276     rb->lcd_puts_scroll(0, 1, "Press " BATTERY_OFF_TXT " to cancel the test");
 277 #ifdef HAVE_LCD_BITMAP
 278     rb->lcd_puts_scroll(0, 2, "Anything else will resume");
 279 #endif
 280     rb->lcd_update();
 281
 282     while (1)
 283     {
 284         button = rb->button_get(true);
 285         if (IS_SYSEVENT(button))
 286             continue;
 287         if (button == BATTERY_OFF)
 288         {
 289             rb->queue_post(&thread_q, EV_EXIT, 0);
 290             rb->thread_wait(thread_id);
 291             /* remove the thread's queue from the broadcast list */
 292             rb->queue_delete(&thread_q);
 293             return true;
 294         }
 295         else return false;
 296     }
 297 }
 298
 299 #define BIT_CHARGER     0x1
 300 #define BIT_CHARGING    0x2
 301 #define BIT_USB_POWER   0x4
 302
 303 #define HMS(x) (x)/3600,((x)%3600)/60,((x)%3600)%60
 304
 305 /* use long for aligning */
 306 unsigned long thread_stack[THREAD_STACK_SIZE/sizeof(long)];
 307
 308 #if CONFIG_CHARGING || defined(HAVE_USB_POWER)
 309 static unsigned int charge_state(void)
 310 {
 311     unsigned int ret = 0;
 312 #if CONFIG_CHARGING
 313     if (rb->charger_inserted())
 314         ret = BIT_CHARGER;
 315 #if CONFIG_CHARGING >= CHARGING_MONITOR
 316     if (rb->charging_state())
 317         ret |= BIT_CHARGING;
 318 #endif
 319 #endif
 320 #ifdef HAVE_USB_POWER
 321     if (rb->usb_powered())
 322         ret |= BIT_USB_POWER;
 323 #endif
 324     return ret;
 325 }
 326 #endif
 327
 328
 329 static void flush_buffer(void* data)
 330 {
 331     (void)data;
 332     int fd, secs;
 333     unsigned int i;
 334
 335     /* don't access the disk when in usb mode, or when no data is available */
 336     if (in_usb_mode || (buf_idx == 0))
 337         return;
 338
 339     fd = rb->open(BATTERY_LOG, O_RDWR | O_CREAT | O_APPEND, 0666);
 340     if (fd < 0)
 341         return;
 342
 343     for (i = 0; i < buf_idx; i++)
 344     {
 345         secs = bat[i].ticks/HZ;
 346         rb->fdprintf(fd,
 347                 "%02d:%02d:%02d,  %05d,     %03d%%,     "
 348                 "%02d:%02d,         %04d,   "
 349 #if CONFIG_CHARGING
 350                 "  %c"
 351 #if CONFIG_CHARGING >= CHARGING_MONITOR
 352                 ",  %c"
 353 #endif
 354 #endif
 355 #ifdef HAVE_USB_POWER
 356                 ",  %c"
 357 #endif
 358                 "\n",
 359
 360                 HMS(secs), secs, bat[i].level,
 361                 bat[i].eta / 60, bat[i].eta % 60,
 362                 bat[i].voltage
 363 #if CONFIG_CHARGING
 364                 , (bat[i].flags & BIT_CHARGER) ? 'A' : '-'
 365 #if CONFIG_CHARGING >= CHARGING_MONITOR
 366                 , (bat[i].flags & BIT_CHARGING) ? 'C' : '-'
 367 #endif
 368 #endif
 369 #ifdef HAVE_USB_POWER
 370                 , (bat[i].flags & BIT_USB_POWER) ? 'U' : '-'
 371 #endif
 372         );
 373     }
 374     rb->close(fd);
 375
 376     buf_idx = 0;
 377 }
 378
 379
 380 void thread(void)
 381 {
 382     bool exit = false;
 383     char *exit_reason = "unknown";
 384     long sleep_time = 60 * HZ;
 385     struct queue_event ev;
 386     int fd;
 387
 388     in_usb_mode = false;
 389     buf_idx = 0;
 390
 391     while (!exit)
 392     {
 393         /* add data to buffer */
 394         if (buf_idx < BUF_ELEMENTS)
 395         {
 396             bat[buf_idx].ticks = *rb->current_tick;
 397             bat[buf_idx].level = rb->battery_level();
 398             bat[buf_idx].eta = rb->battery_time();
 399             bat[buf_idx].voltage = rb->battery_voltage();
 400 #if CONFIG_CHARGING || defined(HAVE_USB_POWER)
 401             bat[buf_idx].flags = charge_state();
 402 #endif
 403             buf_idx++;
 404             rb->register_storage_idle_func(flush_buffer);
 405         }
 406
 407         /* What to do when the measurement buffer is full:
 408            1) save our measurements to disk but waste some power doing so?
 409            2) throw away measurements to save some power?
 410            The choice made here is to save the measurements. It is quite unusual
 411            for this to occur because it requires > 16 hours of no disk activity.
 412          */
 413         if (buf_idx == BUF_ELEMENTS) {
 414             flush_buffer(NULL);
 415         }
 416
 417         /* sleep some time until next measurement */
 418         rb->queue_wait_w_tmo(&thread_q, &ev, sleep_time);
 419         switch (ev.id)
 420         {
 421             case SYS_USB_CONNECTED:
 422                 in_usb_mode = true;
 423                 rb->usb_acknowledge(SYS_USB_CONNECTED_ACK);
 424                 break;
 425             case SYS_USB_DISCONNECTED:
 426                 in_usb_mode = false;
 427                 rb->usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 428                 break;
 429             case SYS_POWEROFF:
 430                 exit_reason = "power off";
 431                 exit = true;
 432                 break;
 433             case EV_EXIT:
 434 #ifdef HAVE_LCD_BITMAP
 435                 rb->splash(HZ, "Exiting battery_bench...");
 436 #else
 437                 rb->splash(HZ, "bench exit");
 438 #endif
 439                 exit_reason = "plugin exit";
 440                 exit = true;
 441                 break;
 442         }
 443     }
 444
 445     /* unregister flush callback and flush to disk */
 446     rb->unregister_storage_idle_func(flush_buffer, true);
 447
 448     /* log end of bench and exit reason */
 449     fd = rb->open(BATTERY_LOG, O_RDWR | O_CREAT | O_APPEND, 0666);
 450     if (fd >= 0)
 451     {
 452         rb->fdprintf(fd, "--Battery bench ended, reason: %s--\n", exit_reason);
 453         rb->close(fd);
 454     }
 455 }
 456
 457
 458 #ifdef HAVE_LCD_BITMAP
 459 typedef void (*plcdfunc)(int x, int y, const unsigned char *str);
 460
 461 static void put_centered_str(const char* str, plcdfunc putsxy, int lcd_width, int line)
 462 {
 463     int strwdt, strhgt;
 464     rb->lcd_getstringsize(str, &strwdt, &strhgt);
 465     putsxy((lcd_width - strwdt)/2, line*(strhgt), str);
 466 }
 467 #endif
 468
 469 int main(void)
 470 {
 471     int button, fd;
 472     bool on = false;
 473 #ifdef HAVE_LCD_BITMAP
 474     int i;
 475     const char *msgs[] = { "Battery Benchmark","Check file", BATTERY_LOG,
 476                            "for more info", BATTERY_ON_TXT, BATTERY_OFF_TXT " - quit" };
 477 #endif
 478     rb->lcd_clear_display();
 479
 480 #ifdef HAVE_LCD_BITMAP
 481     rb->lcd_clear_display();
 482     rb->lcd_setfont(FONT_SYSFIXED);
 483
 484     for (i = 0; i<(int)(sizeof(msgs)/sizeof(char *)); i++)
 485         put_centered_str(msgs[i],rb->lcd_putsxy,LCD_WIDTH,i+1);
 486 #else
 487     rb->lcd_puts_scroll(0, 0, "Batt.Bench.");
 488     rb->lcd_puts_scroll(0, 1, "PLAY/STOP");
 489 #endif
 490     rb->lcd_update();
 491
 492 #ifdef HAVE_REMOTE_LCD
 493     rb->lcd_remote_clear_display();
 494     put_centered_str(msgs[0],rb->lcd_remote_putsxy,LCD_REMOTE_WIDTH,0);
 495     put_centered_str(msgs[sizeof(msgs)/sizeof(char*)-2],
 496                     rb->lcd_remote_putsxy,LCD_REMOTE_WIDTH,1);
 497     put_centered_str(msgs[sizeof(msgs)/sizeof(char*)-1],
 498                     rb->lcd_remote_putsxy,LCD_REMOTE_WIDTH,2);
 499     rb->lcd_remote_update();
 500 #endif
 501
 502     do
 503     {
 504         button = rb->button_get(true);
 505         switch (button)
 506         {
 507             case BATTERY_ON:
 508 #ifdef BATTERY_RC_ON
 509             case BATTERY_RC_ON:
 510 #endif
 511                 on = true;
 512                 break;
 513             case BATTERY_OFF:
 514 #ifdef BATTERY_RC_OFF
 515             case BATTERY_RC_OFF:
 516 #endif
 517                 return PLUGIN_OK;
 518
 519             default:
 520                 if (rb->default_event_handler(button) == SYS_USB_CONNECTED)
 521                     return PLUGIN_USB_CONNECTED;
 522         }
 523     }while(!on);
 524
 525     fd = rb->open(BATTERY_LOG, O_RDONLY);
 526     if (fd < 0)
 527     {
 528         fd = rb->open(BATTERY_LOG, O_RDWR | O_CREAT, 0666);
 529         if (fd >= 0)
 530         {
 531             rb->fdprintf(fd,
 532                 "# This plugin will log your battery performance in a\n"
 533                 "# file (%s) every minute.\n"
 534                 "# To properly test your battery:\n"
 535                 "# 1) Select and playback an album. "
 536                 "# (Be sure to be more than the player's buffer)\n"
 537                 "# 2) Set to repeat.\n"
 538                 "# 3) Let the player run completely out of battery.\n"
 539                 "# 4) Recharge and copy (or whatever you want) the txt file to "
 540                 "# your computer.\n"
 541                 "# Now you can make graphs with the data of the battery log.\n"
 542                 "# Do not enter another plugin during the test or else the \n"
 543                 "# logging activity will end.\n\n"
 544                 "# P.S: You can decide how you will make your tests.\n"
 545                 "# Just don't open another plugin to be sure that your log "
 546                 "will continue.\n\n",BATTERY_LOG);
 547             rb->fdprintf(fd,
 548                 "# Battery bench run for %s version %s\n\n"
 549                 ,MODEL_NAME,rb->rbversion);
 550
 551             rb->fdprintf(fd,
 552                 "# Battery type: %d mAh      Buffer Entries: %d\n"
 553                 "# Time:,  Seconds:,  Level:,  Time Left:,  Voltage[mV]:"
 554 #if CONFIG_CHARGING
 555                 ", C:"
 556 #endif
 557 #if CONFIG_CHARGING >= CHARGING_MONITOR
 558                 ", S:"
 559 #endif
 560 #ifdef HAVE_USB_POWER
 561                 ", U:"
 562 #endif
 563                 "\n"
 564                 ,rb->global_settings->battery_capacity,
 565                 (int)BUF_ELEMENTS);
 566             rb->close(fd);
 567         }
 568         else
 569         {
 570             rb->splash(HZ / 2, "Cannot create file!");
 571             return PLUGIN_ERROR;
 572         }
 573     }
 574     else
 575     {
 576         rb->close(fd);
 577         fd = rb->open(BATTERY_LOG, O_RDWR | O_APPEND);
 578         rb->fdprintf(fd, "\n--File already present. Resuming Benchmark--\n");
 579         rb->fdprintf(fd,
 580             "Battery bench run for %s version %s\n\n"
 581             ,MODEL_NAME,rb->rbversion);
 582         rb->close(fd);
 583     }
 584
 585     rb->queue_init(&thread_q, true); /* put the thread's queue in the bcast list */
 586     if ((thread_id = rb->create_thread(thread, thread_stack,
 587         sizeof(thread_stack), 0, "Battery Benchmark"
 588         IF_PRIO(, PRIORITY_BACKGROUND)
 589         IF_COP(, CPU))) == 0)
 590     {
 591         rb->splash(HZ, "Cannot create thread!");
 592         return PLUGIN_ERROR;
 593     }
 594
 595     rb->plugin_tsr(exit_tsr);
 596
 597     return PLUGIN_OK;
 598 }