dft: adding validation logic to the dft config

Signed-off-by: Felipe Garay <[email protected]>

Author: fgaray

src/dft/src/Dft.cpp

@@ -84,6 +84,8 @@ void Dft::pre_dft()
 
 void Dft::previewDft(bool verbose)
 {
+  dft_config_->validate(logger_);
+
   for (const auto& [test_mode, test_mode_config] :
        dft_config_->getTestModesConfig()) {
     previewDft(test_mode_config, verbose);
@@ -124,6 +126,8 @@ void Dft::scanReplace()
 
 void Dft::insertDft()
 {
+  dft_config_->validate(logger_);
+
   // iterate and call per test mode
   for (const auto& [_, test_mode_config] : dft_config_->getTestModesConfig()) {
     insertDft(test_mode_config);

src/dft/src/config/DftConfig.cpp

@@ -32,6 +32,8 @@
 
 #include "DftConfig.hh"
 
+#include <iostream>
+
 namespace dft {
 
 namespace {
@@ -85,4 +87,11 @@ DftConfig::getTestModesConfig() const
   return test_modes_config_;
 }
 
+void DftConfig::validate(utl::Logger* logger) const
+{
+  for (const auto& [test_mode_name, test_mode_config] : test_modes_config_) {
+    test_mode_config.validate(logger);
+  }
+}
+
 }  // namespace dft

src/dft/src/config/DftConfig.hh

@@ -56,6 +56,9 @@ class DftConfig
   // Prints the information currently being used by DFT for config
   void report(utl::Logger* logger) const;
 
+  // Checks that the config is in a valid state. Reports issues in the logger
+  void validate(utl::Logger* logger) const;
+
  private:
   // A DFT config can have multiple test modes. If no test mode was defined by
   // the user, then we use the "default" test mode.

src/dft/src/config/ScanArchitectConfig.cpp

@@ -29,9 +29,10 @@
 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 // POSSIBILITY OF SUCH DAMAGE.
-
 #include "ScanArchitectConfig.hh"
 
+#include <iostream>
+
 #include "Formatting.hh"
 
 namespace dft {
@@ -87,4 +88,13 @@ std::string ScanArchitectConfig::ClockMixingName(
   }
 }
 
+void ScanArchitectConfig::validate(utl::Logger* logger) const
+{
+  if (!max_chains_.has_value() && !max_length_.has_value()) {
+    logger->warn(
+        utl::DFT, 45, "Either max_chains or max_length should be specified");
+    return;
+  }
+}
+
 }  // namespace dft

src/dft/src/config/ScanArchitectConfig.hh

@@ -67,6 +67,9 @@ class ScanArchitectConfig
   // Prints using logger->report the config used by Scan Architect
   void report(utl::Logger* logger) const;
 
+  // Checks that the config is in a valid state. Reports issues in the logger
+  void validate(utl::Logger* logger) const;
+
   static std::string ClockMixingName(ClockMixing clock_mixing);
 
  private:

src/dft/src/config/ScanStitchConfig.cpp

@@ -72,4 +72,9 @@ void ScanStitchConfig::report(utl::Logger* logger) const
   logger->report("- Scan Out Name Pattern: '{}'", out_name_pattern_);
 }
 
+void ScanStitchConfig::validate(utl::Logger* logger) const
+{
+  // TODO: For ScanStitchConfig we don't have anything to validate now
+}
+
 }  // namespace dft

src/dft/src/config/ScanStitchConfig.hh

@@ -31,6 +31,8 @@
 // POSSIBILITY OF SUCH DAMAGE.
 #pragma once
 
+#include <optional>
+
 #include "utl/Logger.h"
 #include "Macros.hh"
 
@@ -54,6 +56,11 @@ class ScanStitchConfig
   // Prints using logger->report the config used by Scan Stitch
   void report(utl::Logger* logger) const;
 
+  // Checks that the config is in a valid state. Reports issues in the logger
+  // TODO: For ScanStitchConfig we don't have anything to validate now, it
+  // always returns std::nullopt
+  void validate(utl::Logger* logger) const;
+
  private:
   std::string enable_name_pattern_ = "scan_enable_{}";
   std::string in_name_pattern_ = "scan_in_{}";

src/dft/src/config/TestModeConfig.cpp

@@ -65,4 +65,10 @@ const std::string& TestModeConfig::getName() const
   return name_;
 }
 
+void TestModeConfig::validate(utl::Logger* logger) const
+{
+  scan_architect_config_.validate(logger);
+  scan_stitch_config_.validate(logger);
+}
+
 }  // namespace dft

src/dft/src/config/TestModeConfig.hh

@@ -54,6 +54,9 @@ class TestModeConfig
 
   const std::string& getName() const;
 
+  // Checks that the config is in a valid state. Reports issues in the logger
+  void validate(utl::Logger* logger) const;
+
  private:
   std::string name_;
   ScanArchitectConfig scan_architect_config_;