Merge pull request #129 from arntsonl/addonrework

Addon Rework - Per-Core Addons with Manager

include/addonmanager.h

@@ -0,0 +1,31 @@
+#ifndef _ADDONMANAGER_H_
+#define _ADDONMANAGER_H_
+
+#include "gpaddon.h"
+
+#include <vector>
+#include <pico/mutex.h>
+
+typedef enum ADDON_PROCESS {
+    CORE0_INPUT,
+    CORE1_LOOP
+} _ADDON_PROCESS;
+
+typedef struct AddonBlock {
+    GPAddon * ptr;
+    ADDON_PROCESS process;
+    bool enabled;
+};
+
+class AddonManager {
+public:
+    AddonManager() {}
+    ~AddonManager() {}
+    void LoadAddon(GPAddon*, ADDON_PROCESS, bool enabled=true);
+    void ProcessAddons(ADDON_PROCESS);
+    GPAddon * GetAddon(std::string); // hack for NeoPicoLED
+private:
+    std::vector<AddonBlock*> addons;    // addons currently loaded
+};
+
+#endif

include/gp2040.h

@@ -8,7 +8,7 @@
 
 // GP2040 Classes
 #include "gamepad.h"
-#include "gpaddon.h"
+#include "addonmanager.h"
 
 class GP2040 {
 public:
@@ -17,9 +17,9 @@ class GP2040 {
     void setup();           // setup core0
     void run();             // loop core0
 private:
-    void setupInput(GPAddon*);
     uint64_t nextRuntime;
     Gamepad snapshot;
+    AddonManager addons;
 };
 
 #endif

include/gp2040aux.h

@@ -8,9 +8,8 @@
 
 #include <vector>
 
-#include "addons/i2cdisplay.h"
-#include "addons/neopicoleds.h"
-#include "addons/playerleds.h"
+#include "gpaddon.h"
+#include "addonmanager.h"
 
 class GP2040Aux {
 public:
@@ -19,7 +18,8 @@ class GP2040Aux {
     void setup();           // setup core1
     void run();             // loop core1
 private:
-    void setupAddon(GPAddon*);
+    uint64_t nextRuntime;
+    AddonManager addons;
 };
 
 #endif

include/storagemanager.h

@@ -13,7 +13,6 @@
 #include "enums.h"
 #include "helper.h"
 #include "gamepad.h"
-#include "gpaddon.h"
 
 #define GAMEPAD_STORAGE_INDEX      0 // 1024 bytes for gamepad options
 #define BOARD_STORAGE_INDEX     1024 //  512 bytes for hardware options
@@ -139,9 +138,6 @@ class Storage {
 	uint8_t * GetFeatureData();
 
 	void ResetSettings(); 				// EEPROM Reset Feature
-
-	std::vector<GPAddon*> Addons;		// Modular Features
-	std::vector<GPAddon*> Inputs;
 
 private:
 	Storage() : gamepad(0) {

src/addonmanager.cpp

@@ -0,0 +1,30 @@
+#include "addonmanager.h"
+
+void AddonManager::LoadAddon(GPAddon* addon, ADDON_PROCESS processAt, bool enabled) {
+    if (addon->available()) {
+        AddonBlock * block = new AddonBlock;
+		addon->setup();
+        block->ptr = addon;
+        block->process = processAt;
+        block->enabled = enabled;
+        addons.push_back(block);
+	} else {
+        delete addon; // Don't use the memory if we don't have to
+    }
+}
+
+void AddonManager::ProcessAddons(ADDON_PROCESS processType) {
+    // Loop through all addons and process any that match our type
+    for (std::vector<AddonBlock*>::iterator it = addons.begin(); it != addons.end(); it++) {
+        if ( (*it)->process == processType && (*it)->enabled == true)
+            (*it)->ptr->process();
+    }
+}
+
+// HACK : change this for NeoPicoLED
+GPAddon * AddonManager::GetAddon(std::string name) { // hack for NeoPicoLED
+    for (std::vector<AddonBlock*>::iterator it = addons.begin(); it != addons.end(); it++) {
+        if ( (*it)->ptr->name() == name )
+            return (*it)->ptr;
+    }
+}

src/inputs/analog.cpp → src/addons/analog.cpp

@@ -1,4 +1,4 @@
-#include "inputs/analog.h"
+#include "addons/analog.h"
 #include "storagemanager.h"
 
 #include "hardware/adc.h"

src/inputs/i2canalog1219.cpp → src/addons/i2canalog1219.cpp

@@ -1,12 +1,12 @@
-#include "inputs/i2canalog1219.h"
+#include "addons/i2canalog1219.h"
 #include "storagemanager.h"
 
 #define ADS_MAX (float)((1 << 23) - 1)
 #define VREF_VOLTAGE 2.048f
 
 bool I2CAnalog1219Input::available() {
     BoardOptions boardOptions = Storage::getInstance().getBoardOptions();
-	return (boardOptions.i2cAnalog1219SDAPin != -1 ||
+	return (boardOptions.i2cAnalog1219SDAPin != -1 &&
         boardOptions.i2cAnalog1219SCLPin != -1);
 }
 

src/inputs/jslider.cpp → src/addons/jslider.cpp

@@ -1,4 +1,4 @@
-#include "inputs/jslider.h"
+#include "addons/jslider.h"
 
 #include "storagemanager.h"
 

src/inputs/reverse.cpp → src/addons/reverse.cpp

@@ -1,4 +1,4 @@
-#include "inputs/reverse.h"
+#include "addons/reverse.h"
 #include "storagemanager.h"
 #include "GamepadEnums.h"
 

src/inputs/turbo.cpp → src/addons/turbo.cpp

@@ -1,4 +1,4 @@
-#include "inputs/turbo.h"
+#include "addons/turbo.h"
 
 #include "storagemanager.h"
 

src/configmanager.cpp

@@ -1,4 +1,6 @@
 #include "configmanager.h"
+
+#include "addonmanager.h"
 #include "configs/webconfig.h"
 #include "addons/neopicoleds.h"
 
@@ -26,15 +28,6 @@ void ConfigManager::setGamepadOptions(Gamepad* gamepad) {
 
 void ConfigManager::setLedOptions(LEDOptions ledOptions) {
 	Storage::getInstance().setLEDOptions(ledOptions);
-
-    // Configure LEDs in the neopico
-	for (std::vector<GPAddon*>::iterator it = Storage::getInstance().Addons.begin(); it != Storage::getInstance().Addons.end(); it++) {
-		if ((*it)->name() == NeoPicoLEDName) {
-			NeoPicoLEDAddon * neopicoled = (NeoPicoLEDAddon*)(*it);
-			neopicoled->configureLEDs();
-			break; // trigger LED configuration
-		}
-	} 
 }
 
 void ConfigManager::setBoardOptions(BoardOptions boardOptions) {

src/gp2040.cpp

@@ -1,14 +1,16 @@
 // GP2040 includes
 #include "gp2040.h"
 #include "helper.h"
-#include "configmanager.h" // Managers
+
+#include "configmanager.h" // Global Managers
 #include "storagemanager.h"
+#include "addonmanager.h"
 
-#include "inputs/analog.h" // Inputs
-#include "inputs/i2canalog1219.h"
-#include "inputs/jslider.h"
-#include "inputs/reverse.h"
-#include "inputs/turbo.h"
+#include "addons/analog.h" // Inputs for Core0
+#include "addons/i2canalog1219.h"
+#include "addons/jslider.h"
+#include "addons/reverse.h"
+#include "addons/turbo.h"
 
 // Pico includes
 #include "pico/bootrom.h"
@@ -27,7 +29,7 @@ GP2040::GP2040() : nextRuntime(0) {
 GP2040::~GP2040() {
 }
 
-void GP2040::setup() {	
+void GP2040::setup() {
     // Setup Gamepad and Gamepad Storage
 	Gamepad * gamepad = Storage::getInstance().GetGamepad();
 	gamepad->setup();
@@ -57,13 +59,12 @@ void GP2040::setup() {
 		initialize_driver(inputMode);
 	}
 
-	// Setup Add-on Inputs
-	setupInput(new AnalogInput());
-	setupInput(new I2CAnalog1219Input());
-	setupInput(new JSliderInput());
-	setupInput(new ReverseInput());
-	setupInput(new TurboInput());
-
+	// Setup Add-ons
+	addons.LoadAddon(new AnalogInput(), CORE0_INPUT);
+	addons.LoadAddon(new I2CAnalog1219Input(), CORE0_INPUT);
+	addons.LoadAddon(new JSliderInput(), CORE0_INPUT);
+	addons.LoadAddon(new ReverseInput(), CORE0_INPUT);
+	addons.LoadAddon(new TurboInput(), CORE0_INPUT);
 }
 
 void GP2040::run() {
@@ -90,12 +91,9 @@ void GP2040::run() {
 		gamepad->hotkey(); 	// check for MPGS hotkeys
 		gamepad->process(); // process through MPGS
 
-		// Loop through all input modifiers/features (Analog Sticks, Turbo Buttons, Macro Inputs, Touch Screens, etc.) 
-		for (std::vector<GPAddon*>::iterator it = Storage::getInstance().Inputs.begin(); it != Storage::getInstance().Inputs.end(); it++) {
-			(*it)->process();
-		}
+		addons.ProcessAddons(ADDON_PROCESS::CORE0_INPUT);
 
-		// Copy Processed Gamepad
+		// Copy Processed Gamepad for Core1 (race condition otherwise)
 		memcpy(&processedGamepad->state, &gamepad->state, sizeof(GamepadState));
 
 		// USB FEATURES : Send/Get USB Features (including Player LEDs on X-Input)
@@ -107,10 +105,3 @@ void GP2040::run() {
 		nextRuntime = getMicro() + GAMEPAD_POLL_MICRO;
 	}
 }
-
-void GP2040::setupInput(GPAddon* input) {
-	if (input->available()) {
-		input->setup();
-		Storage::getInstance().Inputs.push_back(input);
-	}
-}

src/gp2040aux.cpp

@@ -1,36 +1,35 @@
 // GP2040 includes
 #include "gp2040aux.h"
 #include "gamepad.h"
-#include "storagemanager.h" // Managers
+
+#include "storagemanager.h" // Global Managers
+#include "addonmanager.h"
+
 #include "addons/i2cdisplay.h" // Add-Ons
 #include "addons/neopicoleds.h"
 #include "addons/playerleds.h"
 
 #include <iterator>
 
-GP2040Aux::GP2040Aux() {
+GP2040Aux::GP2040Aux() : nextRuntime(0) {
 }
 
 GP2040Aux::~GP2040Aux() {
 }
 
 void GP2040Aux::setup() {
-	setupAddon(new I2CDisplayAddon());
-	setupAddon(new NeoPicoLEDAddon());
-	setupAddon(new PlayerLEDAddon());
+	addons.LoadAddon(new I2CDisplayAddon(), CORE1_LOOP);
+	addons.LoadAddon(new NeoPicoLEDAddon(), CORE1_LOOP);
+	addons.LoadAddon(new PlayerLEDAddon(), CORE1_LOOP);
 }
 
 void GP2040Aux::run() {
 	while (1) {
-		for (std::vector<GPAddon*>::iterator it = Storage::getInstance().Addons.begin(); it != Storage::getInstance().Addons.end(); it++) {
-			(*it)->process();
+		if (nextRuntime > getMicro()) { // fix for unsigned
+			sleep_us(50); // Give some time back to our CPU (lower power consumption)
+			continue;
 		}
-	}
-}
-
-void GP2040Aux::setupAddon(GPAddon* addon) {
-	if (addon->available()) {
-		addon->setup();
-		Storage::getInstance().Addons.push_back(addon);
+		addons.ProcessAddons(CORE1_LOOP);
+		nextRuntime = getMicro() + GAMEPAD_POLL_MICRO;
 	}
 }

src/storagemanager.cpp

@@ -18,9 +18,8 @@
 #include "addons/i2cdisplay.h"
 #include "addons/neopicoleds.h"
 #include "addons/playerleds.h"
-
-#include "inputs/i2canalog1219.h"
-#include "inputs/turbo.h"
+#include "addons/i2canalog1219.h"
+#include "addons/turbo.h"
 
 #include "helper.h"