commit 7b21ef21a35ea1736058f89bb05be049ff4ab1ac
author Johnathan Mantey <johnathanx.mantey@intel.com> Mon Aug 08 12:57:55 2022 -0700
committer Ed Tanous <ed@tanous.net> Thu Aug 25 23:31:04 2022 +0000
tree 00380ad1b375d8f69793a609d7545788408caf8a
parent 3446cbad0427f04afce762f34f1e42062857d610

Replace ExportTempate createsHWMon boolean with an enumeration type

The createsHWMon boolean in the ExportTemplate structure applies an
important initialization strategy for some I2C devies. When new I2C
devices are added to the map of potential I2C devices it is common for
entries to be copied, and pasted, without review of all of the
parameters.

This change is an attempt to reduce copy/paste errors. An enumeration
provides better guidance for initializing the new entry.

Tested:
Confirmed, during debug, the correct initialization path is taken
based upon the hasHWMonDir value.
Confirmed I2C entries are still initialized.

Change-Id: I9141e1875ee99bfe1e7abdc616fb5ea2446e40ba
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>

src/overlay.cpp

diff --git a/src/overlay.cpp b/src/overlay.cpp
index 9dfb6b1..6352cba 100644
--- a/src/overlay.cpp
+++ b/src/overlay.cpp
@@ -64,7 +64,8 @@
 static std::string deviceDirName(uint64_t bus, uint64_t address)
 {
     std::ostringstream name;
-    name << bus << "-" << std::hex << std::setw(4) << std::setfill('0') << address;
+    name << bus << "-" << std::hex << std::setw(4) << std::setfill('0')
+         << address;
     return name.str();
 }
 
@@ -160,7 +161,7 @@
 static bool deviceIsCreated(const std::string& busPath,
                             const std::shared_ptr<uint64_t>& bus,
                             const std::shared_ptr<uint64_t>& address,
-                            const bool createsHWMon)
+                            const devices::createsHWMon hasHWMonDir)
 {
     if (!bus || !address)
     {
@@ -169,7 +170,7 @@
 
     std::filesystem::path dirPath = busPath;
     dirPath /= deviceDirName(*bus, *address);
-    if (createsHWMon)
+    if (hasHWMonDir == devices::createsHWMon::hasHWMonDir)
     {
         dirPath /= "hwmon";
     }
@@ -184,7 +185,8 @@
                        const std::shared_ptr<uint64_t>& bus,
                        const std::shared_ptr<uint64_t>& address,
                        const std::string& constructor,
-                       const std::string& destructor, const bool createsHWMon,
+                       const std::string& destructor,
+                       const devices::createsHWMon hasHWMonDir,
                        const size_t retries = 5)
 {
     if (retries == 0U)
@@ -193,7 +195,7 @@
     }
 
     // If it's already instantiated, there's nothing we need to do.
-    if (deviceIsCreated(busPath, bus, address, createsHWMon))
+    if (deviceIsCreated(busPath, bus, address, hasHWMonDir))
     {
         return 0;
     }
@@ -202,24 +204,23 @@
     createDevice(busPath, parameters, constructor);
 
     // If it didn't work, delete it and try again in 500ms
-    if (!deviceIsCreated(busPath, bus, address, createsHWMon))
+    if (!deviceIsCreated(busPath, bus, address, hasHWMonDir))
     {
         deleteDevice(busPath, address, destructor);
 
         std::shared_ptr<boost::asio::steady_timer> createTimer =
             std::make_shared<boost::asio::steady_timer>(io);
         createTimer->expires_after(std::chrono::milliseconds(500));
-        createTimer->async_wait([createTimer, busPath, parameters, bus,
-                                 address, constructor, destructor, createsHWMon,
+        createTimer->async_wait([createTimer, busPath, parameters, bus, address,
+                                 constructor, destructor, hasHWMonDir,
                                  retries](const boost::system::error_code& ec) {
             if (ec)
             {
                 std::cerr << "Timer error: " << ec << "\n";
                 return -2;
             }
-            return buildDevice(busPath, parameters, bus, address,
-                               constructor, destructor, createsHWMon,
-                               retries - 1);
+            return buildDevice(busPath, parameters, bus, address, constructor,
+                               destructor, hasHWMonDir, retries - 1);
         });
     }
 
@@ -235,7 +236,7 @@
     std::string busPath = exportTemplate.busPath;
     std::string constructor = exportTemplate.add;
     std::string destructor = exportTemplate.remove;
-    bool createsHWMon = exportTemplate.createsHWMon;
+    devices::createsHWMon hasHWMonDir = exportTemplate.hasHWMonDir;
     std::string name = "unknown";
     std::shared_ptr<uint64_t> bus = nullptr;
     std::shared_ptr<uint64_t> address = nullptr;
@@ -280,7 +281,7 @@
     }
 
     int err = buildDevice(busPath, parameters, bus, address, constructor,
-                          destructor, createsHWMon);
+                          destructor, hasHWMonDir);
 
     if ((err == 0) && boost::ends_with(type, "Mux") && bus && address &&
         (channels != nullptr))