#2347: Refactor NotificationManager::Notification

doc/BLEFS.md

@@ -14,7 +14,7 @@ There are two relevant UUIDs in this protocol: the version characteristic, and t
 
 UUID: `adaf0100-4669-6c65-5472-616e73666572`
 
-The version characteristic returns the version of the protocol to which the sender adheres. It returns a single unsigned 32-bit integer. The latest version at the time of writing this is 4.
+The version characteristic returns the version of the protocol to which the sender adheres. It returns a single unsigned 16-bit integer. The latest version at the time of writing this is 4.
 
 ### Transfer
 
@@ -71,7 +71,7 @@ To begin writing to a file, a header must first be sent. The header packet shoul
 - Unsigned 32-bit integer encoding the size of the file that will be sent
 - File path: UTF-8 encoded string that is _not_ null terminated.
 
-To continue reading the file after this initial packet, the following packet should be sent until all the data has been sent and a response had been received with 0 free space. No close command is required after the data has been received.
+To continue writing the file after this initial packet, the following packet should be sent until all the data has been sent and a response had been received with 0 free space. No close command is required after the data has been received.
 
 - Command (single byte): `0x22`
 - Status: `0x01`

src/components/ble/AlertNotificationClient.cpp

@@ -156,10 +156,7 @@ void AlertNotificationClient::OnNotification(ble_gap_event* event) {
     size_t bufferSize = std::min(packetLen + stringTerminatorSize, maxBufferSize);
     auto messageSize = std::min(maxMessageSize, (bufferSize - headerSize));
 
-    NotificationManager::Notification notif;
-    os_mbuf_copydata(event->notify_rx.om, headerSize, messageSize - 1, notif.message.data());
-    notif.message[messageSize - 1] = '\0';
-    notif.size = messageSize;
+    NotificationManager::Notification notif(event->notify_rx.om, headerSize, messageSize);
     notif.category = Pinetime::Controllers::NotificationManager::Categories::SimpleAlert;
     notificationManager.Push(std::move(notif));
 

src/components/ble/AlertNotificationService.cpp

@@ -61,11 +61,8 @@ int AlertNotificationService::OnAlert(struct ble_gatt_access_ctxt* ctxt) {
     auto messageSize = std::min(maxMessageSize, (bufferSize - headerSize));
     Categories category;
 
-    NotificationManager::Notification notif;
-    os_mbuf_copydata(ctxt->om, headerSize, messageSize - 1, notif.message.data());
+    NotificationManager::Notification notif(ctxt->om, headerSize, messageSize);
     os_mbuf_copydata(ctxt->om, 0, 1, &category);
-    notif.message[messageSize - 1] = '\0';
-    notif.size = messageSize;
 
     // TODO convert all ANS categories to NotificationController categories
     switch (category) {

src/components/ble/DfuService.cpp

@@ -82,9 +82,7 @@ void DfuService::Init() {
 int DfuService::OnServiceData(uint16_t connectionHandle, uint16_t attributeHandle, ble_gatt_access_ctxt* context) {
 #ifndef PINETIME_IS_RECOVERY
   if (systemTask.GetSettings().GetDfuAndFsMode() == Pinetime::Controllers::Settings::DfuAndFsMode::Disabled) {
-    Pinetime::Controllers::NotificationManager::Notification notif;
-    memcpy(notif.message.data(), denyAlert, denyAlertLength);
-    notif.size = denyAlertLength;
+    Pinetime::Controllers::NotificationManager::Notification notif(denyAlert, denyAlertLength);
     notif.category = Pinetime::Controllers::NotificationManager::Categories::SimpleAlert;
     systemTask.GetNotificationManager().Push(std::move(notif));
     systemTask.PushMessage(Pinetime::System::Messages::OnNewNotification);

src/components/ble/FSService.cpp

@@ -53,9 +53,7 @@ void FSService::Init() {
 int FSService::OnFSServiceRequested(uint16_t connectionHandle, uint16_t attributeHandle, ble_gatt_access_ctxt* context) {
 #ifndef PINETIME_IS_RECOVERY
   if (systemTask.GetSettings().GetDfuAndFsMode() == Pinetime::Controllers::Settings::DfuAndFsMode::Disabled) {
-    Pinetime::Controllers::NotificationManager::Notification notif;
-    memcpy(notif.message.data(), denyAlert, denyAlertLength);
-    notif.size = denyAlertLength;
+    Pinetime::Controllers::NotificationManager::Notification notif(denyAlert, denyAlertLength);
     notif.category = Pinetime::Controllers::NotificationManager::Categories::SimpleAlert;
     systemTask.GetNotificationManager().Push(std::move(notif));
     systemTask.PushMessage(Pinetime::System::Messages::OnNewNotification);

src/components/ble/ImmediateAlertService.cpp

@@ -62,9 +62,7 @@ int ImmediateAlertService::OnAlertLevelChanged(uint16_t attributeHandle, ble_gat
       auto alertLevel = static_cast<Levels>(context->om->om_data[0]);
       auto* alertString = ToString(alertLevel);
 
-      NotificationManager::Notification notif;
-      std::memcpy(notif.message.data(), alertString, strlen(alertString) + 1);
-      notif.size = strlen(alertString) + 1;
+      NotificationManager::Notification notif(alertString, strlen(alertString) + 1);
       notif.category = Pinetime::Controllers::NotificationManager::Categories::SimpleAlert;
       notificationManager.Push(std::move(notif));
 

src/components/ble/NotificationManager.cpp

@@ -132,6 +132,23 @@ size_t NotificationManager::NbNotifications() const {
   return size;
 }
 
+NotificationManager::Notification::Notification() {
+}
+
+NotificationManager::Notification::Notification(const char* message, uint8_t size) {
+  uint8_t effectiveSize = std::min(std::max(size, (uint8_t) 1), NotificationManager::MessageSize);
+  memcpy(this->message.data(), message, effectiveSize - 1);
+  this->message[effectiveSize - 1] = '\0';
+  this->size = effectiveSize;
+}
+
+NotificationManager::Notification::Notification(const struct os_mbuf* om, int off, uint8_t size) {
+  uint8_t effectiveSize = std::min(std::max(size, (uint8_t) 1), NotificationManager::MessageSize);
+  os_mbuf_copydata(om, off, effectiveSize - 1, this->message.data());
+  this->message[effectiveSize - 1] = '\0';
+  this->size = effectiveSize;
+}
+
 const char* NotificationManager::Notification::Message() const {
   const char* itField = std::find(message.begin(), message.begin() + size - 1, '\0');
   if (itField != message.begin() + size - 1) {

src/components/ble/NotificationManager.h

@@ -5,6 +5,12 @@
 #include <cstddef>
 #include <cstdint>
 
+#define min // workaround: nimble's min/max macros conflict with libstdc++
+#define max
+#include <host/ble_gap.h>
+#undef max
+#undef min
+
 namespace Pinetime {
   namespace Controllers {
     class NotificationManager {
@@ -25,17 +31,23 @@ namespace Pinetime {
       static constexpr uint8_t MessageSize {100};
 
       struct Notification {
+      public:
         using Id = uint8_t;
         using Idx = uint8_t;
 
-        std::array<char, MessageSize + 1> message{};
-        uint8_t size;
         Categories category = Categories::Unknown;
         Id id = 0;
         bool valid = false;
 
+        Notification();
+        Notification(const char* message, uint8_t size);
+        Notification(const struct os_mbuf* om, int off, uint8_t size);
         const char* Message() const;
         const char* Title() const;
+
+      private:
+        std::array<char, MessageSize + 1> message {};
+        uint8_t size;
       };
 
       void Push(Notification&& notif);

src/systemtask/SystemTask.cpp

@@ -310,14 +310,14 @@ void SystemTask::Work() {
           if (state != SystemTaskState::GoingToSleep) {
             break;
           }
-          if (BootloaderVersion::IsValid()) {
-            // First versions of the bootloader do not expose their version and cannot initialize the SPI NOR FLASH
-            // if it's in sleep mode. Avoid bricked device by disabling sleep mode on these versions.
-            spiNorFlash.Sleep();
-          }
 
-          // Must keep SPI awake when still updating the display for always on
+          // Must keep SPI and flash awake when still updating the display for always on
           if (msg == Messages::OnDisplayTaskSleeping) {
+            if (BootloaderVersion::IsValid()) {
+              // First versions of the bootloader do not expose their version and cannot initialize the SPI NOR FLASH
+              // if it's in sleep mode. Avoid bricked device by disabling sleep mode on these versions.
+              spiNorFlash.Sleep();
+            }
             spi.Sleep();
           }
 
@@ -409,14 +409,13 @@ void SystemTask::GoToRunning() {
     // SPI only switched off when entering Sleeping, not AOD or GoingToSleep
     if (state == SystemTaskState::Sleeping) {
       spi.Wakeup();
+      spiNorFlash.Wakeup();
     }
 
     // Double Tap needs the touch screen to be in normal mode
     if (!settingsController.isWakeUpModeOn(Pinetime::Controllers::Settings::WakeUpMode::DoubleTap)) {
       touchPanel.Wakeup();
     }
-
-    spiNorFlash.Wakeup();
   }
 
   displayApp.PushMessage(Pinetime::Applications::Display::Messages::GoToRunning);