Readme with notes to the connecty stuff to be refined and edited and appease linter

Author: ineskhou

FprimeZephyrReference/Components/Burnwire/Burnwire.cpp

@@ -35,12 +35,17 @@ void Burnwire ::START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     this->log_ACTIVITY_HI_SetBurnwireState(Fw::On::ON);
     // confirm response
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+
+    this->gpioSet_out(0, Fw::Logic::HIGH);
+    this->gpioSet_out(1, Fw::Logic::HIGH);
 }
 
 void Burnwire ::STOP_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     this->m_state = Fw::On::OFF;
     this->log_ACTIVITY_HI_SetBurnwireState(Fw::On::OFF);
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+    this->gpioSet_out(0, Fw::Logic::LOW);
+    this->gpioSet_out(1, Fw::Logic::LOW);
 }
 
 }  // namespace Components

FprimeZephyrReference/Components/Burnwire/Burnwire.fpp

@@ -25,11 +25,11 @@ module Components {
         # @ Example port: receiving calls from the rate group
         # sync input port run: Svc.Sched
 
-        @ Port to start and stop the burnwire
+        @ Input Port to start and stop the burnwire
         sync input port stop: Fw.Signal
 
-        @ Port sending calls to the GPIO driver
-        output port gpioSet: Drv.GpioWrite
+        @ Port sending calls to the GPIO driver to stop and start the burnwire
+        output port gpioSet: [2] Drv.GpioWrite
 
         # @ Example parameter
         # param PARAMETER_NAME: U32

FprimeZephyrReference/ReferenceDeployment/Top/ReferenceDeploymentTopology.cpp

@@ -14,6 +14,16 @@
 #include <zephyr/drivers/gpio.h>
 
 static const struct gpio_dt_spec ledGpio = GPIO_DT_SPEC_GET(DT_ALIAS(led0), gpios);
+static const struct gpio_dt_spec burnwire0Gpio = {
+    .port = DEVICE_DT_GET(DT_NODELABEL(gpio0)),
+    .pin = 28,
+    .dt_flags = GPIO_ACTIVE_HIGH,
+};
+static const struct gpio_dt_spec burnwire1Gpio = {
+    .port = DEVICE_DT_GET(DT_NODELABEL(gpio0)),
+    .pin = 29,
+    .dt_flags = GPIO_ACTIVE_HIGH,
+};
 
 // Allows easy reference to objects in FPP/autocoder required namespaces
 using namespace ReferenceDeployment;
@@ -55,6 +65,8 @@ void configureTopology() {
     rateGroup1Hz.configure(rateGroup1HzContext, FW_NUM_ARRAY_ELEMENTS(rateGroup1HzContext));
 
     gpioDriver.open(ledGpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
+    gpioBurnwire0.open(burnwire0Gpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
+    gpioBurnwire1.open(burnwire1Gpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
 }
 
 // Public functions for use in main program are namespaced with deployment name ReferenceDeployment

FprimeZephyrReference/ReferenceDeployment/Top/instances.fpp

@@ -63,6 +63,10 @@ module ReferenceDeployment {
 
   instance gpioDriver: Zephyr.ZephyrGpioDriver base id 0x10015000
 
+  instance gpioBurnwire0: Zephyr.ZephyrGpioDriver base id 0x10015100
+
+  instance gpioBurnwire1: Zephyr.ZephyrGpioDriver base id 0x10015200
+
   instance watchdog: Components.Watchdog base id 0x10016000
 
   instance burnwire: Components.Burnwire base id 0x10017000

FprimeZephyrReference/ReferenceDeployment/Top/topology.fpp

@@ -27,6 +27,8 @@ module ReferenceDeployment {
     instance timer
     instance comDriver
     instance gpioDriver
+    instance gpioBurnwire0
+    instance gpioBurnwire1
     instance watchdog
     instance prmDb
     instance burnwire
@@ -95,10 +97,17 @@ module ReferenceDeployment {
       rateGroup1Hz.RateGroupMemberOut[4] -> watchdog.run
     }
 
+
     connections Watchdog {
       watchdog.gpioSet -> gpioDriver.gpioWrite
     }
 
+    connections BurnwireGpio {
+      burnwire.gpioSet[0] -> gpioBurnwire0.gpioWrite
+      burnwire.gpioSet[1] -> gpioBurnwire1.gpioWrite
+    }
+
+
     connections ReferenceDeployment {
 
     }

README.md

@@ -67,3 +67,54 @@ Finally, run the fprime-gds.
 ```shell
 make gds
 ```
+
+# How to add a component
+
+1. Overlay
+
+
+you also want to add aliases
+
+ aliases {
+        burnwire0 = &burnwire0;
+        burnwire1 = &burnwire1;
+    };
+
+
+2.
+
+In RefereneceDeploymentTopology.cpp
+static const struct gpio_dt_spec burnwireGpio = GPIO_DT_SPEC_GET(DT_ALIAS(burnwire0), gpios);
+
+    gpioBurnwire0.open(burnwire0Gpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
+    gpioBurnwire1.open(burnwire1Gpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
+
+
+and
+
+gpioDriver.open(burnwire0Gpio, Zephyr::ZephyrGpioDriver::GpioConfiguration::OUT);
+
+in topology.fpp
+
+connections burnwire1 {
+      burnwire1.gpioSet -> gpioDriver.gpioWrite
+    }
+
+
+
+
+in instances.fpp
+instance gpioBurnwire0: Zephyr.ZephyrGpioDriver base id 0x10015100
+
+  instance gpioBurnwire1: Zephyr.ZephyrGpioDriver base id 0x10015200
+
+
+in topology.fpp
+
+  instance gpioBurnwire0
+    instance gpioBurnwire1
+
+3. Make a new component in the components folder
+4. Add the component to the instances and topology folder
+
+in topology.fpp also     instance burnwire

boards/rpi_pico2_rp2350a_m33.overlay

@@ -13,6 +13,16 @@
         gpios = <&gpio0 28 GPIO_ACTIVE_HIGH>;
         label = "Burnwire 0, 28";
     };
+
+    burnwire1: burnwire1 {
+        gpios = <&gpio0 29 GPIO_ACTIVE_HIGH>;
+        label = "Burnwire 1, 29";
+    };
+
+    aliases {
+        burnwire0 = &burnwire0;
+        burnwire1 = &burnwire1;
+    };
 };
 
 /* Override the default LED definition to use GPIO 24 instead of GPIO 25 for PROVES FC board*/