rockbox/apps/plugin.c
Linus Nielsen Feltzing d7f3d1c8ec Added cpu_frequency to the plugin API
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@6094 a1c6a512-1295-4272-9138-f99709370657
2005-03-01 14:36:16 +00:00

480 lines
11 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2002 Björn Stenberg
*
* All files in this archive are subject to the GNU General Public License.
* See the file COPYING in the source tree root for full license agreement.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#include <stdbool.h>
#include <string.h>
#include <stdio.h>
#include <atoi.h>
#include <timefuncs.h>
#include <ctype.h>
#include "debug.h"
#include "button.h"
#include "lcd.h"
#include "dir.h"
#include "file.h"
#include "kernel.h"
#include "sprintf.h"
#include "screens.h"
#include "misc.h"
#include "mas.h"
#include "plugin.h"
#include "lang.h"
#include "keyboard.h"
#include "mpeg.h"
#include "buffer.h"
#include "mp3_playback.h"
#include "backlight.h"
#include "ata.h"
#include "talk.h"
#include "mp3data.h"
#include "powermgmt.h"
#include "system.h"
#ifdef HAVE_LCD_BITMAP
#include "peakmeter.h"
#include "widgets.h"
#endif
#if MEM >= 32
#define PLUGIN_BUFFER_SIZE 0xC0000
#else
#define PLUGIN_BUFFER_SIZE 0x8000
#endif
#ifdef SIMULATOR
static unsigned char pluginbuf[PLUGIN_BUFFER_SIZE];
void *sim_plugin_load(char *plugin, int *fd);
void sim_plugin_close(int fd);
#else
#define sim_plugin_close(x)
extern unsigned char pluginbuf[];
#include "bitswap.h"
#endif
static bool plugin_loaded = false;
static int plugin_size = 0;
#ifndef SIMULATOR
static void (*pfn_timer)(void) = NULL; /* user timer handler */
#endif
static void (*pfn_tsr_exit)(void) = NULL; /* TSR exit callback */
static int plugin_test(int api_version, int model, int memsize);
static const struct plugin_api rockbox_api = {
PLUGIN_API_VERSION,
plugin_test,
/* lcd */
lcd_clear_display,
lcd_puts,
lcd_puts_scroll,
lcd_stop_scroll,
lcd_set_contrast,
#ifdef HAVE_LCD_CHARCELLS
lcd_define_pattern,
lcd_get_locked_pattern,
lcd_unlock_pattern,
lcd_putc,
lcd_put_cursor,
lcd_remove_cursor,
PREFIX(lcd_icon),
#else
lcd_putsxy,
lcd_puts_style,
lcd_puts_scroll_style,
lcd_bitmap,
lcd_drawline,
lcd_clearline,
lcd_drawpixel,
lcd_clearpixel,
lcd_setfont,
font_get,
lcd_clearrect,
lcd_fillrect,
lcd_drawrect,
lcd_invertrect,
lcd_getstringsize,
lcd_update,
lcd_update_rect,
scrollbar,
checkbox,
&lcd_framebuffer[0][0],
lcd_blit,
#ifndef SIMULATOR
lcd_roll,
#endif
#endif
backlight_on,
backlight_off,
backlight_set_timeout,
splash,
/* button */
button_get,
button_get_w_tmo,
button_status,
button_clear_queue,
/* file */
(open_func)PREFIX(open),
close,
(read_func)read,
PREFIX(lseek),
(creat_func)PREFIX(creat),
(write_func)write,
PREFIX(remove),
PREFIX(rename),
PREFIX(ftruncate),
PREFIX(filesize),
fdprintf,
read_line,
settings_parseline,
#ifndef SIMULATOR
ata_sleep,
#endif
/* dir */
PREFIX(opendir),
PREFIX(closedir),
PREFIX(readdir),
/* kernel/ system */
PREFIX(sleep),
yield,
&current_tick,
default_event_handler,
default_event_handler_ex,
create_thread,
remove_thread,
reset_poweroff_timer,
#ifndef SIMULATOR
system_memory_guard,
#endif
/* strings and memory */
snprintf,
strcpy,
strncpy,
strlen,
strrchr,
strcmp,
strcasecmp,
strncasecmp,
memset,
memcpy,
_ctype_,
atoi,
strchr,
strcat,
memcmp,
/* sound */
mpeg_sound_set,
#ifndef SIMULATOR
mp3_play_data,
mp3_play_pause,
mp3_play_stop,
mp3_is_playing,
bitswap,
#endif
/* playback control */
PREFIX(mpeg_play),
mpeg_stop,
mpeg_pause,
mpeg_resume,
mpeg_next,
mpeg_prev,
mpeg_ff_rewind,
mpeg_next_track,
playlist_amount,
mpeg_status,
mpeg_has_changed_track,
mpeg_current_track,
mpeg_flush_and_reload_tracks,
mpeg_get_file_pos,
mpeg_get_last_header,
#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
mpeg_set_pitch,
#endif
#if !defined(SIMULATOR) && (CONFIG_HWCODEC != MASNONE)
/* MAS communication */
mas_readmem,
mas_writemem,
mas_readreg,
mas_writereg,
#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
mas_codec_writereg,
mas_codec_readreg,
#endif
#endif /* !simulator and HWCODEC != MASNONE */
/* misc */
srand,
rand,
(qsort_func)qsort,
kbd_input,
get_time,
set_time,
plugin_get_buffer,
plugin_get_mp3_buffer,
#ifndef SIMULATOR
plugin_register_timer,
plugin_unregister_timer,
#endif
plugin_tsr,
#if defined(DEBUG) || defined(SIMULATOR)
debugf,
#endif
&global_settings,
mp3info,
count_mp3_frames,
create_xing_header,
find_next_frame,
battery_level,
battery_level_safe,
#if (CONFIG_HWCODEC == MAS3587F) || (CONFIG_HWCODEC == MAS3539F)
peak_meter_scale_value,
peak_meter_set_use_dbfs,
peak_meter_get_use_dbfs,
#endif
/* new stuff at the end, sort into place next time
the API gets incompatible */
#ifndef SIMULATOR
&cpu_frequency,
#endif
};
int plugin_load(const char* plugin, void* parameter)
{
enum plugin_status (*plugin_start)(struct plugin_api* api, void* param);
int rc;
#ifndef SIMULATOR
char buf[64];
#endif
int fd;
#ifdef HAVE_LCD_BITMAP
int xm,ym;
#endif
if (pfn_tsr_exit != NULL) /* if we have a resident old plugin: */
{
pfn_tsr_exit(); /* force it to exit now */
pfn_tsr_exit = NULL;
}
#ifdef HAVE_LCD_BITMAP
lcd_clear_display();
xm = lcd_getxmargin();
ym = lcd_getymargin();
lcd_setmargins(0,0);
lcd_update();
#else
lcd_clear_display();
#endif
#ifdef SIMULATOR
plugin_start = sim_plugin_load((char *)plugin, &fd);
if(!plugin_start)
return -1;
#else
fd = open(plugin, O_RDONLY);
if (fd < 0) {
snprintf(buf, sizeof buf, str(LANG_PLUGIN_CANT_OPEN), plugin);
splash(HZ*2, true, buf);
return fd;
}
/* zero out plugin buffer to ensure a properly zeroed bss area */
memset(pluginbuf, 0, PLUGIN_BUFFER_SIZE);
plugin_start = (void*)&pluginbuf;
plugin_size = read(fd, plugin_start, PLUGIN_BUFFER_SIZE);
close(fd);
if (plugin_size < 0) {
/* read error */
snprintf(buf, sizeof buf, str(LANG_READ_FAILED), plugin);
splash(HZ*2, true, buf);
return -1;
}
if (plugin_size == 0) {
/* loaded a 0-byte plugin, implying it's not for this model */
splash(HZ*2, true, str(LANG_PLUGIN_WRONG_MODEL));
return -1;
}
#endif
plugin_loaded = true;
invalidate_icache();
rc = plugin_start((struct plugin_api*) &rockbox_api, parameter);
/* explicitly casting the pointer here to avoid touching every plugin. */
button_clear_queue();
plugin_loaded = false;
switch (rc) {
case PLUGIN_OK:
break;
case PLUGIN_USB_CONNECTED:
return PLUGIN_USB_CONNECTED;
case PLUGIN_WRONG_API_VERSION:
splash(HZ*2, true, str(LANG_PLUGIN_WRONG_VERSION));
break;
case PLUGIN_WRONG_MODEL:
splash(HZ*2, true, str(LANG_PLUGIN_WRONG_MODEL));
break;
default:
splash(HZ*2, true, str(LANG_PLUGIN_ERROR));
break;
}
sim_plugin_close(fd);
#ifdef HAVE_LCD_BITMAP
/* restore margins */
lcd_setmargins(xm,ym);
#endif
return PLUGIN_OK;
}
/* Returns a pointer to the portion of the plugin buffer that is not already
being used. If no plugin is loaded, returns the entire plugin buffer */
void* plugin_get_buffer(int* buffer_size)
{
int buffer_pos;
if (plugin_loaded)
{
if (plugin_size >= PLUGIN_BUFFER_SIZE)
return NULL;
*buffer_size = PLUGIN_BUFFER_SIZE-plugin_size;
buffer_pos = plugin_size;
}
else
{
*buffer_size = PLUGIN_BUFFER_SIZE;
buffer_pos = 0;
}
return &pluginbuf[buffer_pos];
}
/* Returns a pointer to the mp3 buffer.
Playback gets stopped, to avoid conflicts. */
void* plugin_get_mp3_buffer(int* buffer_size)
{
mpeg_stop();
talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
*buffer_size = mp3end - mp3buf;
return mp3buf;
}
#ifndef SIMULATOR
/* Register a periodic time callback, called every "cycles" CPU clocks.
Note that this function will be called in interrupt context! */
int plugin_register_timer(int cycles, int prio, void (*timer_callback)(void))
{
int phi = 0; /* bits for the prescaler */
int prescale = 1;
while (cycles > 0x10000)
{ /* work out the smallest prescaler that makes it fit */
phi++;
prescale *= 2;
cycles /= 2;
}
if (prescale > 8 || cycles == 0 || prio < 1 || prio > 15)
return 0; /* error, we can't do such period, bad argument */
#if CONFIG_CPU == SH7034
and_b(~0x10, &TSTR); /* Stop the timer 4 */
and_b(~0x10, &TSNC); /* No synchronization */
and_b(~0x10, &TMDR); /* Operate normally */
pfn_timer = timer_callback; /* install 2nd level ISR */
and_b(~0x01, &TSR4);
TIER4 = 0xF9; /* Enable GRA match interrupt */
GRA4 = (unsigned short)(cycles - 1);
TCR4 = 0x20 | phi; /* clear at GRA match, set prescaler */
IPRD = (IPRD & 0xFF0F) | prio << 4; /* interrupt priority */
or_b(0x10, &TSTR); /* start timer 4 */
#else
pfn_timer = timer_callback;
#endif
return cycles * prescale; /* return the actual period, in CPU clocks */
}
/* disable the user timer */
void plugin_unregister_timer(void)
{
#if CONFIG_CPU == SH7034
and_b(~0x10, &TSTR); /* stop the timer 4 */
IPRD = (IPRD & 0xFF0F); /* disable interrupt */
pfn_timer = NULL;
#endif
}
#if CONFIG_CPU == SH7034
/* interrupt handler for user timer */
#pragma interrupt
void IMIA4(void)
{
if (pfn_timer != NULL)
pfn_timer(); /* call the user timer function */
and_b(~0x01, &TSR4); /* clear the interrupt */
}
#endif /* CONFIG_CPU == SH7034 */
#endif /* #ifndef SIMULATOR */
/* The plugin wants to stay resident after leaving its main function, e.g.
runs from timer or own thread. The callback is registered to later
instruct it to free its resources before a new plugin gets loaded. */
void plugin_tsr(void (*exit_callback)(void))
{
pfn_tsr_exit = exit_callback; /* remember the callback for later */
}
static int plugin_test(int api_version, int model, int memsize)
{
if (api_version < PLUGIN_MIN_API_VERSION ||
api_version > PLUGIN_API_VERSION)
return PLUGIN_WRONG_API_VERSION;
if (model != MODEL)
return PLUGIN_WRONG_MODEL;
if (memsize != MEM)
return PLUGIN_WRONG_MODEL;
return PLUGIN_OK;
}