gpio: notify about failed locks

xoseperez · Mar 16, 2023 · 3a1e041 · 3a1e041
1 parent 704ddc4
commit 3a1e041
Show file tree

Hide file tree

Showing 23 changed files with 15,895 additions and 15,793 deletions.
diff --git a/code/espurna/data/index.all.html.gz b/code/espurna/data/index.all.html.gz
diff --git a/code/espurna/data/index.curtain.html.gz b/code/espurna/data/index.curtain.html.gz
diff --git a/code/espurna/data/index.garland.html.gz b/code/espurna/data/index.garland.html.gz
diff --git a/code/espurna/data/index.light.html.gz b/code/espurna/data/index.light.html.gz
diff --git a/code/espurna/data/index.lightfox.html.gz b/code/espurna/data/index.lightfox.html.gz
diff --git a/code/espurna/data/index.rfbridge.html.gz b/code/espurna/data/index.rfbridge.html.gz
diff --git a/code/espurna/data/index.rfm69.html.gz b/code/espurna/data/index.rfm69.html.gz
diff --git a/code/espurna/data/index.sensor.html.gz b/code/espurna/data/index.sensor.html.gz
diff --git a/code/espurna/data/index.small.html.gz b/code/espurna/data/index.small.html.gz
diff --git a/code/espurna/data/index.thermostat.html.gz b/code/espurna/data/index.thermostat.html.gz
diff --git a/code/espurna/gpio.cpp b/code/espurna/gpio.cpp
@@ -621,6 +621,19 @@ class Hardware : public GpioBase {
  Mask _mask;
 };
 
+namespace origin {
+namespace internal {
+
+std::forward_list<Origin> origins;
+
+} // namespace internal
+
+void add(Origin origin) {
+ internal::origins.emplace_front(origin);
+}
+
+} // namespace origin
+
 #if WEB_SUPPORT
 namespace web {
 
@@ -651,6 +664,19 @@ void onVisible(JsonObject& root) {
  }
  }
  }
+
+ JsonObject& info = root.createNestedObject(F("gpioInfo"));
+
+ JsonArray& locks = info.createNestedArray(F("failed-locks"));
+ for (auto& origin : origin::internal::origins) {
+ if (!origin.result) {
+ JsonArray& entry = locks.createNestedArray();
+ entry.add(origin.pin);
+ entry.add(origin.location.file);
+ entry.add(origin.location.func);
+ entry.add(origin.location.line);
+ }
+ }
 }
 
 void setup() {
@@ -661,27 +687,15 @@ void setup() {
 } // namespace web
 #endif
 
-namespace origin {
-namespace internal {
-
-std::forward_list<Origin> origins;
-
-} // namespace internal
-
-void add(Origin origin) {
- internal::origins.emplace_front(origin);
-}
-
-} // namespace origin
-
 #if TERMINAL_SUPPORT
 namespace terminal {
 
 PROGMEM_STRING(GpioLocks, "GPIO.LOCKS");
 
 void gpio_list_origins(::terminal::CommandContext&& ctx) {
  for (const auto& origin : origin::internal::origins) {
- ctx.output.printf_P(PSTR("%c %s GPIO%hhu\t%d:%s:%s\n"),
+ ctx.output.printf_P(PSTR("%c %c %s GPIO%hhu\t%d:%s:%s\n"),
+ origin.result ? ' ' : '!',
  origin.lock ? '*' : ' ',
  origin.base, origin.pin,
  origin.location.line,

diff --git a/code/espurna/gpio.h b/code/espurna/gpio.h
@@ -26,6 +26,7 @@ struct Origin {
  const char* base;
  uint8_t pin;
  bool lock;
+ bool result;
  SourceLocation location;
 };
 
@@ -85,16 +86,20 @@ inline bool gpioLock(GpioBase& base, unsigned char pin, bool value,
  espurna::SourceLocation source_location = espurna::make_source_location())
 {
  if (base.valid(pin)) {
+ const auto old = base.lock(pin);
+ base.lock(pin, value);
+
+ const auto result = value != old;
+
  gpioLockOrigin(espurna::gpio::Origin{
  .base = base.id(),
  .pin = pin,
  .lock = value,
- .location = trim_source_location(source_location)
+ .result = result,
+ .location = trim_source_location(source_location),
  });
 
- bool old = base.lock(pin);
- base.lock(pin, value);
- return (value != old);
+ return result;
  }
 
  return false;

diff --git a/code/espurna/static/index.all.html.gz.h b/code/espurna/static/index.all.html.gz.h
diff --git a/code/espurna/static/index.curtain.html.gz.h b/code/espurna/static/index.curtain.html.gz.h
diff --git a/code/espurna/static/index.garland.html.gz.h b/code/espurna/static/index.garland.html.gz.h
diff --git a/code/espurna/static/index.light.html.gz.h b/code/espurna/static/index.light.html.gz.h
diff --git a/code/espurna/static/index.lightfox.html.gz.h b/code/espurna/static/index.lightfox.html.gz.h
diff --git a/code/espurna/static/index.rfbridge.html.gz.h b/code/espurna/static/index.rfbridge.html.gz.h
diff --git a/code/espurna/static/index.rfm69.html.gz.h b/code/espurna/static/index.rfm69.html.gz.h
diff --git a/code/espurna/static/index.sensor.html.gz.h b/code/espurna/static/index.sensor.html.gz.h
diff --git a/code/espurna/static/index.small.html.gz.h b/code/espurna/static/index.small.html.gz.h
diff --git a/code/espurna/static/index.thermostat.html.gz.h b/code/espurna/static/index.thermostat.html.gz.h
diff --git a/code/html/custom.js b/code/html/custom.js
@@ -137,10 +137,10 @@ function magnitudeTypedKey(magnitude, name) {
 // Utils
 // -----------------------------------------------------------------------------
 
-function notifyError(message, source, lineno, colno, error) {
+function showErrorNotification(message) {
  let container = document.getElementById("error-notification");
  if (container.childElementCount > 0) {
- return;
+ return false;
  }
 
  container.style.display = "inherit";
@@ -149,15 +149,24 @@ function notifyError(message, source, lineno, colno, error) {
  let notification = document.createElement("div");
  notification.classList.add("pure-u-1");
  notification.classList.add("pure-u-lg-1");
+ notification.textContent = message;
+
+ container.appendChild(notification);
+
+ return false;
+}
+
+function notifyError(message, source, lineno, colno, error) {
+ let text = "";
  if (error) {
- notification.textContent += error.stack;
+ text = error.stack;
  } else {
- notification.textContent += message;
+ text = message;
  }
- notification.textContent += "\n\nFor more info see the Developer Tools console.";
- container.appendChild(notification);
 
- return false;
+ text += "\n\nFor more info see the Debug Log and / or Developer Tools console.";
+
+ return showErrorNotification(text);
 }
 
 window.onerror = notifyError;
@@ -2556,6 +2565,18 @@ function processData(data) {
  return;
  }
 
+ if ("gpioInfo" === key) {
+ let failed = "Could not acquire locks on the following pins, check configuration\n\n";
+ for (const [pin, file, func, line] of value["failed-locks"]) {
+ failed += `GPIO${pin} @ ${file}:${func}:${line}\n`;
+ }
+
+ if (failed.length > 0) {
+ showErrorNotification(failed);
+ }
+ return;
+ }
+
  // ---------------------------------------------------------------------
  // Actions
  // ---------------------------------------------------------------------