GFX : wait end of transfert using a task notification.

Code cleaning in SpiMaster.

src/Components/Gfx/Gfx.cpp

@@ -1,4 +1,6 @@
 #include <libraries/svc/nrf_svci.h>
+#include <FreeRTOS.h>
+#include <task.h>
 #include "Gfx.h"
 #include "../../drivers/St7789.h"
 using namespace Pinetime::Components;
@@ -17,10 +19,12 @@ void Gfx::ClearScreen() {
   state.currentIteration = 0;
   state.busy = true;
   state.action = Action::FillRectangle;
+  state.taskToNotify = xTaskGetCurrentTaskHandle();
 
   lcd.BeginDrawBuffer(0, 0, width, height);
   lcd.NextDrawBuffer(reinterpret_cast<const uint8_t *>(buffer), width * 2);
-  while(state.busy) {} // TODO wait on an event/queue/... instead of polling
+  WaitTransfertFinished();
+
 }
 
 void Gfx::FillRectangle(uint8_t x, uint8_t y, uint8_t w, uint8_t h, uint16_t color) {
@@ -30,10 +34,13 @@ void Gfx::FillRectangle(uint8_t x, uint8_t y, uint8_t w, uint8_t h, uint16_t col
   state.currentIteration = 0;
   state.busy = true;
   state.action = Action::FillRectangle;
+  state.color = color;
+  state.taskToNotify = xTaskGetCurrentTaskHandle();
 
   lcd.BeginDrawBuffer(x, y, w, h);
   lcd.NextDrawBuffer(reinterpret_cast<const uint8_t *>(buffer), width * 2);
-  while(state.busy) {} // TODO wait on an event/queue/... instead of polling
+
+  WaitTransfertFinished();
 }
 
 void Gfx::DrawString(uint8_t x, uint8_t y, uint16_t color, const char *text, const FONT_INFO *p_font, bool wrap) {
@@ -100,10 +107,11 @@ void Gfx::DrawChar(const FONT_INFO *font, uint8_t c, uint8_t *x, uint8_t y, uint
   state.font = const_cast<FONT_INFO *>(font);
   state.character = c;
   state.color = color;
+  state.taskToNotify = xTaskGetCurrentTaskHandle();
 
   lcd.BeginDrawBuffer(*x, y, bytes_in_line*8, font->height);
   lcd.NextDrawBuffer(reinterpret_cast<const uint8_t *>(&buffer), bytes_in_line*8*2);
-  while(state.busy) {} // TODO wait on an event/queue/... instead of polling
+  WaitTransfertFinished();
 
   *x += font->charInfo[char_idx].widthBits + font->spacePixels;
 }
@@ -131,6 +139,7 @@ bool Gfx::GetNextBuffer(uint8_t **data, size_t &size) {
   state.remainingIterations--;
   if (state.remainingIterations == 0) {
     state.busy = false;
+    NotifyEndOfTransfert(state.taskToNotify);
     return false;
   }
 
@@ -162,4 +171,16 @@ bool Gfx::GetNextBuffer(uint8_t **data, size_t &size) {
   return true;
 }
 
+void Gfx::NotifyEndOfTransfert(TaskHandle_t task) {
+  if(task != nullptr) {
+    BaseType_t xHigherPriorityTaskWoken = pdFALSE;
+    vTaskNotifyGiveFromISR(task, &xHigherPriorityTaskWoken);
+    portYIELD_FROM_ISR(xHigherPriorityTaskWoken);
+  }
+}
+
+void Gfx::WaitTransfertFinished() const {
+  ulTaskNotifyTake(pdTRUE, 500);
+}
+
 

src/Components/Gfx/Gfx.h

@@ -2,6 +2,8 @@
 #include <cstdint>
 #include <nrf_font.h>
 #include <drivers/BufferProvider.h>
+#include <FreeRTOS.h>
+#include <task.h>
 
 
 namespace Pinetime {
@@ -36,6 +38,7 @@ namespace Pinetime {
           volatile FONT_INFO *font;
           volatile uint16_t color;
           volatile uint8_t character;
+          volatile TaskHandle_t taskToNotify = nullptr;
         };
 
         volatile State state;
@@ -45,6 +48,8 @@ namespace Pinetime {
 
         void pixel_draw(uint8_t x, uint8_t y, uint16_t color);
         void SetBackgroundColor(uint16_t color);
+        void WaitTransfertFinished() const;
+        void NotifyEndOfTransfert(TaskHandle_t task);
     };
   }
 }

src/drivers/SpiMaster.cpp

@@ -26,9 +26,9 @@ bool SpiMaster::Init() {
   }
 
   /* Configure pins, frequency and mode */
-  NRF_SPIM0->PSELSCK  = params.pinSCK;
+  spiBaseAddress->PSELSCK  = params.pinSCK;
-  NRF_SPIM0->PSELMOSI = params.pinMOSI;
+  spiBaseAddress->PSELMOSI = params.pinMOSI;
-  NRF_SPIM0->PSELMISO = params.pinMISO;
+  spiBaseAddress->PSELMISO = params.pinMISO;
   nrf_gpio_pin_set(pinCsn); /* disable Set slave select (inactive high) */
 
   uint32_t frequency;
@@ -36,7 +36,7 @@ bool SpiMaster::Init() {
     case Frequencies::Freq8Mhz: frequency = 0x80000000; break;
     default: return false;
   }
-  NRF_SPIM0->FREQUENCY = frequency;
+  spiBaseAddress->FREQUENCY = frequency;
 
   uint32_t regConfig = 0;
   switch(params.bitOrder) {
@@ -52,26 +52,24 @@ bool SpiMaster::Init() {
     default: return false;
   }
 
-  setup_workaround_for_ftpan_58(NRF_SPIM0, 0, 0);
+  spiBaseAddress->CONFIG = regConfig;
+  spiBaseAddress->EVENTS_ENDRX = 0;
+  spiBaseAddress->EVENTS_ENDTX = 0;
+  spiBaseAddress->EVENTS_END = 0;
 
-  NRF_SPIM0->CONFIG = regConfig;
+  spiBaseAddress->INTENSET = ((unsigned)1 << (unsigned)6);
-  NRF_SPIM0->EVENTS_ENDRX = 0;
+  spiBaseAddress->INTENSET = ((unsigned)1 << (unsigned)1);
-  NRF_SPIM0->EVENTS_ENDTX = 0;
+  spiBaseAddress->INTENSET = ((unsigned)1 << (unsigned)19);
-  NRF_SPIM0->EVENTS_END = 0;
 
-  NRF_SPIM0->INTENSET = ((unsigned)1 << (unsigned)6);
+  spiBaseAddress->ENABLE = (SPIM_ENABLE_ENABLE_Enabled << SPIM_ENABLE_ENABLE_Pos);
-  NRF_SPIM0->INTENSET = ((unsigned)1 << (unsigned)1);
-  NRF_SPIM0->INTENSET = ((unsigned)1 << (unsigned)19);
 
-  NRF_SPIM0->ENABLE = (SPIM_ENABLE_ENABLE_Enabled << SPIM_ENABLE_ENABLE_Pos);
+  NRFX_IRQ_PRIORITY_SET(SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQn,2);
-
-  NRFX_IRQ_PRIORITY_SET(SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQn,6);
   NRFX_IRQ_ENABLE(SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQn);
   return true;
 }
 
 
-void SpiMaster::setup_workaround_for_ftpan_58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel) {
+void SpiMaster::SetupWorkaroundForFtpan58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel) {
   // Create an event when SCK toggles.
   NRF_GPIOTE->CONFIG[gpiote_channel] = (GPIOTE_CONFIG_MODE_Event << GPIOTE_CONFIG_MODE_Pos) |
                                        (spim->PSEL.SCK << GPIOTE_CONFIG_PSEL_Pos) |
@@ -81,6 +79,21 @@ void SpiMaster::setup_workaround_for_ftpan_58(NRF_SPIM_Type *spim, uint32_t ppi_
   NRF_PPI->CH[ppi_channel].EEP = (uint32_t) &NRF_GPIOTE->EVENTS_IN[gpiote_channel];
   NRF_PPI->CH[ppi_channel].TEP = (uint32_t) &spim->TASKS_STOP;
   NRF_PPI->CHENSET = 1U << ppi_channel;
+
+  // Disable IRQ
+  spim->INTENCLR = (1<<6);
+  spim->INTENCLR = (1<<1);
+  spim->INTENCLR = (1<<19);
+}
+
+void SpiMaster::DisableWorkaroundForFtpan58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel) {
+  NRF_GPIOTE->CONFIG[gpiote_channel] = 0;
+  NRF_PPI->CH[ppi_channel].EEP = 0;
+  NRF_PPI->CH[ppi_channel].TEP = 0;
+  NRF_PPI->CHENSET = ppi_channel;
+  spim->INTENSET = (1<<6);
+  spim->INTENSET = (1<<1);
+  spim->INTENSET = (1<<19);
 }
 
 void SpiMaster::OnEndEvent(BufferProvider& provider) {
@@ -89,19 +102,11 @@ void SpiMaster::OnEndEvent(BufferProvider& provider) {
   auto s = currentBufferSize;
   if(s > 0) {
     auto currentSize = std::min((size_t) 255, s);
-
+    PrepareTx(currentBufferAddr, currentSize);
-    NRF_SPIM0->TXD.PTR = (uint32_t) currentBufferAddr;
-    NRF_SPIM0->TXD.MAXCNT = currentSize;
-    NRF_SPIM0->TXD.LIST = 0;
-
     currentBufferAddr += currentSize;
     currentBufferSize -= currentSize;
 
-    NRF_SPIM0->RXD.PTR = (uint32_t) 0;
+    spiBaseAddress->TASKS_START = 1;
-    NRF_SPIM0->RXD.MAXCNT = 0;
-    NRF_SPIM0->RXD.LIST = 0;
-
-    NRF_SPIM0->TASKS_START = 1;
   } else {
     uint8_t* buffer = nullptr;
     size_t size = 0;
@@ -110,18 +115,11 @@ void SpiMaster::OnEndEvent(BufferProvider& provider) {
       currentBufferSize = size;
       auto s = currentBufferSize;
       auto currentSize = std::min((size_t)255, s);
-      NRF_SPIM0->TXD.PTR = (uint32_t) currentBufferAddr;
+      PrepareTx(currentBufferAddr, currentSize);
-      NRF_SPIM0->TXD.MAXCNT = currentSize;
-      NRF_SPIM0->TXD.LIST = 0;
-
       currentBufferAddr += currentSize;
       currentBufferSize -= currentSize;
 
-      NRF_SPIM0->RXD.PTR = (uint32_t) 0;
+      spiBaseAddress->TASKS_START = 1;
-      NRF_SPIM0->RXD.MAXCNT = 0;
-      NRF_SPIM0->RXD.LIST = 0;
-
-      NRF_SPIM0->TASKS_START = 1;
     } else {
       busy = false;
       nrf_gpio_pin_set(pinCsn);
@@ -133,6 +131,16 @@ void SpiMaster::OnStartedEvent(BufferProvider& provider) {
   if(!busy) return;
 }
 
+void SpiMaster::PrepareTx(const volatile uint32_t bufferAddress, const volatile size_t size) {
+  spiBaseAddress->TXD.PTR = bufferAddress;
+  spiBaseAddress->TXD.MAXCNT = size;
+  spiBaseAddress->TXD.LIST = 0;
+  spiBaseAddress->RXD.PTR = 0;
+  spiBaseAddress->RXD.MAXCNT = 0;
+  spiBaseAddress->RXD.LIST = 0;
+  spiBaseAddress->EVENTS_END = 0;
+}
+
 bool SpiMaster::Write(const uint8_t *data, size_t size) {
   if(data == nullptr) return false;
 
@@ -141,18 +149,9 @@ bool SpiMaster::Write(const uint8_t *data, size_t size) {
   }
 
   if(size == 1) {
-    setup_workaround_for_ftpan_58(NRF_SPIM0, 0,0);
+    SetupWorkaroundForFtpan58(spiBaseAddress, 0,0);
-    NRF_SPIM0->INTENCLR = (1<<6);
-    NRF_SPIM0->INTENCLR = (1<<1);
-    NRF_SPIM0->INTENCLR = (1<<19);
   } else {
-    NRF_GPIOTE->CONFIG[0] = 0;
+    DisableWorkaroundForFtpan58(spiBaseAddress, 0, 0);
-    NRF_PPI->CH[0].EEP = 0;
-    NRF_PPI->CH[0].TEP = 0;
-    NRF_PPI->CHENSET = 0;
-    NRF_SPIM0->INTENSET = (1<<6);
-    NRF_SPIM0->INTENSET = (1<<1);
-    NRF_SPIM0->INTENSET = (1<<19);
   }
 
   nrf_gpio_pin_clear(pinCsn);
@@ -162,21 +161,13 @@ bool SpiMaster::Write(const uint8_t *data, size_t size) {
   busy = true;
 
   auto currentSize = std::min((size_t)255, (size_t)currentBufferSize);
-  NRF_SPIM0->TXD.PTR = currentBufferAddr;
+  PrepareTx(currentBufferAddr, currentSize);
-  NRF_SPIM0->TXD.MAXCNT = currentSize;
-  NRF_SPIM0->TXD.LIST = 0;
-
   currentBufferSize -= currentSize;
   currentBufferAddr += currentSize;
-
+  spiBaseAddress->TASKS_START = 1;
-  NRF_SPIM0->RXD.PTR = (uint32_t) 0;
-  NRF_SPIM0->RXD.MAXCNT = 0;
-  NRF_SPIM0->RXD.LIST = 0;
-  NRF_SPIM0->EVENTS_END = 0;
-  NRF_SPIM0->TASKS_START = 1;
 
   if(size == 1) {
-    while (NRF_SPIM0->EVENTS_END == 0);
+    while (spiBaseAddress->EVENTS_END == 0);
     busy = false;
   }
 
@@ -184,8 +175,8 @@ bool SpiMaster::Write(const uint8_t *data, size_t size) {
 }
 
 void SpiMaster::Sleep() {
-  while(NRF_SPIM0->ENABLE != 0) {
+  while(spiBaseAddress->ENABLE != 0) {
-    NRF_SPIM0->ENABLE = (SPIM_ENABLE_ENABLE_Disabled << SPIM_ENABLE_ENABLE_Pos);
+    spiBaseAddress->ENABLE = (SPIM_ENABLE_ENABLE_Disabled << SPIM_ENABLE_ENABLE_Pos);
   }
   nrf_gpio_cfg_default(params.pinSCK);
   nrf_gpio_cfg_default(params.pinMOSI);

src/drivers/SpiMaster.h

@@ -34,7 +34,9 @@ namespace Pinetime {
         void Wakeup();
 
       private:
-        void setup_workaround_for_ftpan_58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel);
+        void SetupWorkaroundForFtpan58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel);
+        void DisableWorkaroundForFtpan58(NRF_SPIM_Type *spim, uint32_t ppi_channel, uint32_t gpiote_channel);
+        void PrepareTx(const volatile uint32_t bufferAddress, const volatile size_t size);
 
         NRF_SPIM_Type *  spiBaseAddress;
         uint8_t pinCsn;