added binaries headers and updated code

added binaries in external files to make the app file more readable. Added a new subscribe and callback to support the async setup

Author: viswajith-g

examples/tests/app_loader/README.md

@@ -0,0 +1,41 @@
+# Dynamic App Loader (Helper App)
+=================================
+
+This app waits upon the user to press a button on the device.
+There are three stages to this:
+
+1. Setup Phase
+2. Flash Phase
+3. Load Phase
+
+#### Setup Phase
+During the setup phase, the application passes the size of the new app `(blink)`'s 
+binary to the app_loader capsule. 
+
+The capsule returns with either a success or failure. 
+
+On success, the app requests the app_loader capsule to flash the `blink` app.
+
+On Failure, the app exits logs the reason for failure and exits.
+
+#### Flash Phase
+The app sends the binary of the `blink` app 512 bytes (this is the size of the shared 
+buffer between the app and the capsule) at a time along with the offset.
+
+The capsule checks that these values do not violate the bounds dictated by the kernel 
+and then requests the kernel to flash the app. 
+
+The kernel performs more stringent checking on the request to ensure that memory access
+violations do not take place, and flashes the app.
+
+The capsule then returns with either a success or failure. 
+
+On success, the app requests the app_loader capsule to load the `blink` app.
+
+On Failure, the app exits logs the reason for failure and exits.
+
+#### Load Phase
+The app requests the capsule to load the new app. There are only two outcomes: 
+
+1. The `blink` app is loaded successfully and functions without requiring a restart.
+2. The load process failed somewhere, and the app is erased.

examples/tests/app_loader/main.c

@@ -0,0 +1,16 @@
+#pragma once
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#include <stdint.h>
+
+// app binaries
+extern uint8_t blink[2048];
+extern uint8_t adc[16384];
+
+#ifdef __cplusplus
+}
+#endif

libtock/internal/app_binaries.c

@@ -1,6 +1,3 @@
-#include <stdio.h>
-#include <string.h>
-
 #include "internal/app_loader.h"
 #include "tock.h"
 
@@ -9,11 +6,16 @@ int app_loader_exists(void) {
   return tock_command_return_novalue_to_returncode(res);
 }
 
-int app_loader_subscribe(subscribe_upcall cb, void *userdata) {
+int app_loader_setup_subscribe(subscribe_upcall cb, void *userdata) {
   subscribe_return_t sval = subscribe(DRIVER_NUM_APP_LOADER, 0, cb, userdata);
   return tock_subscribe_return_to_returncode(sval);
 }
 
+int app_loader_write_subscribe(subscribe_upcall cb, void *userdata) {
+  subscribe_return_t sval = subscribe(DRIVER_NUM_APP_LOADER, 1, cb, userdata);
+  return tock_subscribe_return_to_returncode(sval);
+}
+
 int app_loader_write_buffer(uint8_t *buffer, uint32_t len) {
   allow_ro_return_t aval = allow_readonly(DRIVER_NUM_APP_LOADER, 0, (void*) buffer, len);
   return tock_allow_ro_return_to_returncode(aval);
@@ -33,28 +35,3 @@ int app_loader_command_load(void) {
   syscall_return_t res = command(DRIVER_NUM_APP_LOADER, 3, 0, 0);
   return tock_command_return_novalue_to_returncode(res);
 }
-
-int button_subscribe(subscribe_upcall callback, void *ud) {
-  subscribe_return_t res = subscribe(DRIVER_NUM_BUTTON, 0, callback, ud);
-  return tock_subscribe_return_to_returncode(res);
-}
-
-int button_count(int* count) {
-  syscall_return_t res = command(DRIVER_NUM_BUTTON, 0, 0, 0);
-  return tock_command_return_u32_to_returncode(res, (uint32_t*) count);
-}
-
-int button_enable_interrupt(int button_num) {
-  syscall_return_t res = command(DRIVER_NUM_BUTTON, 1, button_num, 0);
-  return tock_command_return_novalue_to_returncode(res);
-}
-
-int button_disable_interrupt(int button_num) {
-  syscall_return_t res = command(DRIVER_NUM_BUTTON, 2, button_num, 0);
-  return tock_command_return_novalue_to_returncode(res);
-}
-
-int button_read(int button_num, int* button_value) {
-  syscall_return_t res = command(DRIVER_NUM_BUTTON, 3, button_num, 0);
-  return tock_command_return_u32_to_returncode(res, (uint32_t*) button_value);
-}

libtock/internal/app_binaries.h

@@ -9,19 +9,22 @@ extern "C"
 
 // Driver number for system call
 #define DRIVER_NUM_APP_LOADER   0x50004
-#define DRIVER_NUM_BUTTON       0x3
-
-// Button value macros
-#define BUTTON_1 0
-#define BUTTON_2 1
-
 
+#define BUTTON1 0
+#define BUTTON2 1
 
 /*
  * Command to check if the `app_loader` capsule exists.
  */
 int app_loader_exists(void);
 
+/*
+ * Function to setup the callback from capsule.
+ * This function takes in the function that will be executed
+ * when the callback is triggered.
+ */
+int app_loader_setup_subscribe(subscribe_upcall cb, void *userdata);
+
 /*
  * Command to request the kernel to set up for a new app.
  * This functions takes the size of the new app as the argument. 
@@ -33,7 +36,7 @@ int app_loader_command_setup(uint32_t app_length);
  * This function takes in the function that will be executed
  * when the callback is triggered.
  */
-int app_loader_subscribe(subscribe_upcall cb, void *userdata);
+int app_loader_write_subscribe(subscribe_upcall cb, void *userdata);
 
 /*
  * Function to set up a shared buffer with the capsule.
@@ -57,42 +60,10 @@ int app_loader_command_write(uint32_t flash_offset, uint32_t write_length);
 int app_loader_command_load(void);
 
 /*
- * Internal function to write new app to flash. 
- */
-int write_app(void);
-
-
-/*
- * Function to setup the callback to be executed when 
- * a button is pressed.
- * 
- * This function takes in the function that will be executed
- * when the callback is triggered.
- */
-int button_subscribe(subscribe_upcall callback, void *ud);
-
-/*
- * Function to enable interrupts for the specified button number.
+ * Internal function to write new app to flash. Takes app size as argument.
  */
-int button_enable_interrupt(int button_num);
+int write_app(double size, uint8_t binary[]);
 
-/*
- * Function to disable interrupts for the specified button number.
- */
-int button_disable_interrupt(int button_num);
-
-/*
- * Function to read the value of the button. 
- *
- * `button_num` corresponds to which physical button is pressed.
- * `button_val` corresponds to whether it is pressed (1) or depressed (0)
- */
-int button_read(int button_num, int* button_value);
-
-/*
- * Function to count the number of buttons on a device. 
- */
-int button_count(int* count);
 
 #ifdef __cplusplus
 }

libtock/internal/app_loader.c

@@ -0,0 +1,30 @@
+import os
+
+def read_binary_file(file_name):
+    parent_directory = os.path.dirname(os.getcwd())
+    grandparent_directory = os.path.dirname(parent_directory)
+    file_path = os.path.join(grandparent_directory, file_name)
+    with open(file_path, 'rb') as file:
+        binary_data = file.read()
+    return binary_data
+
+def binary_to_array(binary_data):
+    hex_array = [hex(byte) for byte in binary_data]
+    return hex_array
+
+def print_hex_array(hex_array):
+    print("Hexadecimal Array:")
+    count = 0
+    for hex_byte in hex_array:
+        print(f"0x{hex_byte[2:].zfill(2)}", end=", ")  # Add prefix '0x' and leading zero padding
+        count += 1
+        if count % 14 == 0:
+            print()  # Add a new line after every 14 elements
+    if count % 14 != 0:
+        print()  # Add a new line if the last line is not complete
+
+
+file_name = 'examples/adc/build/cortex-m4/cortex-m4.tbf'
+binary_data = read_binary_file(file_name)
+hex_array = binary_to_array(binary_data)
+print_hex_array(hex_array)