add way to lock portion of plugin buffer for TSR plugins

Some things in core that should probably be plugins steal the plugin buffer
for their own use, TSR plugins have no way to detect or prevent this
lock buffer reserves buffer_size bytes directly after the plugin itself
returns the unreserved bytes still available from the plugin buffer

Change-Id: I5a7849e209129b09400036a594569ef396b1b85f

2 files changed, 24 insertions, 0 deletions

diff --git a/apps/plugin.c b/apps/plugin.c
index 670770dfc6..e0766e47bf 100644
--- a/apps/plugin.c
+++ b/apps/plugin.c
@@ -809,6 +809,7 @@ static const struct plugin_api rockbox_api = {
     onplay_show_playlist_menu,
     queue_remove_from_head,
     core_set_keyremap,
+    plugin_reserve_buffer,
 };
 
 static int plugin_buffer_handle;
@@ -963,6 +964,27 @@ int plugin_load(const char* plugin, const void* parameter)
     return rc;
 }
 
+/* For Terminate Stay Resident plugins
+ * Locks buffer_size bytes of the plugin buffer
+ * freed on plugin exit; call plugin_get_buffer first then reserve all
+ * or a portion with plugin_reserve_buffer()
+ * Returns size of buffer remaining */
+size_t plugin_reserve_buffer(size_t buffer_size)
+{
+    size_t locked_size = 0;
+
+    if (current_plugin_handle)
+    {
+        locked_size = ALIGN_UP(plugin_size + buffer_size, 0x8);
+        if (locked_size > PLUGIN_BUFFER_SIZE)
+            locked_size = PLUGIN_BUFFER_SIZE;
+
+        plugin_size = locked_size;
+    }
+
+    return (PLUGIN_BUFFER_SIZE - locked_size);
+}
+
 /* 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(size_t *buffer_size)
diff --git a/apps/plugin.h b/apps/plugin.h
index de1077c9b4..2e0ace2e48 100644
--- a/apps/plugin.h
+++ b/apps/plugin.h
@@ -49,6 +49,7 @@
 
 char* strncpy(char *, const char *, size_t);
 void* plugin_get_buffer(size_t *buffer_size);
+size_t plugin_reserve_buffer(size_t buffer_size);
 int plugin_open(const char *plugin, const char *parameter);
 
 #ifndef __PCTOOL__
@@ -935,6 +936,7 @@ struct plugin_api {
     void (*onplay_show_playlist_menu)(const char* path, void (*playlist_insert_cb));
     void (*queue_remove_from_head)(struct event_queue *q, long id);
     int (*core_set_keyremap)(struct button_mapping* core_keymap, int count);
+    size_t (*plugin_reserve_buffer)(size_t buffer_size);
 };
 
 /* plugin header */