Adding documentation for DAC module and its testbench

Author: ErickOF

modules/dac/include/dac.hpp

@@ -5,21 +5,48 @@
 #include "vunit.hpp"
 
 
+/**
+ * @brief Digital to Analog Converter module representation
+ * This module generates an analog signal based on the [Vmin, Vmax] voltage
+ * range
+ * 
+ * @tparam BITS - the number of output bits of the digital code
+ * @tparam VMIN - lowest voltage value
+ * @tparam VMAX - highest voltage value
+ * @tparam VU - voltage unit based on VUnit
+ */
 template <unsigned int BITS = 8, int VMIN = 0, int VMAX = 5, VUnit VU = VUnit::v>
 SCA_TDF_MODULE(dac)
 {
 protected:
-  const double V_MAX = static_cast<double>(VMAX) / static_cast<double>(VU);
+  // Min voltage value based on the voltage units
   const double V_MIN = static_cast<double>(VMIN) / static_cast<double>(VU);
+  // Max voltage value based on the voltage units
+  const double V_MAX = static_cast<double>(VMAX) / static_cast<double>(VU);
+  // Max digital output code
   const double MAX_DIG = static_cast<double>((1 << BITS) - 1);
 public:
+  // Input digital code
   sca_tdf::sca_in<sc_dt::sc_uint<BITS> > in;
+  // Output analog voltage
   sca_tdf::sca_out<double> out;
 
-  SCA_CTOR(dac) : in("in"), out("out") {
+  /**
+   * @brief Construct a new dac object
+   * 
+   */
+  SCA_CTOR(dac) : in("in"), out("out")
+  {
+    // Propagation time from input to output
     set_timestep(sca_core::sca_time(0.1, sc_core::SC_US));
   }
 
+  /**
+   * @brief Convert the digital signal into analog signal
+   * The N-bit digital code is converted into an analog signal in a voltage
+   * range from Vmin to Vmax
+   * 
+   */
   void processing()
   {
     double dig_in = static_cast<double>(this->in.read().to_uint());
@@ -28,4 +55,5 @@ SCA_TDF_MODULE(dac)
     this->out.write(ana_out);
   }
 };
+
 #endif // IPS_DAC_MODEL_HPP

modules/dac/include/test_dac.hpp modules/dac/include/seq_item_dac.hppmodules/dac/include/test_dac.hpp renamed to modules/dac/include/seq_item_dac.hpp

@@ -1,15 +1,22 @@
-#ifndef IPS_TEST_DAC_HPP
-#define IPS_TEST_DAC_HPP
+#ifndef IPS_SEQ_ITEM_DAC_HPP
+#define IPS_SEQ_ITEM_DAC_HPP
 
 #include <cstdlib>
 
 
+/**
+ * @brief This class is used to generate the digital code for the test
+ * 
+ * @tparam N 
+ */
 template <unsigned int N>
-SCA_TDF_MODULE(test_dac) {
+SCA_TDF_MODULE(seq_item_dac)
+{
 public:
   sca_tdf::sca_out<sc_dt::sc_uint<N> > o_dig;
 
-  SCA_CTOR(test_dac) {
+  SCA_CTOR(seq_item_dac)
+  {
     set_timestep(sca_core::sca_time(0.1, sc_core::SC_US));
   }
 
@@ -19,4 +26,4 @@ SCA_TDF_MODULE(test_dac) {
   }
 };
 
-#endif // IPS_TEST_DAC_HPP
+#endif // IPS_SEQ_ITEM_DAC_HPP

modules/dac/src/tb_dac.cpp

@@ -1,29 +1,41 @@
 #include <systemc-ams.h>
 #include "dac.hpp"
-#include "test_dac.hpp"
+#include "seq_item_dac.hpp"
 
 #define N 8
 
 
 int sc_main(int, char*[])
 {
+  // Max number of sequence items to test
+  const int MAX_SEQ_ITEMS = (1 << N) - 1;
+
+  // Signals to connect
   sca_tdf::sca_signal<sc_dt::sc_uint<N> > s_dig;
   sca_tdf::sca_signal<double> s_ana_out;
 
-  const int MAX_ITER = (1 << N) - 1;
-
+  // DUT
   dac<N> ips_dac("ips_dac");
   ips_dac.in(s_dig);
   ips_dac.out(s_ana_out);
 
-  test_dac<N> ips_test_dac("ips_test_dac");
-  ips_test_dac.o_dig(s_dig);
+  // Sequence item generator for DAC
+  seq_item_dac<N> ips_seq_item_dac("ips_seq_item_dac");
+  ips_seq_item_dac.o_dig(s_dig);
 
+  // Dump waveform
   sca_util::sca_trace_file* tf = sca_util::sca_create_vcd_trace_file("ips_dac");
   sca_util::sca_trace(tf, s_dig, "in");
   sca_util::sca_trace(tf, s_ana_out, "out");
 
-  sc_start(MAX_ITER * 0.1, SC_US);
+  // Start time
+  std::cout << "@" << sc_time_stamp() << std::endl;
+
+  // Run test
+  sc_start(MAX_SEQ_ITEMS * 0.1, SC_US);
+
+  // End time
+  std::cout << "@" << sc_time_stamp() << std::endl;
 
   sca_util::sca_close_vcd_trace_file(tf);
 

modules/utils/include/vunit.hpp

@@ -1,9 +1,17 @@
 #ifndef IPS_VUnit_HPP
 #define IPS_VUnit_HPP
 
+
+/**
+ * @brief Presents the voltage units
+ * 
+ */
 enum class VUnit {
+  // Normal volts
   v = 1,
+  // Milivolts
   mv = 1000,
+  // Microvolts
   uv = 1000000,
 };