RTC best practices (#97)

* rtc manager best practices

* Move rtc first in topology configure

---------

Co-authored-by: Sam S. Yu <[email protected]>

Author: nateinaction

FprimeZephyrReference/Components/Drv/RtcManager/RtcManager.cpp

@@ -11,20 +11,25 @@ namespace Drv {
 // Component construction and destruction
 // ----------------------------------------------------------------------
 
-RtcManager ::RtcManager(const char* const compName) : RtcManagerComponentBase(compName), m_console_throttled(false) {
-    // Initialize device
-    this->dev = device_get_binding("RV3028");
-}
+RtcManager ::RtcManager(const char* const compName) : RtcManagerComponentBase(compName) {}
 
 RtcManager ::~RtcManager() {}
 
+// ----------------------------------------------------------------------
+// Public helper methods
+// ----------------------------------------------------------------------
+
+void RtcManager ::configure(const struct device* dev) {
+    this->m_dev = dev;
+}
+
 // ----------------------------------------------------------------------
 // Handler implementations for typed input ports
 // ----------------------------------------------------------------------
 
 void RtcManager ::timeGetPort_handler(FwIndexType portNum, Fw::Time& time) {
     // Check device readiness
-    if (!device_is_ready(this->dev)) {
+    if (!device_is_ready(this->m_dev)) {
         // Use logger instead of events since this fn is in a critical path for FPrime
         // to get time. Events require time, if this method fails an event will fail.
         //
@@ -38,7 +43,7 @@ void RtcManager ::timeGetPort_handler(FwIndexType portNum, Fw::Time& time) {
 
     // Get time from RTC
     struct rtc_time time_rtc = {};
-    rtc_get_time(this->dev, &time_rtc);
+    rtc_get_time(this->m_dev, &time_rtc);
 
     // Convert to generic tm struct
     struct tm* time_tm = rtc_time_to_tm(&time_rtc);
@@ -67,7 +72,7 @@ void RtcManager ::timeGetPort_handler(FwIndexType portNum, Fw::Time& time) {
 
 void RtcManager ::TIME_SET_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, Drv::TimeData t) {
     // Check device readiness
-    if (!device_is_ready(this->dev)) {
+    if (!device_is_ready(this->m_dev)) {
         // Emit device not ready event
         this->log_WARNING_HI_DeviceNotReady();
 
@@ -104,7 +109,7 @@ void RtcManager ::TIME_SET_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, Drv::Time
     };
 
     // Set time on RTC
-    const int status = rtc_set_time(this->dev, &time_rtc);
+    const int status = rtc_set_time(this->m_dev, &time_rtc);
 
     if (status != 0) {
         // Emit time not set event

FprimeZephyrReference/Components/Drv/RtcManager/RtcManager.hpp

@@ -32,6 +32,14 @@ class RtcManager final : public RtcManagerComponentBase {
     //! Destroy RtcManager object
     ~RtcManager();
 
+  public:
+    // ----------------------------------------------------------------------
+    // Public helper methods
+    // ----------------------------------------------------------------------
+
+    //! Configure the RTC device
+    void configure(const struct device* dev);
+
   private:
     // ----------------------------------------------------------------------
     // Handler implementations for typed input ports
@@ -67,7 +75,7 @@ class RtcManager final : public RtcManagerComponentBase {
     bool timeDataIsValid(Drv::TimeData t);
 
     //! device stores the initialized Zephyr RTC device
-    const struct device* dev;
+    const struct device* m_dev;
 };
 
 }  // namespace Drv

FprimeZephyrReference/ReferenceDeployment/Main.cpp

@@ -10,12 +10,13 @@
 #include <zephyr/kernel.h>
 #include <zephyr/sys/printk.h>
 
-const struct device* ina219Sys = device_get_binding("INA219 sys");
-const struct device* ina219Sol = device_get_binding("INA219 sol");
+const struct device* ina219Sys = DEVICE_DT_GET(DT_NODELABEL(ina219_0));
+const struct device* ina219Sol = DEVICE_DT_GET(DT_NODELABEL(ina219_1));
 const struct device* serial = DEVICE_DT_GET(DT_NODELABEL(cdc_acm_uart0));
 const struct device* lora = DEVICE_DT_GET(DT_NODELABEL(lora0));
 const struct device* lsm6dso = DEVICE_DT_GET(DT_NODELABEL(lsm6dso0));
 const struct device* lis2mdl = DEVICE_DT_GET(DT_NODELABEL(lis2mdl0));
+const struct device* rtc = DEVICE_DT_GET(DT_NODELABEL(rtc0));
 
 int main(int argc, char* argv[]) {
     // ** DO NOT REMOVE **//
@@ -32,6 +33,7 @@ int main(int argc, char* argv[]) {
     inputs.uartDevice = serial;
     inputs.lsm6dsoDevice = lsm6dso;
     inputs.lis2mdlDevice = lis2mdl;
+    inputs.rtcDevice = rtc;
     inputs.baudRate = 115200;
 
     // Setup, cycle, and teardown topology

FprimeZephyrReference/ReferenceDeployment/Top/ReferenceDeploymentTopology.cpp

@@ -103,6 +103,9 @@ void setupTopology(const TopologyState& state) {
     // Autocoded task kick-off (active components). Function provided by autocoder.
     startTasks(state);
 
+    // Try to configure the RTC device first because all other components need time
+    rtcManager.configure(state.rtcDevice);
+
     // We have a pipeline for both the LoRa and UART drive to allow for ground harness debugging an
     // for over-the-air communications.
     lora.start(state.loraDevice, Zephyr::TransmitState::DISABLED);

FprimeZephyrReference/ReferenceDeployment/Top/ReferenceDeploymentTopologyDefs.hpp

@@ -79,6 +79,7 @@ struct TopologyState {
     const device* ina219SolDevice;                //!< device path for solar panel ina219
     const device* lsm6dsoDevice;                  //!< LSM6DSO device path for accelerometer/gyroscope
     const device* lis2mdlDevice;                  //!< LIS2MDL device path for magnetometer
+    const device* rtcDevice;                      //!< RTC device path
 };
 
 namespace PingEntries = ::PingEntries;

boards/bronco_space/proves_flight_control_board_v5/proves_flight_control_board_v5.dtsi

@@ -141,7 +141,7 @@ zephyr_udc0: &usbd {
 	pinctrl-names = "default";
 	clock-frequency = <100000>;
 
-	ina219Sys: ina219Sys@40 {
+	ina219_0: ina219_0@40 {
 		compatible = "ti,ina219";
 		reg = <0x40>;
 		brng = <0>;
@@ -152,7 +152,8 @@ zephyr_udc0: &usbd {
 		lsb-microamp = <61>;
 		label = "INA219 sys";
 	};
-	ina219Sol: ina219Sol@41 {
+
+	ina219_1: ina219_1@41 {
 		compatible = "ti,ina219";
 		reg = <0x41>;
 		brng = <0>;
@@ -183,7 +184,8 @@ zephyr_udc0: &usbd {
 		reg = <0x1e>;
 		label = "LIS2MDL";
 	};
-	rv3028: rv3028@52 {
+
+	rtc0: rtc0@52 {
 		compatible = "microcrystal,rv3028";
 		reg = <0x52>;
 		int-gpios = <&gpio0 27 GPIO_ACTIVE_HIGH>;