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 #include <stdarg.h>
  22
  23 extern "C" {
  24     #include "drivers/display.h"
  25 }
  26
  27 #include "unittest_macros.h"
  28 #include "gtest/gtest.h"
  29
  30 void displayPortTestBufferSubstring(int x, int y, const char * expectedFormat, ...) __attribute__ ((format (printf, 3, 4)));
  31
  32 #define UNITTEST_DISPLAYPORT_ROWS 16
  33 #define UNITTEST_DISPLAYPORT_COLS 30
  34 #define UNITTEST_DISPLAYPORT_BUFFER_LEN (UNITTEST_DISPLAYPORT_ROWS * UNITTEST_DISPLAYPORT_COLS)
  35
  36 char testDisplayPortBuffer[UNITTEST_DISPLAYPORT_BUFFER_LEN];
  37
  38 static displayPort_t testDisplayPort;
  39
  40 static int displayPortTestGrab(displayPort_t *displayPort)
  41 {
  42     UNUSED(displayPort);
  43     return 0;
  44 }
  45
  46 static int displayPortTestRelease(displayPort_t *displayPort)
  47 {
  48     UNUSED(displayPort);
  49     return 0;
  50 }
  51
  52 static int displayPortTestClearScreen(displayPort_t *displayPort, displayClearOption_e options)
  53 {
  54     UNUSED(displayPort);
  55     UNUSED(options);
  56     memset(testDisplayPortBuffer, ' ', UNITTEST_DISPLAYPORT_BUFFER_LEN);
  57     return 0;
  58 }
  59
  60 static bool displayPortTestDrawScreen(displayPort_t *displayPort)
  61 {
  62     UNUSED(displayPort);
  63     return 0;
  64 }
  65
  66 static int displayPortTestScreenSize(const displayPort_t *displayPort)
  67 {
  68     UNUSED(displayPort);
  69     return 0;
  70 }
  71
  72 static int displayPortTestWriteString(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, const char *s)
  73 {
  74     UNUSED(displayPort);
  75     UNUSED(attr);
  76     for (unsigned int i = 0; i < strlen(s); i++) {
  77         testDisplayPortBuffer[(y * UNITTEST_DISPLAYPORT_COLS) + x + i] = s[i];
  78     }
  79     return 0;
  80 }
  81
  82 static int displayPortTestWriteChar(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, uint8_t c)
  83 {
  84     UNUSED(displayPort);
  85     UNUSED(attr);
  86     testDisplayPortBuffer[(y * UNITTEST_DISPLAYPORT_COLS) + x] = c;
  87     return 0;
  88 }
  89
  90 static bool displayPortTestIsTransferInProgress(const displayPort_t *displayPort)
  91 {
  92     UNUSED(displayPort);
  93     return 0;
  94 }
  95
  96 static int displayPortTestHeartbeat(displayPort_t *displayPort)
  97 {
  98     UNUSED(displayPort);
  99     return 0;
 100 }
 101
 102 static void displayPortTestRedraw(displayPort_t *displayPort)
 103 {
 104     UNUSED(displayPort);
 105 }
 106
 107 static uint32_t displayPortTestTxBytesFree(const displayPort_t *displayPort)
 108 {
 109     UNUSED(displayPort);
 110     return 0;
 111 }
 112
 113 static const displayPortVTable_t testDisplayPortVTable = {
 114     .grab = displayPortTestGrab,
 115     .release = displayPortTestRelease,
 116     .clearScreen = displayPortTestClearScreen,
 117     .drawScreen = displayPortTestDrawScreen,
 118     .screenSize = displayPortTestScreenSize,
 119     .writeString = displayPortTestWriteString,
 120     .writeChar = displayPortTestWriteChar,
 121     .isTransferInProgress = displayPortTestIsTransferInProgress,
 122     .heartbeat = displayPortTestHeartbeat,
 123     .redraw = displayPortTestRedraw,
 124     .txBytesFree = displayPortTestTxBytesFree
 125 };
 126
 127 displayPort_t *displayPortTestInit(void)
 128 {
 129     displayInit(&testDisplayPort, &testDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MAX7456);
 130     testDisplayPort.rows = UNITTEST_DISPLAYPORT_ROWS;
 131     testDisplayPort.cols = UNITTEST_DISPLAYPORT_COLS;
 132     return &testDisplayPort;
 133 }
 134
 135 void displayPortTestPrint(void)
 136 {
 137     for (int i = 0; i < UNITTEST_DISPLAYPORT_BUFFER_LEN; i++) {
 138         if (i > 0 && i % UNITTEST_DISPLAYPORT_COLS == 0) {
 139             printf("\n");
 140         }
 141         printf("%c", testDisplayPortBuffer[i]);
 142     }
 143     printf("\n\n");
 144 }
 145
 146 void displayPortTestBufferIsEmpty()
 147 {
 148     for (size_t i = 0; i < UNITTEST_DISPLAYPORT_BUFFER_LEN; i++) {
 149         EXPECT_EQ(' ', testDisplayPortBuffer[i]);
 150         if (testDisplayPortBuffer[i] != ' ') {
 151             testDisplayPortBuffer[UNITTEST_DISPLAYPORT_BUFFER_LEN - 1] = '\0';
 152             printf("FIRST ERROR AT:%d\r\n", (int)i);
 153             printf("DISPLAY:%s\r\n", testDisplayPortBuffer);
 154             break;
 155         }
 156     }
 157 }
 158
 159 void displayPortTestBufferSubstring(int x, int y, const char * expectedFormat, ...)
 160 {
 161     char expected[UNITTEST_DISPLAYPORT_BUFFER_LEN];
 162
 163     va_list args;
 164     va_start(args, expectedFormat);
 165     vsnprintf(expected, UNITTEST_DISPLAYPORT_BUFFER_LEN, expectedFormat, args);
 166     va_end(args);
 167
 168 #ifdef DEBUG_OSD
 169     displayPortTestPrint();
 170 #endif
 171
 172     for (size_t i = 0; i < strlen(expected); i++) {
 173         EXPECT_EQ(expected[i], testDisplayPortBuffer[(y * testDisplayPort.cols) + x + i]);
 174     }
 175 }