src/test/unit/unittest_displayport.h

   1 /*
   2  * This file is part of Cleanflight.
   3  *
   4  * Cleanflight is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * Cleanflight is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with Cleanflight.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #pragma once
  19
  20 #include <string.h>
  21
  22 extern "C" {
  23     #include "drivers/display.h"
  24 }
  25
  26 #include "unittest_macros.h"
  27 #include "gtest/gtest.h"
  28
  29 void displayPortTestBufferSubstring(int x, int y, const char * expectedFormat, ...) __attribute__ ((format (printf, 3, 4)));
  30
  31 #define UNITTEST_DISPLAYPORT_ROWS 16
  32 #define UNITTEST_DISPLAYPORT_COLS 30
  33 #define UNITTEST_DISPLAYPORT_BUFFER_LEN (UNITTEST_DISPLAYPORT_ROWS * UNITTEST_DISPLAYPORT_COLS)
  34
  35 char testDisplayPortBuffer[UNITTEST_DISPLAYPORT_BUFFER_LEN];
  36
  37 static displayPort_t testDisplayPort;
  38
  39 static int displayPortTestGrab(displayPort_t *displayPort)
  40 {
  41     UNUSED(displayPort);
  42     return 0;
  43 }
  44
  45 static int displayPortTestRelease(displayPort_t *displayPort)
  46 {
  47     UNUSED(displayPort);
  48     return 0;
  49 }
  50
  51 static int displayPortTestClearScreen(displayPort_t *displayPort)
  52 {
  53     UNUSED(displayPort);
  54     memset(testDisplayPortBuffer, ' ', UNITTEST_DISPLAYPORT_BUFFER_LEN);
  55     return 0;
  56 }
  57
  58 static bool displayPortTestDrawScreen(displayPort_t *displayPort)
  59 {
  60     UNUSED(displayPort);
  61     return 0;
  62 }
  63
  64 static int displayPortTestScreenSize(const displayPort_t *displayPort)
  65 {
  66     UNUSED(displayPort);
  67     return 0;
  68 }
  69
  70 static int displayPortTestWriteString(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, const char *s)
  71 {
  72     UNUSED(displayPort);
  73     UNUSED(attr);
  74     for (unsigned int i = 0; i < strlen(s); i++) {
  75         testDisplayPortBuffer[(y * UNITTEST_DISPLAYPORT_COLS) + x + i] = s[i];
  76     }
  77     return 0;
  78 }
  79
  80 static int displayPortTestWriteChar(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, uint8_t c)
  81 {
  82     UNUSED(displayPort);
  83     UNUSED(attr);
  84     testDisplayPortBuffer[(y * UNITTEST_DISPLAYPORT_COLS) + x] = c;
  85     return 0;
  86 }
  87
  88 static bool displayPortTestIsTransferInProgress(const displayPort_t *displayPort)
  89 {
  90     UNUSED(displayPort);
  91     return 0;
  92 }
  93
  94 static int displayPortTestHeartbeat(displayPort_t *displayPort)
  95 {
  96     UNUSED(displayPort);
  97     return 0;
  98 }
  99
 100 static void displayPortTestRedraw(displayPort_t *displayPort)
 101 {
 102     UNUSED(displayPort);
 103 }
 104
 105 static uint32_t displayPortTestTxBytesFree(const displayPort_t *displayPort)
 106 {
 107     UNUSED(displayPort);
 108     return 0;
 109 }
 110
 111 static const displayPortVTable_t testDisplayPortVTable = {
 112     .grab = displayPortTestGrab,
 113     .release = displayPortTestRelease,
 114     .clearScreen = displayPortTestClearScreen,
 115     .drawScreen = displayPortTestDrawScreen,
 116     .screenSize = displayPortTestScreenSize,
 117     .writeString = displayPortTestWriteString,
 118     .writeChar = displayPortTestWriteChar,
 119     .isTransferInProgress = displayPortTestIsTransferInProgress,
 120     .heartbeat = displayPortTestHeartbeat,
 121     .redraw = displayPortTestRedraw,
 122     .txBytesFree = displayPortTestTxBytesFree
 123 };
 124
 125 displayPort_t *displayPortTestInit(void)
 126 {
 127     displayInit(&testDisplayPort, &testDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MAX7456);
 128     testDisplayPort.rows = UNITTEST_DISPLAYPORT_ROWS;
 129     testDisplayPort.cols = UNITTEST_DISPLAYPORT_COLS;
 130     return &testDisplayPort;
 131 }
 132
 133 void displayPortTestPrint(void)
 134 {
 135     for (int i = 0; i < UNITTEST_DISPLAYPORT_BUFFER_LEN; i++) {
 136         if (i > 0 && i % UNITTEST_DISPLAYPORT_COLS == 0) {
 137             printf("\n");
 138         }
 139         printf("%c", testDisplayPortBuffer[i]);
 140     }
 141     printf("\n\n");
 142 }
 143
 144 void displayPortTestBufferIsEmpty()
 145 {
 146     for (size_t i = 0; i < UNITTEST_DISPLAYPORT_BUFFER_LEN; i++) {
 147         EXPECT_EQ(' ', testDisplayPortBuffer[i]);
 148         if (testDisplayPortBuffer[i] != ' ') {
 149             testDisplayPortBuffer[UNITTEST_DISPLAYPORT_BUFFER_LEN - 1] = '\0';
 150             printf("FIRST ERROR AT:%d\r\n", (int)i);
 151             printf("DISPLAY:%s\r\n", testDisplayPortBuffer);
 152             break;
 153         }
 154     }
 155 }
 156
 157 void displayPortTestBufferSubstring(int x, int y, const char * expectedFormat, ...)
 158 {
 159     char expected[UNITTEST_DISPLAYPORT_BUFFER_LEN];
 160
 161     va_list args;
 162     va_start(args, expectedFormat);
 163     vsnprintf(expected, UNITTEST_DISPLAYPORT_BUFFER_LEN, expectedFormat, args);
 164     va_end(args);
 165
 166 #ifdef DEBUG_OSD
 167     displayPortTestPrint();
 168 #endif
 169
 170     for (size_t i = 0; i < strlen(expected); i++) {
 171         EXPECT_EQ(expected[i], testDisplayPortBuffer[(y * testDisplayPort.cols) + x + i]);
 172     }
 173 }