From d98e789a8d392ed8cc21644f4c5d901a77518824 Mon Sep 17 00:00:00 2001
From: Mateusz Grzywacz <mateusz.grzywacz@mudita.com>
Date: Mon, 25 Jan 2021 18:11:34 +0100
Subject: [PATCH] [EGD-5193] Eink - Power off the display

The eink has to be powered off sometimes. Implement a
timer of arbitrary timeout (3,8s) to power off the
display if it's not used.
---
 module-services/service-eink/EinkDisplay.cpp | 12 ++--
 module-services/service-eink/EinkDisplay.hpp |  2 +-
 module-services/service-eink/ServiceEink.cpp | 59 +++++++++++++++-----
 module-services/service-eink/ServiceEink.hpp | 14 ++---
 module-services/service-gui/ServiceGUI.cpp   | 17 ++++--
 module-services/service-gui/ServiceGUI.hpp   |  1 +
 6 files changed, 71 insertions(+), 34 deletions(-)

diff --git a/module-services/service-eink/EinkDisplay.cpp b/module-services/service-eink/EinkDisplay.cpp
index b003733100b322ebdc61963f6cf162947d53836b..a7f6153514b2853a2982586d354900b65dc0d0bd 100644
--- a/module-services/service-eink/EinkDisplay.cpp
+++ b/module-services/service-eink/EinkDisplay.cpp
@@ -143,10 +143,10 @@ namespace service::eink
         return true;
     }
 
-    bool EinkDisplay::setWaveform(EinkWaveforms_e mode, std::int32_t temperature)
+    EinkStatus_e EinkDisplay::setWaveform(EinkWaveforms_e mode, std::int32_t temperature)
     {
         if (!isNewWaveformNeeded(mode, temperature)) {
-            return true;
+            return EinkOK;
         }
 
         auto currentOffset =
@@ -160,13 +160,13 @@ namespace service::eink
 
         if (offset == currentOffset) {
             // current waveform is still the best fit
-            return true;
+            return EinkOK;
         }
 
         auto file = std::fopen(LutsFileName, "rb");
         if (file == nullptr) {
             LOG_FATAL("Could not find the LUTS.bin file. Returning");
-            return false;
+            return EinkWaveformsFileOpenFail;
         }
         auto fileHandlerCleanup = gsl::finally([&file]() { std::fclose(file); });
 
@@ -184,7 +184,7 @@ namespace service::eink
         std::fread(&currentWaveform.LUTCData[1], 1, LUTCSize, file);
 
         EinkUpdateWaveform(&currentWaveform);
-        return true;
+        return EinkOK;
     }
 
     unsigned int EinkDisplay::toWaveformTemperatureOffset(std::int32_t temperature) noexcept
@@ -194,7 +194,7 @@ namespace service::eink
         if (temperature >= LUTTemperatureSubcritical)
             return LUTTemperatureOffsetSubcritical;
         if (temperature < LUTTemperatureMinimal) {
-            temperature = 0;
+            temperature = LUTTemperatureMinimal;
         }
         return temperature / LUTTemperatureOffsetInterval;
     }
diff --git a/module-services/service-eink/EinkDisplay.hpp b/module-services/service-eink/EinkDisplay.hpp
index 08316bfa2edb544339d6986eec710b654c557e87..6449e8f34c6e242f3ca7b254d1b10096a9011cc3 100644
--- a/module-services/service-eink/EinkDisplay.hpp
+++ b/module-services/service-eink/EinkDisplay.hpp
@@ -33,7 +33,7 @@ namespace service::eink
         void powerOff();
         void shutdown();
 
-        bool setWaveform(EinkWaveforms_e mode, std::int32_t temperature);
+        EinkStatus_e setWaveform(EinkWaveforms_e mode, std::int32_t temperature);
         void setMode(EinkDisplayColorMode_e mode) noexcept;
 
         std::int32_t getLastTemperature() const noexcept;
diff --git a/module-services/service-eink/ServiceEink.cpp b/module-services/service-eink/ServiceEink.cpp
index 61220b564cdc38cd116a87bd31ab9fb9a964d620..66ac520d361877315e74733ee145a40178066e71 100644
--- a/module-services/service-eink/ServiceEink.cpp
+++ b/module-services/service-eink/ServiceEink.cpp
@@ -4,8 +4,8 @@
 #include "ServiceEink.hpp"
 #include "messages/EinkModeMessage.hpp"
 #include "messages/PrepareDisplayEarlyRequest.hpp"
-#include <service-gui/Common.hpp>
 #include <service-gui/messages/EinkInitialized.hpp>
+#include <service-gui/Common.hpp>
 #include <time/ScopedTime.hpp>
 
 #include <log/log.hpp>
@@ -16,16 +16,20 @@
 
 #include <cstring>
 #include <memory>
+#include <gsl_util>
 
 namespace service::eink
 {
     namespace
     {
         constexpr auto ServceEinkStackDepth = 4096 + 1024;
+        constexpr std::chrono::milliseconds displayPowerOffTimeout{3800};
     } // namespace
 
     ServiceEink::ServiceEink(const std::string &name, std::string parent)
-        : sys::Service(name, parent, ServceEinkStackDepth), currentState{State::Running}
+        : sys::Service(name, std::move(parent), ServceEinkStackDepth), currentState{State::Running},
+          displayPowerOffTimer{
+              std::make_unique<sys::Timer>(this, displayPowerOffTimeout.count(), sys::Timer::Type::SingleShot)}
     {
         connect(typeid(EinkModeMessage),
                 [this](sys::Message *message) -> sys::MessagePointer { return handleEinkModeChangedMessage(message); });
@@ -35,6 +39,8 @@ namespace service::eink
 
         connect(typeid(PrepareDisplayEarlyRequest),
                 [this](sys::Message *request) -> sys::MessagePointer { return handlePrepareEarlyRequest(request); });
+
+        displayPowerOffTimer->connect([this](sys::Timer &it) { display.powerOff(); });
     }
 
     sys::MessagePointer ServiceEink::DataReceivedHandler(sys::DataMessage *msgl, sys::ResponseMessage *response)
@@ -118,39 +124,64 @@ namespace service::eink
         }
         utils::time::Scoped measurement("ImageMessage");
 
-        updateDisplay(message->getData(), message->getRefreshMode());
+        showImage(message->getData(), message->getRefreshMode());
         return std::make_shared<service::eink::ImageDisplayedNotification>(message->getContextId());
     }
 
-    void ServiceEink::updateDisplay(std::uint8_t *frameBuffer, ::gui::RefreshModes refreshMode)
+    void ServiceEink::showImage(std::uint8_t *frameBuffer, ::gui::RefreshModes refreshMode)
     {
-        prepareDisplay(refreshMode, WaveformTemperature::KEEP_CURRENT);
+        displayPowerOffTimer->stop();
+
+        auto displayPowerOffTimerReload = gsl::finally([this]() { displayPowerOffTimer->reload(); });
 
-        if (const auto status = display.update(frameBuffer); status != EinkOK) {
+        if (const auto status = prepareDisplay(refreshMode, WaveformTemperature::KEEP_CURRENT);
+            status != EinkStatus_e ::EinkOK) {
+            LOG_FATAL("Failed to prepare frame");
+            return;
+        }
+
+        if (const auto status = updateDisplay(frameBuffer, refreshMode); status != EinkStatus_e ::EinkOK) {
             LOG_FATAL("Failed to update frame");
+            return;
         }
 
-        const auto isDeepRefresh = refreshMode == ::gui::RefreshModes::GUI_REFRESH_DEEP;
-        if (const auto status =
-                display.refresh(isDeepRefresh ? EinkDisplayTimingsDeepCleanMode : EinkDisplayTimingsFastRefreshMode);
-            status != EinkOK) {
+        if (const auto status = refreshDisplay(refreshMode); status != EinkStatus_e ::EinkOK) {
             LOG_FATAL("Failed to refresh frame");
+            return;
         }
     }
 
-    void ServiceEink::prepareDisplay(::gui::RefreshModes refreshMode, WaveformTemperature behaviour)
+    EinkStatus_e ServiceEink::updateDisplay(std::uint8_t *frameBuffer, ::gui::RefreshModes refreshMode)
+    {
+        return display.update(frameBuffer);
+    }
+
+    EinkStatus_e ServiceEink::refreshDisplay(::gui::RefreshModes refreshMode)
+    {
+        const auto isDeepRefresh = refreshMode == ::gui::RefreshModes::GUI_REFRESH_DEEP;
+        return display.refresh(isDeepRefresh ? EinkDisplayTimingsDeepCleanMode : EinkDisplayTimingsFastRefreshMode);
+    }
+
+    EinkStatus_e ServiceEink::prepareDisplay(::gui::RefreshModes refreshMode, WaveformTemperature behaviour)
     {
+        EinkStatus_e status;
+
+        displayPowerOffTimer->stop();
         display.powerOn();
 
         const auto temperature = behaviour == WaveformTemperature::KEEP_CURRENT ? display.getLastTemperature()
                                                                                 : EinkGetTemperatureInternal();
+
         if (refreshMode == ::gui::RefreshModes::GUI_REFRESH_DEEP) {
-            display.setWaveform(EinkWaveforms_e::EinkWaveformGC16, temperature);
-            display.dither();
+            status = display.setWaveform(EinkWaveforms_e::EinkWaveformGC16, temperature);
+            if (status == EinkOK) {
+                display.dither();
+            }
         }
         else {
-            display.setWaveform(EinkWaveforms_e::EinkWaveformDU2, temperature);
+            status = display.setWaveform(EinkWaveforms_e::EinkWaveformDU2, temperature);
         }
+        return status;
     }
 
     sys::MessagePointer ServiceEink::handlePrepareEarlyRequest(sys::Message *message)
diff --git a/module-services/service-eink/ServiceEink.hpp b/module-services/service-eink/ServiceEink.hpp
index da416dd80b3c1694b5600a546959a115cbca60b9..1ab26c854d6f6186773dca111ebbfc90a4647e5e 100644
--- a/module-services/service-eink/ServiceEink.hpp
+++ b/module-services/service-eink/ServiceEink.hpp
@@ -6,6 +6,7 @@
 #include <Service/Common.hpp>
 #include <Service/Message.hpp>
 #include <Service/Service.hpp>
+#include <Service/Timer.hpp>
 
 #include "EinkDisplay.hpp"
 
@@ -47,8 +48,11 @@ namespace service::eink
 
         void enterActiveMode();
         void suspend();
-        void updateDisplay(std::uint8_t *frameBuffer, ::gui::RefreshModes refreshMode);
-        void prepareDisplay(::gui::RefreshModes refreshMode, WaveformTemperature behaviour);
+
+        void showImage(std::uint8_t *frameBuffer, ::gui::RefreshModes refreshMode);
+        EinkStatus_e prepareDisplay(::gui::RefreshModes refreshMode, WaveformTemperature behaviour);
+        EinkStatus_e refreshDisplay(::gui::RefreshModes refreshMode);
+        EinkStatus_e updateDisplay(uint8_t *frameBuffer, ::gui::RefreshModes refreshMode);
 
         sys::MessagePointer handleEinkModeChangedMessage(sys::Message *message);
         sys::MessagePointer handleImageMessage(sys::Message *message);
@@ -56,11 +60,7 @@ namespace service::eink
 
         EinkDisplay display;
         State currentState;
-
-        /*
-         * PowerOffTimer to be implemented when needed.
-         * It should power off the display when not used for 3000ms.
-         */
+        std::unique_ptr<sys::Timer> displayPowerOffTimer;
     };
 } // namespace service::eink
 
diff --git a/module-services/service-gui/ServiceGUI.cpp b/module-services/service-gui/ServiceGUI.cpp
index f8adad05a2e46e7b6d1f95872d9308958a6b124b..599b923c7afb8ee1c7aca55f4da68d1890e95c29 100644
--- a/module-services/service-gui/ServiceGUI.cpp
+++ b/module-services/service-gui/ServiceGUI.cpp
@@ -126,7 +126,7 @@ namespace service::gui
                 setState(State::Suspended);
             }
 
-            if (!contextPool->isAnyContextLocked()) {
+            if (!isAnyFrameBeingRenderedOrDisplayed()) {
                 prepareDisplayEarly(drawMsg->mode);
             }
             notifyRenderer(std::move(drawMsg->commands), drawMsg->mode);
@@ -206,7 +206,7 @@ namespace service::gui
         contextReleaseTimer->connect([this, contextId](sys::Timer &it) {
             eink::ImageDisplayedNotification notification{contextId};
             handleImageDisplayedNotification(&notification);
-            LOG_WARN("Context # %d released after timeout. Does ServiceEink respond properly?", contextId);
+            LOG_WARN("Context #%d released after timeout. Does ServiceEink respond properly?", contextId);
         });
         contextReleaseTimer->start();
     }
@@ -237,7 +237,9 @@ namespace service::gui
         contextReleaseTimer->stop();
         setState(State::Idle);
 
-        if (isNextFrameReady()) {
+        // Even if the next render is already cached, if any context in the pool is currently being processed, then
+        // we better wait for it.
+        if (isNextFrameReady() and not isAnyFrameBeingRenderedOrDisplayed()) {
             trySendNextFrame();
         }
         return sys::MessageNone{};
@@ -245,9 +247,12 @@ namespace service::gui
 
     bool ServiceGUI::isNextFrameReady() const noexcept
     {
-        // Even if the next render is already cached, if any context in the pool is currently being processed, then we
-        // better wait for it.
-        return cachedRender.has_value() && !contextPool->isAnyContextLocked();
+        return cachedRender.has_value();
+    }
+
+    bool ServiceGUI::isAnyFrameBeingRenderedOrDisplayed() const noexcept
+    {
+        return contextPool->isAnyContextLocked();
     }
 
     void ServiceGUI::trySendNextFrame()
diff --git a/module-services/service-gui/ServiceGUI.hpp b/module-services/service-gui/ServiceGUI.hpp
index 8ee24afab632d5c2b11812d1bf51ed5cf5ec621f..6c4e7d22080cfbd6741c1b151864bf42971dde04 100644
--- a/module-services/service-gui/ServiceGUI.hpp
+++ b/module-services/service-gui/ServiceGUI.hpp
@@ -71,6 +71,7 @@ namespace service::gui
         void sendOnDisplay(::gui::Context *context, int contextId, ::gui::RefreshModes refreshMode);
         void scheduleContextRelease(int contextId);
         bool isNextFrameReady() const noexcept;
+        bool isAnyFrameBeingRenderedOrDisplayed() const noexcept;
         void trySendNextFrame();
 
         void setState(State state) noexcept;